ci: Run the Flagsmith SDK behavioural spec (#147)

Author: khvn26

.gitattributes

@@ -6,3 +6,4 @@
 .prettierrc export-ignore
 tests export-ignore
 composer.phar export-ignore
+sdk-spec export-ignore

.github/workflows/sdk-spec.yml

@@ -0,0 +1,17 @@
+name: SDK spec
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  sdk-spec:
+    # Keep the ref in `uses:` and `spec-ref` in sync.
+    uses: Flagsmith/sdk-spec/.github/workflows/run-spec.yml@v0.3.0
+    with:
+      spec-ref: v0.3.0
+      language: php

renovate.json

@@ -4,6 +4,15 @@
     "ignorePresets": [":semanticPrefixFixDepsChoreOthers"],
     "semanticCommitType": "deps",
     "git-submodules": { "enabled": true },
+    "customManagers": [
+        {
+            "customType": "regex",
+            "managerFilePatterns": ["/^\\.github/workflows/sdk-spec\\.yml$/"],
+            "matchStrings": ["spec-ref: (?<currentValue>v[\\d.]+)"],
+            "depNameTemplate": "Flagsmith/sdk-spec",
+            "datasourceTemplate": "github-tags"
+        }
+    ],
     "packageRules": [
         {
             "matchUpdateTypes": [
@@ -23,6 +32,11 @@
             "matchManagers": ["git-submodules"],
             "versioning": "semver-coerced",
             "enabled": true
+        },
+        {
+            "matchPackageNames": ["Flagsmith/sdk-spec"],
+            "groupName": "SDK spec",
+            "enabled": true
         }
     ]
 }

sdk-spec/Dockerfile

@@ -0,0 +1,20 @@
+# Runs this SDK, built from source, under the Flagsmith SDK behavioural spec.
+# docker build -f sdk-spec/Dockerfile --build-context harness=<sdk-spec>/harness/php .
+FROM docker.io/library/php:8.4-cli
+
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends libgmp-dev unzip \
+    && docker-php-ext-install bcmath gmp \
+    && rm -rf /var/lib/apt/lists/*
+COPY --from=docker.io/library/composer:2 /usr/bin/composer /usr/bin/composer
+
+WORKDIR /sdk
+COPY composer.json ./
+COPY src ./src
+# Install the SDK with Guzzle as its PSR-18 HTTP client, as an application would.
+RUN composer require guzzlehttp/guzzle:^7.3 --update-no-dev --optimize-autoloader --no-interaction --no-progress
+
+COPY --from=harness harness.php /harness/harness.php
+COPY sdk-spec/steps.php ./sdk-spec/steps.php
+
+ENTRYPOINT ["php", "/harness/harness.php", "sdk-spec/steps.php"]

sdk-spec/steps.php

@@ -0,0 +1,38 @@
+<?php
+
+/**
+ * Steps for the Flagsmith SDK behavioural spec: https://github.com/Flagsmith/sdk-spec
+ *
+ * Each function implements the Gherkin step in the comment above it.
+ */
+
+declare(strict_types=1);
+
+use Flagsmith\Flagsmith;
+use Flagsmith\Models\Flags;
+
+function asSpecFlags(Flags $flags): array
+{
+    return array_map(
+        fn ($flag) => ['feature' => $flag->getFeatureName(), 'enabled' => $flag->getEnabled(), 'value' => $flag->getValue()],
+        $flags->allFlags(),
+    );
+}
+
+// Create the SDK client
+function createClient(string $environmentKey, string $apiUrl): Flagsmith
+{
+    return new Flagsmith(apiKey: $environmentKey, host: $apiUrl);
+}
+
+// When the application gets the environment flags
+function getEnvironmentFlags(Flagsmith $flagsmith): array
+{
+    return asSpecFlags($flagsmith->getEnvironmentFlags());
+}
+
+// When the application gets the flags for identity "{identifier}" with traits:
+function getIdentityFlags(Flagsmith $flagsmith, string $identifier, object $traits): array
+{
+    return asSpecFlags($flagsmith->getIdentityFlags($identifier, $traits));
+}