add a golang library to support go modules

Signed-off-by: soorena776 <[email protected]>

makelib/golang_with_modules.mk

@@ -0,0 +1,347 @@
+# Copyright 2016 The Upbound Authors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# ====================================================================================
+# Options
+
+# The go project including repo name, for example, github.com/rook/rook
+GO_PROJECT ?= $(PROJECT_REPO)
+
+# the packages to be built statically, for example, $(GO_PROJECT)/cmd/mytool
+ifeq ($(GO_STATIC_PACKAGES),)
+$(error please set GO_STATIC_PACKAGES prior to including golang.mk)
+endif
+
+# Optional. These are subdirs that we look for all go files to test, vet, and fmt
+GO_SUBDIRS ?= cmd pkg
+
+# Optional. Additional subdirs used for integration or e2e testings
+GO_INTEGRATION_TESTS_SUBDIRS ?=
+
+# Optional directories (relative to CURDIR)
+GO_VENDOR_DIR ?= vendor
+GO_PKG_DIR ?= $(WORK_DIR)/pkg
+
+# Optional build flags passed to go tools
+GO_BUILDFLAGS ?=
+GO_LDFLAGS ?=
+GO_TAGS ?=
+GO_TEST_FLAGS ?=
+GO_TEST_SUITE ?=
+GO_NOCOV ?=
+
+# ====================================================================================
+# Setup go environment
+
+# turn on more verbose build when V=1
+ifeq ($(V),1)
+GO_LDFLAGS += -v -n
+GO_BUILDFLAGS += -x
+endif
+
+# whether to generate debug information in binaries. this includes DWARF and symbol tables.
+ifeq ($(DEBUG),0)
+GO_LDFLAGS += -s -w
+endif
+
+# supported go versions
+GO_SUPPORTED_VERSIONS ?= 1.7|1.8|1.9|1.10|1.11|1.12|1.13
+
+# no GOPATH is set, since go modules are being used
+GOPATH := 
+
+# enable go modules
+export GO111MODULE=on
+
+# set GOOS and GOARCH
+GOOS := $(OS)
+GOARCH := $(ARCH)
+export GOOS GOARCH
+
+# set GOOS and GOARCH
+GOHOSTOS := $(HOSTOS)
+GOHOSTARCH := $(HOSTARCH)
+
+GO_PACKAGES := $(foreach t,$(GO_SUBDIRS),$(GO_PROJECT)/$(t)/...)
+GO_INTEGRATION_TEST_PACKAGES := $(foreach t,$(GO_INTEGRATION_TESTS_SUBDIRS),$(GO_PROJECT)/$(t)/integration)
+
+ifneq ($(GO_TEST_PARALLEL),)
+GO_TEST_FLAGS += -p $(GO_TEST_PARALLEL)
+endif
+
+ifneq ($(GO_TEST_SUITE),)
+GO_TEST_FLAGS += -run '$(GO_TEST_SUITE)'
+endif
+
+# setup tools used during the build
+GOJUNIT := $(TOOLS_HOST_DIR)/go-junit-report
+GOCOVER_COBERTURA := $(TOOLS_HOST_DIR)/gocover-cobertura
+GOIMPORTS := $(TOOLS_HOST_DIR)/goimports
+CONTROLLERGEN := $(TOOLS_HOST_DIR)/controller-gen
+
+GO := go
+GOHOST := GOOS=$(GOHOSTOS) GOARCH=$(GOHOSTARCH) go
+GO_VERSION := $(shell $(GO) version | sed -ne 's/[^0-9]*\(\([0-9]\.\)\{0,4\}[0-9][^.]\).*/\1/p')
+
+# we use a consistent version of gofmt even while running different go compilers.
+# see https://github.com/golang/go/issues/26397 for more details
+GOFMT_VERSION := 1.11
+ifneq ($(findstring $(GOFMT_VERSION),$(GO_VERSION)),)
+GOFMT := $(shell which gofmt)
+else
+GOFMT := $(TOOLS_HOST_DIR)/gofmt$(GOFMT_VERSION)
+endif
+
+# We use a consistent version of golangci-lint to ensure everyone gets the same
+# linters.
+GOLANGCILINT_VERSION := 1.15.0
+GOLANGCILINT := $(TOOLS_HOST_DIR)/golangci-lint-v$(GOLANGCILINT_VERSION)
+
+GO_BIN_DIR := $(abspath $(OUTPUT_DIR)/bin)
+GO_OUT_DIR := $(GO_BIN_DIR)/$(PLATFORM)
+GO_TEST_DIR := $(abspath $(OUTPUT_DIR)/tests)
+GO_TEST_OUTPUT := $(GO_TEST_DIR)/$(PLATFORM)
+GO_LINT_DIR := $(abspath $(OUTPUT_DIR)/lint)
+GO_LINT_OUTPUT := $(GO_LINT_DIR)/$(PLATFORM)
+
+ifeq ($(GOOS),windows)
+GO_OUT_EXT := .exe
+endif
+
+ifeq ($(RUNNING_IN_CI),true)
+# Output checkstyle XML rather than human readable output.
+GO_LINT_ARGS := --out-format=checkstyle > $(GO_LINT_OUTPUT)/checkstyle.xml
+
+# Output verbose tests that can be parsed into JUnit XML.
+GO_TEST_FLAGS += -v
+endif
+
+# NOTE: the install suffixes are matched with the build container to speed up the
+# the build. Please keep them in sync.
+
+# we run go build with -i which on most system's would want to install packages
+# into the system's root dir. using our own pkg dir avoid thats
+ifneq ($(GO_PKG_DIR),)
+GO_PKG_BASE_DIR := $(abspath $(GO_PKG_DIR)/$(PLATFORM))
+GO_PKG_STATIC_FLAGS := -pkgdir $(GO_PKG_BASE_DIR)_static
+endif
+
+GO_COMMON_FLAGS = $(GO_BUILDFLAGS) -tags '$(GO_TAGS)'
+GO_STATIC_FLAGS = $(GO_COMMON_FLAGS) $(GO_PKG_STATIC_FLAGS) -installsuffix static  -ldflags '$(GO_LDFLAGS)'
+
+# ====================================================================================
+# Go Targets
+
+go.init: go.vendor
+	@if ! `$(GO) version | grep -q -E '\bgo($(GO_SUPPORTED_VERSIONS))\b'`; then \
+		$(ERR) unsupported go version. Please make install one of the following supported version: '$(GO_SUPPORTED_VERSIONS)' ;\
+		exit 1 ;\
+	fi
+
+go.build:
+	@$(INFO) go build $(PLATFORM)
+	$(foreach p,$(GO_STATIC_PACKAGES),@CGO_ENABLED=0 $(GO) build -mod=vendor -v -i -o $(GO_OUT_DIR)/$(lastword $(subst /, ,$(p)))$(GO_OUT_EXT) $(GO_STATIC_FLAGS) $(p) || $(FAIL) ${\n})
+	$(foreach p,$(GO_TEST_PACKAGES) $(GO_LONGHAUL_TEST_PACKAGES),@CGO_ENABLED=0 $(GO) test -mod=vendor -i -c -o $(GO_TEST_OUTPUT)/$(lastword $(subst /, ,$(p)))$(GO_OUT_EXT) $(GO_STATIC_FLAGS) $(p) || $(FAIL ${\n}))
+	@$(MAKE) go.writeable.mod.folder
+	@$(OK) go build $(PLATFORM)
+
+go.install:
+	@$(INFO) go install $(PLATFORM)
+	$(foreach p,$(GO_STATIC_PACKAGES),@CGO_ENABLED=0 $(GO) install -v $(GO_STATIC_FLAGS) $(p) || $(FAIL) ${\n})
+	@$(OK) go install $(PLATFORM)
+
+go.test.unit: $(GOJUNIT) $(GOCOVER_COBERTURA)
+	@$(INFO) go test unit-tests
+ifeq ($(GO_NOCOV),true)
+	@$(WARN) coverage analysis is disabled
+	@CGO_ENABLED=0 $(GOHOST) test $(GO_TEST_FLAGS) $(GO_STATIC_FLAGS) $(GO_PACKAGES) || $(FAIL)
+else
+	@mkdir -p $(GO_TEST_OUTPUT)
+	@CGO_ENABLED=0 $(GOHOST) test -i -cover $(GO_STATIC_FLAGS) $(GO_PACKAGES) || $(FAIL)
+	@CGO_ENABLED=0 $(GOHOST) test -covermode=count -coverprofile=$(GO_TEST_OUTPUT)/coverage.txt $(GO_TEST_FLAGS) $(GO_STATIC_FLAGS) $(GO_PACKAGES) 2>&1 | tee $(GO_TEST_OUTPUT)/unit-tests.log || $(FAIL)
+	@cat $(GO_TEST_OUTPUT)/unit-tests.log | $(GOJUNIT) -set-exit-code > $(GO_TEST_OUTPUT)/unit-tests.xml || $(FAIL)
+	@$(GOCOVER_COBERTURA) < $(GO_TEST_OUTPUT)/coverage.txt > $(GO_TEST_OUTPUT)/coverage.xml
+endif
+	@$(MAKE) go.writeable.mod.folder
+	@$(OK) go test unit-tests
+
+# Depends on go.test.unit, but is only run in CI with a valid token after unit-testing is complete
+# DO NOT run locally.
+go.test.codecov:
+	@$(INFO) go test codecov
+	@cd $(GO_TEST_OUTPUT) && bash <(curl -s https://codecov.io/bash) || $(FAIL)
+	@$(OK) go test codecov
+
+go.test.integration: $(GOJUNIT)
+	@$(INFO) go test integration-tests
+	@mkdir -p $(GO_TEST_OUTPUT) || $(FAIL)
+	@CGO_ENABLED=0 $(GOHOST) test -i $(GO_STATIC_FLAGS) $(GO_INTEGRATION_TEST_PACKAGES) || $(FAIL)
+	@CGO_ENABLED=0 $(GOHOST) test $(GO_TEST_FLAGS) $(GO_STATIC_FLAGS) $(GO_INTEGRATION_TEST_PACKAGES) $(TEST_FILTER_PARAM) 2>&1 | tee $(GO_TEST_OUTPUT)/integration-tests.log || $(FAIL)
+	@cat $(GO_TEST_OUTPUT)/integration-tests.log | $(GOJUNIT) -set-exit-code > $(GO_TEST_OUTPUT)/integration-tests.xml || $(FAIL)
+	@$(MAKE) go.writeable.mod.folder
+	@$(OK) go test integration-tests
+
+go.lint: $(GOLANGCILINT)
+	@$(INFO) golangci-lint
+	@mkdir -p $(GO_LINT_OUTPUT)
+	@$(GOLANGCILINT) run $(GO_LINT_ARGS) || $(FAIL)
+	@$(OK) golangci-lint
+
+go.vet:
+	@$(INFO) go vet $(PLATFORM)
+	@CGO_ENABLED=0 $(GOHOST) vet $(GO_COMMON_FLAGS) $(GO_PACKAGES) $(GO_INTEGRATION_TEST_PACKAGES) || $(FAIL)
+	@$(OK) go vet $(PLATFORM)
+
+go.fmt: $(GOFMT)
+	@$(INFO) go fmt
+	@gofmt_out=$$($(GOFMT) -s -d -e $(GO_SUBDIRS) $(GO_INTEGRATION_TESTS_SUBDIRS) 2>&1) && [ -z "$${gofmt_out}" ] || (echo "$${gofmt_out}" 1>&2; $(FAIL))
+	@$(OK) go fmt
+
+go.fmt.simplify: $(GOFMT)
+	@$(INFO) gofmt simplify
+	@$(GOFMT) -l -s -w $(GO_SUBDIRS) $(GO_INTEGRATION_TESTS_SUBDIRS) || $(FAIL)
+	@$(OK) gofmt simplify
+
+go.imports: $(GOIMPORTS)
+	@$(INFO) goimports
+	@goimports_out=$$($(GOIMPORTS) -d -e -local $(GO_PROJECT) $(GO_SUBDIRS) $(GO_INTEGRATION_TESTS_SUBDIRS) 2>&1) && [ -z "$${goimports_out}" ] || (echo "$${goimports_out}" 1>&2; $(FAIL))
+	@$(OK) goimports
+
+go.imports.fix: $(GOIMPORTS)
+	@$(INFO) goimports fix
+	@$(GOIMPORTS) -l -w -local $(GO_PROJECT) $(GO_SUBDIRS) $(GO_INTEGRATION_TESTS_SUBDIRS) || $(FAIL)
+	@$(OK) goimports fix
+
+go.validate: go.vet go.fmt
+
+go.vendor.verify:
+	@$(INFO) verify dependencies have expected content
+	@$(GO) mod verify || $(FAIL)
+	@$(OK) go modules dependencies verified
+
+go.vendor:
+	@$(INFO) go mod vendor
+	@$(GO) mod vendor || $(FAIL)
+	@$(MAKE) go.writeable.mod.folder
+	@$(OK) go mod vendor
+
+go.clean:
+	@rm -fr $(GO_BIN_DIR) $(GO_TEST_DIR)
+
+go.distclean:
+	@rm -rf $(GO_VENDOR_DIR) $(GO_PKG_DIR)
+
+# make sure the pkg/mod folder is writable (otherwise it won't be deleted)
+go.writeable.mod.folder:
+	@test -d ~/go/pkg/mod && find ~/go/pkg/mod -type d -exec chmod 777 {} \; || echo 
+
+# Generate manifests e.g. CRD, RBAC etc.
+manifests: $(CONTROLLERGEN)
+	@$(INFO) Generating CRD manifests
+	@$(CONTROLLERGEN) crd:trivialVersions=true paths=./aws/... output:dir=$(CRD_DIR)
+	@$(OK) Generating CRD manifests
+
+go.generate: $(GOIMPORTS) $(CONTROLLERGEN)
+	@$(INFO) go generate $(PLATFORM)
+	@CGO_ENABLED=0 CONTROLLERGEN=$(CONTROLLERGEN) $(GOHOST) generate $(GO_COMMON_FLAGS) $(GO_PACKAGES) $(GO_INTEGRATION_TEST_PACKAGES) || $(FAIL)
+	@find $(GO_SUBDIRS) $(GO_INTEGRATION_TESTS_SUBDIRS) -type f -name 'zz_generated*' -exec $(GOIMPORTS) -l -w -local $(GO_PROJECT) {} \;
+	@$(OK) go generate $(PLATFORM)
+
+.PHONY: go.init go.build go.install go.test.unit go.test.integration go.test.codecov go.lint go.vet go.fmt go.generate
+.PHONY: go.validate go.vendor go.vendor.verify go.clean go.distclean
+
+# ====================================================================================
+# Common Targets
+
+build.init: go.init
+build.check: go.lint
+build.code.platform: go.build
+clean: go.clean
+distclean: go.distclean
+lint.init: go.init
+lint.run: go.lint
+test.init: go.init
+test.run: go.test.unit
+
+# ====================================================================================
+# Special Targets
+
+fmt: go.imports
+fmt.simplify: go.fmt.simplify
+imports: go.imports
+imports.fix: go.imports.fix
+vendor: go.vendor
+vendor.verify: go.vendor.verify
+vet: go.vet
+generate codegen: go.generate
+
+define GO_HELPTEXT
+Go Targets:
+    generate        Runs go code generation followed by goimports on generated files.
+    fmt             Checks go source code for formatting issues.
+    fmt.simplify    Format, simplify, update source files.
+    imports         Checks go source code import lines for issues.
+    imports.fix     Updates go source files to fix issues with import lines.
+    vendor          Updates vendor packages.
+    vendor.verify   Verify dependencies have expected content.
+    vet             Checks go source code and reports suspicious constructs.
+    test.unit.nocov Runs unit tests without coverage (faster for iterative development)
+endef
+export GO_HELPTEXT
+
+go.help:
+	@echo "$$GO_HELPTEXT"
+
+help-special: go.help
+
+.PHONY: fmt vendor vet go.help
+
+# ====================================================================================
+# Tools install targets
+
+$(GOLANGCILINT):
+	@$(INFO) installing golangci-lint-v$(GOLANGCILINT_VERSION) $(HOSTOS)-$(HOSTARCH)
+	@mkdir -p $(TOOLS_HOST_DIR)/tmp-golangci-lint || $(FAIL)
+	@curl -fsSL https://github.com/golangci/golangci-lint/releases/download/v$(GOLANGCILINT_VERSION)/golangci-lint-$(GOLANGCILINT_VERSION)-$(HOSTOS)-$(HOSTARCH).tar.gz | tar -xz --strip-components=1 -C $(TOOLS_HOST_DIR)/tmp-golangci-lint || $(FAIL)
+	@mv $(TOOLS_HOST_DIR)/tmp-golangci-lint/golangci-lint $(GOLANGCILINT) || $(FAIL)
+	@rm -fr $(TOOLS_HOST_DIR)/tmp-golangci-lint
+	@$(OK) installing golangci-lint-v$(GOLANGCILINT_VERSION) $(HOSTOS)-$(HOSTARCH)
+
+$(GOFMT):
+	@$(INFO) installing gofmt$(GOFMT_VERSION)
+	@mkdir -p $(TOOLS_HOST_DIR)/tmp-fmt || $(FAIL)
+	@curl -sL https://dl.google.com/go/go$(GOFMT_VERSION).$(HOSTOS)-$(HOSTARCH).tar.gz | tar -xz -C $(TOOLS_HOST_DIR)/tmp-fmt || $(FAIL)
+	@mv $(TOOLS_HOST_DIR)/tmp-fmt/go/bin/gofmt $(GOFMT) || $(FAIL)
+	@rm -fr $(TOOLS_HOST_DIR)/tmp-fmt
+	@$(OK) installing gofmt$(GOFMT_VERSION)
+
+$(GOIMPORTS):
+	@$(MAKE) go.get GOPKG=golang.org/x/tools/cmd/goimports
+
+$(GOJUNIT):
+	@$(MAKE) go.get GOPKG=github.com/jstemmer/go-junit-report
+
+$(GOCOVER_COBERTURA): $(GOJUNIT)
+	@$(MAKE) go.get GOPKG=github.com/t-yuki/gocover-cobertura
+
+$(CONTROLLERGEN):
+	@$(MAKE) go.get GOPKG=sigs.k8s.io/controller-tools/cmd/[email protected]
+
+go.get:
+	@$(INFO) installing $(GOPKG)
+	@GOBIN=$(TOOLS_HOST_DIR) $(GOHOST) get $(GOPKG) || $(FAIL)
+	@# the below command reverts the go.mod modification because of running `go get`
+	@# otherwise the build becomes dirty and won't be published
+	@$(GOHOST) mod tidy
+	@$(OK) installed $(GOPKG)