Add lifecycle support to FPC client SDK (#522)

* Add lifecycle support to FPC client sdk

- Implement LifecycleInitEnclave on top of resmgmt package
- Implement NewCCPackage
- Add SGX attestation paramer API
- Integrate LifecycleInitEnclave and NewCCPackage in integration test
- Rename client_sdk/go/test to client_sdk/go/sample
- Refactor client sdk structure to be aligned with fabric client go sdk
- Update godoc and references

Signed-off-by: bur <bur@zurich.ibm.com>

Author: mbrandenburger

README.md

@@ -123,7 +123,7 @@ Additional google documents provide details on FPC 1.0:
 
 ### Source organization
 
-- [`client_sdk`](client_sdk/): The FPC Go Client SDK
+- [`client_sdk`](client_sdk/go/): The FPC Go Client SDK
 - [`cmake`](cmake/): CMake build rules shared across the project
 - [`common`](common/): Shared C/C++ code
 - [`config`](config/): SGX configuration
@@ -569,7 +569,7 @@ before designing, implementing and deploying an FPC-based solution.
 
 ### FPC Client-side SDK
 
-See **[Godocs](https://pkg.go.dev/github.com/hyperledger-labs/fabric-private-chaincode/client_sdk/go/fpc)**
+See **[Godocs](https://pkg.go.dev/github.com/hyperledger-labs/fabric-private-chaincode/client_sdk/go/)**
 for Go Client SDK.
 For the command-line invocations, use the **`fabric/bin/peer.sh`** wrapper script.
 Both make FPC related client-side encryption and decryption transparent to the user, i.e., client-side programming is mostly standard Fabric and agnostic to FPC.

client_sdk/go/Makefile

@@ -5,7 +5,7 @@
 TOP = ../..
 include $(TOP)/build.mk
 
-SUB_DIRS = fpc test
+SUB_DIRS = pkg sample
 
 all build test clean clobber:
 	$(foreach DIR, $(SUB_DIRS), $(MAKE) -C $(DIR) $@ || exit ;)

client_sdk/go/README.md

@@ -1,12 +1,11 @@
-# FPC Go SDK
-
-The FPC API is built on top of the new gateway API of the Fabric Go SDK.
-For more documentation, see [godoc](https://pkg.go.dev/github.com/hyperledger-labs/fabric-private-chaincode/client_sdk/go/fpc)
-and a [test program](./test/main.go) to illustrate it use.
-<!-- TODO: replace above reference to test program with hello world example once done ...-->
+# FPC Client SDK for Go
 
+The FPC Client SDK for Go builds on top of the [Fabric Client SDK Go](https://godoc.org/github.com/hyperledger/fabric-sdk-go).
+For more documentation, see [godoc](https://pkg.go.dev/github.com/hyperledger-labs/fabric-private-chaincode/client_sdk/go/)
+and a [sample program](./sample/main.go) to illustrate it use.
+<!-- TODO: replace above reference to sample program with hello world example once done ...-->
 
 ## Testing
-See [`test/main.go`](./test/main.go) for a simple test program and
+See [`sample/main.go`](./sample/main.go) for a simple test program and
 [integration/test-network/README.md](../../integration/test-network/README.md)
 for instructions to run it.

client_sdk/go/doc.go

@@ -0,0 +1,27 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+// Package fpcclientsdk enables Go developers to build solutions that interact with FPC chaincode for Hyperledger Fabric.
+// The FPC Client SDK builds on top of the Fabric Client SDK Go (https://godoc.org/github.com/hyperledger/fabric-sdk-go)
+// and provides FPC specific functionality such as enclave initialization and secure interaction with a FPC chaincode.
+// The main goal is to ease the interaction with a FPC chaincode and provide similar experience as offered by normal
+// chaincode interaction.
+//
+// Packages for end developer usage
+//
+// pkg/client/resmgmt: Provides resource management capabilities such as installing FPC chaincode.
+// Reference: https://godoc.org/github.com/hyperledger-labs/fabric-private-chaincode/client_sdk/go/pkg/client/resmgmt
+//
+// pkg/gateway: Enables Go developers to build client applications using the Hyperledger
+// Fabric programming model.
+// Reference: https://godoc.org/github.com/hyperledger-labs/fabric-private-chaincode/client_sdk/go/pkg/gateway
+//
+// Usage samples
+//
+// samples/main.go: Illustrates the use of the FPC Client SDK. The application can be used with the our test-network.
+// Reference: https://github.com/hyperledger-labs/fabric-private-chaincode/tree/master/integration/test-network
+//
+package fpcclientsdk

client_sdk/go/fpc/logging.go

@@ -6,11 +6,5 @@
 TOP = ../../..
 include $(TOP)/build.mk
 
-build:
-	$(GO) build
-
 test:
-	$(GO) test $(GOTAGS) -v ./...
-
-clean:
-	$(GO) clean
+	${GO} test $(GOTAGS) -race -covermode=atomic ./...