Merge pull request #196 from lagom/rgc/remove-tls

Remove TLS from gRPC samples

.travis.yml

@@ -13,6 +13,7 @@ env:
   global:
     - TRAVIS_JDK=11
     - JABBA_HOME=$HOME/.jabba    
+    - RUN_DROP_TRAVIS_CACHES_STAGE=true
 
 before_install:
   # See https://github.com/travis-ci/travis-ci/issues/4629#issuecomment-239493916
@@ -42,6 +43,17 @@ before_cache:
 
 jobs:
   include:
+
+    - stage: drop-travis-caches
+      # Introduced 2020-10-19 as we noticed serious problems with Travis' caching
+      script:
+        - rm -rf $HOME/.cache/coursier
+        - rm -rf $HOME/.ivy2/cache
+        - rm -rf $HOME/.jabba
+        - rm -rf $HOME/.sbt
+        - rm -rf $HOME/.m2/repository
+      name: "drop-travis-caches"
+
     # Mixed Persistence Samples
     - stage: test-java-11
       name: "Run tests Mixed Persistence (java)"
@@ -141,10 +153,18 @@ jobs:
         - docker-compose -f couchbase-persistence/docker/docker-compose.yml up -d couchbase
         - sleep 30s
         - "cd couchbase-persistence/couchbase-persistence-scala-sbt && sbt test stage"
+
 
 stages:
-  - test-java-11
-  - test-java-8
+  - name: drop-travis-caches
+    # to drop caches trigger a custom build with
+    # env:
+    #   global:
+    #     - RUN_DROP_TRAVIS_CACHES_STAGE=true
+    if: env(RUN_DROP_TRAVIS_CACHES_STAGE) = true
+  - name: test-java-11
+  - name: test-java-8
+
 
 notifications:
   webhooks:

grpc-example/grpc-example-java/build.sbt

@@ -9,9 +9,7 @@ version in ThisBuild := "1.0-SNAPSHOT"
 // the Java version that will be used for cross-compiled libraries
 scalaVersion in ThisBuild := "2.12.12"
 
-lagomServiceEnableSsl in ThisBuild := true
-val `hello-impl-HTTPS-port` = 11000
-
+val `hello-impl-HTTP-port` = 11000
 val playGrpcRuntime = "com.lightbend.play"  %% "play-grpc-runtime"          % BuildInfo.playGrpcVersion
 val lagomGrpcTestkit = "com.lightbend.play" %% "lagom-javadsl-grpc-testkit" % BuildInfo.playGrpcVersion % Test
 // TODO remove after upgrade Akka gRPC
@@ -44,7 +42,7 @@ lazy val `hello-impl` = (project in file("hello-impl"))
 
   // WORKAROUND: Lagom still can't register a service under the gRPC name so we hard-code
   // the port and the use the value to add the entry on the Service Registry
-  lagomServiceHttpsPort := `hello-impl-HTTPS-port`,
+  lagomServiceHttpPort := `hello-impl-HTTP-port`,
 
   libraryDependencies ++= Seq(
     lagomJavadslTestKit,
@@ -75,6 +73,7 @@ lazy val `hello-proxy-impl` = (project in file("hello-proxy-impl"))
     libraryDependencies ++= Seq(
       lagomJavadslTestKit,
       lagomLogback,
+      playGrpcRuntime,
       akkaHttp
     )
   )
@@ -91,9 +90,8 @@ lagomKafkaEnabled in ThisBuild := false
 
 // This adds an entry on the LagomDevMode Service Registry. With this information on
 // the Service Registry a client using Service Discovery to Lookup("helloworld.GreeterService")
