v2 implementation based on fabric-chaincode-go/v2 (#137)

The v2 implementation retains wire-level compatibility with Fabric but does include the following breaking changes: - Chaincode implementations that make direct use of fabric-protos-go will experience protocol buffer namespace conflicts (as described in https://protobuf.dev/reference/go/faq/). Any use of fabric-protos-go must be replaced by fabric-protos-go-apiv2. Signed-off-by: Mark S. Lewis <[email protected]>
hyperledger · Jun 20, 2024 · b8b28e7 · b8b28e7
1 parent 66f7b67
commit b8b28e7
Show file tree

Hide file tree

Showing 83 changed files with 17,018 additions and 114 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -8,93 +8,11 @@ on:
   workflow_call:
 
 jobs:
-  license_check:
-    name: License check
-    runs-on: ubuntu-22.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 16
-          registry-url: "https://npm.pkg.github.com"
-      - name: install Tools
-        run: |
-          npm install -g [email protected]
-      - name: Check Licenses
-        run: license-check-and-add check -f ci/license-config.json
+  checks:
+    uses: ./.github/workflows/check.yml
 
-  tutorial:
-    name: Check tutorial
-    runs-on: ubuntu-22.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-go@v5
-        with:
-          go-version: "1.21"
-      - name: Check tutorial contents
-        run: ci/scripts/tutorial-checks.sh
+  test-v1:
+    uses: ./.github/workflows/test-v1.yml
 
-  lint:
-    name: Lint
-    runs-on: ubuntu-22.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-go@v5
-        with:
-          go-version: "1.21"
-      - name: Staticcheck
-        run: make staticcheck
-      - name: golangci-lint
-        uses: golangci/golangci-lint-action@v6
-        with:
-          version: latest
-
-  unit_test:
-    name: Unit test
-    runs-on: ubuntu-22.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-go@v5
-        with:
-          go-version: "1.21"
-      - name: Run tests (excluding fv)
-        run: make unit-test
-
-  functional_test:
-    name: Functional test
-    runs-on: ubuntu-22.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-go@v5
-        with:
-          go-version: "1.21"
-      - name: Run functional tests
-        run: make functional-test
-
-  integration_test:
-    name: Integration test
-    runs-on: ubuntu-22.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-go@v5
-        with:
-          go-version: "1.21"
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 16
-          registry-url: "https://npm.pkg.github.com"
-      - name: Run the integration tests
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          docker build . --file integrationtest/Dockerfile --tag hyperledger/fabric-contract-api-go-integrationtest
-
-          ci/scripts/setup-integration-chaincode.sh
-
-          curl -sSL https://raw.githubusercontent.com/hyperledger/fabric/main/scripts/install-fabric.sh | bash -s -- samples binary docker
-          export TEST_NETWORK_DIR=$(pwd)/fabric-samples/test-network
-
-          cd ./integrationtest
-          npm ci
-
-          npx fabric-chaincode-integration run
+  test-v2:
+    uses: ./.github/workflows/test-v2.yml
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -0,0 +1,19 @@
+# Copyright the Hyperledger Fabric contributors. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+name: Checks
+
+on:
+  workflow_call:
+
+jobs:
+  tutorial:
+    name: Check tutorial
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.21"
+      - name: Check tutorial contents
+        run: ci/scripts/tutorial-checks.sh
diff --git a/.github/workflows/test-v1.yml b/.github/workflows/test-v1.yml
@@ -0,0 +1,73 @@
+# Copyright the Hyperledger Fabric contributors. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+name: Test (v1)
+
+on:
+  workflow_call:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.21"
+      - name: Staticcheck
+        run: make -f Makefile.v1 staticcheck
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: latest
+
+  unit_test:
+    name: Unit test
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.21"
+      - name: Run tests (excluding fv)
+        run: make -f Makefile.v1 unit-test
+
+  functional_test:
+    name: Functional test
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.21"
+      - name: Run functional tests
+        run: make -f Makefile.v1 functional-test
+
+  integration_test:
+    name: Integration test
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.21"
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 16
+          registry-url: "https://npm.pkg.github.com"
+      - name: Run the integration tests
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          docker build . --file integrationtest/Dockerfile --tag hyperledger/fabric-contract-api-go-integrationtest
+
+          ci/scripts/setup-integration-chaincode.sh
+
+          curl -sSL https://raw.githubusercontent.com/hyperledger/fabric/main/scripts/install-fabric.sh | bash -s -- samples binary docker
+          export TEST_NETWORK_DIR=$(pwd)/fabric-samples/test-network
+
+          cd ./integrationtest
+          npm ci
+
+          npx fabric-chaincode-integration run
diff --git a/.github/workflows/test-v2.yml b/.github/workflows/test-v2.yml
@@ -0,0 +1,74 @@
+# Copyright the Hyperledger Fabric contributors. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+name: Test (v2)
+
+on:
+  workflow_call:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.21"
+      - name: Staticcheck
+        run: make staticcheck
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: latest
+          working-directory: v2
+
+  unit_test:
+    name: Unit test
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.21"
+      - name: Run tests (excluding fv)
+        run: make unit-test
+
+  functional_test:
+    name: Functional test
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.21"
+      - name: Run functional tests
+        run: make functional-test
+
+  integration_test:
+    name: Integration test
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.21"
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 16
+          registry-url: "https://npm.pkg.github.com"
+      - name: Run the integration tests
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          docker build . --file integrationtest/Dockerfile --tag hyperledger/fabric-contract-api-go-integrationtest
+
+          ci/scripts/setup-integration-chaincode.sh
+
+          curl -sSL https://raw.githubusercontent.com/hyperledger/fabric/main/scripts/install-fabric.sh | bash -s -- samples binary docker
+          export TEST_NETWORK_DIR=$(pwd)/fabric-samples/test-network
+
+          cd ./integrationtest
+          npm ci
+
+          npx fabric-chaincode-integration run
diff --git a/.golangci.yml b/.golangci.yml
@@ -9,6 +9,7 @@ linters:
     - errcheck
     - gocyclo
     - gofmt
+    - goheader
     - goimports
     - gosec
     - gosimple
@@ -21,3 +22,7 @@ linters:
 linters-settings:
   gocyclo:
     min-complexity: 18
+  goheader:
+    template: |-
+      Copyright the Hyperledger Fabric contributors. All rights reserved.
+      SPDX-License-Identifier: Apache-2.0
diff --git a/Makefile b/Makefile
@@ -1,17 +1,24 @@
 # Copyright the Hyperledger Fabric contributors. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-base_dir := $(patsubst %/,%,$(dir $(realpath $(lastword $(MAKEFILE_LIST)))))
+base_dir := $(patsubst %/,%,$(dir $(realpath $(lastword $(MAKEFILE_LIST)))))/v2
 functional_dir := $(base_dir)/internal/functionaltests
 go_bin_dir := $(shell go env GOPATH)/bin
 
+mockery_version := 2.43.2
+kernel_name := $(shell uname -s)
+machine_hardware := $(shell uname -m)
+
+.PHONY: test
+test: generate lint unit-test functional-test
+
 .PHONY: lint
 lint: staticcheck golangci-lint
 
 .PHONY: staticcheck
 staticcheck:
 	go install honnef.co/go/tools/cmd/staticcheck@latest
-	staticcheck -f stylish './...'
+	cd '$(base_dir)' && staticcheck -f stylish ./...
 
 .PHONY: install-golangci-lint
 install-golangci-lint:
@@ -22,11 +29,24 @@ $(go_bin_dir)/golangci-lint:
 
 .PHONY: golangci-lint
 golangci-lint: $(go_bin_dir)/golangci-lint
-	golangci-lint run
+	cd '$(base_dir)' && golangci-lint run
+
+.PHONY: install-mockery
+install-mockery:
+	curl --fail --location \
+		'https://github.com/vektra/mockery/releases/download/v$(mockery_version)/mockery_$(mockery_version)_$(kernel_name)_$(machine_hardware).tar.gz' \
+		| tar -C '$(go_bin_dir)' -xzf - mockery
+
+$(go_bin_dir)/mockery:
+	$(MAKE) install-mockery
+
+.PHONY: generate
+generate: $(go_bin_dir)/mockery
+	cd '$(base_dir)' && mockery
 
 .PHONY: unit-test
 unit-test:
-	go test -race $$(go list '$(base_dir)/...' | grep -v functionaltests)
+	cd '$(base_dir)' && go test -race $$(go list ./... | grep -v functionaltests)
 
 .PHONY: functional-test
 functional-test:
@@ -36,4 +56,4 @@ functional-test:
 .PHONY: scan
 scan:
 	go install golang.org/x/vuln/cmd/govulncheck@latest
-	govulncheck '$(base_dir)/...'
+	cd '$(base_dir)' && govulncheck ./...
diff --git a/Makefile.v1 b/Makefile.v1
@@ -0,0 +1,42 @@
+# Copyright the Hyperledger Fabric contributors. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+base_dir := $(patsubst %/,%,$(dir $(realpath $(lastword $(MAKEFILE_LIST)))))
+functional_dir := $(base_dir)/internal/functionaltests
+go_bin_dir := $(shell go env GOPATH)/bin
+
+.PHONY: test
+test: lint unit-test functional-test
+
+.PHONY: lint
+lint: staticcheck golangci-lint
+
+.PHONY: staticcheck
+staticcheck:
+	go install honnef.co/go/tools/cmd/staticcheck@latest
+	cd '$(base_dir)' && staticcheck -f stylish ./...
+
+.PHONY: install-golangci-lint
+install-golangci-lint:
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b '$(go_bin_dir)'
+
+$(go_bin_dir)/golangci-lint:
+	$(MAKE) install-golangci-lint
+
+.PHONY: golangci-lint
+golangci-lint: $(go_bin_dir)/golangci-lint
+	cd '$(base_dir)' && golangci-lint run
+
+.PHONY: unit-test
+unit-test:
+	cd '$(base_dir)' && go test -race $$(go list ./... | grep -v functionaltests)
+
+.PHONY: functional-test
+functional-test:
+	go install github.com/cucumber/godog/cmd/[email protected]
+	cd '$(functional_dir)' && godog run features/*
+
+.PHONY: scan
+scan:
+	go install golang.org/x/vuln/cmd/govulncheck@latest
+	cd '$(base_dir)' && govulncheck ./...