[upd] Обновление из master ветки и небольшие улучшения и исправления

Author: popkovkirill

README.md

@@ -156,42 +156,20 @@ You can use any of the constants defined by the pcntl extension https://www.php.
 
 Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
 
-## Consumer testing
+## Consumer faking
 
 Testing tools have been added to test the developed handlers. You can create a fake 
 Consumer and call the topic listening command:
 
 ```php
 use Ensi\LaravelPhpRdKafkaConsumer\Commands\KafkaConsumeCommand;
-use Ensi\LaravelPhpRdKafkaConsumer\Tests\KafkaManagerFaker;
+use Ensi\LaravelPhpRdKafkaConsumer\Tests\ConsumerFaker;
 use RdKafka\Message;
 
-test('test consume apache kafka', function () {
-    KafkaManagerFaker::new('test-model')
-        ->addMessage(new Message())
-        ->bind();
-    
-    artisan(KafkaConsumeCommand::class, ['topic-key' => 'test-model'])
-        ->assertOk();
-});
-```
-
-or
-
-```php
-use Ensi\LaravelPhpRdKafkaConsumer\Consumers\Factories\ConsumerFactory;
-use Ensi\LaravelPhpRdKafkaConsumer\Tests\KafkaManagerFaker;
-use RdKafka\Message;
-
-test('test consume apache kafka', function () {
-    KafkaManagerFaker::new('test-model')
-        ->addMessage(new Message())
-        ->bind();
-    
-    resovle(ConsumerFactory::class)
-        ->build('test-model')
-        ->listen();
-});
+ConsumerFaker::new('test-model')
+    ->addMessage(new Message())
+    ->addMessage(new Message())
+    ->consume();
 ```
 
 ## Testing

src/Commands/KafkaConsumeCommand.php

@@ -86,7 +86,7 @@ public function handle(ConsumerFactory $consumerFactory): int
             $this->consumer = $consumerFactory
                 ->build($this->getTopicKey(), $this->getConsumer());
 
-            $this->info("Start listening to topic: \"{$this->getTopicKey()}\"".
+            $this->info("Start listening to topic: \"{$this->getTopicKey()}\"" .
                 " ({$this->consumer->getTopicName()}), consumer \"{$this->getConsumer()}\"");
 
             $this->consumer
@@ -117,8 +117,8 @@ private function errorThrowable(Throwable $exception): void
             return;
         }
 
-        $this->error('An error occurred while listening to the topic: '.
-            $exception->getMessage(). ' '. $exception->getFile() . '::' . $exception->getLine());
+        $this->error('An error occurred while listening to the topic: ' .
+            $exception->getMessage() . ' ' . $exception->getFile() . '::' . $exception->getLine());
     }
 
     private function makeLogger(): ConsumerLoggerInterface

src/Consumers/Factories/ConsumerFactory.php

