Enable CI for Ubuntu 18.04 and 20.04 + fix READMEs (#532)

* move to dual-os CI
* update README files

Signed-off-by: Bruno Vavala <bruno.vavala@intel.com>
Co-authored-by: Michael Steiner <michael.steiner@intel.com>
Co-authored-by: Marcus Brandenburger <bur@zurich.ibm.com>

Author: 3 people

.github/workflows/test.yaml

@@ -6,7 +6,19 @@ name: FPC test
 on: [push, pull_request]
 jobs:
   docker:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-18.04
+            os-version: 18.04
+            os-name: bionic
+
+          - os: ubuntu-20.04
+            os-version: 20.04
+            os-name: focal
+
     steps:
       - uses: actions/checkout@v2
         with:
@@ -16,4 +28,12 @@ jobs:
           DOCKER_DEV_CI_MODE: 1
           DOCKER_BUILDKIT: 0
           DOCKER_QUIET_BUILD: 1
-        run: make -C utils/docker run DOCKER_DEV_OPTIONAL_CMD='env DOCKER_QUIET_BUILD=1 DOCKER_BUILDKIT=0 make all clobber'
+        run: |
+            DOCKER_BUILD_OPTS="--build-arg UBUNTU_VERSION=${{ matrix.os-version }} --build-arg UBUNTU_NAME=${{ matrix.os-name }}" \
+            make -C utils/docker run DOCKER_DEV_OPTIONAL_CMD='env DOCKER_QUIET_BUILD=1 \
+                                                                  DOCKER_BUILDKIT=0 \
+                                                                  DOCKER_BUILD_OPTS="--build-arg UBUNTU_VERSION=${{ matrix.os-version }} --build-arg UBUNTU_NAME=${{ matrix.os-name }}" \
+                                                              make all clobber'
+            # we pass DOCKER_BUILD_OPTS, similar to DOCKER_QUITE_BUILD and DOCKER_BUILDKIT, to both 'make' invocations as 
+            # they are required when building the containers as part of 'make run' and when building inside the container (as part of make all)
+            # but make run does not automatically propagate environment variables to the container.

README.md

@@ -234,13 +234,11 @@ to set privileges to manage docker as a non-root user. See the
 official docker [documentation](https://docs.docker.com/install/linux/linux-postinstall/)
 for more details.
 
-We provide a docker image containing the FPC development environment. This will enable you to get a quick start to
-get FPC running.
+We provide instructions to build and run a docker image containing the FPC development environment.
 
 First make sure your host has
-* A running Docker daemon compatible with docker provided by Ubuntu
-  18.04, currently `Docker version 18.09`.  It also should use
-  `/var/run/docker.sock` as socket to interact with the daemon (or you
+* Docker 18.09 (or higher).
+  It also should use `/var/run/docker.sock` as socket to interact with the daemon (or you
   will have to override in `<absolute-project-path>/fabric-private-chaincode/config.override.mk` the default definition in make of `DOCKER_DAEMON_SOCKET`)
 * GNU make
 
@@ -304,12 +302,25 @@ Make sure that you have the following required dependencies installed:
 
 * [Go](https://golang.org/) 1.15.4 or higher
 
-* Docker 18.x and docker-compose (1.25.x or higher)
+* Docker 18.09 (or higher) and docker-compose 1.25.x (or higher)
+  Note that version from Ubuntu 18.04 is not recent enough!  To upgrade, install a recent version following the instructions from [docker.com](https://docs.docker.com/compose/install/), e.g., for version 1.25.4 execute	
+  ```bash	
+  sudo curl -L "https://github.com/docker/compose/releases/download/1.25.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose	
+  sudo chmod +x /usr/local/bin/docker-compose
+  ```
+
+  To install docker-componse 1.25.4 from [docker.com](https://docs.docker.com/compose/install/), execute
+  ```bash
+  sudo curl -L "https://github.com/docker/compose/releases/download/1.25.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+  sudo chmod +x /usr/local/bin/docker-compose
+  ``` 
 
-* yq (version 3.x. Newer versions (v4.x and higher) are currently *not* supported!)
+* yq v3.x (newer versions, v4.x and higher, are currently *not* supported!)
   You can install `yq` v3 via `go get`.
   ```bash
   GO111MODULE=on go get github.com/mikefarah/yq/v3
+  ```
+
 * Protocol Buffers
     - Protocol Buffers 3.0.x needed for the Intel SGX SDK
     - Protocol Buffers 3.11.x or higher and [Nanopb](http://github.com/nanopb/nanopb) 0.4.3
@@ -327,6 +338,7 @@ Make sure that you have the following required dependencies installed:
 * Clang-format 6.x or higher
 
 * jq
+
 * hex (for Ubuntu, found in package basez)
 
 * A recent version of [PlantUML](http://plantuml.com/), including Graphviz, for building documentation. See [Documentation](#building-documentation) for our recommendations on installing. The version available in common package repositories may be out of date.
@@ -342,7 +354,7 @@ official [documentation](https://github.com/intel/linux-sgx). Please make sure t
 SDK version as denoted above in the list of requirements.
 
 For SGX SSL, just follow the instructions on the [corresponding
-github page](https://github.com/intel/intel-sgx-Sal). In case you are
+github page](https://github.com/intel/intel-sgx-ssl). In case you are
 building for simulation mode only and do not have HW support, you
 might also want to make sure that [simulation mode is set](https://github.com/intel/intel-sgx-ssl#available-make-flags)
 when building and installing it.
@@ -379,7 +391,7 @@ export PROTOC_CMD=/usr/local/proto3/bin/protoc
 
 Clone the code and make sure it is on your `$GOPATH`. (Important: we assume in this documentation and default configuration that your `$GOPATH` has a _single_ root-directoy!)
 ```bash
-    git clone --recursive https://github.com/hyperledger-labs/fabric-private-chaincode.git $GOPATH/src/github.com/hyperledger-labs/fabric-private-chaincode
+git clone --recursive https://github.com/hyperledger-labs/fabric-private-chaincode.git $GOPATH/src/github.com/hyperledger-labs/fabric-private-chaincode
 ```
 
 #### Prepare Fabric
@@ -446,16 +458,12 @@ The current code should work behind a proxy assuming
     outlined in the Docker documentation for
     [clients](https://docs.docker.com/network/proxy/) and the
     [daemon](https://docs.docker.com/config/daemon/systemd/#httphttps-proxy).
-If you run Ubuntu 18.04, make sure you run docker 18.09 or later. Otherwise you will run into problems with DNS resolution inside the container.
+  * the docker version is correct.
+    Otherwise you may run into problems with DNS resolution inside the container.
+  * the docker-compose version is correct.
+    For example, the docker-compose from Ubuntu 18.04 (docker-compose 1.17)
+    is _not_ recent enough to understand `~/.docker/config.json` and related proxy options.
 
-You will also require a recent version of docker-compose. In particular, the docker-compose from Ubuntu 18.04
-(docker-compose 1.17) is _not_ recent enough to understand `~/.docker/config.json` and related proxy options.
-To upgrade, install a recent version following the instructions from [docker.com](https://docs.docker.com/compose/install/), e.g.,
-for version 1.25.4 execute
-```bash
-sudo curl -L "https://github.com/docker/compose/releases/download/1.25.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
-sudo chmod +x /usr/local/bin/docker-compose
-```
 Furthermore, for docker-compose networks to work properly with proxies, the `noProxy`
 variable in your `~/.docker/config.json` should at least contain `127.0.0.1,127.0.1.1,localhost,.org1.example.com,.example.com`.
 
@@ -587,7 +595,7 @@ section.
   Sorniotti: Blockchain and Trusted Computing: Problems, Pitfalls, and a
   Solution for Hyperledger Fabric. https://arxiv.org/abs/1805.08541
 
--  [Fabric Private Chaincode RFC](https://github.com/hyperledger/fabric-rfcs/blob/d1dc48ee934b1430b43f870f4d01e7f145576ec8/text/0000-fabric-private-chaincode-1.0.md) <!-- TODO: fix-me with pointer to version in fabric-rfcs once RFC is accepted ... -->
+- [Fabric Private Chaincode RFC](https://github.com/hyperledger/fabric-rfcs/blob/d1dc48ee934b1430b43f870f4d01e7f145576ec8/text/0000-fabric-private-chaincode-1.0.md) <!-- TODO: fix-me with pointer to version in fabric-rfcs once RFC is accepted ... -->
 
 - Presentation at the Hyperledger Fabric contributor meeting
   August 21, 2019.

integration/test-network/README.md

@@ -3,12 +3,8 @@
 The FPC test network builds on the test-network provided by [fabric-samples](https://github.com/hyperledger/fabric-samples).
 We provide fabric-samples as a submodule in `$FPC_PATH/integration/test-network/fabric-samples`.
 
-In order to use FPC with the test network, make sure you have installed [yq](https://github.com/mikefarah/yq) (version 3.x).
-Not that newer versions (v4.x and higher) are currently not supported.
-You can install `yq` v3 via `go get`.
-```bash
-GO111MODULE=on go get github.com/mikefarah/yq/v3
-```
+Before moving forward, follow the main [README](../../README.md) to set up your environment.
+
 ## Prepare FPC containers and network
 
 Before you start the network make sure you build ercc and ecc containers:

utils/docker/base-rt/Dockerfile

@@ -8,7 +8,7 @@
 #
 #  Configuration (build) paramaters (for defaults, see below section with ARGs)
 #  - ubuntu version to use:     UBUNTU_VERSION
-#  - ubuntu name to use:        UBUNTU_VERSION
+#  - ubuntu name to use:        UBUNTU_NAME
 #  - sgx sdk/psw version:       SGX
 #  - protobuf version:          PROTO_VERSION
 #  - additional apt pkgs:       APT_ADD_PKGS