Socket moved to connections, added interface. Finished tests for all protocol versions.

Author: stefanak-michal

Bolt.php

@@ -5,6 +5,7 @@
 use Exception;
 use Bolt\PackStream\{IPacker, IUnpacker};
 use Bolt\protocol\AProtocol;
+use Bolt\connection\IConnection;
 
 /**
  * Main class Bolt
@@ -32,9 +33,9 @@ final class Bolt
     private $protocol;
 
     /**
-     * @var Socket
+     * @var IConnection
      */
-    private $socket;
+    private $connection;
 
     /**
      * @var array
@@ -77,7 +78,7 @@ final class Bolt
      */
     public function __construct(string $ip = '127.0.0.1', int $port = 7687, int $timeout = 15)
     {
-        $this->socket = new Socket($ip, $port, $timeout);
+        $this->connection = new \Bolt\connection\Socket($ip, $port, $timeout);
 
         $packerClass = "\\Bolt\\PackStream\\v" . $this->packStreamVersion . "\\Packer";
         if (!class_exists($packerClass)) {
@@ -142,8 +143,8 @@ private function handshake(): bool
         if (self::$debug)
             echo 'HANDSHAKE';
 
-        $this->socket->write(chr(0x60) . chr(0x60) . chr(0xb0) . chr(0x17));
-        $this->socket->write($this->packProtocolVersions());
+        $this->connection->write(chr(0x60) . chr(0x60) . chr(0xb0) . chr(0x17));
+        $this->connection->write($this->packProtocolVersions());
 
         $this->unpackProtocolVersion();
         if (empty($this->version)) {
@@ -155,7 +156,7 @@ private function handshake(): bool
         if (!class_exists($protocolClass)) {
             Bolt::error('Requested Protocol version (' . $this->version . ') not yet implemented');
         } else {
-            $this->protocol = new $protocolClass($this->packer, $this->unpacker, $this->socket);
+            $this->protocol = new $protocolClass($this->packer, $this->unpacker, $this->connection);
         }
 
         return $this->protocol instanceof AProtocol;
@@ -168,7 +169,7 @@ private function unpackProtocolVersion()
     {
         $result = [];
 
-        foreach (str_split($this->socket->read(4)) as $ch)
+        foreach (str_split($this->connection->read(4)) as $ch)
             $result[] = unpack('C', $ch)[1] ?? 0;
 
         $result = array_filter($result);
@@ -218,7 +219,7 @@ private function packProtocolVersions(): string
      */
     public function init(string $name, string $user, string $password, array $routing = null): bool
     {
-        if (!$this->socket->connect())
+        if (!$this->connection->connect())
             return false;
 
         if (!$this->handshake())
@@ -401,7 +402,7 @@ public function __destruct()
             $this->protocol->goodbye();
         }
 
-        $this->socket->disconnect();
+        $this->connection->disconnect();
     }
 
 }

connection/IConnection.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Bolt\connection;
+
+/**
+ * Interface IConnection
+ *
+ * @author Michal Stefanak
+ * @link https://github.com/stefanak-michal/Bolt
+ * @package Bolt\connection
+ */
+interface IConnection
+{
+    public function connect(): bool;
+
+    public function write(string $buffer);
+
+    public function read(int $length = 2048): string;
+
+    public function disconnect();
+}

Socket.php renamed to connection/Socket.php

@@ -1,15 +1,17 @@
 <?php
 
-namespace Bolt;
+namespace Bolt\connection;
+
+use Bolt\Bolt;
 
 /**
  * Socket class
  *
  * @author Michal Stefanak
  * @link https://github.com/stefanak-michal/Bolt
- * @package Bolt
+ * @package Bolt\connection
  */
-final class Socket
+class Socket implements IConnection
 {
 
     /**

phpunit.xml

@@ -10,10 +10,10 @@
     </php>
     <filter>
         <whitelist>
-            <directory suffix=".php">protocol</directory>
+            <directory suffix=".php">connection</directory>
             <directory suffix=".php">PackStream</directory>
+            <directory suffix=".php">protocol</directory>
             <file>Bolt.php</file>
-            <file>Socket.php</file>
         </whitelist>
     </filter>
 </phpunit>

protocol/AProtocol.php

@@ -4,7 +4,7 @@
 
 use Bolt\Bolt;
 use Bolt\PackStream\{IPacker, IUnpacker};
-use Bolt\Socket;
+use Bolt\connection\IConnection;
 use Exception;
 
 /**
@@ -33,21 +33,21 @@ abstract class AProtocol implements IProtocol
     protected $unpacker;
 
     /**
-     * @var Socket
+     * @var IConnection
      */
-    private $socket;
+    private $connection;
 
     /**
      * AProtocol constructor.
      * @param IPacker $packer
      * @param IUnpacker $unpacker
-     * @param Socket $socket
+     * @param IConnection $connection
      */
-    public function __construct(IPacker $packer, IUnpacker $unpacker, Socket $socket)
+    public function __construct(IPacker $packer, IUnpacker $unpacker, IConnection $connection)
     {
         $this->packer = $packer;
         $this->unpacker = $unpacker;
-        $this->socket = $socket;
+        $this->connection = $connection;
     }
 
     public function begin(...$args): bool
@@ -71,17 +71,17 @@ public function goodbye(...$args)
     }
 
     /**
-     * Write to socket
+     * Write to connection
      * @param string $buffer
      * @throws Exception
      */
     protected function write(string $buffer)
     {
-        $this->socket->write($buffer);
+        $this->connection->write($buffer);
     }
 
     /**
-     * Read from socket
+     * Read from connection
      * @param int|null $signature
      * @return mixed|null
      * @throws Exception
@@ -90,11 +90,11 @@ protected function read(?int &$signature)
     {
         $msg = '';
         while (true) {
-            $header = $this->socket->read(2);
+            $header = $this->connection->read(2);
             if (ord($header[0]) == 0x00 && ord($header[1]) == 0x00)
                 break;
             $length = unpack('n', $header)[1] ?? 0;
-            $msg .= $this->socket->read($length);
+            $msg .= $this->connection->read($length);
         }
 
         $output = null;

protocol/V3.php

@@ -160,7 +160,7 @@ public function goodbye(...$args)
             $msg = $this->packer->pack(0x02);
         } catch (Exception $ex) {
             Bolt::error($ex->getMessage());
-            return false;
+            return;
         }
 
         $this->write($msg);

tests/ATest.php

@@ -2,7 +2,8 @@
 
 namespace Bolt\tests;
 
-use \PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\TestCase;
+use Bolt\connection\IConnection;
 
 /**
  * Class TestBase
@@ -14,30 +15,96 @@ abstract class ATest extends TestCase
 {
 
     /**
-     * @var bool
+     * @var int Internal pointer for "readArray"
      */
-    private static $bypass = false;
+    static $readIndex = 0;
+    /**
+     * @var array Order of consecutive returns from "read" method calls
+     */
+    static $readArray = [];
+    /**
+     * @var int Internal pointer for "writeBuffer"
+     */
+    static $writeIndex = 0;
+    /**
+     * @var array Expected write buffers or keep empty to skip verification
+     */
+    static $writeBuffer = [];
+
+    /**
+     * Mock Socket class with "write" and "read" methods
+     * @return IConnection
+     */
+    protected function mockConnection()
+    {
+        $mockBuilder = $this
+            ->getMockBuilder(IConnection::class)
+            ->disableOriginalConstructor();
+        call_user_func([$mockBuilder, method_exists($mockBuilder, 'onlyMethods') ? 'onlyMethods' : 'setMethods'], ['write', 'read', 'connect', 'disconnect']);
+        /** @var IConnection $connection */
+        $connection = $mockBuilder->getMock();
+
+        $connection
+            ->method('write')
+            ->with(
+                $this->callback(function ($buffer) {
+                    $i = self::$writeIndex;
+                    self::$writeIndex++;
+
+                    //skip write buffer check
+                    if (empty(self::$writeBuffer))
+                        return true;
+
+                    //verify expected buffer
+                    return (self::$writeBuffer[$i] ?? '') == $buffer;
+                })
+            );
+
+        $connection
+            ->method('read')
+            ->will($this->returnCallback([$this, 'readCallback']));
+
+        return $connection;
+    }
 
     /**
-     * Bypass Socket final keyword before autoload
+     * Mocked Socket read method
+     * @return string
      */
-    public static function setUpBeforeClass(): void
+    public function readCallback(): string
     {
-        if (!self::$bypass) {
-            $path = __DIR__;
-            while (!file_exists($path . DS . 'Socket.php')) {
-                $path = dirname($path);
-            }
-
-            $content = file_get_contents($path . DS . 'Socket.php');
-            if (strpos($content, "final class Socket") !== false) {
-                file_put_contents($path . DS . 'Socket.php', str_replace('final class Socket', 'class Socket', $content));
-                $socket = new \Bolt\Socket('localhost', 0, 0);
-                file_put_contents($path . DS . 'Socket.php', $content);
-            }
+        switch (self::$readArray[self::$readIndex]) {
+            case 1:
+                $output = hex2bin('0003'); // header of length 3
+                break;
+            case 2:
+                $output = hex2bin('B170A0'); // success {}
+                break;
+            case 3:
+                $output = hex2bin('B171A0'); // record {}
+                break;
+            case 4:
+                $output = hex2bin('004b'); // failure header
+                break;
+            case 5:
+                $output = hex2bin('b17fa284636f6465d0254e656f2e436c69656e744572726f722e53746174656d656e742e53796e7461784572726f72876d657373616765d012736f6d65206572726f72206d657373616765'); // failure message
+                break;
+            default:
+                $output = hex2bin('0000'); // end
         }
 
-        self::$bypass = true;
+        self::$readIndex++;
+        return (string)$output;
     }
 
+    /**
+     * Reset mockup IConnetion variables
+     */
+    protected function setUp()
+    {
+        self::$readIndex = 0;
+        self::$readArray = [];
+        self::$writeIndex = 0;
+        self::$writeBuffer = [];
+    }
 }

tests/BoltTest.php

@@ -11,7 +11,7 @@
  * @link https://github.com/stefanak-michal/Bolt
  *
  * @covers \Bolt\Bolt
- * @covers \Bolt\Socket
+ * @covers \Bolt\connection\Socket
  *
  * @package Bolt\tests
  * @requires PHP >= 7.1