grpc.port property is properly populated by config server client, should fix 99 and 103

Author: Alexander Furer

grpc-spring-boot-starter-demo/src/test/java/org/lognet/springboot/grpc/DefaultGrpcPortTest.java

@@ -1,5 +1,6 @@
 package org.lognet.springboot.grpc;
 
+import org.hamcrest.CoreMatchers;
 import org.junit.Assert;
 import org.junit.runner.RunWith;
 import org.lognet.springboot.grpc.autoconfigure.GRpcServerProperties;
@@ -8,6 +9,7 @@
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.context.junit4.SpringRunner;
 
+import static org.junit.Assert.assertThat;
 import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.NONE;
 
 @RunWith(SpringRunner.class)
@@ -23,7 +25,7 @@ protected int getPort() {
 
     @Override
     protected void beforeGreeting() {
-        Assert.assertEquals(0, gRpcServerProperties.getPort());
+        assertThat( gRpcServerProperties.getPort(), CoreMatchers.nullValue(Integer.class));
         Assert.assertEquals(GRpcServerProperties.DEFAULT_GRPC_PORT, runningPort);
     }
 }

grpc-spring-boot-starter-demo/src/test/java/org/lognet/springboot/grpc/EnvVarGrpcPortTest.java

@@ -45,7 +45,7 @@ protected int getPort() {
 
     @Override
     protected void beforeGreeting() {
-        Assert.assertEquals(randomPort, gRpcServerProperties.getPort());
+        Assert.assertEquals(randomPort, gRpcServerProperties.getPort().intValue());
         Assert.assertEquals(randomPort, runningPort);
     }
 }

grpc-spring-boot-starter-demo/src/test/java/org/lognet/springboot/grpc/RandomGrpcPortTest.java

@@ -2,9 +2,7 @@
 
 import org.junit.Assert;
 import org.junit.runner.RunWith;
-import org.lognet.springboot.grpc.context.LocalRunningGrpcPort;
 import org.lognet.springboot.grpc.demo.DemoApp;
-import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.context.junit4.SpringRunner;
 
@@ -14,20 +12,9 @@
 @SpringBootTest(classes = {DemoApp.class}, webEnvironment = NONE, properties = "grpc.port=0")
 public class RandomGrpcPortTest extends GrpcServerTestBase {
 
-    @Value("${local.grpc.port}")
-    int port;
-
-    @LocalRunningGrpcPort
-    int runningPort;
-
-    @Override
-    protected int getPort() {
-        return port;
-    }
-
     @Override
     protected void beforeGreeting() {
-        Assert.assertEquals(0,gRpcServerProperties.getPort());
-        Assert.assertEquals(port,runningPort);
+        Assert.assertEquals(0,gRpcServerProperties.getPort().intValue());
+
     }
 }

grpc-spring-boot-starter/src/main/java/org/lognet/springboot/grpc/autoconfigure/GRpcAutoConfiguration.java

@@ -6,7 +6,6 @@
 import org.lognet.springboot.grpc.GRpcServerBuilderConfigurer;
 import org.lognet.springboot.grpc.GRpcServerRunner;
 import org.lognet.springboot.grpc.GRpcService;
-import org.lognet.springboot.grpc.context.LocalRunningGrpcPort;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.AutoConfigureOrder;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
@@ -22,21 +21,17 @@
 
 @AutoConfigureOrder
 @ConditionalOnBean(annotation = GRpcService.class)
-@EnableConfigurationProperties(GRpcServerProperties.class)
+@EnableConfigurationProperties (GRpcServerProperties.class)
 public class GRpcAutoConfiguration {
 
-    @LocalRunningGrpcPort
-    private int port;
 
     @Autowired
     private GRpcServerProperties grpcServerProperties;
 
-
-
     @Bean
     @ConditionalOnProperty(value = "grpc.enabled", havingValue = "true", matchIfMissing = true)
     public GRpcServerRunner grpcServerRunner(GRpcServerBuilderConfigurer configurer) {
-        return new GRpcServerRunner(configurer, ServerBuilder.forPort(port));
+        return new GRpcServerRunner(configurer, ServerBuilder.forPort(grpcServerProperties.getRunningPort()));
     }
 
     @Bean

grpc-spring-boot-starter/src/main/java/org/lognet/springboot/grpc/autoconfigure/GRpcServerProperties.java

@@ -1,22 +1,32 @@
 package org.lognet.springboot.grpc.autoconfigure;
 
+import lombok.AccessLevel;
 import lombok.Getter;
 import lombok.Setter;
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.stereotype.Component;
+import org.springframework.util.SocketUtils;
+
+import java.util.Optional;
 
 /**
  * Created by alexf on 26-Jan-16.
  */
 
 @ConfigurationProperties("grpc")
 @Getter @Setter
+@Component("grpcProperties")
 public class GRpcServerProperties {
     public static final int DEFAULT_GRPC_PORT = 6565;
     /**
      * gRPC server port
      *
      */
-    private int port = 0;
+    private Integer port = null;
+
+    @Setter(AccessLevel.NONE)
+    @Getter(AccessLevel.NONE)
+    private Integer runningPort= null;
 
     /**
      * Enables the embedded grpc server.
@@ -37,5 +47,18 @@ public class GRpcServerProperties {
      */
     private boolean enableReflection = false;
 
+    public Integer getRunningPort(){
+        if ( null == runningPort) {
+            synchronized (this) {
+                if (null==runningPort) {
+                    runningPort = Optional.ofNullable(port)
+                            .map(p -> 0 == p ? SocketUtils.findAvailableTcpPort() : p)
+                            .orElse(DEFAULT_GRPC_PORT);
+                }
+            }
+        }
+        return runningPort;
+
+    }
 
 }

grpc-spring-boot-starter/src/main/java/org/lognet/springboot/grpc/context/GRpcServerEnvironment.java

@@ -8,7 +8,6 @@
         ElementType.ANNOTATION_TYPE })
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
-@Value("#{environment.containsProperty('grpc.port') && '0' != environment.getProperty('grpc.port') ? environment.getProperty('grpc.port'): ${" + LocalRunningGrpcPort.propertyName + "}}")
+@Value("#{@'grpc-org.lognet.springboot.grpc.autoconfigure.GRpcServerProperties'.getRunningPort()}")
 public @interface LocalRunningGrpcPort {
-    String propertyName = "local.grpc.port";
 }

