dk.cloudcreate.essentials.components.foundation.test.reactive.command.AbstractDurableLocalCommandBusIT Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of foundation-test Show documentation
This library focuses purely on providing test templates for the foundational patterns defined in the foundation module which can be used by other modules to test their implementation
The newest version!
/*
 * Copyright 2021-2024 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package dk.cloudcreate.essentials.components.foundation.test.reactive.command;

import dk.cloudcreate.essentials.components.foundation.messaging.RedeliveryPolicy;
import dk.cloudcreate.essentials.components.foundation.messaging.queue.*;
import dk.cloudcreate.essentials.components.foundation.reactive.command.DurableLocalCommandBus;
import dk.cloudcreate.essentials.components.foundation.transaction.*;
import dk.cloudcreate.essentials.reactive.command.*;
import dk.cloudcreate.essentials.shared.Exceptions;
import dk.cloudcreate.essentials.shared.collections.Lists;
import org.awaitility.Awaitility;
import org.junit.jupiter.api.*;
import org.slf4j.*;

import java.time.Duration;

import static org.assertj.core.api.Assertions.*;

public abstract class AbstractDurableLocalCommandBusIT> {
    public static final String ON_PURPOSE = "On purpose";

    protected UOW_FACTORY    unitOfWorkFactory;
    protected DURABLE_QUEUES durableQueues;

    protected DurableLocalCommandBus commandBus;

    protected TestSendAndDontWaitErrorHandler errorHandler;

    @BeforeEach
    void setup() {
        unitOfWorkFactory = createUnitOfWorkFactory();
        durableQueues = createDurableQueues(unitOfWorkFactory);
        durableQueues.start();

        errorHandler = new TestSendAndDontWaitErrorHandler();
        commandBus = DurableLocalCommandBus.builder()
                                           .setDurableQueues(durableQueues)
                                           .setSendAndDontWaitErrorHandler(errorHandler)
                                           .setCommandQueueName(DurableLocalCommandBus.DEFAULT_COMMAND_QUEUE_NAME)
                                           .setCommandQueueRedeliveryPolicy(RedeliveryPolicy.fixedBackoff(Duration.ofMillis(100), 1))
                .build();
        commandBus.start();
    }

    @AfterEach
    void cleanup() {
        if (commandBus != null) {
            commandBus.stop();
        }
        if (durableQueues != null) {
            durableQueues.stop();
        }
    }

    protected abstract DURABLE_QUEUES createDurableQueues(UOW_FACTORY unitOfWorkFactory);

    protected abstract UOW_FACTORY createUnitOfWorkFactory();

    @Test
    void test_sync_send() {
        // Given
        var cmdHandler = new TestCommandHandler(String.class);
        commandBus.addCommandHandler(cmdHandler);

        // When
        var result = commandBus.send("Hello World");

        // Then
        assertThat(result).isEqualTo(TestCommandHandler.TEST);
        assertThat(cmdHandler.receivedCommand).isEqualTo("Hello World");
    }

    @Test
    void test_sync_send_with_command_processing_exception() {
        // Given
        var cmdHandler = new ExceptionThrowingCommandHandler();
        commandBus.addCommandHandler(cmdHandler);

        // When
        assertThatThrownBy(() -> commandBus.send("Hello World"))
                .isInstanceOf(RuntimeException.class)
                .hasMessage(ON_PURPOSE);
    }

    @Test
    void test_async_send() {
        // Given
        var cmdHandler = new TestCommandHandler(String.class);
        commandBus.addCommandHandler(cmdHandler);

        // When
        var result = commandBus.sendAsync("Hello World")
                               .block(Duration.ofMillis(1000));

        // Then
        assertThat(result).isEqualTo(TestCommandHandler.TEST);
        assertThat(cmdHandler.receivedCommand).isEqualTo("Hello World");
    }

    @Test
    void test_sendAndDontWait_with_managed_transaction() {
        // Given
        var cmdHandler = new TestCommandHandler(String.class);
        commandBus.addCommandHandler(cmdHandler);

        //
        unitOfWorkFactory.usingUnitOfWork(() -> commandBus.sendAndDontWait("Hello World"));

        // Then
        Awaitility.waitAtMost(Duration.ofMillis(500))
                  .untilAsserted(() -> assertThat(cmdHandler.receivedCommand).isEqualTo("Hello World"));
    }

    @Test
    void test_sendAndDontWait() {
        // Given
        var cmdHandler = new TestCommandHandler(String.class);
        commandBus.addCommandHandler(cmdHandler);

        //
        commandBus.sendAndDontWait("Hello World");

        // Then
        Awaitility.waitAtMost(Duration.ofMillis(2000))
                  .untilAsserted(() -> assertThat(cmdHandler.receivedCommand).isEqualTo("Hello World"));
    }

    @Test
    void test_sendAndDontWait_with_managed_transaction_and_with_error() {
        // Given
        var cmdHandler = new ExceptionThrowingCommandHandler();
        commandBus.addCommandHandler(cmdHandler);
        var command = "Hello World";
        var errorQueueSizePrior = durableQueues.getDeadLetterMessages(commandBus.getCommandQueueName(),
                                                                      DurableQueues.QueueingSortOrder.ASC,
                                                                      0,
                                                                      10).size();

        // When
        commandBus.sendAndDontWait(command);

        // Then
        Awaitility.waitAtMost(Duration.ofMillis(500))
                  .untilAsserted(() -> assertThat(errorHandler.exception).isNotNull());
        assertThat(errorHandler.exception).isInstanceOf(RuntimeException.class);
        assertThat(errorHandler.exception).hasMessage(ON_PURPOSE);
        assertThat(errorHandler.command.getPayload()).isEqualTo(command);
        assertThat(errorHandler.commandHandler).isEqualTo(cmdHandler);

        Awaitility.waitAtMost(Duration.ofMillis(1000))
                  .untilAsserted(() -> assertThat(durableQueues.getDeadLetterMessages(commandBus.getCommandQueueName(),
                                                                                      DurableQueues.QueueingSortOrder.ASC,
                                                                                      0,
                                                                                      10)).hasSize(errorQueueSizePrior + 1));
        assertThat(Lists.last(durableQueues.getDeadLetterMessages(commandBus.getCommandQueueName(),
                                                                  DurableQueues.QueueingSortOrder.ASC,
                                                                  0,
                                                                  10)).get().getMessage().getPayload()).isEqualTo(command);
    }

    @Test
    void test_sendAndDontWait_with_error() {
        // Given
        var cmdHandler = new ExceptionThrowingCommandHandler();
        commandBus.addCommandHandler(cmdHandler);
        var command = "Hello World";
        var errorQueueSizePrior = durableQueues.getDeadLetterMessages(commandBus.getCommandQueueName(),
                                                                      DurableQueues.QueueingSortOrder.ASC,
                                                                      0,
                                                                      10).size();

        // When
        unitOfWorkFactory.usingUnitOfWork(() -> commandBus.sendAndDontWait(command));

        // Then
        Awaitility.waitAtMost(Duration.ofMillis(500))
                  .untilAsserted(() -> assertThat(errorHandler.exception).isNotNull());
        assertThat(errorHandler.exception).isInstanceOf(RuntimeException.class);
        assertThat(errorHandler.exception).hasMessage(ON_PURPOSE);
        assertThat(errorHandler.command.getPayload()).isEqualTo(command);
        assertThat(errorHandler.commandHandler).isEqualTo(cmdHandler);

        Awaitility.waitAtMost(Duration.ofMillis(1000))
                  .untilAsserted(() -> assertThat(durableQueues.getDeadLetterMessages(commandBus.getCommandQueueName(),
                                                                                      DurableQueues.QueueingSortOrder.ASC,
                                                                                      0,
                                                                                      10)).hasSize(errorQueueSizePrior + 1));
        assertThat(Lists.last(durableQueues.getDeadLetterMessages(commandBus.getCommandQueueName(),
                                                                  DurableQueues.QueueingSortOrder.ASC,
                                                                  0,
                                                                  10)).get().getMessage().getPayload()).isEqualTo(command);
    }

    @Test
    void test_sendAndDontWait_with_delay() {
        // Given
        var cmdHandler = new TestCommandHandler(String.class);
        commandBus.addCommandHandler(cmdHandler);

        // When
        unitOfWorkFactory.usingUnitOfWork(() -> commandBus.sendAndDontWait("Hello World",
                                                                           Duration.ofMillis(1000)));

        // Then
        Awaitility.await()
                  .atLeast(Duration.ofMillis(500))
                  .untilAsserted(() -> assertThat(cmdHandler.receivedCommand).isNotNull());
        Awaitility.waitAtMost(Duration.ofMillis(600))
                  .untilAsserted(() -> assertThat(cmdHandler.receivedCommand).isEqualTo("Hello World"));
    }

    @Test
    void test_sendAndDontWait_with_delay_and_error() {
        // Given
        var cmdHandler = new ExceptionThrowingCommandHandler();
        commandBus.addCommandHandler(cmdHandler);

        var command = "Hello World with delay";
        var errorQueueSizePrior = durableQueues.getDeadLetterMessages(commandBus.getCommandQueueName(),
                                                                      DurableQueues.QueueingSortOrder.ASC,
                                                                      0,
                                                                      10).size();

        // When
        unitOfWorkFactory.usingUnitOfWork(() -> commandBus.sendAndDontWait(command,
                                                                           Duration.ofMillis(1000)));

        // Then
        Awaitility.await()
                  .atLeast(Duration.ofMillis(500))
                  .untilAsserted(() -> assertThat(errorHandler.exception).isNotNull());
        Awaitility.waitAtMost(Duration.ofMillis(600))
                  .untilAsserted(() -> assertThat(errorHandler.exception).isNotNull());
        assertThat(errorHandler.exception).isInstanceOf(RuntimeException.class);
        assertThat(errorHandler.exception).hasMessage(ON_PURPOSE);
        assertThat(errorHandler.command.getPayload()).isEqualTo(command);
        assertThat(errorHandler.commandHandler).isEqualTo(cmdHandler);
        Awaitility.waitAtMost(Duration.ofMillis(1000))
                  .untilAsserted(() -> assertThat(durableQueues.getDeadLetterMessages(commandBus.getCommandQueueName(),
                                                                                      DurableQueues.QueueingSortOrder.ASC,
                                                                                      0,
                                                                                      10)).hasSize(errorQueueSizePrior + 1));
        assertThat(Lists.last(durableQueues.getDeadLetterMessages(commandBus.getCommandQueueName(),
                                                                  DurableQueues.QueueingSortOrder.ASC,
                                                                  0,
                                                                  10)).get().getMessage().getPayload()).isEqualTo(command);
    }

    @Test
    void test_async_send_with_command_processing_exception() {
        // Given
        var cmdHandler = new ExceptionThrowingCommandHandler();
        commandBus.addCommandHandler(cmdHandler);

        // When
        assertThatThrownBy(() -> commandBus.sendAsync("Hello World")
                                           .block(Duration.ofMillis(1000)))
                .isInstanceOf(RuntimeException.class)
                .hasMessage(ON_PURPOSE);
    }

    @Test
    void test_no_matching_command_handler() {
        var longCmdHandler = new TestCommandHandler(Long.class);
        commandBus.addCommandHandler(longCmdHandler);

        assertThatThrownBy(() -> commandBus.send("Hello World"))
                .isInstanceOf(NoCommandHandlerFoundException.class);
    }

    @Test
    void test_multiple_matching_command_handlers() {
        var longCmdHandler = new TestCommandHandler(Long.class);
        commandBus.addCommandHandler(longCmdHandler);
        var longCmd2Handler = new TestCommandHandler(Long.class);
        commandBus.addCommandHandler(longCmd2Handler);

        assertThatThrownBy(() -> commandBus.send(10L))
                .isInstanceOf(MultipleCommandHandlersFoundException.class);
    }

    private static class TestCommandHandler implements CommandHandler {
        private static      Logger   log  = LoggerFactory.getLogger(TestCommandHandler.class);
        public static final String   TEST = "test";
        private final       Class canHandleCommandsOfType;
        private             Object   receivedCommand;

        private TestCommandHandler(Class canHandleCommandsOfType) {
            this.canHandleCommandsOfType = canHandleCommandsOfType;
        }


        @Override
        public boolean canHandle(Class commandType) {
            return canHandleCommandsOfType.isAssignableFrom(commandType);
        }

        @Override
        public Object handle(Object command) {
            log.info("Received command: {}", command);
            receivedCommand = command;
            return TEST;
        }
    }

    private static class ExceptionThrowingCommandHandler implements CommandHandler {
        private static Logger log = LoggerFactory.getLogger(ExceptionThrowingCommandHandler.class);

        @Override
        public boolean canHandle(Class commandType) {
            return true;
        }

        @Override
        public Object handle(Object command) {
            log.info("Received command '{}', will now throw a RuntimeException", command);
            throw new RuntimeException(ON_PURPOSE);
        }
    }

    private static class TestSendAndDontWaitErrorHandler implements SendAndDontWaitErrorHandler {
        private Throwable      exception;
        private QueuedMessage  command;
        private CommandHandler commandHandler;

        @Override
        public void handleError(Throwable exception, Object command, CommandHandler commandHandler) {
            this.exception = exception;
            this.command = (QueuedMessage) command;
            this.commandHandler = commandHandler;

            // rethrow exception otherwise the command will not be retried by the Queue
            Exceptions.sneakyThrow(exception);
        }
    }
}