Merge pull request #387 from tempestphp/add-command-bus-tests

Adds command bus tests

Author: aidan-casey

CHANGELOG.md

@@ -5,4 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [Unreleased]
+
+### Added
+- Unit tests for the CommandBus `dispatch` method.

composer.json

@@ -99,6 +99,7 @@
     "autoload-dev": {
         "psr-4": {
             "Tempest\\Clock\\Tests\\": "src/Tempest/Clock/tests",
+            "Tempest\\CommandBus\\Tests\\": "src/Tempest/CommandBus/tests",
             "Tempest\\Container\\Tests\\": "src/Tempest/Container/tests",
             "Tempest\\Core\\Tests\\": "src/Tempest/Core/tests",
             "Tempest\\Database\\Tests\\": "src/Tempest/Database/tests",

phpunit.xml.dist

@@ -24,7 +24,7 @@
       <directory suffix=".php">src</directory>
     </include>
     <exclude>
-      <directory suffix="Test.php">src</directory>
+      <directory suffix=".php">src/Tempest/**/tests</directory>
       <directory suffix=".cache.php">src</directory>
     </exclude>
   </source>

src/Tempest/CommandBus/composer.json

@@ -13,6 +13,11 @@
             "Tempest\\CommandBus\\": "src"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Tempest\\CommandBus\\Tests\\": "tests"
+        }
+    },
     "license": "MIT",
     "minimum-stability": "dev"
 }

src/Tempest/CommandBus/tests/Fixtures/CreateUserCommand.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\CommandBus\Tests\Fixtures;
+
+final readonly class CreateUserCommand
+{
+    public function __construct(
+        public string $firstName,
+        public string $lastName,
+    ) {
+    }
+}

src/Tempest/CommandBus/tests/Fixtures/CreateUserCommandHandler.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\CommandBus\Tests\Fixtures;
+
+use Tempest\CommandBus\CommandHandler;
+
+final class CreateUserCommandHandler
+{
+    public string $firstName;
+
+    public string $lastName;
+
+    #[CommandHandler]
+    public function __invoke(CreateUserCommand $command): void
+    {
+        $this->firstName = $command->firstName;
+        $this->lastName = $command->lastName;
+    }
+}

src/Tempest/CommandBus/tests/Fixtures/DeleteUserCommand.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\CommandBus\Tests\Fixtures;
+
+final readonly class DeleteUserCommand
+{
+    public function __construct(public int $id)
+    {
+    }
+}

src/Tempest/CommandBus/tests/GenericCommandBusTest.php

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\CommandBus\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Tempest\CommandBus\CommandBus;
+use Tempest\CommandBus\CommandBusConfig;
+use Tempest\CommandBus\CommandHandler;
+use Tempest\CommandBus\CommandHandlerNotFound;
+use Tempest\CommandBus\GenericCommandBus;
+use Tempest\CommandBus\Tests\Fixtures\CreateUserCommand;
+use Tempest\CommandBus\Tests\Fixtures\CreateUserCommandHandler;
+use Tempest\CommandBus\Tests\Fixtures\DeleteUserCommand;
+use Tempest\Container\GenericContainer;
+use Tempest\Reflection\ClassReflector;
+
+/**
+ * @internal
+ * @small
+ */
+final class GenericCommandBusTest extends TestCase
+{
+    private CommandBus $commandBus;
+
+    public function test_getting_command_handler_that_exists(): void
+    {
+        $command = new CreateUserCommand('Jim', 'Halpert');
+
+        $this->commandBus->dispatch($command);
+
+        $this->assertCount(1, $this->commandBus->getHistory());
+        $this->assertSame($command, $this->commandBus->getHistory()[0]);
+    }
+
+    public function test_exception_is_thrown_when_command_handler_doesnt_exist(): void
+    {
+        $command = new DeleteUserCommand(12);
+
+        $this->expectExceptionObject(
+            new CommandHandlerNotFound($command)
+        );
+
+        $this->commandBus->dispatch($command);
+    }
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        // TODO: I'd like to make this easier to setup.
+        $config = new CommandBusConfig();
+
+        $createUserCommandHandlerClass = new ClassReflector(CreateUserCommandHandler::class);
+        $createUserCommandHandlerMethod = $createUserCommandHandlerClass->getMethod('__invoke');
+        $createUserCommandHandler = $createUserCommandHandlerMethod->getAttribute(CommandHandler::class);
+
+        $config->addHandler(
+            commandHandler: $createUserCommandHandler,
+            commandName: CreateUserCommand::class,
+            handler: $createUserCommandHandlerMethod
+        );
+
+        $this->commandBus = new GenericCommandBus(
+            container: new GenericContainer(),
+            commandBusConfig: $config
+        );
+    }
+}