grpc-spring-boot-starter/src/main/java/org/lognet/springboot/grpc/context/LocalRunningGrpcPort.java

@@ -1,4 +1,3 @@
 org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
-org.lognet.springboot.grpc.autoconfigure.GRpcAutoConfiguration
-org.springframework.boot.env.EnvironmentPostProcessor=\
-org.lognet.springboot.grpc.context.GRpcServerEnvironment
+ org.lognet.springboot.grpc.autoconfigure.GRpcAutoConfiguration
+

grpc-spring-boot-starter/src/main/resources/META-INF/spring.factories

@@ -1,59 +1,67 @@
 package org.lognet.springboot.grpc;
 
 import org.junit.AfterClass;
-import org.junit.BeforeClass;
-import org.junit.Test;
+import org.junit.ClassRule;
+import org.junit.rules.TemporaryFolder;
 import org.junit.runner.RunWith;
 import org.lognet.springboot.grpc.demo.DemoApp;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.core.env.Environment;
 import org.springframework.test.context.junit4.SpringRunner;
 import org.springframework.util.SocketUtils;
 
 import java.io.File;
+import java.io.FileOutputStream;
 import java.io.IOException;
+import java.io.OutputStream;
 import java.net.URISyntaxException;
-import java.nio.file.Paths;
 import java.util.Optional;
+import java.util.Properties;
 
-import static org.junit.Assert.assertEquals;
 
 @RunWith(SpringRunner.class)
 @SpringBootTest(classes = DemoApp.class,
         // Normally spring.cloud.config.enabled:true is the default but since we have the
         // config server on the classpath we need to set it explicitly
         properties = { "spring.cloud.config.enabled:true"})
-public class ConfigServerEnvironmentTest extends GrpcServerTestBase{
+public abstract class ConfigServerEnvironmentBaseTest extends GrpcServerTestBase{
 
     private static int configPort = SocketUtils.findAvailableTcpPort();
     private static ConfigurableApplicationContext server;
 
-    @BeforeClass
-    public static void startConfigServer() throws IOException, URISyntaxException {
-        File configDir = Paths.get(ConfigServerEnvironmentTest.class.getResource("/config-repo/grpc-demo.properties").toURI())
-                .toFile()
-                .getParentFile();
+    @ClassRule
+    public static TemporaryFolder temporaryFolder = new TemporaryFolder();
 
+    @Autowired
+    protected Environment environment;
 
 
+    public static void startConfigServer(Properties properties) throws IOException, URISyntaxException {
+
+        File cfgFile = temporaryFolder.newFile("grpc-demo.properties");
+        try(OutputStream os = new FileOutputStream(cfgFile)) {
+            properties.store(os,null);
+        }
+
 
         server = SpringApplication.run(org.springframework.cloud.config.server.ConfigServerApplication.class,
                 "--server.port=" + configPort,
                 "--spring.autoconfigure.exclude=org.lognet.springboot.grpc.autoconfigure.GRpcAutoConfiguration",
                 "--spring.cloud.config.server.health.enabled=false",
                 "--spring.cloud.config.server.bootstrap=false",
                 "--spring.profiles.active=native",
-                "--spring.cloud.config.server.native.search-locations[0]=file:"+configDir.getAbsolutePath()
+                "--grpc.enabled=false",
+                "--spring.cloud.config.server.native.search-locations[0]=file:"+temporaryFolder.getRoot().getAbsolutePath()
         );
         System.setProperty("config.port", "" + configPort);
 
     }
 
-    @Test
-    public void assertConfigServerConfiguredPort(){
-        assertEquals(6666,getPort());
-    }
+
+
     @AfterClass
     public static void close() {
         System.clearProperty("config.port");

grpc-spring-boot2-starter-demo/src/test/java/org/lognet/springboot/grpc/ConfigServerEnvironmentTest.java renamed to grpc-spring-boot2-starter-demo/src/test/java/org/lognet/springboot/grpc/ConfigServerEnvironmentBaseTest.java

@@ -0,0 +1,33 @@
+package org.lognet.springboot.grpc;
+
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.util.Properties;
+
+import static org.junit.Assert.assertEquals;
+
+
+public class ConfigServerEnvironmentTest1 extends ConfigServerEnvironmentBaseTest{
+
+
+    @BeforeClass
+    public static void startConfigServer() throws IOException, URISyntaxException {
+        Properties properties = new Properties();
+        properties.put("grpc.port","6666");
+        startConfigServer(properties);
+
+    }
+
+
+
+
+    @Test
+    public void assertConfigServerConfiguredPort(){
+        assertEquals(6666,getPort());
+    }
+
+
+}