Add integration test for curl event publisher (#77)

Author: keelerm84

.circleci/config.yml

@@ -19,10 +19,15 @@ jobs:
       docker-image:
         type: string
 
+    environment:
+      LD_INCLUDE_INTEGRATION_TESTS: 1
+
     docker:
       - image: <<parameters.docker-image>>
+      - image: wiremock/wiremock
 
     steps:
+      - setup_remote_docker
       - checkout
       - run:
           name: validate composer.json

CONTRIBUTING.md

@@ -33,3 +33,9 @@ To run all unit tests:
 ```
 
 It is preferable to run tests against all supported minor versions of PHP (as described in `README.md` under Requirements), or at least the lowest and highest versions, prior to submitting a pull request. However, LaunchDarkly's CI tests will run automatically against all supported versions.
+
+By default, this test suite does not include any integration test that relies on external dependencies. To include them, set the environment variable `LD_INCLUDE_INTEGRATION_TESTS=1` before running the tests. Note that you will also need an instance of [WireMock](http://wiremock.org/) for the tests to connect to. This can be run via docker as follows:
+
+```
+docker run --rm -p 8080:8080 wiremock/wiremock
+```

composer.json

@@ -22,8 +22,8 @@
         "friendsofphp/php-cs-fixer": ">=2.2.19 <3.0",
         "guzzlehttp/guzzle": "^7",
         "kevinrob/guzzle-cache-middleware": "^3",
-        "phpunit/phpunit": "^9",
         "phpunit/php-code-coverage": "^9",
+        "phpunit/phpunit": "^9",
         "vimeo/psalm": "4.9.2"
     },
     "suggest": {

tests/Impl/Integrations/CurlEventPublisherTest.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace LaunchDarkly\Tests\Impl\Integrations;
+
+use GuzzleHttp\Client;
+use LaunchDarkly\EventPublisher;
+use LaunchDarkly\Impl\Integrations;
+use LaunchDarkly\LDClient;
+use PHPUnit\Framework\TestCase;
+
+class CurlEventPublisherTest extends TestCase
+{
+    public function setUp(): void
+    {
+        if (!getenv("LD_INCLUDE_INTEGRATION_TESTS")) {
+            $this->markTestSkipped("Skipping integration test");
+        }
+
+        $client = new Client();
+        $client->request('DELETE', 'http://localhost:8080/__admin/requests');
+    }
+
+    public function testSendsCorrectBodyAndHeaders()
+    {
+        $event = json_encode(["key" => "user-key"]);
+        $publisher = new Integrations\CurlEventPublisher('sdk-key', ['events_uri' => 'http://localhost:8080']);
+        $publisher->publish($event);
+
+        $requests = [];
+        $client = new Client();
+
+        // Provide time for the curl to execute
+        $start = time();
+        while (time() - $start < 5) {
+            $response = $client->request('GET', 'http://localhost:8080/__admin/requests');
+            $body = json_decode($response->getBody()->getContents(), true);
+            $requests = $body['requests'];
+
+            if ($requests) {
+                break;
+            }
+            usleep(100);
+        }
+
+        if (!$requests) {
+            $this->fail("Unable to connect to endpoint within specified timeout");
+        }
+
+        $this->assertCount(1, $requests);
+
+        $request = $requests[0]['request'];
+
+        // Validate that we hit the right endpoint with the right data
+        $this->assertEquals($event, $request['body']);
+        $this->assertEquals('/bulk', $request['url']);
+
+        // And validate that we provided all the correct headers
+        $headers = $request['headers'];
+        $this->assertEquals('application/json', $headers['Content-Type']);
+        $this->assertEquals('application/json', $headers['Accept']);
+        $this->assertEquals('sdk-key', $headers['Authorization']);
+        $this->assertEquals('PHPClient/' . LDClient::VERSION, $headers['User-Agent']);
+        $this->assertEquals(EventPublisher::CURRENT_SCHEMA_VERSION, $headers['X-LaunchDarkly-Event-Schema']);
+    }
+}