change test service to not require Docker, enable tests in CI (#100)

Author: eli-darkly

.circleci/config.yml

@@ -53,6 +53,7 @@ jobs:
 
     environment:
       LD_INCLUDE_INTEGRATION_TESTS: 1
+      TEST_HARNESS_PARAMS: -junit build/contract-tests-output/junit-results.xml
 
     docker:
       - image: cimg/php:<<parameters.php-version>>
@@ -90,10 +91,23 @@ jobs:
       - run:
           name: run tests
           command: php -d xdebug.mode=coverage vendor/bin/phpunit
-          enviroment:
+          environment:
             XDEBUG_MODE: coverage
 
+      - run:
+          name: build contract test service
+          command: make build-contract-tests
+      - run:
+          name: start contract test service
+          command: make start-contract-test-service
+          background: true
+      - run:
+          name: run contract tests
+          command: mkdir -p build/contract-tests-output && make run-contract-tests
+
       - store_test_results:
           path: build/phpunit
+      - store_test_results:
+          path: build/contract-tests-output
       - store_artifacts:
           path: build/phpunit

.gitignore

@@ -1,4 +1,5 @@
 /vendor/
+/test-service/vendor/
 /doc/
 *.iml
 composer.phar

Dockerfile.testservice

@@ -2,17 +2,23 @@
 TEMP_TEST_OUTPUT=/tmp/sse-contract-test-service.log
 
 # TEST_HARNESS_PARAMS can be set to add -skip parameters for any contract tests that cannot yet pass
-TEST_HARNESS_PARAMS=
+# Explanation of current skips:
+# - "secondary": In the PHP SDK this is not an addressable attribute for clauses; in other
+#   SDKs, it is. This was underspecified in the past; in future major versions, the other
+#   SDKs and the contract tests will be in line with the PHP behavior.
+# - "date - bad syntax", "semver - bad type": The PHP SDK has insufficiently strict
+#   validation for these types. We will definitely fix this in 5.0 but may or may not
+#   address it in 4.x, since it does not prevent any valid values from working.
+TEST_HARNESS_PARAMS := $(TEST_HARNESS_PARAMS) \
+	-skip 'evaluation/parameterized/secondary' \
+	-skip 'evaluation/parameterized/operators - date - bad syntax' \
+	-skip 'evaluation/parameterized/operators - semver - bad type'
 
 build-contract-tests:
-	@docker build -f Dockerfile.testservice -t php-test-service .
+	@cd test-service && composer install --no-progress
 
 start-contract-test-service: build-contract-tests
-	@docker run -it --rm \
-		--name php-test-service \
-		--publish 8000:8000 \
-		--add-host=host.docker.internal:host-gateway \
-		php-test-service
+	@cd test-service && php -S localhost:8000 index.php
 
 start-contract-test-service-bg:
 	@echo "Test service output will be captured in $(TEMP_TEST_OUTPUT)"

Makefile

@@ -5,3 +5,5 @@ This directory contains an implementation of the cross-platform SDK testing prot
 To run these tests locally, run `make contract-tests` from the SDK project root directory. This downloads the correct version of the test harness tool automatically.
 
 Or, to test against an in-progress local version of the test harness, run `make start-contract-test-service` from the SDK project root directory; then, in the root directory of the `sdk-test-harness` project, build the test harness and run it from the command line.
+
+The test service is designed to be run by any web server; PHP's built-in development server is adequate. The server must be configured to run `index.php` for all requests. The environment variable `LD_TEST_SERVICE_DATA_DIR` can be set, if desired, to point to a specific file path where the test service can store data; otherwise it will create a directory under `/tmp`.

test-service/.htaccess

@@ -31,11 +31,11 @@ public static function createSdkClient($params, $logger)
         ];
 
         $pollingConfig = $config['polling'] ?? [];
-        $options['base_uri'] = self::adjustBaseUri($pollingConfig['baseUri'] ?? null);
+        $options['base_uri'] = $pollingConfig['baseUri'] ?? null;
 
         $options['send_events'] = ($config['events'] ?? null) !== null;
         $eventsConfig = $config['events'] ?? [];
-        $options['events_uri'] = self::adjustBaseUri($eventsConfig['baseUri'] ?? null);
+        $options['events_uri'] = $eventsConfig['baseUri'] ?? null;
         $options['all_attributes_private'] = $eventsConfig['allAttributesPrivate'] ?? false;
         $options['private_attribute_names'] = $eventsConfig['globalPrivateAttributes'] ?? null;
 
@@ -53,6 +53,10 @@ public function doCommand($reqParams)
         $command = $reqParams['command'];
         $commandParams = $reqParams[$command] ?? null;
         switch ($command) {
+            case 'aliasEvent':
+                $this->doAliasEvent($commandParams);
+                return null;
+
             case 'customEvent':
                 $this->doCustomEvent($commandParams);
                 return null;
@@ -79,11 +83,12 @@ public function doCommand($reqParams)
         }
     }
 
-    private static function adjustBaseUri($baseUri)
+    private function doAliasEvent($params)
     {
-        return $baseUri ?
-            preg_replace('@^http://localhost:@', 'http://host.docker.internal:', $baseUri)
-            : null;
+        $this->_client->alias(
+            $this->makeUser($params['user']),
+            $this->makeUser($params['previousUser'])
+        );
     }
 
     private function doCustomEvent($params)

test-service/README.md

@@ -7,10 +7,10 @@
   ],
   "require": {
     "doctrine/cache": "^1.0",
-    "guzzlehttp/guzzle": "^7",
-    "kevinrob/guzzle-cache-middleware": "^3",
+    "guzzlehttp/guzzle": "^6.3 | ^7",
+    "kevinrob/guzzle-cache-middleware": "^4.0",
     "launchdarkly/server-sdk": "*",
-    "mikecao/flight": "1.*",
+    "mikecao/flight": "1.* | 2.*",
     "monolog/monolog": "1.*",
     "php": ">=7.3",
     "psr/log": "1.*"

test-service/SdkClientEntity.php

@@ -1,5 +1,8 @@
 <?php
 
+// This script is executed by the webserver for every request, regardless of the
+// request path. We use Flight to route requests.
+
 require_once 'vendor/autoload.php';
 
 require_once 'SdkClientEntity.php';
@@ -12,6 +15,16 @@
 $logger = new Monolog\Logger('testservice');
 $logger->pushHandler(new Monolog\Handler\StreamHandler('php://stderr', Monolog\Logger::DEBUG));
 
-$store = new TestDataStore('/app/test-service/data-store');
+$dataStorePath = getenv("LD_TEST_SERVICE_DATA_DIR");
+if (!$dataStorePath) {
+    $dataStorePath = '/tmp/php-server-sdk-test-service';
+}
+if (!is_dir($dataStorePath)) {
+    if (!mkdir($dataStorePath, 0700, true)) {
+        return false;
+    }
+}
+
+$store = new TestDataStore($dataStorePath);
 $service = new TestService($store, $logger);
 $service->start();