review: add proper integration tests

Author: ivanaugustobd

Api/Data/MessageInterface.php

@@ -5,16 +5,75 @@
 
 interface MessageInterface
 {
+    public const FIELD_GROUP = 'group';
+    public const FIELD_JOB = 'job';
+    public const FIELD_TARGET = 'target';
+    public const FIELD_ADDITIONAL_DATA = 'additional_data';
+    public const FIELD_STATUS = 'status';
+
+    public const DEFAULT_GROUP = 'default';
+
+    public const STATUS_PENDING = 'pending';
+    public const STATUS_PROCESSING = 'processing';
+    public const STATUS_SUCCESS = 'success';
+    public const STATUS_ERROR = 'error';
+
+    /**
+     * "group" getter
+     *
+     * @return string
+     */
+    public function getGroup();
+
+    /**
+     * "group" setter
+     *
+     * @param string $group
+     * @return \Discorgento\Queue\Api\Data\MessageInterface
+     */
+    public function setGroup($group): self;
+
+    /**
+     * "job" getter
+     *
+     * @return string|null
+     */
+    public function getJob();
+
+    /**
+     * "job" setter
+     *
+     * @param string $job
+     * @return \Discorgento\Queue\Api\Data\MessageInterface
+     */
+    public function setJob($job): self;
+
+    /**
+     * "target" getter
+     *
+     * @return string|null
+     */
+    public function getTarget();
+
+    /**
+     * "target" setter
+     *
+     * @param string $target
+     * @return \Discorgento\Queue\Api\Data\MessageInterface
+     */
+    public function setTarget($target): self;
+
     /**
      * Set additional data that can be used by the job later
      *
      * @param array|null $additionalData
-     * @return self
+     * @return \Discorgento\Queue\Api\Data\MessageInterface
      */
     public function setAdditionalData($additionalData);
 
     /**
      * Retrieve additional data array
+     *
      * @return array
      */
     public function getAdditionalData();

Command/ClearCommand.php

@@ -0,0 +1,71 @@
+<?php declare(strict_types=1);
+/**
+ * @author IronPlane Team
+ * @copyright Copyright (c) 2023 IronPlane (https://www.ironplane.com)
+ */
+
+namespace Discorgento\Queue\Command;
+
+use Discorgento\Queue\Model\MessageRepository;
+use Discorgento\Queue\Model\ResourceModel\Message\CollectionFactory as MessagesCollectionFactory;
+
+class ClearCommand
+{
+    /** @var MessagesCollectionFactory */
+    private $messagesCollectionFactory;
+
+    /** @var MessageRepository */
+    private $messageRepository;
+
+    // phpcs:ignore
+    public function __construct(
+        MessagesCollectionFactory $messagesCollectionFactory,
+        MessageRepository $messageRepository
+    ) {
+        $this->messagesCollectionFactory = $messagesCollectionFactory;
+        $this->messageRepository = $messageRepository;
+    }
+
+    /**
+     * Clear the queue jobs
+     *
+     * @return int Amount of messages cleared
+     */
+    public function execute(): int
+    {
+        $messageCleanerIterator = $this->iterator();
+        foreach ($messageCleanerIterator as $clearedMessage) {
+            // iterator is cleaning the queue
+        }
+
+        return $messageCleanerIterator->getReturn();
+    }
+
+    /**
+     * Clear the queue jobs
+     *
+     * @return \Generator
+     */
+    public function iterator(): \Generator
+    {
+        $messages = $this->messagesCollectionFactory->create();
+        $total = $messages->getSize();
+
+        foreach ($messages as $message) {
+            $this->messageRepository->delete($message);
+            yield $message;
+        }
+
+        return $total;
+    }
+
+    /**
+     * Get the total amount of messages in the queue
+     *
+     * @return int
+     */
+    public function getTotal() : int
+    {
+        return $this->messagesCollectionFactory->create()->getSize();
+    }
+}

Console/Command/Clear.php

@@ -4,8 +4,7 @@
 namespace Discorgento\Queue\Console\Command;
 
 use Discorgento\Core\Helper\Data as CoreHelper;
-use Discorgento\Queue\Model\MessageRepository;
-use Discorgento\Queue\Model\ResourceModel\Message\CollectionFactory as MessagesCollectionFactory;
+use Discorgento\Queue\Command\ClearCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\ProgressBarFactory;
 use Symfony\Component\Console\Input\InputInterface;
@@ -14,35 +13,31 @@
 
 class Clear extends Command
 {
+    /** @var ClearCommand */
+    private $clearCommand;
+
     /** @var ConfirmationQuestionFactory */
     private $confirmationQuestionFactory;
 
     /** @var CoreHelper */
     private $coreHelper;
 
-    /** @var MessagesCollectionFactory */
-    private $messagesCollectionFactory;
-
-    /** @var MessageRepository */
-    private $messageRepository;
-
     /** @var ProgressBarFactory */
     private $progressBarFactory;
 
     // phpcs:ignore
     public function __construct(
+        ClearCommand $clearCommand,
         ConfirmationQuestionFactory $confirmationQuestionFactory,
         CoreHelper $coreHelper,
-        MessagesCollectionFactory $messagesCollectionFactory,
-        MessageRepository $messageRepository,
         ProgressBarFactory $progressBarFactory,
         string $name = null
     ) {
         parent::__construct($name);
+
+        $this->clearCommand = $clearCommand;
         $this->confirmationQuestionFactory = $confirmationQuestionFactory;
         $this->coreHelper = $coreHelper;
-        $this->messagesCollectionFactory = $messagesCollectionFactory;
-        $this->messageRepository = $messageRepository;
         $this->progressBarFactory = $progressBarFactory;
     }
 
@@ -62,10 +57,8 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $messages = $this->messagesCollectionFactory->create();
-
-        $totalMessages = $messages->getSize();
-        if ($totalMessages < 1) {
+        $total = $this->clearCommand->getTotal();
+        if ($total < 1) {
             $output->writeln("<error>There's no pending jobs.</error>");
 
             return 0;
@@ -87,11 +80,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         $progressBar = $this->progressBarFactory->create([
             'output' => $output,
-            'max' => $totalMessages,
+            'max' => $total,
         ]);
 
-        foreach ($messages as $message) {
-            $this->messageRepository->delete($message);
+        foreach ($this->clearCommand->iterator() as $clearedMessage) {
             $progressBar->advance();
         }
 

Model/Message.php

@@ -4,16 +4,11 @@
 namespace Discorgento\Queue\Model;
 
 use Discorgento\Queue\Api\Data\MessageInterface;
-use Discorgento\Queue\Model\ResourceModel\Message as MessageResourceModel;
-use Magento\Framework\DataObject\IdentityInterface;
 use Magento\Framework\Model\AbstractModel;
+use Magento\Framework\Serialize\SerializerInterface;
 
-class Message extends AbstractModel implements MessageInterface, IdentityInterface
+class Message extends AbstractModel implements MessageInterface
 {
-    public const CACHE_TAG = 'discorgento_queue';
-
-    public const STATUS_PENDING = 'pending';
-
     /** @var SerializerInterface */
     private $serializer;
 
@@ -30,36 +25,66 @@ public function __construct(
         $this->serializer = $serializer;
     }
 
-    public const STATUS_PROCESSING = 'processing';
+    /**
+     * @inheritDoc
+     */
+    public function getGroup()
+    {
+        return $this->getData(self::FIELD_GROUP) ?: self::DEFAULT_GROUP;
+    }
 
-    public const STATUS_SUCCESS = 'success';
+    /**
+     * @inheritDoc
+     */
+    public function setGroup($group): self
+    {
+        return $this->setData(self::FIELD_GROUP, $group);
+    }
 
-    public const STATUS_ERROR = 'error';
+    /**
+     * @inheritDoc
+     */
+    public function getJob()
+    {
+        return $this->getData(self::FIELD_JOB);
+    }
 
-    /** @inheritDoc */
-    protected function _construct()
+    /**
+     * @inheritDoc
+     */
+    public function setJob($job): self
     {
-        $this->_init(MessageResourceModel::class);
+        return $this->setData(self::FIELD_JOB, $job);
     }
 
-    /** @inheritDoc */
-    public function getIdentities()
+    /**
+     * @inheritDoc
+     */
+    public function getTarget()
+    {
+        return $this->getData(self::FIELD_TARGET);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function setTarget($target): self
     {
-        return [self::CACHE_TAG . "_{$this->getId()}"];
+        return $this->setData(self::FIELD_TARGET, $target);
     }
 
     /** @inheritDoc */
     public function setAdditionalData($additionalData)
     {
         $encodedData = $this->serializer->serialize($additionalData ?: []);
 
-        return $this->setData('additional_data', $encodedData);
+        return $this->setData(self::FIELD_ADDITIONAL_DATA, $encodedData);
     }
 
     /** @inheritDoc */
     public function getAdditionalData()
     {
-        $encodedData = (string) $this->getData('additional_data');
+        $encodedData = (string) $this->getData(self::FIELD_ADDITIONAL_DATA);
 
         return $this->serializer->unserialize($encodedData, true) ?: [];
     }

Model/MessageManagement.php

@@ -12,6 +12,7 @@
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Filesystem\Driver\File as FileDriver;
 use Magento\Framework\ObjectManagerInterface;
+use Magento\Framework\Serialize\SerializerInterface;
 use Magento\Framework\Stdlib\DateTime\DateTime;
 use Psr\Log\LoggerInterface;
 
@@ -40,6 +41,9 @@ class MessageManagement implements MessageManagementInterface
     /** @var SearchCriteriaBuilder */
     private $searchCriteriaBuilder;
 
+    /** @var SerializerInterface */
+    private $serializer;
+
     // phpcs:ignore
     public function __construct(
         DateTime $date,
@@ -48,7 +52,8 @@ public function __construct(
         MessageRepositoryInterface $messageRepository,
         ObjectManagerInterface $objectManager,
         ScopeConfigInterface $scopeConfig,
-        SearchCriteriaBuilder $searchCriteriaBuilder
+        SearchCriteriaBuilder $searchCriteriaBuilder,
+        SerializerInterface $serializer
     ) {
         $this->date = $date;
         $this->fileDriver = $fileDriver;
@@ -57,6 +62,7 @@ public function __construct(
         $this->objectManager = $objectManager;
         $this->scopeConfig = $scopeConfig;
         $this->searchCriteriaBuilder = $searchCriteriaBuilder;
+        $this->serializer = $serializer;
     }
 
     /** @inheritDoc */
@@ -77,7 +83,7 @@ public function process(MessageInterface $message)
             );
 
             if (is_array($result)) {
-                $result = json_encode($result, JSON_PRETTY_PRINT);
+                $result = $this->serializer->serialize($result);
             }
 
             $status = Message::STATUS_SUCCESS;