#21 Allow to configure http and grpc ports

Adven27 · Adven27 · commit 24a03881f501 · 2021-09-29T23:15:53.000+03:00
diff --git a/README.md b/README.md
@@ -110,24 +110,33 @@ docker run \
 ```
 ## How To:
 
-#### 1. Change grpc server properties
+#### 1. Configuring gRPC server
 
-Currently, following grpc server properties are supported<sup>*</sup>:
+Currently, following grpc server properties are supported:
 
 ```properties
+GRPC_SERVER_PORT
 GRPC_SERVER_MAXHEADERLISTSIZE
 GRPC_SERVER_MAXMESSAGESIZE
 GRPC_SERVER_MAXINBOUNDMETADATASIZE
 GRPC_SERVER_MAXINBOUNDMESSAGESIZE
 ```
-<sub>*The first two are deprecated in favor of the last two</sub>
 
 Could be used like this:
 
 ```posh
 docker run -e GRPC_SERVER_MAXHEADERLISTSIZE=1000 adven27/grpc-wiremock
 ```
 
+### 3. Configuring WireMock server
+
+WireMock server may be configured by passing [command line options](http://wiremock.org/docs/running-standalone/) 
+prefixed by `wiremock_`:
+
+```posh
+docker run -e WIREMOCK_DISABLE-REQUEST-LOGGING -e WIREMOCK_PORT=0 adven27/grpc-wiremock
+```
+
 #### 2. Speed up container start
 
 In case you don't need to change proto files, you can build your own image with precompiled protos.  
@@ -162,10 +171,9 @@ docker run -e SPRING_PROFILES_ACTIVE=load adven27/grpc-wiremock
 ```
 ```posh
 docker run \
-    -e WIREMOCK_SERVER_DISABLEREQUESTJOURNAL=true \
-    -e WIREMOCK_SERVER_ASYNCHRONOUSRESPONSEENABLED=true \
-    -e WIREMOCK_SERVER_ASYNCHRONOUSRESPONSETHREADS=10 \
-    -e WIREMOCK_SERVER_STUBREQUESTLOGGINGDISABLED=true \
-    -e WIREMOCK_SERVER_VERBOSE=false \
-    adven27/grpc-wiremock
+  -e WIREMOCK_NO-REQUEST-JOURNAL \
+  -e WIREMOCK_DISABLE-REQUEST-LOGGING \
+  -e WIREMOCK_ASYNC-RESPONSE-ENABLED \
+  -e WIREMOCK_ASYNC-RESPONSE-THREADS=10 \
+  adven27/grpc-wiremock
 ```
