ldc-cocotte/tests/Unit/App/Actions/Orders/FinalizeOrderTest.php

313 lines
13 KiB
PHP

<?php
declare(strict_types=1);
use App\Attributes\Locked;
use App\Contracts\HandlesFailure;
use App\Contracts\HandlesLockTimeout;
use App\Contracts\HandlesSuccess;
use App\Contracts\ProvidesLockKey;
use App\Cqs\Actions\Orders\FinalizeOrder;
use App\Cqs\Actions\Orders\FinalizeOrderInput;
use App\Cqs\Actions\Orders\FinalizeOrderOutput;
use App\Enums\FinalizeOrderStatus;
use Domain\Builders\OrderBuilderCompleted;
use Domain\Enums\OrderStatus;
use Domain\Exceptions\OrderTunnel\ExpiredPickupTimeSlotException;
use Domain\Exceptions\OrderTunnel\OrderLimitExceededException;
use Domain\Exceptions\OrderTunnel\RegateExportFailedException;
use Domain\Exceptions\OrderTunnel\UnorderableProductException;
use Domain\Exceptions\OrderTunnel\WeeklyLimitExceededException;
use Domain\Models\Entities\Order;
use Domain\Models\ValueObjects\DeliveryAddress;
use Domain\Models\ValueObjects\Entities\OrderId;
use Domain\Models\ValueObjects\Entities\ShopId;
use Domain\Models\ValueObjects\Entities\ShopperId;
use Domain\Models\ValueObjects\Matricule;
use Domain\Models\ValueObjects\OrderEmployee;
use Domain\Models\ValueObjects\OrderReference;
use Domain\Models\ValueObjects\PickupTimeSlot;
use Domain\Models\ValueObjects\ShopperEstablishmentCode;
use Domain\Models\ValueObjects\ShopperServiceCode;
use Domain\Models\ValueObjects\ShopperSiteCode;
use Domain\Services\OrderTunnelService;
use Money\Money;
use Ramsey\Uuid\Uuid;
describe('FinalizeOrder', function (): void {
it('finalizes order and returns reference via OrderTunnelService', function (): void {
// GIVEN
$input = new FinalizeOrderInput();
$orderReference = new OrderReference(Uuid::uuid7());
$builder = \Mockery::mock(OrderBuilderCompleted::class);
$order = new Order(
id: new OrderId(Uuid::uuid7()),
shopId: new ShopId(Uuid::uuid7()),
reference: $orderReference,
employee: new OrderEmployee(
matricule: new Matricule('1234567'),
firstname: 'Jean',
lastname: 'Dupont',
facility: new ShopperEstablishmentCode('ETAB01'),
site: new ShopperSiteCode('SITEA'),
service: new ShopperServiceCode('101'),
),
deliveryAddress: new DeliveryAddress(
name: 'Shop',
address: '1 rue Test',
postcode: '75001',
city: 'Paris',
),
pickupTimeSlot: new PickupTimeSlot(now(), new \DateInterval('PT1H')),
status: OrderStatus::WAITING,
total: Money::EUR(1000),
lines: [],
);
$orderTunnelService = \Mockery::mock(OrderTunnelService::class);
$orderTunnelService->shouldReceive('getBuilderCompletedOrFail')
->once()
->andReturn($builder);
$orderTunnelService->shouldReceive('finalizeOrder')
->once()
->with($builder)
->andReturn($order);
$action = new FinalizeOrder($orderTunnelService);
// WHEN
$result = $action($input);
// THEN
expect($result)->toBeInstanceOf(FinalizeOrderOutput::class)
->and($result->status)->toBe(FinalizeOrderStatus::SUCCESS)
->and($result->orderReference)->not->toBeNull()
->and($result->orderReference?->value)->toBe($orderReference->value);
});
it('returns expiredTimeSlot output when finalizeOrder throws ExpiredPickupTimeSlotException', function (): void {
// GIVEN
$input = new FinalizeOrderInput();
$builder = \Mockery::mock(OrderBuilderCompleted::class);
$orderTunnelService = \Mockery::mock(OrderTunnelService::class);
$orderTunnelService->shouldReceive('getBuilderCompletedOrFail')->once()->andReturn($builder);
$orderTunnelService->shouldReceive('finalizeOrder')
->once()
->with($builder)
->andThrow(new ExpiredPickupTimeSlotException('Invalid or unavailable time slot'));
$action = new FinalizeOrder($orderTunnelService);
// WHEN
$result = $action($input);
// THEN
expect($action)->not->toBeInstanceOf(HandlesFailure::class)
->and($result)->toBeInstanceOf(FinalizeOrderOutput::class)
->and($result->status)->toBe(FinalizeOrderStatus::EXPIRED_TIME_SLOT)
->and($result->orderReference)->toBeNull()
->and($result->errorMessage)->toBe('Invalid or unavailable time slot');
});
it('returns unorderableProduct output when finalizeOrder throws UnorderableProductException', function (): void {
// GIVEN
$input = new FinalizeOrderInput();
$builder = \Mockery::mock(OrderBuilderCompleted::class);
$orderTunnelService = \Mockery::mock(OrderTunnelService::class);
$orderTunnelService->shouldReceive('getBuilderCompletedOrFail')->once()->andReturn($builder);
$orderTunnelService->shouldReceive('finalizeOrder')
->once()
->with($builder)
->andThrow(new UnorderableProductException('One or more products in your basket are no longer available for order.'));
$action = new FinalizeOrder($orderTunnelService);
// WHEN
$result = $action($input);
// THEN
expect($result)->toBeInstanceOf(FinalizeOrderOutput::class)
->and($result->status)->toBe(FinalizeOrderStatus::UNORDERABLE_PRODUCT)
->and($result->orderReference)->toBeNull()
->and($result->errorMessage)->toBe('One or more products in your basket are no longer available for order.');
});
it('returns orderLimitExceeded output when finalizeOrder throws OrderLimitExceededException', function (): void {
// GIVEN
$input = new FinalizeOrderInput();
$builder = \Mockery::mock(OrderBuilderCompleted::class);
$orderTunnelService = \Mockery::mock(OrderTunnelService::class);
$orderTunnelService->shouldReceive('getBuilderCompletedOrFail')->once()->andReturn($builder);
$orderTunnelService->shouldReceive('finalizeOrder')
->once()
->with($builder)
->andThrow(new OrderLimitExceededException());
$action = new FinalizeOrder($orderTunnelService);
// WHEN
$result = $action($input);
// THEN
expect($result)->toBeInstanceOf(FinalizeOrderOutput::class)
->and($result->status)->toBe(FinalizeOrderStatus::ORDER_LIMIT_EXCEEDED)
->and($result->orderReference)->toBeNull()
->and($result->errorMessage)->toBe('The total amount of this order has been exceeded. Please modify it to validate.');
});
it('returns weeklyLimitExceeded output when finalizeOrder throws WeeklyLimitExceededException', function (): void {
// GIVEN
$input = new FinalizeOrderInput();
$builder = \Mockery::mock(OrderBuilderCompleted::class);
$orderTunnelService = \Mockery::mock(OrderTunnelService::class);
$orderTunnelService->shouldReceive('getBuilderCompletedOrFail')->once()->andReturn($builder);
$orderTunnelService->shouldReceive('finalizeOrder')
->once()
->with($builder)
->andThrow(new WeeklyLimitExceededException());
$action = new FinalizeOrder($orderTunnelService);
// WHEN
$result = $action($input);
// THEN
expect($result)->toBeInstanceOf(FinalizeOrderOutput::class)
->and($result->status)->toBe(FinalizeOrderStatus::WEEKLY_LIMIT_EXCEEDED)
->and($result->orderReference)->toBeNull()
->and($result->errorMessage)->toBe('The total amount for this delivery date has been exceeded. Please modify it to validate.');
});
it('propagates RegateExportFailedException so ActionExecutorService rolls back the transaction', function (): void {
// GIVEN
$input = new FinalizeOrderInput();
$builder = \Mockery::mock(OrderBuilderCompleted::class);
$orderTunnelService = \Mockery::mock(OrderTunnelService::class);
$orderTunnelService->shouldReceive('getBuilderCompletedOrFail')->once()->andReturn($builder);
$orderTunnelService->shouldReceive('finalizeOrder')
->once()
->with($builder)
->andThrow(new RegateExportFailedException('SMTP transport error'));
$action = new FinalizeOrder($orderTunnelService);
// WHEN
expect(fn () => $action($input))
// THEN
->toThrow(RegateExportFailedException::class, 'SMTP transport error');
});
it('has Locked attribute with expected TTL and wait seconds and implements lock contracts', function (): void {
// GIVEN
$orderTunnelService = \Mockery::mock(OrderTunnelService::class);
$action = new FinalizeOrder($orderTunnelService);
$reflection = new \ReflectionClass(FinalizeOrder::class);
$attributes = $reflection->getAttributes(Locked::class);
// WHEN
$locked = ($attributes[0] ?? null)?->newInstance();
// THEN
expect($locked)->toBeInstanceOf(Locked::class)
->and($locked->ttlSeconds)->toBe(30)
->and($locked->waitSeconds)->toBe(10)
->and($locked->key)->toBeNull()
->and($action)->toBeInstanceOf(ProvidesLockKey::class)
->and($action)->toBeInstanceOf(HandlesLockTimeout::class);
});
it('builds lockKey from input shopperId when provided', function (): void {
// GIVEN
$shopperId = new ShopperId(Uuid::uuid7());
$input = new FinalizeOrderInput(shopperId: $shopperId);
$orderTunnelService = \Mockery::mock(OrderTunnelService::class);
$orderTunnelService->shouldNotReceive('getBuilderCompletedOrFail');
$action = new FinalizeOrder($orderTunnelService);
// WHEN
$key = $action->lockKey($input);
// THEN
expect($key)->toBe("order:finalize:shopper:{$shopperId->value}");
});
it('builds lockKey from completed builder when input shopperId is null', function (): void {
// GIVEN
$shopperId = new ShopperId(Uuid::uuid7());
$input = new FinalizeOrderInput();
$builder = \Mockery::mock(OrderBuilderCompleted::class);
$builder->shouldReceive('getShopperId')
->once()
->andReturn($shopperId);
$orderTunnelService = \Mockery::mock(OrderTunnelService::class);
$orderTunnelService->shouldReceive('getBuilderCompletedOrFail')
->once()
->andReturn($builder);
$action = new FinalizeOrder($orderTunnelService);
// WHEN
$key = $action->lockKey($input);
// THEN
expect($key)->toBe("order:finalize:shopper:{$shopperId->value}");
});
it('returns lockTimeout output on lock timeout', function (): void {
// GIVEN
$input = new FinalizeOrderInput();
$orderTunnelService = \Mockery::mock(OrderTunnelService::class);
$action = new FinalizeOrder($orderTunnelService);
// WHEN
$result = $action->onLockTimeout($input);
// THEN
expect($result)->toBeInstanceOf(FinalizeOrderOutput::class)
->and($result->status)->toBe(FinalizeOrderStatus::LOCK_TIMEOUT)
->and($result->orderReference)->toBeNull()
->and($result->errorMessage)->toBeNull();
});
it('implements HandlesSuccess and clears tunnel state when status is SUCCESS', function (): void {
// GIVEN
$input = new FinalizeOrderInput();
$output = FinalizeOrderOutput::success(new OrderReference(Uuid::uuid7()));
$orderTunnelService = \Mockery::mock(OrderTunnelService::class);
$orderTunnelService->shouldReceive('clearTunnelState')->once();
$action = new FinalizeOrder($orderTunnelService);
// WHEN
$action->onSuccess($input, $output);
// THEN
expect($action)->toBeInstanceOf(HandlesSuccess::class);
});
it('does not clear tunnel state in onSuccess when status is not SUCCESS', function (FinalizeOrderOutput $output): void {
// GIVEN
$input = new FinalizeOrderInput();
$orderTunnelService = \Mockery::mock(OrderTunnelService::class);
$orderTunnelService->shouldNotReceive('clearTunnelState');
$action = new FinalizeOrder($orderTunnelService);
// WHEN
$action->onSuccess($input, $output);
// THEN
expect(true)->toBeTrue();
})->with([
'lock timeout' => [FinalizeOrderOutput::lockTimeout()],
'order limit exceeded' => [FinalizeOrderOutput::orderLimitExceeded('Limit exceeded')],
'weekly limit exceeded' => [FinalizeOrderOutput::weeklyLimitExceeded('Weekly limit exceeded')],
'expired time slot' => [FinalizeOrderOutput::expiredTimeSlot('Expired')],
'unorderable product' => [FinalizeOrderOutput::unorderableProduct('Unorderable')],
]);
});