Merge pull request #13 from wk8/wk8/basic_linux_tests

Adding a Makefile for code generation and linting

Author: k8s-ci-robot

.gitignore

@@ -0,0 +1 @@
+/build/

.golangci.yml

@@ -0,0 +1,41 @@
+run:
+  skip-dirs:
+    - release-tools
+linters:
+  fast: false
+  enable:
+    - deadcode
+    - errcheck
+    - gocognit
+    - gocyclo
+    - gofmt
+    - goimports
+    - golint
+    - govet
+    - gosec
+    - ineffassign
+    - misspell
+    - staticcheck
+    - stylecheck
+    - typecheck
+    - unconvert
+    - varcheck
+    - whitespace
+
+linters-settings:
+  govet:
+    # report about shadowed variables
+    check-shadowing: true
+
+issues:
+  exclude:
+    # conversion function names use underscores, and may be unused
+    - "`convert_[a-z]+_[A-Z][a-zA-Z0-9]+_To_[a-z]+_[A-Z][a-zA-Z0-9]+` is unused"
+    - "(don't|should not) use underscores in Go names; func convert_[a-z]+_[A-Z][a-zA-Z0-9]+_To_[a-z]+_[A-Z][a-zA-Z0-9]+ should be"
+
+  exclude-rules:
+  # this file uses MD5 to compare files efficiently
+  - path: integrationtests/utils.go
+    text: "weak cryptographic primitive"
+    linters:
+    - gosec

Makefile

@@ -0,0 +1,79 @@
+## This Makefile is meant to be run on Unix hosts - as such, it only supports the few
+## operations that don't require on a Windows host, mostly code generation and linting.
+
+.DEFAULT_GOAL := all
+SHELL := /bin/bash
+
+ifeq ($(GOPATH),)
+$(error "GOPATH env variable not defined")
+endif
+
+REPO_ROOT = $(CURDIR)
+BUILD_DIR = build
+BUILD_TOOLS_DIR = $(BUILD_DIR)/tools
+
+GO_ENV_VARS = GO111MODULE=on GOOS=windows
+
+.PHONY: all
+all: generate compile lint
+
+.PHONY: compile
+compile: compile-client compile-server compile-csi-proxy-api-gen
+
+.PHONY: compile-client
+compile-client:
+	$(GO_ENV_VARS) go build ./client/...
+
+.PHONY: compile-server
+compile-server:
+	$(GO_ENV_VARS) go build -o $(BUILD_DIR)/server.exe ./cmd/server
+
+CSI_PROXY_API_GEN = $(BUILD_DIR)/csi-proxy-api-gen
+
+.PHONY: compile-csi-proxy-api-gen
+compile-csi-proxy-api-gen:
+	GO111MODULE=on go build -o $(CSI_PROXY_API_GEN) ./cmd/csi-proxy-api-gen
+
+.PHONY: generate
+generate: generate-protobuf generate-csi-proxy-api-gen
+
+# using xargs instead of -exec since the latter doesn't propagate exit statuses
+.PHONY: generate-protobuf
+generate-protobuf:
+	@ if ! which protoc > /dev/null 2>&1; then echo 'Unable to find protoc binary' ; exit 1; fi
+	@ generate_protobuf_for() { \
+		local FILE="$$1"; \
+		local FILE_DIR="$$(dirname "$$FILE")"; \
+		echo "Generating protobuf file from $$FILE"; \
+		protoc -I "$$FILE_DIR" -I "$$GOPATH/src" -I '$(REPO_ROOT)/client/api' "$$FILE" --go_out=plugins="grpc:$$FILE_DIR"; \
+	} ; \
+	export -f generate_protobuf_for; \
+	find '$(REPO_ROOT)' -name '*.proto' -print0 | xargs -0 -n1 $(SHELL) -c 'generate_protobuf_for "$$0"'
+
+.PHONY: generate-csi-proxy-api-gen
+generate-csi-proxy-api-gen: compile-csi-proxy-api-gen
+	$(CSI_PROXY_API_GEN) -i github.com/kubernetes-csi/csi-proxy/client/api,github.com/kubernetes-csi/csi-proxy/integrationtests/apigroups/api/dummy
+
+.PHONY: clean
+clean: clean-protobuf clean-generated
+
+.PHONY: clean-protobuf
+clean-protobuf:
+	find '$(REPO_ROOT)' -name '*.proto' -exec $(SHELL) -c 'rm -vf "$$(dirname {})/$$(basename {} .proto).pb.go"' \;
+
+.PHONY: clean-generated
+clean-generated:
+	find '$(REPO_ROOT)' -name '*_generated.go' -exec $(SHELL) -c '[[ "$$(head -n 1 "{}")" == "// Code generated by csi-proxy-api-gen"* ]] && rm -v {}' \;
+
+# see https://github.com/golangci/golangci-lint/releases
+GOLANGCI_LINT_VERSION = v1.21.0
+GOLANGCI_LINT = $(BUILD_TOOLS_DIR)/golangci-lint/$(GOLANGCI_LINT_VERSION)/golangci-lint
+
+.PHONY: lint
+lint: $(GOLANGCI_LINT)
+	$(GO_ENV_VARS) $(GOLANGCI_LINT) run
+	git --no-pager diff --exit-code
+
+# see https://github.com/golangci/golangci-lint#binary-release
+$(GOLANGCI_LINT):
+	curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b "$$(dirname '$(GOLANGCI_LINT)')" '$(GOLANGCI_LINT_VERSION)'

