# # Copyright 2016 the original author or authors. # # 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. # # set default shell SHELL = bash -e -o pipefail # Variables VERSION ?= $(shell cat ./VERSION) DOCKER_LABEL_VCS_DIRTY = false ifneq ($(shell git ls-files --others --modified --exclude-standard 2>/dev/null | wc -l | sed -e 's/ //g'),0) DOCKER_LABEL_VCS_DIRTY = true endif ## Docker related DOCKER_EXTRA_ARGS ?= DOCKER_REGISTRY ?= DOCKER_REPOSITORY ?= DOCKER_TAG ?= ${VERSION} ADAPTER_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-openonu-adapter-go:${DOCKER_TAG} TYPE ?= minimal ## Docker labels. Only set ref and commit date if committed DOCKER_LABEL_VCS_URL ?= $(shell git remote get-url $(shell git remote)) DOCKER_LABEL_VCS_REF = $(shell git rev-parse HEAD) DOCKER_LABEL_BUILD_DATE ?= $(shell date -u "+%Y-%m-%dT%H:%M:%SZ") DOCKER_LABEL_COMMIT_DATE = $(shell git show -s --format=%cd --date=iso-strict HEAD) DOCKER_BUILD_ARGS ?= \ ${DOCKER_EXTRA_ARGS} \ --build-arg org_label_schema_version="${VERSION}" \ --build-arg org_label_schema_vcs_url="${DOCKER_LABEL_VCS_URL}" \ --build-arg org_label_schema_vcs_ref="${DOCKER_LABEL_VCS_REF}" \ --build-arg org_label_schema_build_date="${DOCKER_LABEL_BUILD_DATE}" \ --build-arg org_opencord_vcs_commit_date="${DOCKER_LABEL_COMMIT_DATE}" \ --build-arg org_opencord_vcs_dirty="${DOCKER_LABEL_VCS_DIRTY}" # tool containers VOLTHA_TOOLS_VERSION ?= 2.0.0 GO = docker run --rm --user $$(id -u):$$(id -g) -v ${CURDIR}:/app -v gocache:/.cache -v gocache-${VOLTHA_TOOLS_VERSION}:/go/pkg voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-golang go GO_JUNIT_REPORT = docker run --rm --user $$(id -u):$$(id -g) -v ${CURDIR}:/app -i voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-go-junit-report go-junit-report GOCOVER_COBERTURA = docker run --rm --user $$(id -u):$$(id -g) -v ${CURDIR}:/app -i voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-gocover-cobertura gocover-cobertura GOFMT = docker run --rm --user $$(id -u):$$(id -g) -v ${CURDIR}:/app voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-golang gofmt GOLANGCI_LINT = docker run --rm --user $$(id -u):$$(id -g) -v ${CURDIR}:/app -v gocache:/.cache -v gocache-${VOLTHA_TOOLS_VERSION}:/go/pkg voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-golangci-lint golangci-lint HADOLINT = docker run --rm --user $$(id -u):$$(id -g) -v ${CURDIR}:/app voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-hadolint hadolint .PHONY: docker-build local-protos local-lib-go # This should to be the first and default target in this Makefile help: @echo "Usage: make [<target>]" @echo "where available targets are:" @echo "" @echo "clean : Removes any local filesystem artifacts generated by a build" @echo "distclean : Removes any local filesystem artifacts generated by a build or test run" @echo "build : Build all openonu adapter artifacts" @echo "docker-build : Build openonu adapter docker image" @echo "docker-push : Push the docker images to an external repository" @echo "help : Print this help" @echo "lint : Run all lint targets" @echo "lint-dockerfile : Perform static analysis on Dockerfiles" @echo "lint-mod : Verify the Go dependencies" @echo "lint-sanity : Run the Go language sanity tests (vet)" @echo "lint-style : Verify the Go standard format of the source" @echo "local-protos : Copies a local verison of the VOLTHA protos into the vendor directory" @echo "local-lib-go : Copies a local version of the VOTLHA dependencies into the vendor directory" @echo "sca : Runs various SCA through golangci-lint tool" @echo "test : Run unit tests, if any" @echo ## Local Development Helpers local-protos: ifdef LOCAL_PROTOS rm -rf vendor/github.com/opencord/voltha-protos/v3/go mkdir -p vendor/github.com/opencord/voltha-protos/v3/go cp -r ${LOCAL_PROTOS}/go/* vendor/github.com/opencord/voltha-protos/v3/go rm -rf vendor/github.com/opencord/voltha-protos/v3/go/vendor endif ## Local Development Helpers local-lib-go: ifdef LOCAL_LIB_GO mkdir -p vendor/github.com/opencord/voltha-lib-go/v3/pkg cp -r ${LOCAL_LIB_GO}/pkg/* vendor/github.com/opencord/voltha-lib-go/v3/pkg/ endif ## Docker targets build: docker-build docker-build: local-protos local-lib-go docker build $(DOCKER_BUILD_ARGS) -t ${ADAPTER_IMAGENAME} -f docker/Dockerfile.openonu . docker-push: docker push ${ADAPTER_IMAGENAME} docker-kind-load: @if [ "`kind get clusters | grep voltha-$(TYPE)`" = '' ]; then echo "no voltha-$(TYPE) cluster found" && exit 1; fi kind load docker-image ${ADAPTER_IMAGENAME} --name=voltha-$(TYPE) --nodes $(shell kubectl get nodes --template='{{range .items}}{{.metadata.name}},{{end}}' | sed 's/,$$//') ## lint and unit tests lint-dockerfile: @echo "Running Dockerfile lint check ..." @${HADOLINT} $$(find . -name "Dockerfile.*") @echo "Dockerfile lint check OK" lint-style: @echo "Running style check..." @gofmt_out="$$(${GOFMT} -l $$(find . -name '*.go' -not -path './vendor/*'))" ;\ if [ ! -z "$$gofmt_out" ]; then \ echo "$$gofmt_out" ;\ echo "Style check failed on one or more files ^, run 'go fmt' to fix." ;\ exit 1 ;\ fi @echo "Style check OK" lint-sanity: @echo "Running sanity check..." @${GO} vet -mod=vendor ./... @echo "Sanity check OK" lint-mod: @echo "Running dependency check..." @${GO} mod verify @echo "Dependency check OK. Running vendor check..." @git status > /dev/null @git diff-index --quiet HEAD -- go.mod go.sum vendor || (echo "ERROR: Staged or modified files must be committed before running this test" && echo "`git status`" && exit 1) @[[ `git ls-files --exclude-standard --others go.mod go.sum vendor` == "" ]] || (echo "ERROR: Untracked files must be cleaned up before running this test" && echo "`git status`" && exit 1) ${GO} mod tidy ${GO} mod vendor @git status > /dev/null @git diff-index --quiet HEAD -- go.mod go.sum vendor || (echo "ERROR: Modified files detected after running go mod tidy / go mod vendor" && echo "`git status`" && exit 1) @[[ `git ls-files --exclude-standard --others go.mod go.sum vendor` == "" ]] || (echo "ERROR: Untracked files detected after running go mod tidy / go mod vendor" && echo "`git status`" && exit 1) @echo "Vendor check OK." lint: local-lib-go lint-style lint-sanity lint-mod lint-dockerfile test: @mkdir -p ./tests/results @${GO} test -mod=vendor -v -coverprofile ./tests/results/go-test-coverage.out -covermode count ./... 2>&1 | tee ./tests/results/go-test-results.out ;\ RETURN=$$? ;\ ${GO_JUNIT_REPORT} < ./tests/results/go-test-results.out > ./tests/results/go-test-results.xml ;\ ${GOCOVER_COBERTURA} < ./tests/results/go-test-coverage.out > ./tests/results/go-test-coverage.xml ;\ exit $$RETURN sca: @mkdir -p ./sca-report @echo "Running static code analysis..." @${GOLANGCI_LINT} run --deadline=4m --out-format junit-xml ./... | tee ./sca-report/sca-report.xml @echo "Static code analysis OK" clean: distclean distclean: rm -rf ./sca-report mod-update: ${GO} mod tidy ${GO} mod vendor