Fixed problem with process that keeps running

Author: mcustiel

README.md

@@ -1,2 +1,78 @@
 # phiremock-codeception-extension
-Codeception extension and module to make working with phiremock even easier.
+Codeception extension and module to make working with Phiremock even easier. It allows to start a Phiremock server  specifically for the acceptance tests to run or to connect to an already running Phiremock server.
+
+## Extension
+The extension provides an easy way to start a Phiremock server with configured host, port, debug mode and logs path.
+
+### Configuration
+In codeception.yml you will need to enable Phiremock extension and configure it in a proper way:
+
+```yaml
+extensions:
+    enabled:
+        - \Codeception\Extension\Phiremock
+    config:
+        \Codeception\Extension\Phiremock:
+            listen: 127.0.0.1:18080 # defaults to 0.0.0.0:8086
+            bin_path: ../vendor/bin # defaults to codeception_dir/../vendor/bin 
+            logs_path: /var/log/my_app/tests/logs # defaults to codeception's tests output dir
+            debug: true # defaults to false
+```
+
+## Module
+The module allows you to connect to a Phiremock server and to interact with it in a semantic way through the codeception actor in your tests.
+
+### Configuration
+You need to enable Phiremock module in your suite's configuration file:
+
+```yaml
+modules:
+    enabled:
+        - Phiremock:
+            host: 127.0.0.1
+            port: 18080
+```
+
+### Use
+The module provides the following handy methods to communicate with Phiremock server:
+
+#### expectARequestToRemoteServiceWithAResponse
+Allows you to setup an expectation in Phiremock, specifying the expected request and the response the server should give for it:
+
+```php
+    $I->expectARequestToRemoteServiceWithAResponse(
+        Phiremock::on(
+            A::getRequest()->andUrl(Is::equalTo('/some/url'))
+        )->then(
+            Respond::withStatusCode(203)->andBody('I am a response')
+        )
+    );
+```
+
+### haveACleanSetupInRemoteService
+Cleans the server of all configured expectations, scenarios and requests history.
+
+```php
+    $I->haveACleanSetupInRemoteService();
+```
+
+### dontExpectRequestsInRemoteService
+Cleans all previously configured expectations and requests history.
+
+```php
+    $I->dontExpectRequestsInRemoteService();
+```
+
+### haveCleanScenariosInRemoteService
+Cleans the state of all scenarios (sets all of them to inital state).
+
+```php
+    $I->haveCleanScenariosInRemoteService();
+```
+
+### seeRemoteServiceReceived
+Allows you to verify that the server received a request a given amount of times. This request could or not be previously set up as an expectation.
+
+```php
+    $I->seeRemoteServiceReceived(1, A::getRequest()->andUrl(Is::equalTo('/some/url')));
+```

src/Extension/Phiremock.php

@@ -27,7 +27,8 @@ class Phiremock extends CodeceptionExtension
     public static $events = [];
 
     protected $config = [
-        'listen'   => '0.0.0.0:8086'
+        'listen' => '0.0.0.0:8086',
+        'debug'  => false
     ];
 
     /**
@@ -50,13 +51,20 @@ public function __construct(
     ) {
         $this->config['bin_path'] = Config::projectDir() . '../vendor/bin';
         $this->config['logs_path'] = Config::logDir();
+
         parent::__construct($config, $options);
 
         $this->initProcess($process);
 
         list($ip, $port) = explode(':', $this->config['listen']);
-        $executablePath = $this->config['bin_path'];
-        $this->process->start($ip, $port, $executablePath, $this->config['logs_path']);
+
+        $this->process->start(
+            $ip,
+            $port,
+            $this->config['bin_path'],
+            $this->config['logs_path'],
+            $this->config['debug']
+        );
     }
 
     private function initProcess($process)

src/Extension/PhiremockProcess.php

@@ -47,12 +47,12 @@ class PhiremockProcess
      *
      * @throws \Exception
      */
-    public function start($ip, $port, $path, $logsPath)
+    public function start($ip, $port, $path, $logsPath, $debug)
     {
         $this->checkIfProcessIsRunning();
 
         $this->process = proc_open(
-            $this->getCommandPrefix() . "{$path}/phiremock -i {$ip} -p {$port}",
+            $this->getCommandPrefix() . "{$path}/phiremock -i {$ip} -p {$port}" . ($debug? ' -d' : ''),
             $this->createProcessDescriptors($logsPath),
             $this->pipes,
             null,
@@ -130,8 +130,8 @@ public function stop()
     private function getCommandPrefix()
     {
         if (PHP_OS == 'WIN32' || PHP_OS == 'WINNT' || PHP_OS == 'Windows') {
-            return 'exec ';
+            return '';
         }
-        return '';
+        return 'exec ';
     }
 }