Add go.work to deal with multi module dependencies

This patch aligns the cinder-operator to the work already done
in both glance and openstack operator where go.work is added
to deal with multi module dependencies and run linters on API
module.
A go.work default file has been added to the repository, and
the related target is created in the Makefile. However, both
vet and generate targets don't call gowork, and we rely on the
default go.work file.

Signed-off-by: Francesco Pantano <[email protected]>

.gitignore

@@ -30,3 +30,7 @@ config/manager/kustomization.yaml
 
 # Common CI tools repository
 CI_TOOLS_REPO
+
+# generated workspace file
+go.work
+go.work.sum

Makefile

@@ -40,6 +40,9 @@ BUNDLE_GEN_FLAGS ?= -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)
 
 VERIFY_TLS ?= true
 
+# GOWORK
+GOWORK ?= off
+
 # USE_IMAGE_DIGESTS defines if images are resolved via tags or digests
 # You can enable this value if you would like to use SHA Based Digests
 # To enable set flag to true
@@ -118,10 +121,11 @@ fmt: ## Run go fmt against code.
 .PHONY: vet
 vet: ## Run go vet against code.
 	go vet ./...
+	go vet ./... ./api/...
 
 .PHONY: test
 test: manifests generate fmt vet envtest ## Run tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test ./... -coverprofile cover.out
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test ./... ./api/... -coverprofile cover.out
 
 ##@ Build
 
@@ -272,20 +276,31 @@ get-ci-tools:
 
 # Run go fmt against code
 gofmt: get-ci-tools
-	$(CI_TOOLS_REPO_DIR)/test-runner/gofmt.sh
+	GOWORK=$(GOWORK) $(CI_TOOLS_REPO_DIR)/test-runner/gofmt.sh
+	GOWORK=$(GOWORK) $(CI_TOOLS_REPO_DIR)/test-runner/gofmt.sh ./api
 
 # Run go vet against code
 govet: get-ci-tools
-	$(CI_TOOLS_REPO_DIR)/test-runner/govet.sh
+	GOWORK=$(GOWORK) $(CI_TOOLS_REPO_DIR)/test-runner/govet.sh
+	GOWORK=$(GOWORK) $(CI_TOOLS_REPO_DIR)/test-runner/govet.sh ./api
 
 # Run go test against code
 gotest: get-ci-tools
-	$(CI_TOOLS_REPO_DIR)/test-runner/gotest.sh
+	GOWORK=$(GOWORK) $(CI_TOOLS_REPO_DIR)/test-runner/gotest.sh
+	GOWORK=$(GOWORK) $(CI_TOOLS_REPO_DIR)/test-runner/gotest.sh ./api
 
 # Run golangci-lint test against code
 golangci: get-ci-tools
-	$(CI_TOOLS_REPO_DIR)/test-runner/golangci.sh
+	GOWORK=$(GOWORK) $(CI_TOOLS_REPO_DIR)/test-runner/golangci.sh
+	GOWORK=$(GOWORK) $(CI_TOOLS_REPO_DIR)/test-runner/golangci.sh ./api
 
 # Run go lint against code
 golint: get-ci-tools
-	PATH=$(GOBIN):$(PATH); $(CI_TOOLS_REPO_DIR)/test-runner/golint.sh
+	GOWORK=$(GOWORK) PATH=$(GOBIN):$(PATH); $(CI_TOOLS_REPO_DIR)/test-runner/golint.sh
+	GOWORK=$(GOWORK) PATH=$(GOBIN):$(PATH); $(CI_TOOLS_REPO_DIR)/test-runner/golint.sh ./api
+
+.PHONY: gowork
+gowork: ## Generate go.work file to support our multi module repository
+	test -f go.work || go work init
+	go work use .
+	go work use ./api

go.work

@@ -0,0 +1,6 @@
+go 1.18
+
+use (
+	.
+	./api
+)