Fix swagger (#39)

* refactor makefile

* fix swagger

* fix swagger

* fix tests

* remove swagger doc test

* bump to [email protected]

* fix tests

Co-authored-by: Victor Varza <[email protected]>

Author: victorvarza

.github/env

@@ -1 +1 @@
-golang-version=1.16
+golang-version=1.17

Makefile

@@ -36,7 +36,9 @@ all: format generate build test test-e2e
 .PHONY: clean
 clean:
 	# Remove all files and directories ignored by git.
+	# Stop all local containers.
 	git clean -Xfd .
+	./local/cleanup.sh
 
 
 ############
@@ -97,21 +99,23 @@ release-slt:
 # Formatting #
 ##############
 
+.PHONY: format-prereq
+format-prereq:
+	@[ -f $(GOSEC) ] || GOBIN=$(shell pwd)/bin go get "github.com/securego/gosec/v2/cmd/gosec";
+
 .PHONY: format
-format: go-fmt go-vet go-lint go-sec check-license
+format: format-prereq go-fmt go-vet go-lint go-sec check-license
 
 .PHONY: go-fmt
 go-fmt:
 	@echo 'Formatting go code...'
 	@gofmt -s -w .
-	@echo 'Not formatiing issues found in go codebase!'
-
+	@echo 'Not formating issues found in go codebase!'
 
 .PHONY: check-license
 check-license:
 	./hack/check_license.sh
 
-
 .PHONY: go-lint
 go-lint: golangci-lint
 	@echo 'Linting go code...'
@@ -123,21 +127,21 @@ lint-fix: golangci-lint
 	$(GOLANGCI_LINT) run --fix
 
 GOLANGCI_LINT = $(shell pwd)/bin/golangci-lint
+GOLANGCI_LINT_VERSION = "v1.46.2"
 golangci-lint:
-	@[ -f $(GOLANGCI_LINT) ] || { \
-	set -e ;\
-	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell dirname $(GOLANGCI_LINT)) v1.41.1 ;\
-	}
+	@[ -f $(GOLANGCI_LINT) ] || curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell dirname $(GOLANGCI_LINT)) $(GOLANGCI_LINT_VERSION);
 
 GOSEC = $(shell pwd)/bin/gosec
-go-sec: ## Inspects source code for security problems
-	@if ! command -v gosec >/dev/null 2>&1 ; then $(call go-get-tool,$(GOSEC),github.com/securego/gosec/v2/cmd/gosec); fi
+.PHONY: go-sec
+go-sec:
+	@[ -f $(GOSEC) ] || GOBIN=$(shell pwd)/bin go get "github.com/securego/gosec/v2/cmd/gosec";
 	@echo 'Checking source code for security problems...'
 	$(GOSEC)  ./pkg/...
-	@echo 'No security problems found in go codebase!'
+	@echo 'No security problems found in go codebase!'	
 
-go-vet: ## Identifying subtle source code issues
-	@echo 'Vetting go code...'
+.PHONY: go-vet
+go-vet:
+	@echo 'Vetting go code and identify subtle source code issues...'
 	@go vet $(shell pwd)/pkg/apiserver/...
 	@echo 'Not issues found in go codebase!'
 
@@ -146,19 +150,23 @@ go-vet: ## Identifying subtle source code issues
 # Testing #
 ###########
 
-ENVTEST_ASSETS_DIR=$(shell pwd)/testbin
+KUBEBUILDER_ASSETS=$(shell pwd)/kubebuilder
+K8S_VERSION=1.21.2
 
 .PHONY: test
 test:
-	mkdir -p ${ENVTEST_ASSETS_DIR}
-	test -f ${ENVTEST_ASSETS_DIR}/setup-envtest.sh || curl -sSLo ${ENVTEST_ASSETS_DIR}/setup-envtest.sh https://raw.githubusercontent.com/kubernetes-sigs/controller-runtime/v0.7.2/hack/setup-envtest.sh
-	source ${ENVTEST_ASSETS_DIR}/setup-envtest.sh; fetch_envtest_tools $(ENVTEST_ASSETS_DIR); setup_envtest_env $(ENVTEST_ASSETS_DIR); go test -race $(TEST_RUN_ARGS) -short $(PKGS) -count=1 -cover -v
+	@[ -d $(KUBEBUILDER_ASSETS) ] || {\
+		mkdir -p $(KUBEBUILDER_ASSETS);\
+		curl -sSLo envtest-bins.tar.gz "https://go.kubebuilder.io/test-tools/$(K8S_VERSION)/$(GOOS)/$(GOARCH)";\
+		tar -C $(KUBEBUILDER_ASSETS) --strip-components=1 -zvxf envtest-bins.tar.gz;\
+	}
+	KUBEBUILDER_ASSETS=$(KUBEBUILDER_ASSETS)/bin go test -race $(TEST_RUN_ARGS) -short $(PKGS) -count=1 -cover -v
 
 .PHONY: test-e2e
 test-e2e:
 	$(shell pwd)/local/setup.sh
 	@. local/.env.local && go test -race github.com/adobe/cluster-registry/test/e2e -count=1 -v
