Merge pull request #43 from launchdarkly/eb/ch37610/allow-skip-db-tests

add param to skip db tests, update docs for new repo name

Author: eli-darkly

CONTRIBUTING.md

@@ -1,4 +1,39 @@
-Contributing to the LaunchDarkly SDK for PHP
-================================================
+# Contributing to the LaunchDarkly SDK FOR PHP
 
-We encourage pull-requests and other contributions from the community. We've also published an [SDK contributor's guide](http://docs.launchdarkly.com/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work.
+LaunchDarkly has published an [SDK contributor's guide](https://docs.launchdarkly.com/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work. See below for additional information on how to contribute to this SDK.
+
+## Submitting bug reports and feature requests
+ 
+The LaunchDarkly SDK team monitors the issue tracker associated with in the `launchdarkly/php-server-sdk` SDK repository. Bug reports and feature requests specific to this SDK should be filed in this issue tracker. The SDK team will respond to all newly filed issues within two business days.
+
+## Submitting pull requests
+ 
+We encourage pull requests and other contributions from the community. Before submitting pull requests, ensure that all temporary or unintended code is removed. Don't worry about adding reviewers to the pull request; the LaunchDarkly SDK team will add themselves. The SDK team will acknowledge all pull requests within two business days.
+
+## Build instructions
+
+### Prerequisites
+
+The project uses [Composer](https://getcomposer.org/).
+
+If you will be running the full test suite that includes the database integrations, you will need to have instances of Consul, DynamoDB, and Redis running locally. See below for how to skip these tests.
+
+### Installing dependencies
+
+From the project root directory:
+
+```
+composer install
+```
+
+### Testing
+
+To run all unit tests:
+
+```
+phpunit
+```
+
+By default, the full unit test suite includes live tests of the integrations for Consul, DynamoDB, and Redis. To skip these, set the environment variable `LD_SKIP_DATABASE_TESTS=1` before running the 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.

README.md

@@ -1,7 +1,7 @@
 LaunchDarkly SDK for PHP
 ===========================
 
-[![Circle CI](https://circleci.com/gh/launchdarkly/php-client.svg?style=svg)](https://circleci.com/gh/launchdarkly/php-client)
+[![Circle CI](https://circleci.com/gh/launchdarkly/php-server-sdk.svg?style=svg)](https://circleci.com/gh/launchdarkly/php-server-sdk)
 
 Requirements
 ------------
@@ -56,7 +56,7 @@ Require Guzzle as a dependency:
 
 It will then be used as the default way of fetching flags.
 
-With Guzzle, you could persist your cache somewhere other than the default in-memory store, like Memcached or Redis.  You could then specify your cache when initializing the client with the [cache option](https://github.com/launchdarkly/php-client/blob/master/src/LaunchDarkly/LDClient.php#L44).
+With Guzzle, you could persist your cache somewhere other than the default in-memory store, like Memcached or Redis.  You could then specify your cache when initializing the client with the [cache option](https://github.com/launchdarkly/php-server-sdk/blob/master/src/LaunchDarkly/LDClient.php#L44).
 
     $client = new LaunchDarkly\LDClient("YOUR_SDK_KEY", array("cache" => $cacheStorage));
 
@@ -127,7 +127,7 @@ The LaunchDarkly Relay Proxy ([ld-relay](https://github.com/launchdarkly/ld-rela
 Using flag data from a file
 ---------------------------
 
-For testing purposes, the SDK can be made to read feature flag state from a file or files instead of connecting to LaunchDarkly. See [`LaunchDarkly\Integrations\Files`](https://github.com/launchdarkly/php-client/blob/master/src/LaunchDarkly/Integrations/Files.php) and ["Reading flags from a file"](https://docs.launchdarkly.com/docs/reading-flags-from-a-file).
+For testing purposes, the SDK can be made to read feature flag state from a file or files instead of connecting to LaunchDarkly. See [`LaunchDarkly\Integrations\Files`](https://github.com/launchdarkly/php-server-sdk/blob/master/src/LaunchDarkly/Integrations/Files.php) and ["Reading flags from a file"](https://docs.launchdarkly.com/docs/reading-flags-from-a-file).
 
 Testing
 -------
@@ -142,7 +142,7 @@ Check out our [documentation](http://docs.launchdarkly.com) for in-depth instruc
 Contributing
 ------------
 
-We encourage pull-requests and other contributions from the community. We've also published an [SDK contributor's guide](http://docs.launchdarkly.com/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work.
+We encourage pull-requests and other contributions from the community. We've also published an [SDK contributor's guide](http://docs.launchdarkly.com/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work. See [CONTRIBUTING](CONTRIBUTING.md) for more developer information about this project.
 
 About LaunchDarkly
 ------------------

composer.json

@@ -5,7 +5,7 @@
         "launchdarkly",
         "launchdarkly php"
     ],
-    "homepage": "https://github.com/launchdarkly/php-client",
+    "homepage": "https://github.com/launchdarkly/php-server-sdk",
     "license": "Apache-2.0",
     "authors": [
         {

scripts/release.sh

@@ -10,7 +10,7 @@
 # When done you should commit and push the changes made.
 
 set -uxe
-echo "Starting php-client release (version update only)"
+echo "Starting php-server-sdk release (version update only)"
 
 VERSION=$1
 
@@ -22,4 +22,4 @@ LDCLIENT_PHP_TEMP=./LDClient.php.tmp
 sed "s/const VERSION = '.*'/const VERSION = '${VERSION}'/g" $LDCLIENT_PHP > $LDCLIENT_PHP_TEMP
 mv $LDCLIENT_PHP_TEMP $LDCLIENT_PHP
 
-echo "Done with php-client release (version update only)"
+echo "Done with php-server-sdk release (version update only)"

tests/ConsulFeatureRequesterTest.php

@@ -15,8 +15,15 @@ class ConsulFeatureRequesterTest extends FeatureRequesterTestBase
 
     public static function setUpBeforeClass()
     {
-        $sf = new ServiceFactory();
-        self::$kvClient = $sf->get('kv');
+        if (!static::isSkipDatabaseTests()) {
+            $sf = new ServiceFactory();
+            self::$kvClient = $sf->get('kv');
+        }
+    }
+
+    protected function isDatabaseTest()
+    {
+        return true;
     }
 
     protected function makeRequester()

tests/DynamoDbFeatureRequesterTest.php

@@ -15,8 +15,15 @@ class DynamoDbFeatureRequesterTest extends FeatureRequesterTestBase
 
     public static function setUpBeforeClass()
     {
-        self::$dynamoDbClient = new DynamoDbClient(self::makeDynamoDbOptions());
-        self::createTableIfNecessary();
+        if (!static::isSkipDatabaseTests()) {
+            self::$dynamoDbClient = new DynamoDbClient(self::makeDynamoDbOptions());
+            self::createTableIfNecessary();
+        }
+    }
+
+    protected function isDatabaseTest()
+    {
+        return true;
     }
 
     private static function makeDynamoDbOptions()

tests/FeatureRequesterTestBase.php

@@ -9,7 +9,21 @@ class FeatureRequesterTestBase extends \PHPUnit_Framework_TestCase
 {
     public function setUp()
     {
-        $this->deleteExistingData();
+        if ($this->isDatabaseTest() && static::isSkipDatabaseTests()) {
+            $this->markTestSkipped('skipping database tests');
+        } else {
+            $this->deleteExistingData();
+        }
+    }
+
+    protected static function isSkipDatabaseTests()
+    {
+        return isset($_ENV['LD_SKIP_DATABASE_TESTS']) && $_ENV['LD_SKIP_DATABASE_TESTS'];
+    }
+
+    protected function isDatabaseTest()
+    {
+        return false;
     }
 
     protected function deleteExistingData()

tests/RedisFeatureRequesterTest.php

@@ -14,7 +14,14 @@ class RedisFeatureRequesterTest extends FeatureRequesterTestBase
 
     public static function setUpBeforeClass()
     {
-        self::$predisClient = new Client(array());
+        if (!static::isSkipDatabaseTests()) {
+            self::$predisClient = new Client(array());
+        }
+    }
+
+    protected function isDatabaseTest()
+    {
+        return true;
     }
 
     protected function makeRequester()