@@ -52,7 +52,7 @@ protected function makeProcessorData(string $topicKey, string $consumer): Proces
         }
 
         if (!$processorData->hasValidType()) {
-            throw new KafkaConsumerProcessorException("Invalid processor type \"$processorData->type\",".
+            throw new KafkaConsumerProcessorException("Invalid processor type \"$processorData->type\"," .
                 " supported types are: " . implode(',', $processorData->getSupportedTypes()));
         }
 
@@ -89,7 +89,7 @@ class: $processor['class'],
 
     protected function makeConsumerOptions(string $consumer, ProcessorData $processorData): ConsumerOptions
     {
-        $consumerPackageOptions = config('kafka-consumer.consumer_options.'. $consumer, []);
+        $consumerPackageOptions = config('kafka-consumer.consumer_options.' . $consumer, []);
 
         return new ConsumerOptions(
             consumeTimeout: $consumerPackageOptions['consume_timeout'] ?? $processorData->consumeTimeout,

src/Exceptions/KafkaConsumerProcessorException.php

@@ -4,5 +4,4 @@
 
 final class KafkaConsumerProcessorException extends KafkaConsumerException
 {
-
 }

src/Tests/Consumer/KafkaConsumer.php

@@ -4,6 +4,7 @@
 
 use Ensi\LaravelPhpRdKafkaConsumer\Exceptions\KafkaConsumerMessagedEndedException;
 use Ensi\LaravelPhpRdKafkaConsumer\Tests\Consumer\Topics\Metadata;
+use Ensi\LaravelPhpRdKafkaConsumer\Tests\Consumer\Topics\Topic;
 use RdKafka\Conf;
 use RdKafka\KafkaConsumer as BaseKafkaConsumer;
 use RdKafka\TopicConf;
@@ -39,19 +40,34 @@ public function consume($timeout_ms)
         return array_shift($this->messages);
     }
 
-    public function getMetadata($all_topics, $only_topic, $timeout_ms): Metadata
+    /**
+     * @param $all_topics
+     * @param $only_topic
+     * @param $timeout_ms
+     * @return Metadata
+     *
+     * @phpstan-ignore-next-line
+     */
+    public function getMetadata($all_topics, $only_topic = null, $timeout_ms): Metadata
     {
         return $this->metadata;
     }
 
-    public function getCommittedOffsets($topicPartitions, $timeout_ms): array
+    public function getCommittedOffsets($topic_partitions, $timeout_ms): array
     {
-        return $topicPartitions;
+        return $topic_partitions;
     }
 
-    public function newTopic($topic_name, TopicConf $topic_conf = null)
+    /**
+     * @param $topic_name
+     * @param TopicConf|null $topic_conf
+     * @return Topic
+     *
+     * @phpstan-ignore-next-line
+     */
+    public function newTopic($topic_name, $topic_conf = null): Topic
     {
-
+        return new Topic($topic_name);
     }
 
     public function commitAsync($message_or_offsets = null)

src/Tests/ConsumerFaker.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace Ensi\LaravelPhpRdKafkaConsumer\Tests;
+
+use Ensi\LaravelPhpRdKafka\KafkaFacade;
+use Ensi\LaravelPhpRdKafka\KafkaManager as BaseKafkaManager;
+use Ensi\LaravelPhpRdKafkaConsumer\Consumers\Factories\ConsumerFactory;
+use Ensi\LaravelPhpRdKafkaConsumer\Exceptions\KafkaConsumerProcessorException;
+use Ensi\LaravelPhpRdKafkaConsumer\HighLevelConsumer;
+use Ensi\LaravelPhpRdKafkaConsumer\Tests\Consumer\KafkaConsumer;
+use Ensi\LaravelPhpRdKafkaConsumer\Tests\Exceptions\OnlyTestingEnvironmentException;
+use RdKafka\Message;
+use Throwable;
+
+class ConsumerFaker
+{
+    protected array $messages = [];
+
+    protected string $topicName;
+
+    public function __construct(
+        protected string $topicKey,
+        protected string $consumer = 'default'
+    ) {
+        $this->topicName = KafkaFacade::topicNameByClient('consumer', $consumer, $topicKey);
+    }
+
+    public function addMessage(Message $message): self
+    {
+        $message->err = RD_KAFKA_RESP_ERR_NO_ERROR;
+
+        return $this->addMessageRaw($message);
+    }
+
+    public function addMessageRaw(Message $message): self
+    {
+        $this->messages[] = $message;
+
+        return $this;
+    }
+
+    /**
+     * @return void
+     *
+     * @throws KafkaConsumerProcessorException
+     * @throws Throwable
+     */
+    public function consume(): void
+    {
+        $this->bind();
+
+        (new ConsumerFactory(resolve(HighLevelConsumer::class)))
+            ->build($this->topicKey, $this->consumer)
+            ->listen();
+    }
+
+    public function bind(): void
+    {
+        if (!app()->runningUnitTests()) {
+            throw new OnlyTestingEnvironmentException('Следует использовать только в тестировании');
+        }
+
+        app()->scoped(
+            BaseKafkaManager::class,
+            fn () => $this->makeKafkaManager()
+        );
+    }
+
+    private function makeKafkaManager(): KafkaManager
+    {
+        return new KafkaManager(new KafkaConsumer($this->topicName, $this->messages));
+    }
+
+    public static function new(string $topicKey, string $consumer = 'default'): self
+    {
+        return new self($topicKey, $consumer);
+    }
+}

src/Tests/Exceptions/OnlyTestingEnvironmentException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Ensi\LaravelPhpRdKafkaConsumer\Tests\Exceptions;
+
+use LogicException;
+
+final class OnlyTestingEnvironmentException extends LogicException
+{
+}

src/Tests/KafkaManagerFaker.php

@@ -1,16 +1,17 @@
 <?php
 
 use Ensi\LaravelPhpRdKafkaConsumer\Commands\KafkaConsumeCommand;
-use Ensi\LaravelPhpRdKafkaConsumer\Tests\KafkaManagerFaker;
+use Ensi\LaravelPhpRdKafkaConsumer\Tests\ConsumerFaker;
 use Ensi\LaravelPhpRdKafkaConsumer\Tests\TestConsumer;
+
 use function Pest\Laravel\artisan;
 
 use RdKafka\Message;
 
 test('consume command test', function () {
     TestConsumer::fake('test-model');
 
-    KafkaManagerFaker::new('test-model')
+    ConsumerFaker::new('test-model')
         ->addMessage($message = new Message())
         ->bind();
 

tests/Commands/KafkaConsumerCommandTest.php

@@ -0,0 +1,15 @@
+<?php
+
+use Ensi\LaravelPhpRdKafkaConsumer\Tests\ConsumerFaker;
+use Ensi\LaravelPhpRdKafkaConsumer\Tests\TestConsumer;
+use RdKafka\Message;
+
+test('create and consume kafka manager fake', function () {
+    TestConsumer::fake('test-model');
+
+    ConsumerFaker::new('test-model')
+        ->addMessage($message = new Message())
+        ->consume();
+
+    TestConsumer::assertMessageConsumed($message);
+});