-	$(shell pwd)/local/cleanup.sh
+	# $(shell pwd)/local/cleanup.sh
 
 ## Make sure you have set the APISERVER_AUTH_TOKEN env variable.
 ## Use PERFORMANCE_TEST_TIME env var to set the benchmark time per endpoint.
@@ -185,33 +193,24 @@ MANAGER_ROLE ?= "cluster-registry"
 
 CONTROLLER_GEN = $(shell pwd)/bin/controller-gen
 controller-gen: ## Download controller-gen locally if necessary.
-	$(call go-get-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/[email protected])
+	@[ -f $(CONTROLLER_GEN) ] || GOBIN=$(shell pwd)/bin go install sigs.k8s.io/controller-tools/cmd/[email protected]
 
 KUSTOMIZE = $(shell pwd)/bin/kustomize
 kustomize: ## Download kustomize locally if necessary.
-	$(call go-get-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/[email protected])
+	@[ -f $(KUSTOMIZE) ] || GOBIN=$(shell pwd)/bin go install sigs.k8s.io/kustomize/kustomize/[email protected]
 
 manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
 	$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=$(MANAGER_ROLE) webhook paths="$(shell pwd)/pkg/api/..." output:crd:artifacts:config=$(shell pwd)/config/crd/bases output:rbac:artifacts:config=$(shell pwd)/config/rbac
 
 generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
 	$(CONTROLLER_GEN) object:headerFile="$(shell pwd)/hack/boilerplate.go.txt" paths="$(shell pwd)/pkg/api/..."
 
-# go-get-tool will 'go get' any package $2 and install it to $1.
-define go-get-tool
-	@[ -f $(1) ] || { \
-	set -e; \
-	TMP_DIR=$$(mktemp -d); \
-	cd $$TMP_DIR; \
-	go mod init tmp; \
-	echo "Downloading $(2)"; \
-	GOBIN=$(shell pwd)/bin go get $(2); \
-	rm -rf $$TMP_DIR; \
-	}
-endef
 
-# -------------
-# DOCUMENTATION
-# -------------
+#################
+# Documentation #
+#################
+
+SWAGGER_CLI = $(shell pwd)/bin/swag
 swagger:
-	swag init --parseDependency --parseInternal --parseDepth 2 -g cmd/apiserver/apiserver.go --output pkg/apiserver/docs/
+	@[ -f $(SWAGGER_CLI) ] || GOBIN=$(shell pwd)/bin go install github.com/swaggo/swag/cmd/[email protected]
+	$(SWAGGER_CLI) init --parseDependency --parseInternal --parseDepth 2 -g cmd/apiserver/apiserver.go --output pkg/apiserver/docs/

cmd/apiserver/apiserver.go

