Feature/select suites (#41)

* Allow to start several phiremock instances

* Added support for secure phiremock server

* Set defaults

* Allows to provide a list of the suites phiremock-server must be run for

* Cleaned a bit

* Cleaned up a bit

* Removed unused parameters

* Added documentation for new features

* Update README.md

* Update README.md

* Cleaned code a bit

* Fixed composer json

Co-authored-by: Mariano Custiel <[email protected]>

Author: mcustiel

README.md

@@ -1,5 +1,5 @@
 # phiremock-codeception-extension
-Codeception extension to make working with [Phiremock Server](https://github.com/mcustiel/phiremock-server) even easier. It allows to start a Phiremock Server before each suite and stop it when the suite ends.
+Codeception extension to make working with [Phiremock Server](https://github.com/mcustiel/phiremock-server) even easier. It allows to start a Phiremock Server before a suite is executed and stop it when the suite ends.
 
 [![Latest Stable Version](https://poser.pugx.org/mcustiel/phiremock-codeception-extension/v/stable)](https://packagist.org/packages/mcustiel/phiremock-codeception-extension)
 [![Build Status](https://scrutinizer-ci.com/g/mcustiel/phiremock-codeception-extension/badges/build.png?b=master)](https://scrutinizer-ci.com/g/mcustiel/phiremock-codeception-extension/build-status/master)
@@ -42,37 +42,101 @@ extensions:
             start_delay: 1 # default to 0
             expectations_path: /my/expectations/path # defaults to tests/_expectations
             server_factory: \My\FactoryClass # defaults to 'default'
+            extra_instances: [] # deaults to an empty array
+            suites: [] # defaults to an empty array
+            certificate: /path/to/cert # defaults to null
+            certificate_key: /path/to/cert-key # defaults to null
+            cert_passphrase: 'my-pass' # defaults to null
 ```
 Note: Since Codeception version 2.2.7, extensions configuration can be added directly in the suite configuration file. That will avoid phiremock to be started for every suite. 
 
 ### Parameters
 
 #### listen
 Specifies the interface and port where phiremock must listen for requests.
+
 **Default:** 0.0.0.0:8086
 
 #### bin_path
 Path where Phiremock Server's "binary" is located. You can, for instance, point to the location of the phar in your file system.
+
 **Default:** codeception_dir/../vendor/bin/phiremock
 
 #### logs_path
 Path where to write the output.
+
 **Default:** codeception's tests output dir
 
 #### debug
 Whether to write debug data to log file.
+
 **Default:** false
 
 #### start_delay
 Time to wait after Phiremock Server is started before running the tests (used to give time to Phiremock Server to boot) 
+
 **Default:** 0
 
 #### expectations_path
 Specifies a directory to search for json files defining expectations to load by default.
+
 **Default:** codecption_dir/_expectations
 
+#### certificate
+Path to a certificate file to allow phiremock-server to listen for secure https connections. 
+
+**Default:** null. Meaning phiremock will only listen on unsecured http connections.
+
+#### certificate-key
+Path to the certificate key file. 
+
+**Default:** null. 
+
+#### cert-passphrase
+Path to the certificate passphrase used to encrypt the certificate (only needed if encrypted). 
+
+**Default:** null. Meaning no decryption based in passphrase will be performed.
+
+#### suites
+Specifies a list of suites for which the phiremock-server must be executed.
+
+**Default:** [] Empty array, meaning that phiremock will be executed for each suite.
+
+#### extra_instances
+Allows to specify more instances of phiremock-server to run. This is useful if you want, for instance, run one instance listening for http and one listening for https connections. Each instance has its own configuration, and can separately run for different suites.
+
+**Default:** [] Empty array, meaning that no extra phiremock-server instances are configured.
+
+**Example:**
+```yaml
+extensions:
+    enabled:
+        - \Codeception\Extension\Phiremock
+    config:
+        \Codeception\Extension\Phiremock:
+            listen: 127.0.0.1:18080  
+            debug: true 
+            start_delay: 1
+            expectations_path: /my/expectations/path-1 
+            suites: 
+                - acceptance
+            extra_instances: 
+                - 
+                    listen: 127.0.0.1:18081
+                    debug: true
+                    start_delay: 1
+                    expectations_path: /my/expectations/path-2
+                    suites:
+                        - acceptance
+                        - api
+                    certificate: /path/to/cert
+                    certificate_key: /path/to/cert-key 
+                    cert_passphrase: 'my-pass' 
+```
+
 #### server_factory
 Specifies a Factory class extending `\Mcustiel\Phiremock\Server\Factory\Factory`. Useful if you want to provide your own PSR. This works only if you install phiremock as a local dependency required in your composer file.
+
 **Default:** default
 
 **Example:**

codeception.https.yml

@@ -0,0 +1,33 @@
+actor: Tester
+paths:
+    tests: tests
+    log: tests/_output
+    data: tests/_data
+    support: tests/_support
+    envs: tests/_envs
+settings:
+    colors: true
+    memory_limit: 1024M
+bootstrap: _bootstrap.php
+extensions:
+    enabled:
+        - \Codeception\Extension\RunFailed
+        - \Codeception\Extension\Phiremock
+    config:
+        \Codeception\Extension\Phiremock:
+            listen: 0.0.0.0:18080
+            expectations_path:
+            server_factory: Mcustiel\Phiremock\Codeception\Module\Tests\Helpers\FactoryWithGuzzle7
+            logs_path: tests/_output/phiremock.extra.log 
+            debug: true
+            start_delay: 1
+            extra_instances:
+              -
+                listen: 0.0.0.0:18443
+                debug: true
+                expectations_path:
+                certificate: tests/_data/certificate-cert.pem
+                certificate_key:  tests/_data/certificate-key.key
+                logs_path: tests/_output/phiremock.secure.log
+                suites: 
+                  - acceptance

codeception.yml

@@ -6,17 +6,23 @@ paths:
     support: tests/_support
     envs: tests/_envs
 settings:
-    bootstrap: _bootstrap.php
     colors: true
     memory_limit: 1024M
+bootstrap: _bootstrap.php
 extensions:
     enabled:
         - \Codeception\Extension\RunFailed
         - \Codeception\Extension\Phiremock
     config:
         \Codeception\Extension\Phiremock:
-            listen: 0.0.0.0:18080
-            start_delay: 1
             debug: true
-            expectations_path:
-            server_factory: Mcustiel\Phiremock\Codeception\Module\Tests\Helpers\FactoryWithGuzzle7 
+            start_delay: 1
+            suites: 
+              - unit
+            extra_instances:
+              -
+                listen: 0.0.0.0:18080
+                debug: true
+                expectations_path:
+                server_factory: Mcustiel\Phiremock\Codeception\Module\Tests\Helpers\FactoryWithGuzzle7
+                logs_path: tests/_output/phiremock.extra.log 

composer.json

@@ -19,7 +19,8 @@
     ],
     "autoload" : {
         "psr-4" : {
-            "Codeception\\" : "src"
+            "Codeception\\Extension\\" : "src/Extension",
+            "Mcustiel\\Phiremock\\Codeception\\Extension\\": "src/PhiremockExtension"
         }
     },
     "autoload-dev": {
@@ -37,12 +38,12 @@
         "symfony/process": ">=3.0.0 <6.0.0"
     },
     "require-dev": {
-        "mcustiel/phiremock-server": "^1.0",
+        "mcustiel/phiremock-server": "dev-master",
     	"codeception/module-rest": "^1.0",
         "codeception/module-phpbrowser": "^1.0",
         "guzzlehttp/guzzle" : "^7.0"
     },
-    "suggests": {
+    "suggest": {
         "mcustiel/phiremock-server": "As a dev-requirement. Allows the extension to start phiremock automatically from vendor/bin",
         "guzzlehttp/guzzle" : "Version 6 to execute phiremock-server as default"
     },

run-tests.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+./vendor/bin/codecept run && \
+./vendor/bin/codecept -c codeception.https.yml run

src/Extension/Phiremock.php

@@ -18,68 +18,53 @@
 
 namespace Codeception\Extension;
 
-use Codeception\Configuration as Config;
+use Codeception\Event\SuiteEvent;
 use Codeception\Extension as CodeceptionExtension;
+use Codeception\Suite;
+use Mcustiel\Phiremock\Codeception\Extension\Config;
+use Mcustiel\Phiremock\Codeception\Extension\PhiremockProcessManager;
 
-/**
- * Codeception Extension for Phiremock.
- */
 class Phiremock extends CodeceptionExtension
 {
-    private const DEFAULT_PATH = 'vendor/bin/phiremock';
-    private const DEFAULT_PORT = 8086;
-
     /** @var array */
     public static $events = [
         'suite.before' => 'startProcess',
         'suite.after'  => 'stopProcess',
     ];
 
     /** @var array */
-    protected $config = [
-        'listen'            => '0.0.0.0:' . self::DEFAULT_PORT,
-        'debug'             => false,
-        'start_delay'       => 0,
-        'bin_path'          => self::DEFAULT_PATH,
-        'expectations_path' => null,
-        'server_factory'    => 'default'
-    ];
+    protected $config = Config::DEFAULT_CONFIG;
 
-    /** @var PhiremockProcess */
+    /** @var PhiremockProcessManager */
     private $process;
 
-    /**
-     * Class constructor.
-     *
-     * @param array            $config
-     * @param array            $options
-     * @param PhireMockProcess $process optional PhiremockProcess object
-     */
+    /** @var Config */
+    private $extensionConfig;
+
     public function __construct(
         array $config,
         array $options,
-        PhiremockProcess $process = null
+        PhiremockProcessManager $process = null
     ) {
         $this->setDefaultLogsPath();
         parent::__construct($config, $options);
-
+        $this->extensionConfig = new Config($this->config, $this->getOutputCallable());
         $this->initProcess($process);
     }
 
-    public function startProcess(): void
+    public function startProcess(SuiteEvent $event): void
     {
-        list($ip, $port) = explode(':', $this->config['listen']);
-
-        $this->writeln('Starting phiremock...');
-        $this->process->start(
-            $ip,
-            empty($port) ? self::DEFAULT_PORT: (int) $port,
-            $this->getPathFromCodeceptionDir($this->config['bin_path']),
-            $this->getPathFromCodeceptionDir($this->config['logs_path']),
-            $this->config['debug'],
-            $this->config['expectations_path'] ? $this->getPathFromCodeceptionDir($this->config['expectations_path']) : null,
-            $this->getFactoryClass()
-        );
+        $this->writeln('Starting default phiremock instance...');
+        $suite = $event->getSuite();
+        if ($this->mustRunForSuite($suite, $this->extensionConfig->getSuites())) {
+            $this->process->start($this->extensionConfig);
+        }
+        foreach ($this->extensionConfig->getExtraInstances() as $configInstance) {
+            if ($this->mustRunForSuite($suite, $configInstance->getSuites())) {
+                $this->writeln('Starting extra phiremock instance...');
+                $this->process->start($configInstance);
+            }
+        }
         $this->executeDelay();
     }
 
@@ -89,44 +74,35 @@ public function stopProcess(): void
         $this->process->stop();
     }
 
-    private function getFactoryClass(): ?string
+    public function getOutputCallable(): callable
     {
-        if (isset($this->config['server_factory'])) {
-            $factoryClassConfig = $this->config['server_factory'];
-            if ($factoryClassConfig !== 'default') {
-                return $this->config['server_factory'];
-            }
-        }
-        return null;
+        return function (string $message) {
+            $this->writeln($message);
+        };
     }
 
-    private function executeDelay(): void
+    private function mustRunForSuite(Suite $suite, array $allowedSuites): bool
     {
-        if (isset($this->config['startDelay'])) {
-            $this->writeln('PHIREMOCK/DEPRECATION: startDelay option is deprecated and will be removed. Please use start_delay');
-            $this->config['start_delay'] = $this->config['startDelay'];
-        }
-
-        if ($this->config['start_delay']) {
-            sleep($this->config['start_delay']);
-        }
+        return empty($allowedSuites) || in_array($suite->getBaseName(), $allowedSuites, true);
     }
 
-    private function initProcess(?PhiremockProcess $process): void
+    private function executeDelay(): void
     {
-        $this->process = $process ?? new PhiremockProcess();
+        $delay = $this->extensionConfig->getDelay();
+        if ($delay > 0) {
+            sleep($delay);
+        }
     }
 
-    private function setDefaultLogsPath(): void
+    private function initProcess(?PhiremockProcessManager $process): void
     {
-        $this->config['logs_path'] = Config::logDir();
+        $this->process = $process ?? new PhiremockProcessManager($this->getOutputCallable());
     }
 
-    private function getPathFromCodeceptionDir($path): string
+    private function setDefaultLogsPath(): void
     {
-        if (substr($path, 0, 1) === '/') {
-            return $path;
+        if (!isset($this->config['logs_path'])) {
+            $this->config['logs_path'] = Config::getDefaultLogsPath();
         }
-        return realpath(Config::projectDir() . $path);
     }
 }