Add a brief example for the -as-a-service

Signed-off-by: Matthew B White <[email protected]>

Author: mbwhite

examples/fabric-contract-example-as-service/Dockerfile

@@ -0,0 +1,26 @@
+# Copyright 2019 IBM All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+# Example multi-stage dockerfile for Java Chaincode
+
+# the first stage 
+FROM gradle:jdk11 AS GRADLE_BUILD
+ 
+# copy the build.gradle and src code to the container
+COPY src/ src/
+COPY build.gradle ./ 
+
+# Build and package our code
+RUN gradle build shadowJar
+
+
+# the second stage of our build just needs the compiled files
+FROM openjdk:11-jre-slim
+# copy only the artifacts we need from the first stage and discard the rest
+COPY --from=GRADLE_BUILD /home/gradle/build/libs/chaincode.jar /chaincode.jar
+ 
+ENV PORT 9999
+EXPOSE 9999
+
+# set the startup command to execute the jar
+CMD ["java", "-jar", "/chaincode.jar"]

examples/fabric-contract-example-as-service/README.md

@@ -0,0 +1,40 @@
+# Java Chaincode -as-a-service
+
+This example shows how to start the chaincode in it's 'as-a-service' mode.
+Note that this has been improved over the original mechanism
+
+## Build Changes
+
+There are no changes required to tbe build file. For example the `build.gradle` can be left like this
+
+```
+    manifest {
+        attributes 'Main-Class': 'org.hyperledger.fabric.contract.ContractRouter'
+    }
+```
+
+## Contract Code
+
+No changes are required to the contract code. Note that the previous 'bootstrap' main method is not required.
+
+## Environment Variables
+
+The setting of the `CHAINCODE_SERVER_ADDRESS` environment variable will trigger the code to work in the 'as-a-service' mode.  This should be set to the hostname:port that the server will be exposed on.  Typically this would be
+
+```
+CHAINCODE_SERVER_ADDRESS=0.0.0.0:9999
+```
+
+*NOTE* if `CHAINCODE_SERVER_ADDRESS` is set, and the chaincode is deployed as a regular chaincode, this will result in a failure. The chaincode will still start in 'as-a-service' mode.
+
+The `CORE_CHAINCODE_ID_NAME` must also be set to match the ID used when deploying the chaincode.
+
+*For TLS* ensure that 
+- `CORE_PEERT_TLS_ENABLED` is true
+- `CORE_PEER_TLS_ROOTCERT_FILE` is set to the certificate of the root CA
+- `CORE_TLS_CLIENT_KEY_FILE` and `CORE_TLS_CLIENT_CERT_FILE` if using mutual TLS (PEM encoded)
+
+
+## Dockerfile
+
+There is an example dockerfile that shows how the chaincode can be built into a container image.

examples/fabric-contract-example-external/build.gradle renamed to examples/fabric-contract-example-as-service/build.gradle

@@ -15,6 +15,8 @@
 import java.io.InputStream;
 import java.net.InetSocketAddress;
 import java.net.SocketAddress;
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 import java.security.Security;
@@ -25,7 +27,9 @@
 import java.util.logging.Logger;
 import java.util.logging.SimpleFormatter;
 
-import io.grpc.stub.StreamObserver;
+import com.google.protobuf.InvalidProtocolBufferException;
+import com.google.protobuf.util.JsonFormat;
+
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.DefaultParser;
 import org.apache.commons.cli.Options;
@@ -38,16 +42,14 @@
 import org.hyperledger.fabric.protos.peer.ChaincodeShim.ChaincodeMessage;
 import org.hyperledger.fabric.shim.impl.ChaincodeSupportClient;
 import org.hyperledger.fabric.shim.impl.InvocationTaskManager;
-
-import com.google.protobuf.InvalidProtocolBufferException;
-import com.google.protobuf.util.JsonFormat;
+import org.hyperledger.fabric.traces.Traces;
 
 import io.grpc.ManagedChannelBuilder;
 import io.grpc.netty.shaded.io.grpc.netty.GrpcSslContexts;
 import io.grpc.netty.shaded.io.grpc.netty.NegotiationType;
 import io.grpc.netty.shaded.io.grpc.netty.NettyChannelBuilder;
 import io.grpc.netty.shaded.io.netty.handler.ssl.SslContext;