@@ -13,7 +13,8 @@ governing permissions and limitations under the License.
 package main
 
 import (
-	_ "github.com/adobe/cluster-registry/pkg/apiserver/docs"
+	// docs "github.com/adobe/cluster-registry/pkg/apiserver/docs"
+	"github.com/adobe/cluster-registry/pkg/apiserver/docs"
 	"github.com/adobe/cluster-registry/pkg/apiserver/web"
 	api "github.com/adobe/cluster-registry/pkg/apiserver/web"
 	apiv1 "github.com/adobe/cluster-registry/pkg/apiserver/web/handler/v1"
@@ -65,6 +66,8 @@ func main() {
 		AppConfig: appConfig,
 	}
 
+	docs.SwaggerInfo.Host = appConfig.ApiHost
+
 	a.GET("/api/swagger/*", echoSwagger.WrapHandler)
 	a.GET("/livez", web.Livez)
 	a.GET("/readyz", status.Readyz)

go.mod

@@ -1,44 +1,137 @@
 module github.com/adobe/cluster-registry
 
-go 1.15
+go 1.17
 
 require (
-	cloud.google.com/go v0.60.0 // indirect
-	github.com/Azure/go-autorest/autorest v0.11.19 // indirect
-	github.com/Azure/go-autorest/autorest/azure/auth v0.5.7
-	github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751
+	github.com/Azure/go-autorest/autorest/azure/auth v0.5.11
 	github.com/aws/aws-sdk-go v1.36.30
-	github.com/coreos/go-oidc/v3 v3.0.0
-	github.com/go-logr/logr v0.4.0
-	github.com/go-openapi/jsonreference v0.19.6 // indirect
-	github.com/go-openapi/spec v0.20.3 // indirect
-	github.com/go-openapi/swag v0.19.15 // indirect
-	github.com/go-playground/universal-translator v0.17.0 // indirect
-	github.com/golang-jwt/jwt v3.2.2+incompatible // indirect
-	github.com/google/uuid v1.3.0 // indirect
+	github.com/coreos/go-oidc/v3 v3.2.0
+	github.com/go-logr/logr v1.2.0
+	github.com/google/uuid v1.3.0
 	github.com/jinzhu/gorm v1.9.8
-	github.com/labstack/echo/v4 v4.3.0
-	github.com/labstack/gommon v0.3.0
-	github.com/leodido/go-urn v1.2.0 // indirect
-	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/labstack/echo/v4 v4.7.2
+	github.com/labstack/gommon v0.3.1
 	github.com/onsi/ginkgo v1.16.5
-	github.com/onsi/gomega v1.17.0
-	github.com/prometheus/client_golang v1.11.0
-	github.com/securego/gosec/v2 v2.9.6 // indirect
-	github.com/stretchr/testify v1.7.0
-	github.com/swaggo/echo-swagger v1.0.0
-	github.com/swaggo/swag v1.7.0
-	github.com/testcontainers/testcontainers-go v0.12.0 // indirect
-	golang.org/x/lint v0.0.0-20210508222113-6edffad5e616 // indirect
-	golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2
-	golang.org/x/tools v0.1.8 // indirect
+	github.com/onsi/gomega v1.19.0
+	github.com/prometheus/client_golang v1.12.1
+	github.com/stretchr/testify v1.7.2
+	github.com/swaggo/echo-swagger v1.3.3
+	github.com/swaggo/swag v1.8.3
+	github.com/testcontainers/testcontainers-go v0.13.0
+	golang.org/x/net v0.0.0-20220425223048-2871e0cb64e4
 	gopkg.in/go-playground/validator.v9 v9.28.0
 	gopkg.in/square/go-jose.v2 v2.5.1
-	gopkg.in/yaml.v2 v2.4.0 // indirect
-	k8s.io/api v0.21.2
-	k8s.io/apimachinery v0.21.2
-	k8s.io/client-go v0.21.2
-	sigs.k8s.io/controller-runtime v0.9.2
-	sigs.k8s.io/kind v0.14.0 // indirect
-	sigs.k8s.io/yaml v1.3.0 // indirect
+	gopkg.in/yaml.v2 v2.4.0
+	k8s.io/api v0.24.2
+	k8s.io/apimachinery v0.24.2
+	k8s.io/client-go v0.24.2
+	sigs.k8s.io/controller-runtime v0.12.3
+	sigs.k8s.io/yaml v1.3.0
+)
+
+require (
+	cloud.google.com/go v0.81.0 // indirect
+	github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
+	github.com/Azure/go-autorest v14.2.0+incompatible // indirect
+	github.com/Azure/go-autorest/autorest v0.11.24 // indirect
+	github.com/Azure/go-autorest/autorest/adal v0.9.18 // indirect
+	github.com/Azure/go-autorest/autorest/azure/cli v0.4.5 // indirect
+	github.com/Azure/go-autorest/autorest/date v0.3.0 // indirect
+	github.com/Azure/go-autorest/logger v0.2.1 // indirect
+	github.com/Azure/go-autorest/tracing v0.6.0 // indirect
+	github.com/KyleBanks/depth v1.2.1 // indirect
+	github.com/Microsoft/go-winio v0.4.17 // indirect
+	github.com/Microsoft/hcsshim v0.8.23 // indirect
+	github.com/PuerkitoBio/purell v1.1.1 // indirect
+	github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 // indirect
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cenkalti/backoff/v4 v4.1.2 // indirect
+	github.com/cespare/xxhash/v2 v2.1.2 // indirect
+	github.com/containerd/cgroups v1.0.1 // indirect
+	github.com/containerd/containerd v1.5.9 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/dimchansky/utfbom v1.1.1 // indirect
+	github.com/docker/distribution v2.7.1+incompatible // indirect
+	github.com/docker/docker v20.10.11+incompatible // indirect
+	github.com/docker/go-connections v0.4.0 // indirect
+	github.com/docker/go-units v0.4.0 // indirect
+	github.com/emicklei/go-restful v2.9.5+incompatible // indirect
+	github.com/evanphx/json-patch v4.12.0+incompatible // indirect
+	github.com/fsnotify/fsnotify v1.5.1 // indirect
+	github.com/go-logr/zapr v1.2.0 // indirect
+	github.com/go-openapi/jsonpointer v0.19.5 // indirect
+	github.com/go-openapi/jsonreference v0.19.6 // indirect
+	github.com/go-openapi/spec v0.20.4 // indirect
+	github.com/go-openapi/swag v0.19.15 // indirect
+	github.com/go-playground/locales v0.14.0 // indirect
+	github.com/go-playground/universal-translator v0.18.0 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang-jwt/jwt v3.2.2+incompatible // indirect
+	github.com/golang-jwt/jwt/v4 v4.2.0 // indirect
+	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
+	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/google/gnostic v0.5.7-v3refs // indirect
+	github.com/google/go-cmp v0.5.5 // indirect
+	github.com/google/gofuzz v1.1.0 // indirect
+	github.com/imdario/mergo v0.3.12 // indirect
+	github.com/jmespath/go-jmespath v0.4.0 // indirect
+	github.com/josharian/intern v1.0.0 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/leodido/go-urn v1.2.1 // indirect
+	github.com/magiconair/properties v1.8.5 // indirect
+	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/mattn/go-colorable v0.1.11 // indirect
+	github.com/mattn/go-isatty v0.0.14 // indirect
+	github.com/mattn/go-sqlite3 v1.10.0 // indirect
+	github.com/matttproud/golang_protobuf_extensions v1.0.2-0.20181231171920-c182affec369 // indirect
+	github.com/mitchellh/go-homedir v1.1.0 // indirect
+	github.com/moby/sys/mount v0.2.0 // indirect
+	github.com/moby/sys/mountinfo v0.5.0 // indirect
+	github.com/moby/term v0.0.0-20210619224110-3f7ff695adc6 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/morikuni/aec v0.0.0-20170113033406-39771216ff4c // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/nxadm/tail v1.4.8 // indirect
+	github.com/onsi/ginkgo/v2 v2.1.4 // indirect
+	github.com/opencontainers/go-digest v1.0.0 // indirect
+	github.com/opencontainers/image-spec v1.0.2 // indirect
+	github.com/opencontainers/runc v1.0.2 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/prometheus/client_model v0.2.0 // indirect
+	github.com/prometheus/common v0.32.1 // indirect
+	github.com/prometheus/procfs v0.7.3 // indirect
+	github.com/sirupsen/logrus v1.8.1 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/swaggo/files v0.0.0-20220610200504-28940afbdbfe // indirect
+	github.com/valyala/bytebufferpool v1.0.0 // indirect
+	github.com/valyala/fasttemplate v1.2.1 // indirect
+	go.opencensus.io v0.23.0 // indirect
+	go.uber.org/atomic v1.7.0 // indirect
+	go.uber.org/multierr v1.6.0 // indirect
+	go.uber.org/zap v1.19.1 // indirect
+	golang.org/x/crypto v0.0.0-20220525230936-793ad666bf5e // indirect
+	golang.org/x/oauth2 v0.0.0-20211104180415-d3ed0bb246c8 // indirect
+	golang.org/x/sys v0.0.0-20220422013727-9388b58f7150 // indirect
+	golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 // indirect
+	golang.org/x/text v0.3.7 // indirect
+	golang.org/x/time v0.0.0-20220210224613-90d013bbcef8 // indirect
+	golang.org/x/tools v0.1.11 // indirect
+	gomodules.xyz/jsonpatch/v2 v2.2.0 // indirect
+	google.golang.org/appengine v1.6.7 // indirect
+	google.golang.org/genproto v0.0.0-20220107163113-42d7afdf6368 // indirect
+	google.golang.org/grpc v1.40.0 // indirect
+	google.golang.org/protobuf v1.27.1 // indirect
+	gopkg.in/go-playground/assert.v1 v1.2.1 // indirect
+	gopkg.in/inf.v0 v0.9.1 // indirect
+	gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	k8s.io/apiextensions-apiserver v0.24.2 // indirect
+	k8s.io/component-base v0.24.2 // indirect
+	k8s.io/klog/v2 v2.60.1 // indirect
+	k8s.io/kube-openapi v0.0.0-20220328201542-3ee0da9b0b42 // indirect
+	k8s.io/utils v0.0.0-20220210201930-3a6ce19ff2f9 // indirect
+	sigs.k8s.io/json v0.0.0-20211208200746-9f7c6b3444d2 // indirect
+	sigs.k8s.io/structured-merge-diff/v4 v4.2.1 // indirect
 )