Improved WireMock integration through separation of module and extension configurations. Now the module can be used to connect to an existent WireMock without using the extension

Author: mcustiel

README.md

@@ -10,6 +10,10 @@ After the tests are finished it will close the connection and turn wiremock serv
 * [Stubbing using WireMock](http://wiremock.org/stubbing.html)
 * [Verifying using WireMock](http://wiremock.org/verifying.html)
 
+## Note
+
+If you need an application with a functionality that is similar to the one offered by WireMock and is 100% PHP, please give Phiremock a try: [Phiremock](https://github.com/mcustiel/phiremock), it also has a nice [codeception extension](https://github.com/mcustiel/phiremock-codeception-extension). 
+
 ## Installation
 
 ### Composer:
@@ -44,19 +48,22 @@ Or just download the release and include it in your path.
 ## Configuration Examples
 
 ### Module
+The module allow you to connect to a WireMock instance, it can be the one ran by the extension or an already running one.
 
 ```yaml
 # acceptance.suite.yml
 modules:
     enabled:
-        - WireMock
+        - WireMock:
+            host: my.wiremock.host # defaults to 127.0.0.1
+            port: 80 # defaults to 8080
 ```
 
 ### Extension
 
 #### Default configuration 
 
-This configuration will download WireMock version 1.57 and run it on port 8080, writing logs to `/tmp/codeceptionWireMock/logs`
+This configuration will download WireMock version 1.57 and run it on port 8080, writing logs to codeception tests _output dir.
 
 ```yaml
 # codeception.yml

composer.json

@@ -25,17 +25,16 @@
 	"license" : "GPL-3.0+",
 	"require" : {
 		"php" : ">=5.4",
-		"codeception/codeception" : "~2.1.0",
-		"wiremock-php/wiremock-php" : ">=1.43",
-        "mcustiel/php-simple-di" : ">=1.2.0"
+		"codeception/codeception" : "^2.1.0",
+		"wiremock-php/wiremock-php" : "^1.43"
 	},
 	"require-dev" : {
-		"phing/phing" : ">=2.12.0",
-		"squizlabs/php_codesniffer" : ">=2.3.4",
-		"phpmd/phpmd" : ">=2.3.2",
-		"sebastian/phpcpd" : ">=2.0.2",
-		"pdepend/pdepend" : ">=2.0.6",
-		"phploc/phploc" : ">=2.1.1",
-		"phpdocumentor/phpdocumentor" : ">=2.8.5"
+		"phing/phing" : "^2.12.0",
+		"squizlabs/php_codesniffer" : "^2.3.4",
+		"phpmd/phpmd" : "^2.3.2",
+		"sebastian/phpcpd" : "^2.0.2",
+		"pdepend/pdepend" : "^2.0.6",
+		"phploc/phploc" : "^2.1.1",
+		"phpdocumentor/phpdocumentor" : "^2.8.5"
 	}
 }

src/Extension/WireMock.php

@@ -19,7 +19,6 @@
 
 use Codeception\Platform\Extension as CodeceptionExtension;
 use WireMock\Client\WireMock as WireMockClient;
-use Mcustiel\DependencyInjection\DependencyContainer;
 
 /**
  * Codeception Extension for WireMock
@@ -66,25 +65,13 @@ public function __construct(
 
         $this->config = $this->argumentsManager->sanitize($this->config);
 
-        if (!empty($this->config['host'])) {
-            echo "Connecting to wiremock host {$this->config['host']}" . PHP_EOL;
-            $host = $this->config['host'];
-        } else {
-            echo "Starting local wiremock" . PHP_EOL;
-            $this->process->start(
-                $this->getJarPath(),
-                $this->config['logs-path'],
-                $this->mapConfigToWireMockArguments($this->config)
-            );
-            $host = 'localhost';
-            sleep($this->config['start-delay']);
-        }
-        DependencyContainer::getInstance()->add(
-            'wiremockConnection',
-            function() use ($host) {
-                return WireMockClient::create($host, $this->config['port']);
-            }
+        echo "Starting local wiremock" . PHP_EOL;
+        $this->process->start(
+            $this->getJarPath(),
+            $this->config['logs-path'],
+            $this->mapConfigToWireMockArguments($this->config)
         );
+        sleep($this->config['start-delay']);
     }
 
     private function initWireMockProcess($process)
@@ -119,7 +106,7 @@ private function initWireMockArgumentsManager($argumentsManager)
      */
     public function __destruct()
     {
-        $connection = DependencyContainer::getInstance()->get('wiremockConnection');
+        $connection = WireMockClient::create('localhost', $this->config['port']);
         if ($connection->isAlive()) {
             $connection->shutdownServer();
         }

src/Extension/WireMockArguments.php

@@ -17,6 +17,8 @@
  */
 namespace Codeception\Extension;
 
+use Codeception\Configuration as Config;
+
 /**
  * Utility class to work with config parameters and wiremock command line arguments.
  */
@@ -66,9 +68,7 @@ class WireMockArguments
      */
     public function __construct()
     {
-        $this->defaults['logs-path'] = sys_get_temp_dir()
-            . DIRECTORY_SEPARATOR . 'codeceptionWireMock'
-            . DIRECTORY_SEPARATOR . 'logs';
+        $this->defaults['logs-path'] = Config::logDir();
     }
 
     /**

src/Extension/WireMockProcess.php

@@ -51,6 +51,8 @@ public function start($jarPath, $logsPath, $arguments)
     {
         $this->checkIfProcessIsRunning();
 
+        echo "Running " . $this->getCommandPrefix() . "java -jar {$jarPath}{$arguments}";
+
         $this->process = proc_open(
             $this->getCommandPrefix() . "java -jar {$jarPath}{$arguments}",
             $this->createProcessDescriptors($logsPath),
@@ -71,6 +73,7 @@ private function createProcessDescriptors($logsPath)
     {
         $logFile = $logsPath . DIRECTORY_SEPARATOR . self::LOG_FILE_NAME;
         $descriptors = [
+            ['pipe', 'r'],
             ['file', $logFile, 'w'],
             ['file', $logFile, 'a'],
         ];
@@ -128,8 +131,8 @@ public function stop()
     private function getCommandPrefix()
     {
         if (PHP_OS == 'WIN32' || PHP_OS == 'WINNT' || PHP_OS == 'Windows') {
-            return 'exec ';
+            return '';
         }
-        return '';
+        return 'exec ';
     }
 }

src/Module/WireMock.php

@@ -19,10 +19,10 @@
 
 use Codeception\Module as CodeceptionModule;
 use Codeception\TestCase;
-use Codeception\Extension\WireMockConnection;
+use Codeception\Util\Debug;
+use WireMock\Client\WireMock as WireMockClient;
 use WireMock\Client\MappingBuilder;
 use WireMock\Client\RequestPatternBuilder;
-use Mcustiel\DependencyInjection\DependencyContainer;
 
 class WireMock extends CodeceptionModule
 {
@@ -31,14 +31,22 @@ class WireMock extends CodeceptionModule
      */
     private $wireMock;
 
+    protected $config = [
+        'host' => 'localhost',
+        'port' => '8080'
+    ];
+
     /**
      * {@inheritDoc}
-     * @see \Codeception\Module::_before()
+     * @see \Codeception\Module::_beforeSuite()
      */
-    public function _before(TestCase $testCase)
+    public function _beforeSuite($settings = [])
     {
-        parent::_before($testCase);
-        $this->wireMock = DependencyContainer::getInstance()->get('wiremockConnection');
+        $this->config = array_merge($this->config, $settings);
+        Debug::debug(
+            "Connecting to WireMock in: host {$this->config['host']} and port {$this->config['port']}"
+        );
+        $this->wireMock = WireMockClient::create($this->config['host'], $this->config['port']);
     }
 
     public function cleanAllPreviousRequestsToWireMock()

tests/tests/acceptance.suite.yml

@@ -10,5 +10,7 @@ modules:
         - PhpBrowser:
             url: http://localhost/myapp
         - \Helper\Acceptance
-        - WireMock
+        - WireMock:
+            host: localhost
+            port: 18080
         - Asserts