org.grpcmock.springboot.AutoConfigureGrpcMock Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grpcmock-spring-boot Show documentation
gRPC Mock Spring Boot integration
There is a newer version: 0.14.0
package org.grpcmock.springboot;

import io.grpc.Channel;
import io.grpc.Server;
import io.grpc.ServerBuilder;
import io.grpc.ServerInterceptor;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.concurrent.Executor;
import java.util.concurrent.Executors;
import org.springframework.boot.test.autoconfigure.properties.PropertyMapping;
import org.springframework.context.annotation.Import;

/**
 * Annotation for test classes that want to start a gRPC Mock server as part of the Spring
 * Application Context.
 * 
It is recommended to use 0 for gRPC Mock port, as a random free port will be
 * selected and used. Once a random port is selected it can be access via
 * ${grpcmock.server.port} property and used in gRPC {@link Channel} creation.
 * 
Mapping stubs will be cleared after each test run and after each test class run.
 * If test class was run with a fixed port, the test context will be marked as dirty to reinitialise
 * a new one.
 *
 * @author Fadelis
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(GrpcMockConfiguration.class)
@PropertyMapping("grpcmock.server")
@Inherited
public @interface AutoConfigureGrpcMock {

  /**
   * Defines the port value for the gRPC Mock server. If set to 0 a random free port
   * will be picked.
   */
  int port() default 0;

  /**
   * Set this to true to use InProcessServer instead of netty based one.
   */
  boolean useInProcessServer() default false;

  /**
   * Defines the name of in-process server configured. If empty, a random name will be generated
   */
  String name() default "";

  /**
   * Defines {@link ServerInterceptor} for the gRPC Mock server. Interceptors defined here must have
   * a default constructor without any arguments.
   */
  Class[] interceptors() default {};

  /**
   * 
Defines executor thread count to be used for the server, which will create a {@link
   * Executor} via {@link Executors#newFixedThreadPool(int)}.
   * 
If {@link #executorBeanName()} is defined it will take priority over this. If none of these
   * are defined a default {@link Executor} will be used from {@link Server}.
   */
  int executorThreadCount() default -1;

  /**
   * 
Defines executor bean to be used for the gRPC server.
   * This will take priority over {@link #executorThreadCount()}. If none of these
   * are defined a default {@link Executor} will be used from {@link ServerBuilder}.
   */
  String executorBeanName() default "";

  /**
   * Defines the file path for the cert chain. Both this and {@link #privateKeyFile()} must be
   * defined in order to configure server security via {@link ServerBuilder#useTransportSecurity}.
   */
  String certChainFile() default "";

  /**
   * Defines the file path for the private key. Both this and {@link #certChainFile()} must be
   * defined in order to configure server security via {@link ServerBuilder#useTransportSecurity}.
   */
  String privateKeyFile() default "";
}