-// will get "https://localhost:11000" and then be able to send a request.
-// See declaration and usages of `hello-impl-HTTPS-port`.
-lagomUnmanagedServices in ThisBuild := Map("helloworld.GreeterService" -> s"https://localhost:${`hello-impl-HTTPS-port`}")
+// will get "http://localhost:11000" and then be able to send a request.
+lagomUnmanagedServices in ThisBuild := Map("helloworld.GreeterService" -> s"http://127.0.0.1:${`hello-impl-HTTP-port`}")
 
 
 def common = Seq(

grpc-example/grpc-example-java/docs/src/main/paradox/index.md

@@ -16,29 +16,26 @@ cd grpc-example/grpc-example-java
 
 ## Running the example
 
-Using gRPC in Lagom requires adding a Java Agent to the runtime. In order to handle this setting we provide a script that will
-download the ALPN Java Agent and start an interactive `sbt` console properly set up. Use the `ssl-lagom`
-script:
+You can run it like any Lagom application.
+
+In Maven,
 
 ```bash
-./ssl-lagom
+mvn lagom:runAll
 ```
 
-The first time you run the script it will take some time to resolve and download some dependencies. Once
-ready you'll be at the `sbt` console. Use the `runAll` command to start the Lagom gRPC Example:
+In sbt,
 
 ```bash
-sbt:lagom-java-grpc-example> runAll
+sbt runAll
 ```
 
 The `runAll` command starts Lagom in development mode. Once all the services are started you will see Lagom's start message:
 
-```
+```bash
 ...
-[info] Service hello-proxy-impl listening for HTTP on 127.0.0.1:54328
-[info] Service hello-proxy-impl listening for HTTPS on 127.0.0.1:65108
-[info] Service hello-impl listening for HTTP on 127.0.0.1:65499
-[info] Service hello-impl listening for HTTPS on 127.0.0.1:11000
+[INFO] Service hello-impl listening for HTTP on 127.0.0.1:11000
+[INFO] Service hello-proxy-impl listening for HTTP on 127.0.0.1:54328
 [info] (Services started, press enter to stop and go back to the console...)
 ```
 
@@ -56,15 +53,15 @@ Hi Steve! (gRPC)
 
 This application is built with two Lagom services (`hello` and `hello-proxy`) exposing the following endpoints:
 
-```
+```bash
 GET /proxy/rest-hello/:id    # served by hello-proxy-service (HTTP-JSON)
 GET /proxy/grpc-hello/:id    # served by hello-proxy-service (HTTP-JSON)
 GET /api/hello/:id           # served by hello-service (HTTP-JSON)
 ```
 
 And also:
 
-```
+```bash
 /helloworld.GreetingsService/sayHello   # served by hello-service (gRPC)
 ```
 
@@ -82,7 +79,7 @@ curl http://localhost:9000/proxy/rest-hello/Alice
 
 The following happens:
 
-```
+```bash
 curl  --(http)-->  service gateway  --(http)-->  hello-proxy-service  --(http)-->  hello-service
 ```
 
@@ -94,40 +91,31 @@ curl http://localhost:9000/proxy/grpc-hello/Alice
 
 The following happens
 
-```
-curl  --(http)-->  service gateway  --(http)-->  hello-proxy-service  --(gRPC/https)-->  hello-service
+```bash
+curl  --(http)-->  service gateway  --(http)-->  hello-proxy-service  --(gRPC/http)-->  hello-service
 ```
 
 ## Testing the gRPC endpoints
 
 The gRPC endpoints are not accessible via the Lagom Service Gateway so it's only possible to consume them from
-another Lagom service or pointing a client directly to the `https - HTTP/2` port of the Lagom Service. Earlier we
+another Lagom service or pointing a client directly to the `HTTP/2` port of the Lagom Service. Earlier we
 saw that Lagom informs of the following bindings:
 
-```
+```bash
 ...
-[info] Service hello-proxy-impl listening for HTTP on 127.0.0.1:54328
-[info] Service hello-proxy-impl listening for HTTPS on 127.0.0.1:65108
-[info] Service hello-impl listening for HTTP on 127.0.0.1:65499
-[info] Service hello-impl listening for HTTPS on 127.0.0.1:11000
+[INFO] Service hello-impl listening for HTTP on 127.0.0.1:11000
+[INFO] Service hello-proxy-impl listening for HTTP on 127.0.0.1:54328
 [info] (Services started, press enter to stop and go back to the console...)
 ```
 
-You can test the gRPC endpoint using [grpcc](https://github.com/njpatel/grpcc). Because Lagom uses self-signed
-certificates, you will have to export and trust the CA certificate:
-
-```bash
-keytool -export -alias sslconfig-selfsigned  -keystore target/dev-mode/selfsigned.keystore  -storepass "" -file trustedCA.crt
-openssl x509 -in  trustedCA.crt -out trustedCA.pem -inform DER -outform PEM
-```
-
-Once the CA certificate is extracted we can use `grpcc` to test the application:
+You can test the gRPC endpoint using [gRPCurl](https://github.com/fullstorydev/grpcurl).
+Note that for simplicity, this sample is disabling TLS, therefore it's possbile to call the `HTTP/2` endpoint without using https.
 
 ```bash
-$   grpcc --proto hello-impl/src/main/protobuf/helloworld.proto \
-          --address localhost:11000 \
-          --eval 'client.sayHello({name:"Katherine"}, printReply)' \
-          --root_cert ./trustedCA.pem
+$   grpcurl --proto hello-impl/src/main/protobuf/helloworld.proto \
+          -d '{"name": "Katherine" }' \
+          -plaintext 127.0.0.1:11000   \
+          helloworld.GreeterService.SayHello
  {
    "message": "Hi Katherine! (gRPC)"
  }
@@ -136,8 +124,8 @@ $   grpcc --proto hello-impl/src/main/protobuf/helloworld.proto \
 The command above:
 
 1. Uses the gRPC description on `hello-impl/src/main/protobuf/helloworld.proto`
-2. Connects to the `hello-impl` service using `https` at `localhost:11000` (trusting the CA used to build the `localhost:11000` certificate)
-3. Sends a gRPC call `client.sayHello({name:"Katherine"},...)` (`grpcc` requires registering a callback, in this case `printReply` to send the response to the `stdout`).
+1. Connects to the `hello-impl` service at `127.0.0.1:11000` using plaintext over `http`.
+1. Sends a gRPC call `helloworld.GreeterService.SayHello` with `{"name": "Katherine" }` payload.
 
 ## References
 

grpc-example/grpc-example-java/hello-impl/pom.xml

@@ -104,9 +104,8 @@
                 <artifactId>lagom-maven-plugin</artifactId>
                 <configuration>
                     <lagomService>true</lagomService>
-                    <serviceHttpsPort>${hello-impl.https.port}</serviceHttpsPort>
+                    <serviceHttpPort>${hello-impl.http.port}</serviceHttpPort>
                     <serviceAddress>127.0.0.1</serviceAddress>
-                    <serviceEnableSsl>true</serviceEnableSsl>
                 </configuration>
             </plugin>
 

grpc-example/grpc-example-java/hello-impl/src/main/resources/logback.xml

@@ -0,0 +1,24 @@
+<configuration>
+
+  <conversionRule conversionWord="coloredLevel" converterClass="com.lightbend.lagom.internal.logback.ColoredLevel" />
+
+  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+    <encoder>
+      <pattern>%date{"HH:mm:ss.SSS"} %coloredLevel %logger [%mdc] - %msg%n</pattern>
+    </encoder>
+  </appender>
+
+  <!-- Set logging for all Play library classes to INFO -->
+  <logger name="play" level="INFO" />
+  <!-- Set logging for all Akka library classes to INFO -->
+  <logger name="akka" level="INFO" />
+  <!-- Set logging for all Lagom library classes to INFO -->
+  <logger name="com.lightbend.lagom" level="INFO" />
+
+  <logger name="io.grpc" level="INFO"/>
+  <logger name="io.perfmark.PerfMark" level="INFO"/>
+
+  <root level="debug">
+    <appender-ref ref="STDOUT" />
+  </root>
+</configuration>

grpc-example/grpc-example-java/hello-impl/src/test/java/com/example/hello/impl/HelloServiceTest.java

@@ -2,7 +2,7 @@
 
 import akka.grpc.GrpcClientSettings;
 import com.example.hello.api.HelloService;
-import com.lightbend.lagom.javadsl.testkit.grpc.AkkaGrpcClientHelpers;
+import com.lightbend.lagom.javadsl.testkit.ServiceTest;
 import example.myapp.helloworld.grpc.GreeterServiceClient;
 import example.myapp.helloworld.grpc.HelloReply;
 import example.myapp.helloworld.grpc.HelloRequest;
@@ -28,20 +28,16 @@ public void shouldSayHelloUsingALagomClient() throws Exception {
 
     @Test
     public void shouldSayHelloUsingGrpc() throws Exception {
-        withServer(defaultSetup().withSsl(), server -> {
-            AkkaGrpcClientHelpers
-                .withGrpcClient(
-                    server,
-                    GreeterServiceClient::create,
-                    serviceClient -> {
-                        HelloRequest request =
-                            HelloRequest.newBuilder().setName("Steve").build();
-                        HelloReply reply = serviceClient
-                            .sayHello(request)
-                            .toCompletableFuture()
-                            .get(5, SECONDS);
-                        assertEquals("Hi Steve (gRPC)", reply.getMessage());
-                    });
+        withServer(defaultSetup(), server -> {
+            GreeterServiceClient serviceClient = createServiceClient(server);
+
+            HelloRequest request =
+                    HelloRequest.newBuilder().setName("Steve").build();
+            HelloReply reply = serviceClient
+                    .sayHello(request)
+                    .toCompletableFuture()
+                    .get(5, SECONDS);
+            assertEquals("Hi Steve (gRPC)", reply.getMessage());
         });
     }
 
@@ -51,11 +47,7 @@ public void shouldSayHelloUsingGrpc() throws Exception {
     @Test
     public void shouldSayHelloUsingGrpcNoSsl() throws Exception {
         withServer(defaultSetup(), server -> {
-            GrpcClientSettings settings = GrpcClientSettings
-                    .connectToServiceAt("127.0.0.1", server.port(), server.system())
-                    .withTls(false);
-            GreeterServiceClient serviceClient = GreeterServiceClient.create(settings, server.system());
-
+            GreeterServiceClient serviceClient = createServiceClient(server);
             HelloRequest request =
                     HelloRequest.newBuilder().setName("Steve").build();
             HelloReply reply = serviceClient
@@ -66,4 +58,10 @@ public void shouldSayHelloUsingGrpcNoSsl() throws Exception {
         });
     }
 
+    private GreeterServiceClient createServiceClient(ServiceTest.TestServer server) {
+        GrpcClientSettings settings = GrpcClientSettings
+                .connectToServiceAt("127.0.0.1", server.port(), server.system())
+                .withTls(false);
+        return GreeterServiceClient.create(settings, server.system());
+    }
 }

grpc-example/grpc-example-java/hello-proxy-impl/pom.xml

@@ -69,7 +69,6 @@
                 <artifactId>lagom-maven-plugin</artifactId>
                 <configuration>
                     <lagomService>true</lagomService>
-                    <serviceEnableSsl>true</serviceEnableSsl>
                 </configuration>
             </plugin>
 

grpc-example/grpc-example-java/hello-proxy-impl/src/main/resources/application.conf

@@ -9,12 +9,12 @@ akka.grpc.client {
     service-discovery {
       mechanism = "lagom-dev-mode"
       service-name = "helloworld.GreeterService"
-      port-name = "https"
+      port-name = "http"
     }
     override-authority = "localhost"
     deadline = 5s
     connection-attempts = 5
+    use-tls = false
   }
 
 }
-

grpc-example/grpc-example-java/hello-proxy-impl/src/main/resources/logback.xml

@@ -0,0 +1,24 @@
+<configuration>
+
+  <conversionRule conversionWord="coloredLevel" converterClass="com.lightbend.lagom.internal.logback.ColoredLevel" />
+
+  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+    <encoder>
+      <pattern>%date{"HH:mm:ss.SSS"} %coloredLevel %logger [%mdc] - %msg%n</pattern>
+    </encoder>
+  </appender>
+
+  <!-- Set logging for all Play library classes to INFO -->
+  <logger name="play" level="INFO" />
+  <!-- Set logging for all Akka library classes to INFO -->
+  <logger name="akka" level="INFO" />
+  <!-- Set logging for all Lagom library classes to INFO -->
+  <logger name="com.lightbend.lagom" level="INFO" />
+
+  <logger name="io.grpc" level="INFO"/>
+  <logger name="io.perfmark.PerfMark" level="INFO"/>
+
+  <root level="debug">
+    <appender-ref ref="STDOUT" />
+  </root>
+</configuration>

grpc-example/grpc-example-java/hello-proxy-impl/src/test/java/com/example/helloproxy/impl/HelloProxyServiceImplTest.java

@@ -32,8 +32,6 @@ public class HelloProxyServiceImplTest {
     @BeforeClass
     public static void setUp() {
         ServiceTest.Setup setup = defaultSetup()
-            .withCluster(false)
-            .withSsl(false)
             .configureBuilder(builder ->
                 builder
                     .disable(AkkaGrpcClientModule.class)

grpc-example/grpc-example-java/pom.xml

@@ -36,7 +36,7 @@
                     <kafkaEnabled>false</kafkaEnabled>
                     <cassandraEnabled>false</cassandraEnabled>
                     <unmanagedServices>
-                        <helloworld.GreeterService>https://127.0.0.1:${hello-impl.https.port}</helloworld.GreeterService>
+                        <helloworld.GreeterService>http://127.0.0.1:${hello-impl.http.port}</helloworld.GreeterService>
                     </unmanagedServices>
                 </configuration>
             </plugin>
@@ -82,6 +82,6 @@
         <akka.grpc.version>1.0.2</akka.grpc.version>
         <play.grpc.version>0.9.1</play.grpc.version>
 
-        <hello-impl.https.port>11000</hello-impl.https.port>
+        <hello-impl.http.port>11000</hello-impl.http.port>
     </properties>
 </project>