Merge pull request #102 from edudobay/php8

Support PHP 8

.gitignore

@@ -3,3 +3,4 @@
 /composer.phar
 /composer.lock
 /vendor
+.phpunit.result.cache

.travis.yml

@@ -1,15 +1,15 @@
-dist: trusty
+dist: bionic
 
 os: linux
 
 language: php
 
 php:
-  - 7.0
   - 7.1
   - 7.2
   - 7.3
   - 7.4
+  - 8.0
   - nightly
 
 cache:
@@ -41,3 +41,8 @@ script:
 
 services:
   - rabbitmq
+
+addons:
+  apt:
+    packages:
+      - rabbitmq-server

README.md

@@ -9,7 +9,7 @@
 
 ## Requirements
 
-BunnyPHP requires PHP 7.0 and newer.
+BunnyPHP requires PHP 7.1 and newer.
 
 ## Installation
 
@@ -231,6 +231,8 @@ in.
   ```
   $ docker-compose up -d
   ```
+
+  To test against different SSL configurations (as in CI builds), you can set environment variable `CONFIG_NAME=rabbitmq.ssl.verify_none` before running `docker-compose up`.
 
 - Optionally use `docker ps` to display the running containers.  
 

composer.json

@@ -25,13 +25,13 @@
         }
     ],
     "require": {
-        "php": "~7.0",
+        "php": "^7.1 || ^8.0",
         "psr/log": "~1.0",
         "react/event-loop": "^1.0 || ^0.5 || ^0.4",
         "react/promise": "~2.2"
     },
     "require-dev": {
-        "phpunit/phpunit": "~6.5"
+        "phpunit/phpunit": "^7.5 || ^8.5 || ^9.3"
     },
     "autoload": {
         "psr-4": {

docker-compose.yml

@@ -4,11 +4,16 @@ networks:
 services:
   rabbit_node_1:
     image: 'rabbitmq:3-management'
+    entrypoint: /opt/bunny/docker/rabbitmq/entrypoint.sh /usr/local/bin/docker-entrypoint.sh
+    command: rabbitmq-server
     environment:
       RABBITMQ_DEFAULT_USER: testuser
       RABBITMQ_DEFAULT_PASS: testpassword
       RABBITMQ_DEFAULT_VHOST: testvhost
       RABBITMQ_ERLANG_COOKIE: bunny-test-secret
+      CONFIG_NAME: "${CONFIG_NAME:-rabbitmq.ssl.verify_peer}"
+    volumes:
+      - .:/opt/bunny
     networks:
       - main
     hostname: rabbit_node_1
@@ -18,6 +23,13 @@ services:
     tty: true
   bunny:
     build: docker/bunny
+    init: true
+    environment:
+      SSL_TEST: 'yes'
+      SSL_CA: ssl/ca.pem
+      SSL_PEER_NAME: server.rmq
+      SSL_CLIENT_CERT: ssl/client.pem
+      SSL_CLIENT_KEY: ssl/client.key
     volumes:
       - .:/opt/bunny
     networks:

docker/rabbitmq/entrypoint.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+set -eu
+
+is_rabbitmq_gte_3_7_0() {
+	[[ "3.7.0" = $(echo -e "3.7.0\n$RABBITMQ_VERSION" | sort -V | head -n1) ]]
+}
+
+TEST_DATA_ROOT=/opt/bunny/test/ssl
+CONFIG_NAME=${CONFIG_NAME:-}
+
+cp ${TEST_DATA_ROOT}/{ca.pem,server.pem,server.key} /etc/rabbitmq/
+chown rabbitmq /etc/rabbitmq/{ca.pem,server.pem,server.key}
+chmod 0400 /etc/rabbitmq/{ca.pem,server.pem,server.key}
+
+if [[ -n "$CONFIG_NAME" ]]; then
+	if is_rabbitmq_gte_3_7_0; then
+		cp ${TEST_DATA_ROOT}/${CONFIG_NAME}.conf /etc/rabbitmq/rabbitmq.conf
+		chown rabbitmq /etc/rabbitmq/rabbitmq.conf
+	else
+		cp ${TEST_DATA_ROOT}/${CONFIG_NAME}.config /etc/rabbitmq/rabbitmq.config
+		chown rabbitmq /etc/rabbitmq/rabbitmq.config
+	fi
+fi
+
+exec "$@"

src/Bunny/AbstractClient.php

@@ -248,16 +248,13 @@ protected function getStream()
                 $uri .= (strpos($this->options["path"], "/") === 0) ? $this->options["path"] : "/" . $this->options["path"];
             }
 
-            // tcp_nodelay was added in 7.1.0
-            if (PHP_VERSION_ID >= 70100) {
-                stream_context_set_option(
-                    $context, [
-                    "socket" => [
-                        "tcp_nodelay" => true
-                    ]
-                ]);
-            }
-
+            stream_context_set_option(
+                $context, [
+                "socket" => [
+                    "tcp_nodelay" => true
+                ]
+            ]);
+
             $this->stream = @stream_socket_client($uri, $errno, $errstr, (float)$this->options["timeout"], $flags, $context);
 
             if (!$this->stream) {

src/Bunny/ChannelMethods.php

@@ -122,7 +122,7 @@ public function queueDeclare($queue = '', $passive = false, $durable = false, $e
      *
      * @return boolean|Promise\PromiseInterface|Protocol\MethodQueueBindOkFrame
      */
-    public function queueBind($queue = '', $exchange, $routingKey = '', $nowait = false, $arguments = [])
+    public function queueBind($queue, $exchange, $routingKey = '', $nowait = false, $arguments = [])
     {
         return $this->getClient()->queueBind($this->getChannelId(), $queue, $exchange, $routingKey, $nowait, $arguments);
     }
@@ -165,7 +165,7 @@ public function queueDelete($queue = '', $ifUnused = false, $ifEmpty = false, $n
      *
      * @return boolean|Promise\PromiseInterface|Protocol\MethodQueueUnbindOkFrame
      */
-    public function queueUnbind($queue = '', $exchange, $routingKey = '', $arguments = [])
+    public function queueUnbind($queue, $exchange, $routingKey = '', $arguments = [])
     {
         return $this->getClient()->queueUnbind($this->getChannelId(), $queue, $exchange, $routingKey, $arguments);
     }

src/Bunny/ClientMethods.php

@@ -208,7 +208,7 @@ public function awaitConnectionStart()
         throw new \LogicException('This statement should be never reached.');
     }
 
-    public function connectionStartOk($clientProperties = [], $mechanism = 'PLAIN', $response, $locale = 'en_US')
+    public function connectionStartOk($clientProperties, $mechanism, $response, $locale = 'en_US')
     {
         $buffer = new Buffer();
         $buffer->appendUint16(10);
@@ -383,7 +383,7 @@ public function awaitConnectionOpenOk()
         throw new \LogicException('This statement should be never reached.');
     }
 
-    public function connectionClose($replyCode, $replyText = '', $closeClassId, $closeMethodId)
+    public function connectionClose($replyCode, $replyText, $closeClassId, $closeMethodId)
     {
         $buffer = $this->getWriteBuffer();
         $buffer->appendUint8(1);
@@ -749,7 +749,7 @@ public function awaitChannelFlowOk($channel)
         throw new \LogicException('This statement should be never reached.');
     }
 
-    public function channelClose($channel, $replyCode, $replyText = '', $closeClassId, $closeMethodId)
+    public function channelClose($channel, $replyCode, $replyText, $closeClassId, $closeMethodId)
     {
         $buffer = $this->getWriteBuffer();
         $buffer->appendUint8(1);
@@ -1289,7 +1289,7 @@ public function awaitQueueDeclareOk($channel)
         throw new \LogicException('This statement should be never reached.');
     }
 
-    public function queueBind($channel, $queue = '', $exchange, $routingKey = '', $nowait = false, $arguments = [])
+    public function queueBind($channel, $queue, $exchange, $routingKey = '', $nowait = false, $arguments = [])
     {
         $buffer = new Buffer();
         $buffer->appendUint16(50);
@@ -1497,7 +1497,7 @@ public function awaitQueueDeleteOk($channel)
         throw new \LogicException('This statement should be never reached.');
     }
 
-    public function queueUnbind($channel, $queue = '', $exchange, $routingKey = '', $arguments = [])
+    public function queueUnbind($channel, $queue, $exchange, $routingKey = '', $arguments = [])
     {
         $buffer = new Buffer();
         $buffer->appendUint16(50);

src/Bunny/Protocol/Buffer.php

@@ -43,12 +43,7 @@ public function __construct($buffer = "")
         self::isLittleEndian();
 
         if (self::$native64BitPack === null) {
-            if (!defined("PHP_VERSION_ID")) {
-                $version = explode(".", PHP_VERSION);
-                define("PHP_VERSION_ID", ($version[0] * 10000 + $version[1] * 100 + $version[2]));
-            }
-
-            self::$native64BitPack = PHP_VERSION_ID >= 50603 && PHP_INT_SIZE === 8;
+            self::$native64BitPack = PHP_INT_SIZE === 8;
         }
     }
 

test/Bunny/AsyncClientTest.php

@@ -22,7 +22,7 @@ class AsyncClientTest extends TestCase
      */
     private $helper;
 
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 

test/Bunny/ChannelTest.php

@@ -16,7 +16,7 @@ class ChannelTest extends TestCase
      */
     private $helper;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();
 

test/Bunny/ClientTest.php

@@ -20,7 +20,7 @@ class ClientTest extends TestCase
      */
     private $helper;
 
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 

test/Bunny/SSLTest.php

@@ -5,6 +5,8 @@
 use Bunny\Async\Client as AsyncClient;
 use Bunny\Exception\ClientException;
 use Bunny\Test\Exception\TimeoutException;
+use Bunny\Test\Library\AsynchronousClientHelper;
+use Bunny\Test\Library\SynchronousClientHelper;
 use PHPUnit\Framework\TestCase;
 
 use React\EventLoop\Factory;
@@ -17,12 +19,29 @@
 
 class SSLTest extends TestCase
 {
+    /**
+     * @var SynchronousClientHelper
+     */
+    private $helper;
+
+    /**
+     * @var AsynchronousClientHelper
+     */
+    private $asyncHelper;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->helper = new SynchronousClientHelper();
+        $this->asyncHelper = new AsynchronousClientHelper();
+    }
 
     public function testConnect()
     {
         $options = $this->getOptions();
 
-        $client = new Client($options);
+        $client = $this->helper->createClient($options);
         $client->connect();
         $client->disconnect();
 
@@ -37,7 +56,7 @@ public function testConnectAsync() {
             throw new TimeoutException();
         });
 
-        $client = new AsyncClient($loop, $options);
+        $client = $this->asyncHelper->createClient($loop, $options);
         $client->connect()->then(function (AsyncClient $client) {
             return $client->disconnect();
         })->then(function () use ($loop) {
@@ -61,7 +80,7 @@ public function testConnectWithMissingClientCert()
 
         $this->expectException(ClientException::class);
 
-        $client = new Client($options);
+        $client = $this->helper->createClient($options);
         $client->connect();
         $client->disconnect();
     }
@@ -73,7 +92,7 @@ public function testConnectToTcpPort()
 
         $this->expectException(ClientException::class);
 
-        $client = new Client($options);
+        $client = $this->helper->createClient($options);
         $client->connect();
         $client->disconnect();
     }
@@ -85,7 +104,7 @@ public function testConnectWithWrongPeerName()
 
         $this->expectException(ClientException::class);
 
-        $client = new Client($options);
+        $client = $this->helper->createClient($options);
         $client->connect();
         $client->disconnect();
     }

test/Library/AsynchronousClientHelper.php

@@ -17,7 +17,7 @@ final class AsynchronousClientHelper extends AbstractClientHelper
      */
     public function createClient(LoopInterface $loop, array $options = null): Client
     {
-        $options = $options ?? $this->getDefaultOptions();
+        $options = array_merge($this->getDefaultOptions(), $options ?? []);
 
         return new Client($loop, $options);
     }

test/Library/SynchronousClientHelper.php

@@ -16,7 +16,7 @@ final class SynchronousClientHelper extends AbstractClientHelper
      */
     public function createClient(array $options = null): Client
     {
-        $options = $options ?? $this->getDefaultOptions();
+        $options = array_merge($this->getDefaultOptions(), $options ?? []);
 
         return new Client($options);
     }

test/ssl/rabbitmq.ssl.verify_none.conf

@@ -7,4 +7,4 @@ ssl_options.cacertfile = /etc/rabbitmq/ca.pem
 ssl_options.certfile = /etc/rabbitmq/server.pem
 ssl_options.keyfile = /etc/rabbitmq/server.key
 ssl_options.verify = verify_none
-ssl_options.fail_if_no_peer_cert = falsee
+ssl_options.fail_if_no_peer_cert = false

test/ssl/rabbitmq.ssl.verify_peer.conf

@@ -7,4 +7,4 @@ ssl_options.cacertfile = /etc/rabbitmq/ca.pem
 ssl_options.certfile = /etc/rabbitmq/server.pem
 ssl_options.keyfile = /etc/rabbitmq/server.key
 ssl_options.verify = verify_peer
-ssl_options.fail_if_no_peer_cert = true
+ssl_options.fail_if_no_peer_cert = true

test/ssl/travis.sh

@@ -15,4 +15,5 @@ else
 	sudo cp rabbitmq.ssl.verify_peer.conf /etc/rabbitmq/rabbitmq.conf
 	sudo cp rabbitmq.ssl.verify_peer.config /etc/rabbitmq/rabbitmq.config
 fi
-sudo service rabbitmq-server restart
+sudo chown rabbitmq: /etc/rabbitmq/{ca.pem,server.pem,server.key,rabbitmq.conf,rabbitmq.config}
+sudo service rabbitmq-server restart