Fix staticcheck checks

staticcheck was only being run against the root directory, which contains no Go files. Change to run recurseively so code is actually checked.

For now, disable checks for missing package documentation.

Fix staticcheck failures and remove use of unnecessary github.com/pkg/errors package.

Disable fail-fast for golang test matrix so all test results can be viewed, even if one fails.

Signed-off-by: Mark S. Lewis <[email protected]>

Author: bestbeforetoday

.github/workflows/golang.yml

@@ -31,8 +31,9 @@ jobs:
   end-to-end:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        FABRIC_VERSION: [2.4.8, 2.5.0-beta]
+        FABRIC_VERSION: ['2.4.8', '2.5.0-beta']
         CREATE_CHANNEL: [create_channel, existing_create_channel]
     steps:
       - uses: actions/checkout@v3

Makefile

@@ -22,7 +22,7 @@ lint: staticcheck golangci-lint
 .PHONEY: staticcheck
 staticcheck:
 	go install honnef.co/go/tools/cmd/staticcheck@latest
-	staticcheck -f stylish '$(base_dir)'
+	staticcheck -f stylish '$(base_dir)/...'
 
 .PHONEY: golangci-lint
 golangci-lint:

go.mod

@@ -16,6 +16,7 @@ require (
 	github.com/onsi/ginkgo/v2 v2.5.0
 	github.com/onsi/gomega v1.24.0
 	github.com/opentracing/opentracing-go v1.2.0
+	github.com/pkg/errors v0.9.1
 	google.golang.org/grpc v1.52.3
 	google.golang.org/protobuf v1.28.1
 	gopkg.in/yaml.v2 v2.4.0
@@ -45,7 +46,6 @@ require (
 	github.com/miekg/pkcs11 v1.1.1 // indirect
 	github.com/pelletier/go-toml v1.8.0 // indirect
 	github.com/pierrec/lz4/v4 v4.1.14 // indirect
-	github.com/pkg/errors v0.9.1 // indirect
 	github.com/rcrowley/go-metrics v0.0.0-20201227073835-cf1acfcdf475 // indirect
 	github.com/spf13/afero v1.3.1 // indirect
 	github.com/spf13/cast v1.4.1 // indirect

internal/channelconfig/channelconfig.go

@@ -64,7 +64,7 @@ func (scv *StandardConfigValue) Value() proto.Message {
 	return scv.value
 }
 
-// HashingAlgorithm returns the only currently valid hashing algorithm.
+// HashingAlgorithmValue returns the only currently valid hashing algorithm.
 // It is a value for the /Channel group.
 func HashingAlgorithmValue() *StandardConfigValue {
 	return &StandardConfigValue{

internal/configtxgen/encoder/encoder.go

@@ -226,7 +226,7 @@ func NewOrdererGroup(conf *genesisconfig.Orderer) (*cb.ConfigGroup, error) {
 	return ordererGroup, nil
 }
 
-// NewConsortiumsGroup returns an org component of the channel configuration.  It defines the crypto material for the
+// NewConsortiumOrgGroup returns an org component of the channel configuration.  It defines the crypto material for the
 // organization (its MSP).  It sets the mod_policy of all elements to "Admins".
 func NewConsortiumOrgGroup(conf *genesisconfig.Organization) (*cb.ConfigGroup, error) {
 	consortiumsOrgGroup := NewConfigGroup()
@@ -364,7 +364,7 @@ func NewConsortiumsGroup(conf map[string]*genesisconfig.Consortium) (*cb.ConfigG
 	return consortiumsGroup, nil
 }
 
-// NewConsortiums returns a consortiums component of the channel configuration.  Each consortium defines the organizations which may be involved in channel
+// NewConsortiumGroup returns a consortiums component of the channel configuration.  Each consortium defines the organizations which may be involved in channel
 // creation, as well as the channel creation policy the orderer checks at channel creation time to authorize the action.  It sets the mod_policy of all
 // elements to "/Channel/Orderer/Admins".
 func NewConsortiumGroup(conf *genesisconfig.Consortium) (*cb.ConfigGroup, error) {

internal/configtxgen/genesisconfig/config.go

@@ -210,13 +210,13 @@ func LoadTopLevel(configPaths ...string) *TopLevel {
 
 	err := config.ReadInConfig()
 	if err != nil {
-		panic(fmt.Errorf("Error reading configuration: %w", err))
+		panic(fmt.Errorf("error reading configuration: %w", err))
 	}
 	log.Printf("Using config file: %s", config.ConfigFileUsed())
 
 	uconf, err := cache.load(config, config.ConfigFileUsed())
 	if err != nil {
-		panic(fmt.Errorf("Error reading configuration: %w", err))
+		panic(fmt.Errorf("error reading configuration: %w", err))
 	}
 	uconf.completeInitialization(filepath.Dir(config.ConfigFileUsed()))
 	fmt.Printf("Loaded configuration: %s", config.ConfigFileUsed())
@@ -241,7 +241,7 @@ func Load(profile string, configPaths ...string) (*Profile, error) {
 
 	uconf, err := cache.load(config, config.ConfigFileUsed())
 	if err != nil {
-		panic(fmt.Errorf("Error loading config from config cache: %w", err))
+		panic(fmt.Errorf("error loading config from config cache: %w", err))
 	}
 
 	result, ok := uconf.Profiles[profile]
@@ -450,7 +450,7 @@ func (c *configCache) load(config *viperutil.ConfigParser, configPath string) (*
 	if !ok {
 		err := config.EnhancedExactUnmarshal(conf)
 		if err != nil {
-			return nil, fmt.Errorf("Error unmarshalling config into struct: %s", err)
+			return nil, fmt.Errorf("error unmarshalling config into struct: %s", err)
 		}
 
 		serializedConf, err = json.Marshal(conf)

internal/configtxgen/viperutil/config_util.go

@@ -291,7 +291,7 @@ func stringFromFileDecodeHook(f reflect.Kind, t reflect.Kind, data interface{})
 			return string(bytes), nil
 		case ok:
 			// fileName was nil
-			return nil, fmt.Errorf("Value of File: was nil")
+			return nil, fmt.Errorf("value of File: was nil")
 		}
 	}
 	return data, nil
@@ -349,7 +349,7 @@ func pemBlocksFromFileDecodeHook(f reflect.Kind, t reflect.Kind, data interface{
 			return result, nil
 		case ok:
 			// fileName was nil
-			return nil, fmt.Errorf("Value of File: was nil")
+			return nil, fmt.Errorf("value of File: was nil")
 		}
 	}
 	return data, nil
@@ -379,7 +379,7 @@ func kafkaVersionDecodeHook(f reflect.Type, t reflect.Type, data interface{}) (i
 
 	v, err := version.NewVersion(data.(string))
 	if err != nil {
-		return nil, fmt.Errorf("Unable to parse Kafka version: %s", err)
+		return nil, fmt.Errorf("unable to parse Kafka version: %s", err)
 	}
 
 	for kafkaVersion, constraints := range kafkaVersionConstraints {
@@ -388,7 +388,7 @@ func kafkaVersionDecodeHook(f reflect.Type, t reflect.Type, data interface{}) (i
 		}
 	}
 
-	return nil, fmt.Errorf("Unsupported Kafka version: '%s'", data)
+	return nil, fmt.Errorf("unsupported Kafka version: '%s'", data)
 }
 
 func bccspHook(f reflect.Type, t reflect.Type, data interface{}) (interface{}, error) {

internal/osnadmin/join.go

@@ -15,7 +15,7 @@ import (
 	"net/http"
 )
 
-// Joins an OSN to a new or existing channel.
+// Join an OSN to a new or existing channel.
 func Join(osnURL string, blockBytes []byte, caCertPool *x509.CertPool, tlsClientCert tls.Certificate) (*http.Response, error) {
 	url := fmt.Sprintf("%s/participation/v1/channels", osnURL)
 	req, err := createJoinRequest(url, blockBytes)

internal/osnadmin/list.go

@@ -13,14 +13,14 @@ import (
 	"net/http"
 )
 
-// Lists the channels an OSN is a member of.
+// ListAllChannels that an OSN is a member of.
 func ListAllChannels(osnURL string, caCertPool *x509.CertPool, tlsClientCert tls.Certificate) (*http.Response, error) {
 	url := fmt.Sprintf("%s/participation/v1/channels", osnURL)
 
 	return httpGet(url, caCertPool, tlsClientCert)
 }
 
-// Lists a single channel an OSN is a member of.
+// ListSingleChannel that an OSN is a member of.
 func ListSingleChannel(osnURL, channelID string, caCertPool *x509.CertPool, tlsClientCert tls.Certificate) (*http.Response, error) {
 	url := fmt.Sprintf("%s/participation/v1/channels/%s", osnURL, channelID)
 

internal/osnadmin/remove.go

@@ -13,7 +13,7 @@ import (
 	"net/http"
 )
 
-// Removes an OSN from an existing channel.
+// Remove an OSN from an existing channel.
 func Remove(osnURL, channelID string, caCertPool *x509.CertPool, tlsClientCert tls.Certificate) (*http.Response, error) {
 	url := fmt.Sprintf("%s/participation/v1/channels/%s", osnURL, channelID)
 

internal/policies/policies.go

@@ -18,7 +18,7 @@ type ConfigPolicy interface {
 	Value() *cb.Policy
 }
 
-// StandardConfigValue implements the ConfigValue interface.
+// StandardConfigPolicy implements the ConfigPolicy interface.
 type StandardConfigPolicy struct {
 	key   string
 	value *cb.Policy

internal/policydsl/policydsl.go

@@ -251,7 +251,7 @@ func secondPass(args ...interface{}) (interface{}, error) {
 	}
 
 	/* get the n in the t out of n */
-	var n int = len(args) - 2
+	n := len(args) - 2
 
 	/* sanity check - t should be positive, permit equal to n+1, but disallow over n+1 */
 	if t < 0 || t > n+1 {

internal/protoutil/unmarshalers.go

@@ -1,38 +1,44 @@
 package protoutil
 
 import (
+	"fmt"
+
 	cb "github.com/hyperledger/fabric-protos-go-apiv2/common"
-	"github.com/pkg/errors"
 	"google.golang.org/protobuf/proto"
 )
 
 // UnmarshalEnvelope unmarshals bytes to a Envelope
 func UnmarshalEnvelope(encoded []byte) (*cb.Envelope, error) {
 	envelope := &cb.Envelope{}
-	err := proto.Unmarshal(encoded, envelope)
-	return envelope, errors.Wrap(err, "error unmarshaling Envelope")
+	if err := proto.Unmarshal(encoded, envelope); err != nil {
+		return nil, fmt.Errorf("error unmarshaling Envelope: %w", err)
+	}
+	return envelope, nil
 }
 
 // UnmarshalPayload unmarshals bytes to a Payload
 func UnmarshalPayload(encoded []byte) (*cb.Payload, error) {
 	payload := &cb.Payload{}
-	err := proto.Unmarshal(encoded, payload)
-	return payload, errors.Wrap(err, "error unmarshaling Payload")
+	if err := proto.Unmarshal(encoded, payload); err != nil {
+		return nil, fmt.Errorf("error unmarshaling Payload: %w", err)
+	}
+	return payload, nil
 }
 
 // UnmarshalChannelHeader unmarshals bytes to a ChannelHeader
 func UnmarshalChannelHeader(bytes []byte) (*cb.ChannelHeader, error) {
 	chdr := &cb.ChannelHeader{}
-	err := proto.Unmarshal(bytes, chdr)
-	return chdr, errors.Wrap(err, "error unmarshaling ChannelHeader")
+	if err := proto.Unmarshal(bytes, chdr); err != nil {
+		return nil, fmt.Errorf("error unmarshaling ChannelHeader: %w", err)
+	}
+	return chdr, nil
 }
 
 // UnmarshalConfigUpdateEnvelope attempts to unmarshal bytes to a *cb.ConfigUpdate
 func UnmarshalConfigUpdateEnvelope(data []byte) (*cb.ConfigUpdateEnvelope, error) {
 	configUpdateEnvelope := &cb.ConfigUpdateEnvelope{}
-	err := proto.Unmarshal(data, configUpdateEnvelope)
-	if err != nil {
-		return nil, err
+	if err := proto.Unmarshal(data, configUpdateEnvelope); err != nil {
+		return nil, fmt.Errorf("error unmarshaling ConfigUpdateEnvelope: %w", err)
 	}
 	return configUpdateEnvelope, nil
 }

pkg/chaincode/approve_test.go

@@ -55,7 +55,7 @@ func NewEndorseResponse(channelName string, result string) *gateway.EndorseRespo
 	}
 }
 
-func NewEvaluateResponse(channelName string, result string) *gateway.EvaluateResponse {
+func NewEvaluateResponse(result string) *gateway.EvaluateResponse {
 	return &gateway.EvaluateResponse{
 		Result: &peer.Response{
 			Payload: []byte(result),

pkg/chaincode/chaincodeCCAAS.go

@@ -11,9 +11,9 @@ import (
 
 // Connection setting used in connection.json
 type Connection struct {
-	Address      string `json:"address"`
-	Dial_timeout string `json:"dial_timeout"`
-	Tls_required bool   `json:"tls_required"`
+	Address     string `json:"address"`
+	DialTimeout string `json:"dial_timeout"`
+	TLSRequired bool   `json:"tls_required"`
 }
 
 // Metadata as metadata.json
@@ -23,7 +23,7 @@ type Metadata struct {
 }
 
 /*
-To use PackageCCAAS you need to start container by yourself. as sample as
+PackageCCAAS requires that you start a container by yourself. as sample as
 ${CONTAINER_CLI} run --rm -d --name peer0org1_${CC_NAME}_ccaas  \
 --network fabric_test \
 -e CHAINCODE_SERVER_ADDRESS=0.0.0.0:${CCAAS_SERVER_PORT} \

pkg/chaincode/chaincodeCCAAS_test.go

@@ -16,9 +16,9 @@ import (
 var _ = Describe("Package", func() {
 	It("CCaaS", func() {
 		dummyConnection := Connection{
-			Address:      "127.0.0.1:8080",
-			Dial_timeout: "10s",
-			Tls_required: false,
+			Address:     "127.0.0.1:8080",
+			DialTimeout: "10s",
+			TLSRequired: false,
 		}
 		dummyMeta := Metadata{
 			Type:  "ccaas",

pkg/chaincode/lifecycle.go

@@ -29,7 +29,7 @@ const (
 	CodePackageFile = "code.tar.gz"
 )
 
-// Chaincode Define
+// Definition of a chaincode
 type Definition struct {
 	ChannelName         string
 	PackageID           string
@@ -45,16 +45,16 @@ type Definition struct {
 
 func (d *Definition) Validate() error {
 	if d.ChannelName == "" {
-		return fmt.Errorf("For channel approve/commit channel name is required")
+		return fmt.Errorf("channel name is required for channel approve/commit")
 	}
 	if d.Name == "" {
-		return fmt.Errorf("For channel approve/commit chaincode name is required")
+		return fmt.Errorf("chaincode name is required for channel approve/commit")
 	}
 	if d.Version == "" {
-		return fmt.Errorf("For channel approve/commit chaincode version is required")
+		return fmt.Errorf("chaincode version is required for channel approve/commit")
 	}
-	if d.Sequence == 0 {
-		return fmt.Errorf("For channel approve/commit chaincode Sequence is required as bigger than 0")
+	if d.Sequence <= 0 {
+		return fmt.Errorf("chaincode sequence must be greater than 0 for channel approve/commit")
 	}
 	return nil
 }

pkg/chaincode/lifecycle_test.go

@@ -31,7 +31,7 @@ var _ = Describe("Lifecycle", func() {
 			Expect(err).To(HaveOccurred())
 		})
 
-		It("Validate Sequence", func() {
+		It("Validate missing / zero Sequence", func() {
 			chaincodeDefinition := &chaincode.Definition{
 				Name:        "CHAINCODE",
 				Version:     "1.0",
@@ -41,6 +41,17 @@ var _ = Describe("Lifecycle", func() {
 			Expect(err).To(HaveOccurred())
 		})
 
+		It("Validate negative Sequence", func() {
+			chaincodeDefinition := &chaincode.Definition{
+				Name:        "CHAINCODE",
+				Version:     "1.0",
+				Sequence:    -1,
+				ChannelName: "mycc",
+			}
+			err := chaincodeDefinition.Validate()
+			Expect(err).To(HaveOccurred())
+		})
+
 		It("Pass validation", func() {
 			chaincodeDefinition := &chaincode.Definition{
 				Name:        "CHAINCODE",

pkg/chaincode/packageID.go

@@ -25,7 +25,7 @@ func PackageID(PackageFile string) (string, error) {
 	return packageID, nil
 }
 
-// PackageID returns the package ID with the label and hash of the chaincode install package
+// GetPackageID returns the package ID with the label and hash of the chaincode install package
 func GetPackageID(label string, ccInstallPkg []byte) string {
 	h := sha256.New()
 	h.Write(ccInstallPkg)

pkg/chaincode/querycommitted_test.go

@@ -35,7 +35,7 @@ var _ = Describe("QueryCommitted", func() {
 			Invoke(gomock.Any(), gomock.Eq(gatewayEvaluateMethod), gomock.Any(), gomock.Any(), gomock.Any()).
 			Do(func(ctx context.Context, method string, in *gateway.EvaluateRequest, out *gateway.EvaluateResponse, opts ...grpc.CallOption) {
 				evaluateCtxErr = ctx.Err()
-				CopyProto(NewEvaluateResponse(channelName, ""), out)
+				CopyProto(NewEvaluateResponse(""), out)
 			})
 
 		mockSigner := NewMockSigner(controller, "", nil, nil)
@@ -78,7 +78,7 @@ var _ = Describe("QueryCommitted", func() {
 			Invoke(gomock.Any(), gomock.Eq(gatewayEvaluateMethod), gomock.Any(), gomock.Any(), gomock.Any()).
 			Do(func(ctx context.Context, method string, in *gateway.EvaluateRequest, out *gateway.EvaluateResponse, opts ...grpc.CallOption) {
 				evaluateRequest = in
-				CopyProto(NewEvaluateResponse(channelName, ""), out)
+				CopyProto(NewEvaluateResponse(""), out)
 			}).
 			Times(1)
 		mockSigner := NewMockSigner(controller, "", nil, nil)

pkg/chaincode/querycommittedwithname_test.go

@@ -37,7 +37,7 @@ var _ = Describe("QueryCommittedWithName", func() {
 			Invoke(gomock.Any(), gomock.Eq(gatewayEvaluateMethod), gomock.Any(), gomock.Any(), gomock.Any()).
 			Do(func(ctx context.Context, method string, in *gateway.EvaluateRequest, out *gateway.EvaluateResponse, opts ...grpc.CallOption) {
 				evaluateCtxErr = ctx.Err()
-				CopyProto(NewEvaluateResponse(channelName, ""), out)
+				CopyProto(NewEvaluateResponse(""), out)
 			})
 
 		mockSigner := NewMockSigner(controller, "", nil, nil)
@@ -82,7 +82,7 @@ var _ = Describe("QueryCommittedWithName", func() {
 			Invoke(gomock.Any(), gomock.Eq(gatewayEvaluateMethod), gomock.Any(), gomock.Any(), gomock.Any()).
 			Do(func(ctx context.Context, method string, in *gateway.EvaluateRequest, out *gateway.EvaluateResponse, opts ...grpc.CallOption) {
 				evaluateRequest = in
-				CopyProto(NewEvaluateResponse(channelName, ""), out)
+				CopyProto(NewEvaluateResponse(""), out)
 			}).
 			Times(1)
 		mockSigner := NewMockSigner(controller, "", nil, nil)