diff --git a/build.gradle b/build.gradle
@@ -1,5 +1,5 @@
 plugins {
-    id 'org.springframework.boot' version '2.4.5'
+    id 'org.springframework.boot' version '2.5.4'
     id 'io.spring.dependency-management' version '1.0.11.RELEASE'
     id 'java'
     id 'com.google.protobuf' version '0.8.16'
@@ -13,7 +13,7 @@ repositories {
     mavenCentral()
 }
 
-def grpcVersion = '1.37.0'
+def grpcVersion = '1.40.1'
 def protobufVersion = '3.16.0'
 def protocVersion = protobufVersion
 
@@ -22,7 +22,7 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-aop'
     implementation "io.grpc:grpc-all:${grpcVersion}"
     implementation 'org.xerial.snappy:snappy-java:1.1.8.4'
-    implementation 'com.github.tomakehurst:wiremock-jre8-standalone:2.30.1'
+    implementation 'com.github.tomakehurst:wiremock-jre8-standalone:2.31.0'
 }
 
 protobuf {
diff --git a/src/main/java/io/adven/grpc/wiremock/GrpcWiremock.java b/src/main/java/io/adven/grpc/wiremock/GrpcWiremock.java
@@ -1,7 +1,6 @@
 package io.adven.grpc.wiremock;
 
 import io.adven.grpc.wiremock.properties.GrpcProperties;
-import io.adven.grpc.wiremock.properties.WiremockProperties;
 import io.grpc.BindableService;
 import io.grpc.Server;
 import io.grpc.netty.NettyServerBuilder;
@@ -23,18 +22,21 @@
 import static java.util.stream.Collectors.joining;
 
 @SpringBootApplication
-@EnableConfigurationProperties({GrpcProperties.class, WiremockProperties.class})
+@EnableConfigurationProperties({GrpcProperties.class})
 public class GrpcWiremock implements CommandLineRunner {
     private static final Logger LOG = LoggerFactory.getLogger(GrpcWiremock.class);
     private final GrpcServer server;
+    private final HttpMock httpMock;
 
-    public GrpcWiremock(GrpcServer server) {
+    public GrpcWiremock(GrpcServer server, HttpMock httpMock) {
         this.server = server;
+        this.httpMock = httpMock;
     }
 
     @Override
     public void run(String... args) throws Exception {
-        server.start(50000);
+        httpMock.start();
+        server.start();
     }
 
     @Service
@@ -52,8 +54,8 @@ public GrpcServer(GrpcProperties grpcProperties, CodecRegistry codecRegistry, Li
             this.latch = new CountDownLatch(1);
         }
 
-        public void start(int port) throws IOException {
-            NettyServerBuilder builder = NettyServerBuilder.forPort(port)
+        public void start() throws IOException {
+            NettyServerBuilder builder = NettyServerBuilder.forPort(grpcProperties.getServer().getPort())
                 .intercept(new ExceptionHandler(grpcProperties.getErrorCodeBy()))
                 .compressorRegistry(codecRegistry.compressorRegistry())
                 .decompressorRegistry(codecRegistry.decompressorRegistry())
@@ -68,32 +70,30 @@ public void start(int port) throws IOException {
 
         private void setProperties(NettyServerBuilder builder) {
             GrpcProperties.ServerProperties server = grpcProperties.getServer();
-            if (server != null) {
-                if (server.getMaxHeaderListSize() != null) {
-                    int val = Math.toIntExact(server.getMaxHeaderListSize().toBytes());
-                    LOG.info("Set maxHeaderListSize = {}", val);
-                    builder.maxHeaderListSize(val);
-                }
-                if (server.getMaxMessageSize() != null) {
-                    int val = Math.toIntExact(server.getMaxMessageSize().toBytes());
-                    LOG.info("Set maxMessageSize = {}", val);
-                    builder.maxMessageSize(val);
-                }
-                if (server.getMaxInboundMetadataSize() != null) {
-                    int val = Math.toIntExact(server.getMaxInboundMetadataSize().toBytes());
-                    LOG.info("Set maxInboundMetadataSize = {}", val);
-                    builder.maxInboundMetadataSize(val);
-                }
-                if (server.getMaxInboundMessageSize() != null) {
-                    int val = Math.toIntExact(server.getMaxInboundMessageSize().toBytes());
-                    LOG.info("Set maxInboundMessageSize = {}", val);
-                    builder.maxInboundMessageSize(val);
-                }
+            if (server.getMaxHeaderListSize() != null) {
+                int val = Math.toIntExact(server.getMaxHeaderListSize().toBytes());
+                LOG.info("Set maxHeaderListSize = {}", val);
+                builder.maxHeaderListSize(val);
+            }
+            if (server.getMaxMessageSize() != null) {
+                int val = Math.toIntExact(server.getMaxMessageSize().toBytes());
+                LOG.info("Set maxMessageSize = {}", val);
+                builder.maxMessageSize(val);
+            }
+            if (server.getMaxInboundMetadataSize() != null) {
+                int val = Math.toIntExact(server.getMaxInboundMetadataSize().toBytes());
+                LOG.info("Set maxInboundMetadataSize = {}", val);
+                builder.maxInboundMetadataSize(val);
+            }
+            if (server.getMaxInboundMessageSize() != null) {
+                int val = Math.toIntExact(server.getMaxInboundMessageSize().toBytes());
+                LOG.info("Set maxInboundMessageSize = {}", val);
+                builder.maxInboundMessageSize(val);
             }
         }
 
         private String summary(Server server) {
-            return "Started " + server + "\nRegistered services:\n" +
+            return "gRPC server is started: " + server + "\nRegistered services:\n" +
                 server.getServices().stream().map(s -> " * " + s.getServiceDescriptor().getName()).collect(joining("\n"));
         }
 
@@ -124,7 +124,6 @@ public void destroy() {
                 }
                 LOG.info("gRPC server stopped.");
             });
-
         }
     }
 
diff --git a/src/main/java/io/adven/grpc/wiremock/HttpMock.java b/src/main/java/io/adven/grpc/wiremock/HttpMock.java
@@ -1,56 +1,70 @@
 package io.adven.grpc.wiremock;
 
 import com.github.tomakehurst.wiremock.WireMockServer;
-import com.github.tomakehurst.wiremock.common.Slf4jNotifier;
-import com.github.tomakehurst.wiremock.core.WireMockConfiguration;
-import com.github.tomakehurst.wiremock.extension.responsetemplating.ResponseTemplateTransformer;
+import com.github.tomakehurst.wiremock.standalone.CommandLineOptions;
 import com.google.protobuf.AbstractMessage;
 import com.google.protobuf.InvalidProtocolBufferException;
 import com.google.protobuf.Message;
 import com.google.protobuf.MessageOrBuilder;
 import com.google.protobuf.util.JsonFormat;
-import io.adven.grpc.wiremock.properties.WiremockProperties;
+import io.adven.grpc.wiremock.configurer.WiremockConfigurer;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.stereotype.Component;
 
-import javax.annotation.PostConstruct;
 import javax.annotation.PreDestroy;
 import java.io.IOException;
 import java.lang.reflect.InvocationTargetException;
 import java.net.URI;
 import java.net.http.HttpClient;
 import java.net.http.HttpRequest;
 import java.net.http.HttpResponse;
-
-import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
+import java.util.Map;
 
 @Component
 public class HttpMock {
     private static final Logger LOG = LoggerFactory.getLogger(HttpMock.class);
-    private final WireMockServer server;
-    private final HttpClient httpClient;
+    private static final String PREFIX = "wiremock_";
+    private final WiremockConfigurer configurer;
+    private WireMockServer server;
+    private final HttpClient httpClient = HttpClient.newHttpClient();
+
+    public HttpMock(WiremockConfigurer configurer) {
+        this.configurer = configurer;
+    }
 
-    public HttpMock(WiremockProperties properties) {
-        WireMockConfiguration config = wireMockConfig()
-            .usingFilesUnderDirectory("/wiremock")
-            .extensions(new ResponseTemplateTransformer(true))
-            .port(8888)
-            .notifier(new Slf4jNotifier(properties.isVerbose()))
-            .stubRequestLoggingDisabled(properties.isStubRequestLoggingDisabled())
-            .asynchronousResponseEnabled(properties.isAsynchronousResponseEnabled())
-            .asynchronousResponseThreads(properties.getAsynchronousResponseThreads());
+    public void start() {
+        String[] args = configurer.configure(envOptions());
+        LOG.info("Starting WireMock server with options:\n{}", String.join("\n", args));
+        CommandLineOptions options = new CommandLineOptions(args);
+        server = new WireMockServer(options);
+        server.start();
+        LOG.info("WireMock server is started:\n{}", setActualPort(options));
+    }
 
-        if (properties.isDisableRequestJournal()) {
-            config.disableRequestJournal();
+    private CommandLineOptions setActualPort(CommandLineOptions options) {
+        if (!options.getHttpDisabled()) {
+            options.setActualHttpPort(server.port());
+        }
+        if (options.httpsSettings().enabled()) {
+            options.setActualHttpsPort(server.httpsPort());
         }
-        server = new WireMockServer(config);
-        httpClient = HttpClient.newHttpClient();
+        return options;
     }
 
-    @PostConstruct
-    public void init() {
-        server.start();
+    private String[] envOptions() {
+        return System.getenv().entrySet().stream()
+            .filter(it -> it.getKey().toLowerCase().startsWith(PREFIX))
+            .map(this::toWiremockOption)
+            .toArray(String[]::new);
+    }
+
+    private String toWiremockOption(Map.Entry<String, String> it) {
+        return "--" + it.getKey().toLowerCase().substring(PREFIX.length()) + (nullOrEmpty(it.getValue()) ? "" : "=" + it.getValue());
+    }
+
+    private boolean nullOrEmpty(String value) {
+        return value == null || value.equals("");
     }
 
     @PreDestroy
diff --git a/src/main/java/io/adven/grpc/wiremock/configurer/DefaultWiremockConfigurer.java b/src/main/java/io/adven/grpc/wiremock/configurer/DefaultWiremockConfigurer.java
@@ -0,0 +1,33 @@
+package io.adven.grpc.wiremock.configurer;
+
+import org.springframework.context.annotation.Profile;
+import org.springframework.stereotype.Component;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import static java.util.Arrays.asList;
+
+@Profile("!load")
+@Component
+public class DefaultWiremockConfigurer implements WiremockConfigurer {
+    private static final String GLOBAL_RESPONSE_TEMPLATING = "--global-response-templating";
+    private static final String LOCAL_RESPONSE_TEMPLATING = "--local-response-templating";
+    private static final String ROOT_DIR = "--root-dir";
+    private static final String PORT = "--port";
+
+    @Override
+    public String[] configure(String... args) {
+        List<String> options = new ArrayList<>(asList(args));
+        if (options.stream().noneMatch(it -> it.equals(GLOBAL_RESPONSE_TEMPLATING) || it.equals(LOCAL_RESPONSE_TEMPLATING))) {
+            options.add(GLOBAL_RESPONSE_TEMPLATING);
+        }
+        if (options.stream().noneMatch(it -> it.startsWith(ROOT_DIR))) {
+            options.add(ROOT_DIR + "=/wiremock");
+        }
+        if (options.stream().noneMatch(it -> it.startsWith(PORT))) {
+            options.add(PORT + "=8888");
+        }
+        return options.toArray(new String[0]);
+    }
+}
diff --git a/src/main/java/io/adven/grpc/wiremock/configurer/LoadWiremockConfigurer.java b/src/main/java/io/adven/grpc/wiremock/configurer/LoadWiremockConfigurer.java
@@ -0,0 +1,28 @@
+package io.adven.grpc.wiremock.configurer;
+
+import org.springframework.context.annotation.Profile;
+import org.springframework.stereotype.Component;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import static java.util.Arrays.asList;
+
+@Profile("load")
+@Component
+public class LoadWiremockConfigurer extends DefaultWiremockConfigurer {
+    private static final String DISABLE_REQUEST_LOGGING = "--disable-request-logging";
+    private static final String DISABLE_REQUEST_JOURNAL = "--no-request-journal";
+    private static final String ASYNCHRONOUS_RESPONSE_ENABLED = "--async-response-enabled";
+    private static final String ASYNCHRONOUS_RESPONSE_THREADS = "--async-response-threads";
+
+    @Override
+    public String[] configure(String... args) {
+        List<String> options = new ArrayList<>(asList(super.configure(args)));
+        options.add(DISABLE_REQUEST_LOGGING);
+        options.add(DISABLE_REQUEST_JOURNAL);
+        options.add(ASYNCHRONOUS_RESPONSE_ENABLED);
+        options.add(ASYNCHRONOUS_RESPONSE_THREADS + "=10");
+        return options.toArray(new String[0]);
+    }
+}
diff --git a/src/main/java/io/adven/grpc/wiremock/configurer/WiremockConfigurer.java b/src/main/java/io/adven/grpc/wiremock/configurer/WiremockConfigurer.java
@@ -0,0 +1,5 @@
+package io.adven.grpc.wiremock.configurer;
+
+public interface WiremockConfigurer {
+    String[] configure(String... args);
+}
diff --git a/src/main/java/io/adven/grpc/wiremock/properties/GrpcProperties.java b/src/main/java/io/adven/grpc/wiremock/properties/GrpcProperties.java
@@ -26,18 +26,24 @@ public ErrorCodeMapping getErrorCodeBy() {
     }
 
     public static class ServerProperties {
+        private final Integer port;
         private final DataSize maxHeaderListSize;
         private final DataSize maxMessageSize;
         private final DataSize maxInboundMetadataSize;
         private final DataSize maxInboundMessageSize;
 
-        public ServerProperties(DataSize maxHeaderListSize, DataSize maxMessageSize, DataSize maxInboundMetadataSize, DataSize maxInboundMessageSize) {
+        public ServerProperties(Integer port, DataSize maxHeaderListSize, DataSize maxMessageSize, DataSize maxInboundMetadataSize, DataSize maxInboundMessageSize) {
+            this.port = port;
             this.maxHeaderListSize = maxHeaderListSize;
             this.maxMessageSize = maxMessageSize;
             this.maxInboundMetadataSize = maxInboundMetadataSize;
             this.maxInboundMessageSize = maxInboundMessageSize;
         }
 
+        public Integer getPort() {
+            return port;
+        }
+
         public DataSize getMaxHeaderListSize() {
             return maxHeaderListSize;
         }
diff --git a/src/main/java/io/adven/grpc/wiremock/properties/WiremockProperties.java b/src/main/java/io/adven/grpc/wiremock/properties/WiremockProperties.java
diff --git a/src/main/resources/application.yaml b/src/main/resources/application.yaml