client/api/filesystem/v1alpha1/api.pb.go

@@ -8,7 +8,7 @@ import "github.com/kubernetes-csi/csi-proxy/client/api/errors.proto";
 // here as an example of what API group and versions will look like. It will actually
 // be implemented in a later patch.
 
-service FileSystem {
+service Filesystem {
     // PathExists checks if the given path exists on the host.
     rpc PathExists(PathExistsRequest) returns (PathExistsResponse) {}
 }

client/api/filesystem/v1alpha1/api.proto

@@ -4,6 +4,7 @@ import (
 	"strings"
 
 	goflag "flag"
+
 	"github.com/spf13/pflag"
 	"k8s.io/gengo/args"
 	"k8s.io/klog"
@@ -32,7 +33,9 @@ func buildArgs(executableName string, cliArgs []string) *args.GeneratorArgs {
 	pflagFlagSet := pflag.NewFlagSet(executableName, pflag.ExitOnError)
 	genericArgs.AddFlags(pflagFlagSet)
 	pflagFlagSet.AddGoFlagSet(goFlagSet)
-	pflagFlagSet.Parse(cliArgs)
+	if err := pflagFlagSet.Parse(cliArgs); err != nil {
+		klog.Fatalf("Unable to parse CLI args: %v", err)
+	}
 
 	klog.Infof("Verbosity level set to %d", verbosityLevel())
 

client/groups/filesystem/v1alpha1/client_generated.go

@@ -121,7 +121,7 @@ func (d *groupDefinition) addVersion(versionPkg *types.Package) {
 					}
 				}
 				errorMsg += fmt.Sprintf("\nYields 2 different signatures for the internal server callback:\n%s\nand\n%s",
-					previousCallback, namedServerCallback.callback)
+					previousCallback.callback, namedServerCallback.callback)
 				klog.Fatalf(errorMsg)
 			}
 		}

cmd/csi-proxy-api-gen/generators/execute.go

@@ -8,7 +8,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/kubernetes-csi/csi-proxy/integrationtests/apigroups/api/dummy/v1"
+	v1 "github.com/kubernetes-csi/csi-proxy/integrationtests/apigroups/api/dummy/v1"
 	"github.com/kubernetes-csi/csi-proxy/integrationtests/apigroups/api/dummy/v1alpha1"
 	"github.com/kubernetes-csi/csi-proxy/integrationtests/apigroups/api/dummy/v1alpha2"
 	v1client "github.com/kubernetes-csi/csi-proxy/integrationtests/apigroups/client/dummy/v1"

cmd/csi-proxy-api-gen/generators/groups_and_versions.go

@@ -1,17 +1,21 @@
 package internal
 
+// ComputeDoubleRequest is the internal representation of requests to the ComputeDouble endpoint.
 type ComputeDoubleRequest struct {
 	Input64 int64
 }
 
+// ComputeDoubleResponse is the internal representation of responses from the ComputeDouble endpoint.
 type ComputeDoubleResponse struct {
 	Response int64
 }
 
+// TellMeAPoemRequest is the internal representation of requests to the TellMeAPoem endpoint.
 type TellMeAPoemRequest struct {
 	IWantATitle bool
 }
 
+// TellMeAPoemResponse is the internal representation of responses from the TellMeAPoem endpoint.
 type TellMeAPoemResponse struct {
 	Title string
 	Lines []string