All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.rxmicro.test.junit.internal.RxMicroRestBasedMicroServiceTestExtension Maven / Gradle / Ivy

There is a newer version: 0.11
Show newest version
/*
 * Copyright (c) 2020. https://rxmicro.io
 *
 * 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
 *
 *     http://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 io.rxmicro.test.junit.internal;

import io.rxmicro.cdi.BeanFactory;
import io.rxmicro.config.Config;
import io.rxmicro.rest.server.HttpServerConfig;
import io.rxmicro.rest.server.RestServerConfig;
import io.rxmicro.rest.server.local.model.ServerContainer;
import io.rxmicro.test.BlockingHttpClient;
import io.rxmicro.test.junit.RxMicroRestBasedMicroServiceTest;
import io.rxmicro.test.local.BlockingHttpClientConfig;
import io.rxmicro.test.local.InvalidTestConfigException;
import io.rxmicro.test.local.component.ConfigResolver;
import io.rxmicro.test.local.component.RestControllerInstanceResolver;
import io.rxmicro.test.local.component.builder.BlockingHttpClientBuilder;
import io.rxmicro.test.local.component.builder.ServerPortHelper;
import io.rxmicro.test.local.component.builder.TestModelBuilder;
import io.rxmicro.test.local.component.injector.BeanFactoryInjector;
import io.rxmicro.test.local.component.injector.BlockingHttpClientInjector;
import io.rxmicro.test.local.component.injector.InjectorFactory;
import io.rxmicro.test.local.component.injector.RepositoryInjector;
import io.rxmicro.test.local.component.injector.RestClientInjector;
import io.rxmicro.test.local.component.injector.RuntimeContextComponentInjector;
import io.rxmicro.test.local.component.injector.SystemOutInjector;
import io.rxmicro.test.local.component.injector.UserCreatedComponentInjector;
import io.rxmicro.test.local.component.validator.RestBasedMicroServiceTestValidator;
import io.rxmicro.test.local.model.TestModel;
import org.junit.jupiter.api.extension.AfterAllCallback;
import org.junit.jupiter.api.extension.AfterEachCallback;
import org.junit.jupiter.api.extension.BeforeAllCallback;
import org.junit.jupiter.api.extension.BeforeEachCallback;
import org.junit.jupiter.api.extension.BeforeTestExecutionCallback;
import org.junit.jupiter.api.extension.ExtensionContext;

import java.util.List;
import java.util.Map;

import static io.rxmicro.rest.server.RequestIdGeneratorType.FOR_TESTS_ONLY;
import static io.rxmicro.rest.server.local.component.RestServerLauncher.launchWithoutRestControllers;
import static io.rxmicro.runtime.local.AbstractFactory.clearFactories;
import static io.rxmicro.runtime.local.InstanceContainer.clearContainer;
import static io.rxmicro.test.HttpServers.getRandomFreePort;
import static io.rxmicro.test.junit.internal.TestObjects.SUPPORTED_TEST_ANNOTATIONS;
import static io.rxmicro.test.junit.internal.TestObjects.getOwnerTestClass;
import static io.rxmicro.test.junit.internal.TestObjects.getTestInstances;
import static io.rxmicro.test.local.UnNamedModuleFixer.restBasedMicroServiceTestsFix;
import static io.rxmicro.test.local.util.Annotations.getRequiredAnnotation;
import static io.rxmicro.test.local.util.Modules.isRequiredModule;
import static io.rxmicro.test.local.util.Safes.safeInvoke;
import static java.lang.Boolean.parseBoolean;
import static java.lang.System.getProperty;
import static java.lang.System.getenv;
import static java.util.Optional.ofNullable;

/**
 * @author nedis
 * @link https://rxmicro.io
 * @since 0.1
 */