-import org.hyperledger.fabric.traces.Traces;
+import io.grpc.stub.StreamObserver;
 
 /**
  * Abstract implementation of {@link Chaincode}.
@@ -348,21 +350,20 @@ private Level mapLevel(final String level) {
     }
 
 
-    private SocketAddress parseHostPort(final String hostAddrStr) {
-        String[] hostArr = hostAddrStr.split(":");
-        String h;
-        int p;
+    private SocketAddress parseHostPort(final String hostAddrStr) throws URISyntaxException {
 
-        if (hostArr.length == 2) {
-            p = Integer.valueOf(hostArr[1].trim());
-            h = hostArr[0].trim();
-        } else {
-            final String msg = String.format(
-                    "peer address argument should be in host:port format, current %s in wrong", hostAddrStr);
-            LOGGER.severe(msg);
-            throw new IllegalArgumentException(msg);
+        // WORKAROUND: add any scheme to make the resulting URI valid.
+        URI uri = new URI("my://" + hostAddrStr); // may throw URISyntaxException
+        String host = uri.getHost();
+        int port = uri.getPort();
+
+        if (uri.getHost() == null || uri.getPort() == -1) {
+            throw new URISyntaxException(uri.toString(),
+            "URI must have host and port parts");
         }
-        return new InetSocketAddress(h, p);
+
+        // validation succeeded
+        return new InetSocketAddress(host, port);
     }
 
     /**
@@ -530,7 +531,7 @@ public Properties getChaincodeConfig() {
      *
      * @return ChaincodeServerProperties populated
      */
-    public final ChaincodeServerProperties getChaincodeServerConfig() {
+    public final ChaincodeServerProperties getChaincodeServerConfig() throws URISyntaxException {
         ChaincodeServerProperties chaincodeServerProperties = new ChaincodeServerProperties();
 
         chaincodeServerProperties.setServerAddress(parseHostPort(chaincodeServerAddress));

examples/fabric-contract-example-external/src/main/java/org/example/contract/MyAsset.java renamed to examples/fabric-contract-example-as-service/src/main/java/org/example/contract/MyAsset.java

@@ -14,6 +14,7 @@
 import org.junit.jupiter.api.Test;
 
 import java.io.IOException;
+import java.net.URISyntaxException;
 
 class ChaincodeServerImplTest {
     @Rule
@@ -82,7 +83,7 @@ void startAndStop() {
             }
 
             chaincodeServer.stop();
-        } catch (IOException e) {
+        } catch (IOException | URISyntaxException e) {
             e.printStackTrace();
         }
     }

examples/fabric-contract-example-external/src/main/java/org/example/contract/MyAssetContract.java renamed to examples/fabric-contract-example-as-service/src/main/java/org/example/contract/MyAssetContract.java

@@ -16,6 +16,7 @@
 import org.junit.jupiter.api.Test;
 
 import java.io.IOException;
+import java.net.URISyntaxException;
 import java.util.Properties;
 
 class NettyGrpcServerTest {
@@ -50,7 +51,7 @@ void initNoTls() {
             final ChaincodeBase chaincodeBase = new EmptyChaincode();
             chaincodeBase.processEnvironmentOptions();
             ChaincodeServer chaincodeServer = new NettyChaincodeServer(chaincodeBase, chaincodeBase.getChaincodeServerConfig());
-        } catch (IOException e) {
+        } catch (IOException | URISyntaxException e) {
             e.printStackTrace();
         }
     }
@@ -172,7 +173,7 @@ void initEnvNotSet() {
     }
 
     @Test
-    void initEnvSetPortChaincodeServerAndCoreChaincodeIdName() throws IOException {
+    void initEnvSetPortChaincodeServerAndCoreChaincodeIdName() throws IOException, URISyntaxException {
         clearEnv();
         environmentVariables.set("CORE_CHAINCODE_ID_NAME", "mycc");
         environmentVariables.set("CHAINCODE_SERVER_ADDRESS", "0.0.0.0:9999");
@@ -214,7 +215,7 @@ void startAndStopSetCoreChaincodeIdName() {
             }
 
             chaincodeServer.stop();
-        } catch (IOException e) {
+        } catch (IOException | URISyntaxException  e) {
             e.printStackTrace();
         }
     }
@@ -239,7 +240,7 @@ void startAndStop() {
             }
 
             chaincodeServer.stop();
-        } catch (IOException e) {
+        } catch (IOException | URISyntaxException e) {
             e.printStackTrace();
         }
     }
@@ -269,7 +270,7 @@ void startAndStopTlsPassword() {
             }
 
             chaincodeServer.stop();
-        } catch (IOException e) {
+        } catch (IOException | URISyntaxException e) {
             e.printStackTrace();
         }
     }
@@ -298,7 +299,7 @@ void startAndStopTlsWithoutPassword() {
             }
 
             chaincodeServer.stop();
-        } catch (IOException e) {
+        } catch (IOException | URISyntaxException e) {
             e.printStackTrace();
         }
     }