Testing system improvements

- Consul agent start / stop no longer managed by travis
- Added simple single-agent Consul manager

Author: dcarbone

.gitignore

@@ -3,4 +3,6 @@
 /.idea
 /*.iml
 /composer.lock
-/tmp
+/tmp
+/consul.log
+/consul.pid

.travis.yml

@@ -21,11 +21,5 @@ install:
   - chmod +x $HOME/bin/consul
   - composer install --no-interaction --no-progress --no-suggest --optimize-autoloader
 
-before_script:
-  - ./tests/run_consul.sh
-
 script:
   - ./vendor/bin/phpunit
-
-after_script:
-  - ./tests/stop_consul.sh

phpunit.local.xml

@@ -11,7 +11,13 @@
         stopOnFailure="true"
         processIsolation="false"
         backupGlobals="false"
-        >
+>
+
+    <php>
+        <env name="CONSUL_HTTP_ADDR" value="127.0.0.1:8500"/>
+        <env name="CONSUL_HTTP_SSL" value="0"/>
+    </php>
+
     <testsuite name="definition">
         <directory>./tests/Definition</directory>
         <directory>./tests/Usage</directory>
@@ -24,8 +30,8 @@
     </filter>
 
     <logging>
-        <log type="coverage-html" target="./tmp/tests/html" />
-        <log type="plain" target="./tmp/tests/php-consul-api-tests.log" />
+        <log type="coverage-html" target="./tmp/tests/html"/>
+        <log type="plain" target="./tmp/tests/php-consul-api-tests.log"/>
     </logging>
 
 </phpunit>

phpunit.xml.dist

@@ -12,6 +12,12 @@
         processIsolation="false"
         backupGlobals="false"
 >
+
+    <php>
+        <env name="CONSUL_HTTP_ADDR" value="127.0.0.1:8500"/>
+        <env name="CONSUL_HTTP_SSL" value="0"/>
+    </php>
+
     <testsuite name="definition">
         <directory>./tests/Definition</directory>
         <directory>./tests/Usage</directory>
@@ -24,7 +30,7 @@
     </filter>
 
     <logging>
-        <log type="plain" target="./tmp/tests/php-consul-api-tests.log" />
+        <log type="plain" target="./tmp/tests/php-consul-api-tests.log"/>
     </logging>
 
 </phpunit>

tests/ConsulManager.php

@@ -0,0 +1,62 @@
+<?php namespace DCarbone\PHPConsulAPITests;
+
+/*
+   Copyright 2016-2017 Daniel Carbone ([email protected])
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+/**
+ * Class ConsulManager
+ * @package DCarbone\PHPConsulAPITests
+ */
+abstract class ConsulManager {
+
+    const PID_FILE = __DIR__ . '/../consul.pid';
+
+    const START_SINGLE_CMD = __DIR__ . '/run_consul.sh';
+    const STOP_SINGLE_CMD = __DIR__ . '/stop_consul.sh';
+
+    /**
+     * Start a single instance of a consul agent in -dev mode
+     */
+    public static function startSingle() {
+        if (file_exists(self::PID_FILE)) {
+            self::stopSingle();
+        }
+
+        shell_exec(self::START_SINGLE_CMD);
+
+        if (file_exists(self::PID_FILE)) {
+            echo "\nconsul pid: " . file_get_contents(self::PID_FILE) . "\n";
+        } else {
+            echo "\nunable to locate consul.pid file!\n";
+        }
+
+        // sleep to allow consul to setup
+        sleep(5);
+    }
+
+    /**
+     * Stop running instance
+     */
+    public static function stopSingle() {
+        if (file_exists(self::PID_FILE)) {
+            shell_exec(self::STOP_SINGLE_CMD);
+            if (file_exists(self::PID_FILE)) {
+                unlink(self::PID_FILE);
+            }
+            sleep(2);
+        }
+    }
+}

tests/Usage/ConfigUsageTest.php

@@ -2,6 +2,7 @@
 
 use DCarbone\PHPConsulAPI\Config;
 use DCarbone\PHPConsulAPI\Consul;
+use DCarbone\PHPConsulAPITests\ConsulManager;
 
 /*
    Copyright 2016-2017 Daniel Carbone ([email protected])
@@ -27,6 +28,14 @@ class ConfigUsageTest extends \PHPUnit_Framework_TestCase {
     const DEFAULT_ADDRESS = '127.0.0.1:8500';
     const DEFAULT_SCHEME = 'http';
 
+    protected function setUp() {
+        ConsulManager::startSingle();
+    }
+
+    protected function tearDown() {
+        ConsulManager::stopSingle();
+    }
+
     /**
      * @return Config
      */