public final class RxMicroRestBasedMicroServiceTestExtension
        implements BeforeAllCallback, BeforeEachCallback, BeforeTestExecutionCallback, AfterEachCallback, AfterAllCallback {

    private static final String DO_NOT_WAIT_FOR_RX_MICRO_TEST_REST_SERVER_STOPPED_ENV_VAR_NAME =
            "DO_NOT_WAIT_FOR_RX_MICRO_TEST_REST_SERVER_STOPPED";

    private static final boolean DO_NOT_WAIT_FOR_RX_MICRO_TEST_REST_SERVER_STOPPED;

    static {
        restBasedMicroServiceTestsFix();
        DO_NOT_WAIT_FOR_RX_MICRO_TEST_REST_SERVER_STOPPED = parseBoolean(
                ofNullable(getenv(DO_NOT_WAIT_FOR_RX_MICRO_TEST_REST_SERVER_STOPPED_ENV_VAR_NAME))
                        .orElseGet(() -> getProperty(DO_NOT_WAIT_FOR_RX_MICRO_TEST_REST_SERVER_STOPPED_ENV_VAR_NAME))
        );
    }

    private final RestBasedMicroServiceTestValidator restBasedMicroServiceTestValidator =
            new RestBasedMicroServiceTestValidator(SUPPORTED_TEST_ANNOTATIONS);

    private final ServerPortHelper serverPortHelper =
            new ServerPortHelper();

    private final BlockingHttpClientBuilder blockingHttpClientBuilder =
            new BlockingHttpClientBuilder();

    private final BeforeTestInvoker beforeTestInvoker =
            new BeforeTestInvoker();

    private final ConfigResolver configResolver =
            new ConfigResolver();

    private RestControllerInstanceResolver restControllerInstanceResolver;

    private BlockingHttpClient blockingHttpClient;

    private RuntimeContextComponentInjector runtimeContextComponentInjector;

    private RepositoryInjector repositoryInjector;

    private RestClientInjector restClientInjector;

    private BlockingHttpClientInjector blockingHttpClientInjector;

    private SystemOutInjector systemOutInjector;

    private UserCreatedComponentInjector userCreatedComponentInjector;

    private BeanFactoryInjector beanFactoryInjector;

    private ServerContainer serverContainer;

    @Override
    public void beforeAll(final ExtensionContext context) {
        final Class testClass = getOwnerTestClass(context);
        final Class[] restControllerClasses =
                getRequiredAnnotation(testClass, RxMicroRestBasedMicroServiceTest.class).value();
        validateNotEmptyArray(restControllerClasses);
        final TestModelBuilder testModelBuilder = new TestModelBuilder(
                isRequiredModule(restControllerClasses[0].getModule(), BeanFactory.class.getModule())
        );
        final TestModel testModel = testModelBuilder.build(testClass);
        restBasedMicroServiceTestValidator.validate(testModel, restControllerClasses);
        final int randomFreePort = getRandomFreePort();
        configResolver.setDefaultConfigValues(testClass);
        final Map configs = configResolver.getStaticConfigMap(
                testModel,
                new HttpServerConfig()
                        .setPort(randomFreePort)
                        .setStartTimeTrackerEnabled(false),
                new RestServerConfig()
                        .setDevelopmentMode()
                        .setGeneratorType(FOR_TESTS_ONLY)
        );
        serverContainer = launchWithoutRestControllers(configs);
        restControllerInstanceResolver = new RestControllerInstanceResolver(restControllerClasses, serverContainer);
        createInjectors(testClass, testModel, configs);
    }

    private void validateNotEmptyArray(final Class[] restControllerClasses) {
        if (restControllerClasses.length == 0) {
            throw new InvalidTestConfigException(
                    "Annotation '?' must contain at least one REST controller class",
                    RxMicroRestBasedMicroServiceTest.class.getName()
            );
        }
    }

    private void createInjectors(final Class testClass,
                                 final TestModel testModel,
                                 final Map configs) {
        final InjectorFactory injectorFactory = new InjectorFactory(testModel);
        blockingHttpClientInjector = injectorFactory.createBlockingHttpClientInjector();
        systemOutInjector = injectorFactory.createSystemOutInjector();
        if (blockingHttpClientInjector.hasField()) {
            final int serverPort = serverPortHelper.getServerPort(configs.values());
            final BlockingHttpClientConfig config =
                    blockingHttpClientInjector.getConfig(testClass, false, serverPort);
            restBasedMicroServiceTestValidator.validate(config);
            blockingHttpClient = blockingHttpClientBuilder.build(testClass, config);
        }
        runtimeContextComponentInjector = injectorFactory.createRuntimeContextComponentInjector();
        userCreatedComponentInjector = injectorFactory.createUserCreatedComponentInjector();
        beanFactoryInjector = injectorFactory.createBeanFactoryInjector();
        repositoryInjector = injectorFactory.createRepositoryInjector();
        restClientInjector = injectorFactory.createRestClientInjector();
    }

    @Override
    public void beforeEach(final ExtensionContext context) {
        final List testInstances = getTestInstances(context);

        runtimeContextComponentInjector.injectIfFound(testInstances);
        repositoryInjector.injectIfFound(testInstances);
        restClientInjector.injectIfFound(testInstances);
        beanFactoryInjector.injectIfFound(testInstances);

        blockingHttpClientInjector.injectIfFound(testInstances, blockingHttpClient);
        systemOutInjector.injectIfFound(testInstances);
    }

    @Override
    public void beforeTestExecution(final ExtensionContext context) {
        final List testInstances = getTestInstances(context);
        beforeTestInvoker.invokeIfFound(context, testInstances);

        serverContainer.register(restControllerInstanceResolver.getRestControllerClasses());
        if (beanFactoryInjector.isBeansFound()) {
            beanFactoryInjector.validateThatAllAlternativesAreUsed();
        } else {
            userCreatedComponentInjector.injectIfFound(
                    testInstances,
                    restControllerInstanceResolver.getRestControllerInstances()
            );
        }
    }

    @Override
    public void afterEach(final ExtensionContext context) {
        clearContainer();
        clearFactories();
        serverContainer.unregisterAllRestControllers();
        systemOutInjector.resetIfNecessary();
    }

    @Override
    public void afterAll(final ExtensionContext context) {
        safeInvoke(blockingHttpClient, BlockingHttpClient::release);
        if (DO_NOT_WAIT_FOR_RX_MICRO_TEST_REST_SERVER_STOPPED) {
            safeInvoke(serverContainer, container -> container.serverInstance().shutdown());
        } else {
            safeInvoke(serverContainer, container -> container.serverInstance().shutdownAndWait());
        }
    }
}