Merge pull request #1 from rezzza/feature/improve-moco-reliability

Improve moco reliability

Author: shouze

README.md

@@ -13,14 +13,14 @@ default:
     extensions:
         Rezzza\MocoBehatExtension\MocoExtension:
             json_file: features/fixtures.yml
+            hostname: 127.0.0.1
+            port: 9997
     suites:
         default:
             contexts:
-                - Rezzza\MocoBehatExtension\MocoContext:
-                    mocoIp: 127.0.0.1
-                    mocoPort: 9997
+                - Rezzza\MocoBehatExtension\MocoContext
 ```
 
-Then you just need to add `MocoWriter` as an argument of your context.
+Then you just need to add `MocoWriter` as an argument of your context and tag your scenario with `@moco`
 
 [See tests](features) for more details

features/check-moco.feature

@@ -10,17 +10,17 @@ Feature: Check moco
                 extensions:
                     Rezzza\MocoBehatExtension\MocoExtension:
                         json_file: features/fixtures.yml
+                        hostname: 127.0.0.1
+                        port: 9997
                     Rezzza\RestApiBehatExtension\Extension:
                         rest:
                             base_url: http://127.0.0.1:9997
                             adaptor_name: curl
                 suites:
                     default:
                         contexts:
-                            - Rezzza\RestApiBehatExtension\RestApiContext:
-                            - Rezzza\MocoBehatExtension\MocoContext:
-                                mocoIp: 127.0.0.1
-                                mocoPort: 9997
+                            - Rezzza\RestApiBehatExtension\RestApiContext
+                            - Rezzza\MocoBehatExtension\MocoContext
             """
         And a file named "features/call_moco.feature" with:
             """

features/mock-http-call.feature

@@ -10,6 +10,8 @@ Feature: Mock HTTP call
                 extensions:
                     Rezzza\MocoBehatExtension\MocoExtension:
                         json_file: features/fixtures.yml
+                        hostname: 127.0.0.1
+                        port: 9999
                     Rezzza\RestApiBehatExtension\Extension:
                         rest:
                             base_url: http://127.0.0.1:9999
@@ -18,10 +20,8 @@ Feature: Mock HTTP call
                     default:
                         contexts:
                             - FeatureContext
-                            - Rezzza\RestApiBehatExtension\RestApiContext:
-                            - Rezzza\MocoBehatExtension\MocoContext:
-                                mocoIp: 127.0.0.1
-                                mocoPort: 9999
+                            - Rezzza\RestApiBehatExtension\RestApiContext
+                            - Rezzza\MocoBehatExtension\MocoContext
             """
         And a file named "features/bootstrap/FeatureContext.php" with:
             """

src/MocoContext.php

@@ -3,33 +3,22 @@
 namespace Rezzza\MocoBehatExtension;
 
 use Behat\Behat\Context\Context;
-use Behat\Behat\Hook\Scope\BeforeScenarioScope;
+use Behat\Behat\Hook\Scope\AfterScenarioScope;
 
 class MocoContext implements Context
 {
     private $mocoWriter;
 
-    private $mocoIp;
-
-    private $mocoPort;
-
-    public function __construct(MocoWriter $mocoWriter, $mocoIp, $mocoPort)
+    public function __construct(MocoWriter $mocoWriter)
     {
         $this->mocoWriter = $mocoWriter;
-        $this->mocoIp = $mocoIp;
-        $this->mocoPort = $mocoPort;
     }
 
     /**
-     * @BeforeScenario @moco
+     * @AfterScenario @moco
      */
-    public function before(BeforeScenarioScope $scope)
+    public function before(AfterScenarioScope $scope)
     {
-        if (false === @fsockopen($this->mocoIp, $this->mocoPort, $errno, $errstr, 3)) {
-            throw new \Exception(
-                sprintf('You should run moco by "bin/moco start -p %s -c %s"', $this->mocoPort, $this->mocoWriter->getJsonFile())
-            );
-        }
         $this->mocoWriter->reset();
     }
 }

src/MocoExtension.php

@@ -14,6 +14,8 @@ class MocoExtension implements Extension
     public function load(ContainerBuilder $container, array $config)
     {
         $container->setParameter('rezzza.moco.json_file', $config['json_file']);
+        $container->setParameter('rezzza.moco.port', $config['port']);
+        $container->setParameter('rezzza.moco.hostname', $config['hostname']);
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/Resources/config'));
         $loader->load('services.xml');
     }
@@ -29,6 +31,8 @@ public function configure(ArrayNodeDefinition $builder)
             ->addDefaultsIfNotSet()
             ->children()
                 ->scalarNode('json_file')->end()
+                ->scalarNode('hostname')->end()
+                ->scalarNode('port')->end()
             ->end()
         ;
     }

src/MocoWriter.php

@@ -8,9 +8,15 @@ class MocoWriter
 
     private $jsonFile;
 
-    public function __construct($jsonFile)
+    private $hostname;
+
+    private $port;
+
+    public function __construct($jsonFile, $hostname, $port)
     {
         $this->jsonFile = $jsonFile;
+        $this->hostname = $hostname;
+        $this->port = $port;
     }
 
     public function mockHttpCall(array $matchedRequest, array $mockedResponse)
@@ -24,17 +30,33 @@ public function mockHttpCall(array $matchedRequest, array $mockedResponse)
     public function writeForMoco()
     {
         file_put_contents($this->jsonFile, json_encode($this->payload));
+        // We need to wait for moco detecting the fixtures file changed
+        // If not, we can perform a request on old configFile
         sleep(1);
+        $this->waitForMoco();
     }
 
     public function reset()
     {
         $this->payload = [];
+        // To avoid false positive by having the next scenario using moco response of the previous scenario
         $this->writeForMoco();
     }
 
-    public function getJsonFile()
+    private function waitForMoco()
     {
-        return $this->jsonFile;
+        $attempts = 0;
+        $max = 10;
+        $ip = gethostbyname($this->hostname);
+        while (false === @stream_socket_client('tcp://'.$ip.':'.$this->port, $errno, $errstr, 5) && ($attempts < $max)) {
+            usleep(200000); // 200ms
+            $attempts++;
+        }
+
+        if ($max <= $attempts) {
+            throw new \Exception(
+                sprintf('You should run moco by "bin/moco start -p %s -c %s"', $this->port, $this->jsonFile)
+            );
+        }
     }
 }

src/Resources/config/services.xml

@@ -5,6 +5,8 @@
     <services>
         <service id="rezzza.moco.moco_writer" class="Rezzza\MocoBehatExtension\MocoWriter" public="false">
             <argument>%rezzza.moco.json_file%</argument>
+            <argument>%rezzza.moco.hostname%</argument>
+            <argument>%rezzza.moco.port%</argument>
         </service>
 
         <service id="rezzza.moco.moco_writer_resolver" class="Rezzza\MocoBehatExtension\MocoWriterResolver" public="false">