Update codebase to PHP 7.4 (#12)

Author: TavoNiievez

.github/workflows/main.yml

@@ -14,7 +14,7 @@ jobs:
 
     strategy:
       matrix:
-        php: [5.6, 7.0, 7.1, 7.2, 7.3, 7.4, 8.0]
+        php: [7.4, 8.0, 8.1]
 
     steps:
     - name: Checkout code

composer.json

@@ -1,28 +1,30 @@
 {
-    "name":"codeception/module-amqp",
-    "description":"AMQP module for Codeception",
-    "keywords":["codeception", "amqp"],
-    "homepage":"http://codeception.com/",
-    "type":"library",
-    "license":"MIT",
-    "authors":[
-        {
-            "name":"Michael Bodnarchuk"
-        },
-        {
-            "name":"Gintautas Miselis"
-        }
-    ],
-    "minimum-stability": "RC",
-    "require": {
-        "php": ">=5.6.0 <9.0",
-        "codeception/codeception": "^4.0",
-        "php-amqplib/php-amqplib": "^2.10|^3.0"
-    },
-    "autoload":{
-        "classmap": ["src/"]
-    },
-    "config": {
-        "classmap-authoritative": true
-    }
+	"name": "codeception/module-amqp",
+	"description": "AMQP module for Codeception",
+	"keywords": [ "codeception", "amqp" ],
+	"homepage": "https://codeception.com/",
+	"type": "library",
+	"license": "MIT",
+	"authors": [
+		{
+			"name": "Michael Bodnarchuk"
+		},
+		{
+			"name": "Gintautas Miselis"
+		}
+	],
+	"minimum-stability": "RC",
+	"require": {
+		"php": "^7.4 | ^8.0",
+		"codeception/codeception": "^4.0",
+		"php-amqplib/php-amqplib": "^2.10 | ^3.0"
+	},
+	"autoload": {
+		"classmap": [
+			"src/"
+		]
+	},
+	"config": {
+		"classmap-authoritative": true
+	}
 }

readme.md

@@ -7,6 +7,10 @@ An AMQP module for Codeception.
 [![Total Downloads](https://poser.pugx.org/codeception/module-amqp/downloads)](https://packagist.org/packages/codeception/module-amqp)
 [![License](https://poser.pugx.org/codeception/module-amqp/license)](/LICENSE)
 
+## Requirements
+
+* `PHP 7.4` or higher.
+
 ## Installation
 
 ```

src/Codeception/Module/AMQP.php

@@ -1,8 +1,12 @@
 <?php
+
+declare(strict_types=1);
+
 namespace Codeception\Module;
 
 use Codeception\Exception\ModuleException;
-use Codeception\Module as CodeceptionModule;
+use Codeception\Lib\Interfaces\RequiresPackage;
+use Codeception\Module;
 use Codeception\TestInterface;
 use Exception;
 use PhpAmqpLib\Channel\AMQPChannel;
@@ -45,8 +49,11 @@
  *
  * * connection - AMQPStreamConnection - current connection
  */
-class AMQP extends CodeceptionModule
+class AMQP extends Module implements RequiresPackage
 {
+    /**
+     * @var array
+     */
     protected $config = [
         'host'           => 'localhost',
         'username'       => 'guest',
@@ -58,18 +65,20 @@ class AMQP extends CodeceptionModule
         'queues'         => []
     ];
 
-    /**
-     * @var AMQPStreamConnection
-     */
-    public $connection;
+    public ?AMQPStreamConnection $connection = null;
+
+    protected ?int $channelId = null;
 
     /**
-     * @var int
+     * @var string[]
      */
-    protected $channelId;
-
     protected $requiredFields = ['host', 'username', 'password', 'vhost'];
 
+    public function _requires()
+    {
+        return [AMQPStreamConnection::class => '"php-amqplib/php-amqplib": "~2.4"'];
+    }
+
     public function _initialize()
     {
         $host = $this->config['host'];
@@ -80,8 +89,8 @@ public function _initialize()
 
         try {
             $this->connection = new AMQPStreamConnection($host, $port, $username, $password, $vhost);
-        } catch (Exception $e) {
-            throw new ModuleException(__CLASS__, $e->getMessage() . ' while establishing connection to MQ server');
+        } catch (Exception $exception) {
+            throw new ModuleException(__CLASS__, $exception->getMessage() . ' while establishing connection to MQ server');
         }
     }
 
@@ -101,14 +110,11 @@ public function _before(TestInterface $test)
      * $I->pushToExchange('exchange.emails', 'thanks');
      * $I->pushToExchange('exchange.emails', new AMQPMessage('Thanks!'));
      * $I->pushToExchange('exchange.emails', new AMQPMessage('Thanks!'), 'severity');
-     * ?>
      * ```
      *
-     * @param string $exchange
-     * @param string|\PhpAmqpLib\Message\AMQPMessage $message
-     * @param string $routing_key
+     * @param string|AMQPMessage $message
      */
-    public function pushToExchange($exchange, $message, $routing_key = null)
+    public function pushToExchange(string $exchange, $message, string $routing_key = null): void
     {
         $message = $message instanceof AMQPMessage
             ? $message
@@ -123,13 +129,11 @@ public function pushToExchange($exchange, $message, $routing_key = null)
      * <?php
      * $I->pushToQueue('queue.jobs', 'create user');
      * $I->pushToQueue('queue.jobs', new AMQPMessage('create'));
-     * ?>
      * ```
      *
-     * @param string $queue
-     * @param string|\PhpAmqpLib\Message\AMQPMessage $message
+     * @param string|AMQPMessage $message
      */
-    public function pushToQueue($queue, $message)
+    public function pushToQueue(string $queue, $message): void
     {
         $message = $message instanceof AMQPMessage
             ? $message
@@ -152,27 +156,18 @@ public function pushToQueue($queue, $message)
      * )
      * ```
      *
-     * @param string $exchange
-     * @param string $type
-     * @param bool $passive
-     * @param bool $durable
-     * @param bool $auto_delete
-     * @param bool $internal
-     * @param bool $nowait
-     * @param array $arguments
-     * @param int $ticket
-     * @return mixed|null
+     * @return mixed
      */
     public function declareExchange(
-        $exchange,
-        $type,
-        $passive = false,
-        $durable = false,
-        $auto_delete = true,
-        $internal = false,
-        $nowait = false,
-        $arguments = null,
-        $ticket = null
+        string $exchange,
+        string $type,
+        bool $passive = false,
+        bool $durable = false,
+        bool $auto_delete = true,
+        bool $internal = false,
+        bool $nowait = false,
+        array $arguments = null,
+        int $ticket = null
     ) {
         return $this->getChannel()->exchange_declare(
             $exchange,
@@ -199,26 +194,18 @@ public function declareExchange(
      * )
      * ```
      *
-     * @param string $queue
-     * @param bool $passive
-     * @param bool $durable
-     * @param bool $exclusive
-     * @param bool $auto_delete
-     * @param bool $nowait
-     * @param array $arguments
-     * @param int $ticket
-     * @return mixed|null
+     * @return mixed
      */
     public function declareQueue(
-        $queue = '',
-        $passive = false,
-        $durable = false,
-        $exclusive = false,
-        $auto_delete = true,
-        $nowait = false,
-        $arguments = null,
-        $ticket = null
-    ) {
+        string $queue = '',
+        bool $passive = false,
+        bool $durable = false,
+        bool $exclusive = false,
+        bool $auto_delete = true,
+        bool $nowait = false,
+        array $arguments = null,
+        int $ticket = null
+    ): ?array {
         return $this->getChannel()->queue_declare(
             $queue,
             $passive,
@@ -245,21 +232,15 @@ public function declareQueue(
      * )
      * ```
      *
-     * @param string $queue
-     * @param string $exchange
-     * @param string $routing_key
-     * @param bool $nowait
-     * @param array $arguments
-     * @param int $ticket
-     * @return mixed|null
+     * @return mixed
      */
     public function bindQueueToExchange(
-        $queue,
-        $exchange,
-        $routing_key = '',
-        $nowait = false,
-        $arguments = null,
-        $ticket = null
+        string $queue,
+        string $exchange,
+        string $routing_key = '',
+        bool $nowait = false,
+        array $arguments = null,
+        int $ticket = null
     ) {
         return $this->getChannel()->queue_bind(
             $queue,
@@ -273,10 +254,8 @@ public function bindQueueToExchange(
 
     /**
      * Add a queue to purge list
-     *
-     * @param string $queue
      */
-    public function scheduleQueueCleanup($queue)
+    public function scheduleQueueCleanup(string $queue): void
     {
         if (!in_array($queue, $this->config['queues'])) {
             $this->config['queues'][] = $queue;
@@ -293,21 +272,19 @@ public function scheduleQueueCleanup($queue)
      * <?php
      * $I->pushToQueue('queue.emails', 'Hello, davert');
      * $I->seeMessageInQueueContainsText('queue.emails','davert');
-     * ?>
      * ```
-     *
-     * @param string $queue
-     * @param string $text
      */
-    public function seeMessageInQueueContainsText($queue, $text)
+    public function seeMessageInQueueContainsText(string $queue, string $text): void
     {
         $msg = $this->getChannel()->basic_get($queue);
-        if (!$msg) {
+        if (!$msg instanceof AMQPMessage) {
             $this->fail("Message was not received");
         }
+
         if (!$msg instanceof AMQPMessage) {
             $this->fail("Received message is not format of AMQPMessage");
         }
+
         $this->debugSection("Message", $msg->body);
         $this->assertStringContainsString($text, $msg->body);
 
@@ -316,14 +293,10 @@ public function seeMessageInQueueContainsText($queue, $text)
 
     /**
      * Count messages in queue.
-     *
-     * @param string $queue
-     *
-     * @return int
      */
-    public function _countMessage($queue)
+    public function _countMessage(string $queue): int
     {
-        list($queue, $messageCount) = $this->getChannel()->queue_declare($queue, true);
+        [$queue, $messageCount] = $this->getChannel()->queue_declare($queue, true);
         return $messageCount;
     }
 
@@ -334,13 +307,9 @@ public function _countMessage($queue)
      * <?php
      * $I->pushToQueue('queue.emails', 'Hello, davert');
      * $I->seeNumberOfMessagesInQueue('queue.emails',1);
-     * ?>
      * ```
-     *
-     * @param string $queue
-     * @param int $expected
      */
-    public function seeNumberOfMessagesInQueue($queue, $expected)
+    public function seeNumberOfMessagesInQueue(string $queue, int $expected): void
     {
         $messageCount = $this->_countMessage($queue);
         $this->assertEquals($expected, $messageCount);
@@ -354,13 +323,9 @@ public function seeNumberOfMessagesInQueue($queue, $expected)
      * $I->pushToQueue('queue.emails', 'Hello, davert');
      * $I->purgeQueue('queue.emails');
      * $I->seeQueueIsEmpty('queue.emails');
-     * ?>
      * ```
-     *
-     * @param string $queue
-     * @param int $expected
      */
-    public function seeQueueIsEmpty($queue)
+    public function seeQueueIsEmpty(string $queue): void
     {
         $messageCount = $this->_countMessage($queue);
         $this->assertEquals(0, $messageCount);
@@ -373,12 +338,9 @@ public function seeQueueIsEmpty($queue)
      * <?php
      * $I->pushToQueue('queue.emails', 'Hello, davert');
      * $I->dontSeeQueueIsEmpty('queue.emails');
-     * ?>
      * ```
-     *
-     * @param string $queue
      */
-    public function dontSeeQueueIsEmpty($queue)
+    public function dontSeeQueueIsEmpty(string $queue): void
     {
         $messageCount = $this->_countMessage($queue);
         $this->assertNotEquals(0, $messageCount);
@@ -390,16 +352,11 @@ public function dontSeeQueueIsEmpty($queue)
      * ``` php
      * <?php
      * $message = $I->grabMessageFromQueue('queue.emails');
-     * ?>
      * ```
-     *
-     * @param string $queue
-     * @return \PhpAmqpLib\Message\AMQPMessage
      */
-    public function grabMessageFromQueue($queue)
+    public function grabMessageFromQueue(string $queue): ?AMQPMessage
     {
-        $message = $this->getChannel()->basic_get($queue);
-        return $message;
+        return $this->getChannel()->basic_get($queue);
     }
 
     /**
@@ -408,15 +365,12 @@ public function grabMessageFromQueue($queue)
      * ``` php
      * <?php
      * $I->purgeQueue('queue.emails');
-     * ?>
      * ```
-     *
-     * @param string $queueName
      */
-    public function purgeQueue($queueName = '')
+    public function purgeQueue(string $queueName = ''): void
     {
         if (! in_array($queueName, $this->config['queues'])) {
-            throw new ModuleException(__CLASS__, "'$queueName' doesn't exist in queues config list");
+            throw new ModuleException(__CLASS__, "'{$queueName}' doesn't exist in queues config list");
         }
 
         $this->getChannel()->queue_purge($queueName, true);
@@ -428,40 +382,39 @@ public function purgeQueue($queueName = '')
      * ``` php
      * <?php
      * $I->purgeAllQueues();
-     * ?>
      * ```
      */
-    public function purgeAllQueues()
+    public function purgeAllQueues(): void
     {
         $this->cleanup();
     }
 
-    /**
-     * @return \PhpAmqpLib\Channel\AMQPChannel
-     */
-    protected function getChannel()
+    protected function getChannel(): AMQPChannel
     {
         if ($this->config['single_channel'] && $this->channelId === null) {
             $this->channelId = $this->connection->get_free_channel_id();
         }
+
         return $this->connection->channel($this->channelId);
     }
 
-    protected function cleanup()
+    protected function cleanup(): void
     {
         if (!isset($this->config['queues'])) {
             throw new ModuleException(__CLASS__, "please set queues for cleanup");
         }
+
         if (!$this->connection) {
             return;
         }
+
         foreach ($this->config['queues'] as $queue) {
             try {
                 $this->getChannel()->queue_purge($queue);
-            } catch (AMQPProtocolChannelException $e) {
+            } catch (AMQPProtocolChannelException $exception) {
                 // ignore if exchange/queue doesn't exist and rethrow exception if it's something else
-                if ($e->getCode() !== 404) {
-                    throw $e;
+                if ($exception->getCode() !== 404) {
+                    throw $exception;
                 }
             }
         }

tests/unit/Codeception/Module/AMQPTest.php

@@ -1,28 +1,32 @@
 <?php
 
+declare(strict_types=1);
 
-class AMQPTest extends \Codeception\PHPUnit\TestCase
+use Codeception\Lib\ModuleContainer;
+use Codeception\Module\AMQP;
+use Codeception\PHPUnit\TestCase;
+use Codeception\Util\Stub;
+
+final class AMQPTest extends TestCase
 {
-    protected $config = array(
+    protected array $config = [
         'host'     => 'localhost',
         'username' => 'guest',
         'password' => 'guest',
         'port' => '5672',
         'vhost'    => '/',
         'cleanup' => false,
-        'queues' => array('queue1')
-    );
+        'queues' => ['queue1']
+    ];
 
-    /**
-     * @var \Codeception\Module\AMQP
-     */
-    protected $module = null;
+    protected AMQP $module;
 
     public function _setUp()
     {
-        $container = \Codeception\Util\Stub::make('Codeception\Lib\ModuleContainer');
-        $this->module = new \Codeception\Module\AMQP($container);
+        $container = Stub::make(ModuleContainer::class);
+        $this->module = new AMQP($container);
         $this->module->_setConfig($this->config);
+
         $res = @stream_socket_client('tcp://localhost:5672');
         if ($res === false) {
             $this->markTestSkipped('AMQP is not running');