@@ -42,8 +51,8 @@ public function testCanConstructConfig() {
     public function testConfigDefaults() {
         $config = new Config();
 
-        $expectedAddress = getenv(Consul::HTTPAddrEnvName) ?: self::DEFAULT_ADDRESS;
-        $expectedScheme = (bool)getenv(Consul::HTTPSSLEnvName) ? 'https' : self::DEFAULT_SCHEME;
+        $expectedAddress = $_ENV[Consul::HTTPAddrEnvName] ?: self::DEFAULT_ADDRESS;
+        $expectedScheme = $_ENV[Consul::HTTPSSLEnvName] ? 'https' : self::DEFAULT_SCHEME;
 
         $this->assertEquals($expectedAddress,
             $config->getAddress(),

tests/Usage/KV/KVClientUsageTest.php

@@ -21,45 +21,82 @@
 use DCarbone\PHPConsulAPI\KV\KVPair;
 use DCarbone\PHPConsulAPI\QueryMeta;
 use DCarbone\PHPConsulAPI\WriteMeta;
+use DCarbone\PHPConsulAPITests\ConsulManager;
 
 /**
  * Class KVClientUsageTest
  * @package DCarbone\PHPConsulAPITests\Usage\KV
  */
 class KVClientUsageTest extends \PHPUnit_Framework_TestCase {
+
+    const KVKey = 'testkey';
+    const KVValue = 'testvalue';
+
+    /**
+     * Sets up the fixture, for example, open a network connection.
+     * This method is called before a test is executed.
+     */
+    protected function setUp() {
+        ConsulManager::startSingle();
+    }
+
+    /**
+     * Tears down the fixture, for example, close a network connection.
+     * This method is called after a test is executed.
+     */
+    protected function tearDown() {
+        ConsulManager::stopSingle();
+    }
+
     /**
      * @return KVClient
      */
     public function testCanConstructClient() {
-        $kv = new KVClient(Config::newDefaultConfig());
+        $kv = new KVClient(new Config());
         $this->assertInstanceOf(KVClient::class, $kv);
         return $kv;
     }
 
     /**
      * @depends testCanConstructClient
-     * @param KVClient $client
      */
-    public function testKVLifecycle(KVClient $client) {
-        $kvp = new KVPair(['Key' => 'testkey', 'Value' => 'testvalue']);
+    public function testCanPutKey() {
+        $client = new KVClient(new Config());
 
-        list($wm, $err) = $client->put($kvp);;
+        list($wm, $err) = $client->put(new KVPair(['Key' => self::KVKey, 'Value' => self::KVValue]));
         $this->assertNull($err, sprintf('Unable to set kvp: %s', (string)$err));
         $this->assertInstanceOf(WriteMeta::class, $wm);
+    }
 
-        list($kvp, $qm, $err) = $client->get('testkey');
-        $this->assertNull($err, sprintf('Unable to get kvp: %s', (string)$err));
+    /**
+     * @depends testCanPutKey
+     */
+    public function testCanGetKey() {
+        $client = new KVClient(new Config());
+        $client->put(new KVPair(['Key' => self::KVKey, 'Value' => self::KVValue]));
+
+        list($kv, $qm, $err) = $client->get(self::KVKey);
+        $this->assertNull($err, sprintf('KV::get returned error: %s', (string)$err));
         $this->assertInstanceOf(QueryMeta::class, $qm);
-        $this->assertInstanceOf(KVPair::class, $kvp);
-        $this->assertEquals('testvalue', $kvp->Value);
+        $this->assertInstanceOf(KVPair::class, $kv);
+    }
 
-        list($wm, $err) = $client->delete('testkey');
-        $this->assertNull($err, sprintf('Unable to delete kvp: %s', (string)$err));
-        $this->assertInstanceOf(WriteMeta::class, $wm);
+    /**
+     * @depends testCanPutKey
+     */
+    public function testCanDeleteKey() {
+        $client = new KVClient(new Config());
+        $client->put(new KVPair(['Key' => self::KVKey, 'Value' => self::KVValue]));
 
-        list($kvp, $qm, $err) = $client->get('testkey');
-        $this->assertNull($err);
-        $this->assertInstanceOf(QueryMeta::class, $qm);
-        $this->assertNull($kvp);
+        list($wm, $err) = $client->delete(self::KVKey);
+        $this->assertNull($err, sprintf('KV::delete returned error: %s', $err));
+        $this->assertInstanceOf(
+            WriteMeta::class,
+            $wm,
+            sprintf(
+                'expected "%s", saw "%s"',
+                WriteMeta::class,
+                is_object($wm) ? get_class($wm) : gettype($wm)
+            ));
     }
 }

tests/run_consul.sh

@@ -1,12 +1,3 @@
 #!/usr/bin/env bash
 
-${HOME}/bin/consul agent -dev &
-
-PID=$!
-
-echo "consul pid: ${PID}"
-
-echo ${PID} > consul.pid
-echo "sleeping for 10 seconds to give consul time to set up..."
-sleep 10
-
+/usr/bin/env consul agent -dev >> consul.log 2>&1 & echo $! > consul.pid