random grpc port usage documentation

Author: Alexander Furer

README.adoc

@@ -28,7 +28,8 @@ dependencies {
 * Start by https://github.com/google/protobuf-gradle-plugin[generating] stub and server interface(s) from your `.proto` file(s).
 * Annotate your server interface implementation(s) with `@org.lognet.springboot.grpc.GRpcService`
 * Optionally configure the server port in your `application.yml/properties`. Default port is `6565`.
-* A random port can be defined by setting the port to `0`. The actual port being used can then be retrieved from the property `local.grpc.port`.
+* A random port can be defined by setting the port to `0`. The actual port being used can then be retrieved from the property `local.grpc.port`, or
+using `@LocalRunningGrpcPort` annotation which will inject the running port (explicitly configured or randomly selected)
 
 [source,yaml]
 ----

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

@@ -43,7 +43,7 @@ public abstract class GrpcServerTestBase {
     @Before
     public final void setupChannels() {
         if(gRpcServerProperties.isEnabled()) {
-            channel = onChannelBuild(ManagedChannelBuilder.forAddress("localhost", gRpcServerProperties.getPort())
+            channel = onChannelBuild(ManagedChannelBuilder.forAddress("localhost",getPort() )
                     .usePlaintext(true)
                     ).build();
         }
@@ -55,6 +55,9 @@ public final void setupChannels() {
 
         }
     }
+    protected int getPort(){
+        return  gRpcServerProperties.getPort();
+    }
 
     protected ManagedChannelBuilder<?>  onChannelBuild(ManagedChannelBuilder<?> channelBuilder){
         return  channelBuilder;
@@ -71,9 +74,9 @@ public final void shutdownChannels() {
     }
 
     @Test
-    public void simpleGreeting() throws ExecutionException, InterruptedException {
-
+    final public void simpleGreeting() throws ExecutionException, InterruptedException {
 
+        beforeGreeting();
         String name ="John";
         final GreeterGrpc.GreeterFutureStub greeterFutureStub = GreeterGrpc.newFutureStub(Optional.ofNullable(channel).orElse(inProcChannel));
         final GreeterOuterClass.HelloRequest helloRequest =GreeterOuterClass.HelloRequest.newBuilder().setName(name).build();
@@ -83,6 +86,11 @@ public void simpleGreeting() throws ExecutionException, InterruptedException {
         afterGreeting();
 
     }
+
+    protected void beforeGreeting() {
+
+    }
+
     protected void afterGreeting(){
 
     }

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

@@ -0,0 +1,37 @@
+package org.lognet.springboot.grpc;
+
+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;
+
+import java.util.concurrent.ExecutionException;
+
+import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.NONE;
+
+@RunWith(SpringRunner.class)
+@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);
+    }
+}