com.freemanan.starter.grpc.extensions.test.GrpcTestEnvironmentPostProcessor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grpc-test
There is a newer version: 3.1.8
package com.freemanan.starter.grpc.extensions.test;

import com.freemanan.starter.grpc.client.GrpcClientProperties;
import com.freemanan.starter.grpc.server.GrpcServerProperties;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.MapPropertySource;
import org.springframework.core.env.StandardEnvironment;
import org.springframework.util.ClassUtils;

/**
 * gRPC integrate with {@link SpringBootTest}.
 *
 * @author Freeman
 */
public class GrpcTestEnvironmentPostProcessor implements EnvironmentPostProcessor {
    private static final Logger log = LoggerFactory.getLogger(GrpcTestEnvironmentPostProcessor.class);

    private static final boolean SPRING_BOOT_TEST_ENV =
            ClassUtils.isPresent("org.springframework.boot.test.context.SpringBootTest", null);
    private static final boolean GRPC_CLIENT_STARTER_EXISTS =
            ClassUtils.isPresent("com.freemanan.starter.grpc.client.GrpcClientProperties", null);
    private static final boolean GRPC_SERVER_STARTER_EXISTS =
            ClassUtils.isPresent("com.freemanan.starter.grpc.server.GrpcServerProperties", null);

    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        if (!SPRING_BOOT_TEST_ENV) {
            return;
        }

        SpringBootTest anno =
                AnnotationUtils.findAnnotation(application.getMainApplicationClass(), SpringBootTest.class);
        if (anno == null) {
            return;
        }

        GrpcTestProperties properties = Binder.get(environment)
                .bind(GrpcTestProperties.PREFIX, GrpcTestProperties.class)
                .orElseGet(GrpcTestProperties::new);

        if (!properties.isEnabled() || !properties.getServer().isEnabled()) {
            return;
        }

        GrpcTestProperties.Server.Port port = properties.getServer().getPort();

        Map configMap = new HashMap<>();
        switch (port) {
            case IN_PROCESS:
                if (GRPC_CLIENT_STARTER_EXISTS && GRPC_SERVER_STARTER_EXISTS) {
                    String serverProperty = GrpcServerProperties.InProcess.PREFIX + ".name";
                    String clientProperty = GrpcClientProperties.InProcess.PREFIX + ".name";
                    if (!environment.containsProperty(serverProperty)
                            && !environment.containsProperty(clientProperty)) {
                        // use in-process if not manually configured
                        String name = UUID.randomUUID().toString();
                        configMap.put(serverProperty, name);
                        configMap.put(clientProperty, name);
                    }
                } else if (GRPC_SERVER_STARTER_EXISTS) {
                    String portProperty = GrpcServerProperties.PREFIX + ".port";
                    configMap.put(portProperty, 0);
                    if (log.isInfoEnabled()) {
                        log.info(
                                "Set 'grpc.test.server.port' to 'IN_PROCESS', but gRPC-client-starter not found in classpath, will start gRPC server with random port");
                    }
                } else {
                    throw new IllegalStateException("gRPC client or server starter not found");
                }
                break;
            case RANDOM_PORT:
                String portProperty = GrpcServerProperties.PREFIX + ".port";
                configMap.put(portProperty, 0);
                break;
            case DEFINED_PORT:
                // do nothing
                break;
            default:
                throw new IllegalArgumentException("Unknown port type: " + port);
        }

        MapPropertySource ps = new MapPropertySource("grpc.extensions.test.property_source", configMap);

        environment.getPropertySources().addAfter(StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME, ps);
    }
}