Refactor unit testing with wrapper for sockect functions

Author: jgil

composer.json

@@ -9,7 +9,6 @@
     "require-dev": {
         "phpunit/phpunit": "4.7.*",
         "satooshi/php-coveralls": "dev-master",
-        "cocur/background-process": "dev-master",
         "squizlabs/php_codesniffer": "~2.0"
     },
     "authors": [

src/.Connection.php.swp

@@ -98,20 +98,32 @@ public function getSubscriptions()
      */
     private $streamSocket;
 
+    /**
+     * Stream wrapper for testing purposes.
+     *
+     * @var mixed StreamWrapper.
+     */ 
+    private $streamWrapper;
+
     /**
      * Constructor.
      *
-     * @param ConnectionOptions $options Connection options object.
+     * @param ConnectionOptions $options       Connection options object.
+     * @param StreamWrapper     $streamWrapper Wrapper for stream functions. Testing purposes.
      */
-    public function __construct(ConnectionOptions $options = null)
+    public function __construct(ConnectionOptions $options = null, StreamWrapper $streamWrapper = null)
     {
         $this->pings = 0;
         $this->pubs = 0;
         $this->subscriptions = [];
         $this->options = $options;
+        $this->streamWrapper = $streamWrapper;
         if (is_null($options)) {
             $this->options = new ConnectionOptions();
         }
+        if (is_null($streamWrapper)) {
+            $this->streamWrapper = new StreamWrapper();
+        }
     }
 
     /**
@@ -163,10 +175,16 @@ private function getStream($address, $timeout = null)
         if (is_null($timeout)) {
             $timeout = intval(ini_get('default_socket_timeout'));
         }
-        $fp = stream_socket_client($address, $errno, $errstr, $timeout, STREAM_CLIENT_CONNECT);
+        $errno = null;
+        $errstr = null;
+        //$fp = stream_socket_client($address, $errno, $errstr, $timeout, STREAM_CLIENT_CONNECT);
+        
+        $fp = $this->streamWrapper->getStreamSocketClient($address, $errno, $errstr, $timeout, STREAM_CLIENT_CONNECT);
+
         if (!$fp) {
             throw new \Exception($errstr, $errno);
         }
+
         //stream_set_blocking($fp, 0);
         return $fp;
     }
@@ -364,10 +382,12 @@ public function wait($quantity = 0)
     public function setStreamTimeout($seconds)
     {
         if ($this->isConnected()) {
-            try {
-                return stream_set_timeout($this->streamSocket, $seconds);
-            } catch (\Exception $e) {
-                return false;
+            if (is_int($seconds)) {
+                try {
+                    return $this->streamWrapper->setStreamTimeout($this->streamSocket, $seconds);
+                } catch (\Exception $e) {
+                    return false;
+                }
             }
         }
 

src/Connection.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Nats;
+
+/**
+ * StreamWrapper class.
+ */
+class StreamWrapper
+{
+    /**
+     * Wrapper for stream_socket_client
+     *
+     * @param string  $address    Address to connect the socket.
+     * @param integer $errno      Number of error.
+     * @param string  $errstr     Description of error.
+     * @param integer $timeout    Timeout.
+     * @param integer $typeStream Type of stream.
+     *
+     * @return stream
+     */
+    public function getStreamSocketClient($address, &$errno, &$errstr, $timeout, $typeStream)
+    {
+        return stream_socket_client($address, $errno, $errstr, $timeout, $typeStream);
+    }
+    
+    /**
+     * Wrapper for stream_set_timeout
+     *
+     * @param mixed   $stream  Stream.
+     * @param integer $seconds Seconds for timeout.
+     *
+     * @return boolean
+     *
+    */
+    public function setStreamTimeout($stream, $seconds)
+    {
+        return stream_set_timeout($stream, $seconds);
+    }
+}

src/StreamWrapper.php

@@ -3,7 +3,10 @@
 
 use Nats;
 use Nats\ConnectionOptions;
-use Cocur\BackgroundProcess\BackgroundProcess;
+use Nats\StreamWrapper;
+use org\bovigo\vfs\vfsStream;
+use org\bovigo\vfs\vfsStreamFile;
+use Prophecy\Argument;
 
 /**
  * Class ConnectionTest.
@@ -31,32 +34,6 @@ class ConnectionTest extends \PHPUnit_Framework_TestCase
      */
     private static $isGnatsd = false;
 
-    /**
-     * Before Class code setup.
-     *
-     * @return void
-     */
-    public static function setUpBeforeClass()
-    {
-        if (($socket = @fsockopen("localhost", 4222, $err))!==false) {
-             self::$isGnatsd = true;
-        } else {
-            self::$process = new BackgroundProcess('/usr/bin/php ./tests/Util/ListeningServerStub.php ');
-            self::$process->run();
-        }
-    }
-
-    /**
-     * After Class code setup.
-     *
-     * @return void
-     */
-    public static function tearDownAfterClass()
-    {
-        if (!self::$isGnatsd) {
-            self::$process->stop();
-        }
-    }
 
     /**
      * SetUp test suite.
@@ -66,15 +43,19 @@ public static function tearDownAfterClass()
     public function setUp()
     {
         $options = new ConnectionOptions();
-        if (!self::$isGnatsd) {
-            time_nanosleep(1, 700000000);
-            $options->setPort(4222);
-        }
-        $this->c = new Nats\Connection($options);
+
+        $streamWrapper = $this->prophesize(StreamWrapper::class);
+        $streamWrapper->getStreamSocketClient(Argument::any(), Argument::any(), Argument::any(), Argument::any(), Argument::any())->will(function ($args) {
+            return fopen("/tmp/".uniqid(), 'w');
+
+        });
+
+        $streamWrapper->setStreamTimeout(Argument::any(), Argument::any())->willReturn(true);
+
+        $this->c = new Nats\Connection($options, $streamWrapper->reveal());
         $this->c->connect();
     }
 
-
     /**
      * Test Connection.
      *
@@ -122,7 +103,6 @@ public function testPublish()
 
     /**
      * Test Reconnect command.
-     *
      * @return void
      */
     public function testReconnect()
@@ -153,9 +133,10 @@ public function testSubscription()
 
         $this->c->publish('foo', 'bar');
         $this->assertEquals(1, $this->c->pubsCount());
-
+/*
         $process = new BackgroundProcess('/usr/bin/php ./tests/Util/ClientServerStub.php ');
         $process->run();
+*/
         // time_nanosleep(1, 0);
         $this->c->wait(1);
     }