blob: ba5f74d993f3d10eddf20d56c1d36963e12d764f [file] [log] [blame]
Scott Bakere7144bc2019-10-01 14:16:47 -07001#
2# Copyright 2016 the original author or authors.
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15#
16
17# set default shell
18SHELL = bash -e -o pipefail
19
20# Variables
21VERSION ?= $(shell cat ./VERSION)
22
23DOCKER_LABEL_VCS_DIRTY = false
24ifneq ($(shell git ls-files --others --modified --exclude-standard 2>/dev/null | wc -l | sed -e 's/ //g'),0)
25 DOCKER_LABEL_VCS_DIRTY = true
26endif
27## Docker related
28DOCKER_EXTRA_ARGS ?=
29DOCKER_REGISTRY ?=
30DOCKER_REPOSITORY ?=
31DOCKER_TAG ?= ${VERSION}$(shell [[ ${DOCKER_LABEL_VCS_DIRTY} == "true" ]] && echo "-dirty" || true)
32AFROUTER_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-afrouter
33AFROUTERD_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-afrouterd
34
35## Docker labels. Only set ref and commit date if committed
36DOCKER_LABEL_VCS_URL ?= $(shell git remote get-url $(shell git remote))
37DOCKER_LABEL_VCS_REF = $(shell git rev-parse HEAD)
38DOCKER_LABEL_BUILD_DATE ?= $(shell date -u "+%Y-%m-%dT%H:%M:%SZ")
39DOCKER_LABEL_COMMIT_DATE = $(shell git show -s --format=%cd --date=iso-strict HEAD)
40
41DOCKER_BUILD_ARGS ?= \
42 ${DOCKER_EXTRA_ARGS} \
43 --build-arg org_label_schema_version="${VERSION}" \
44 --build-arg org_label_schema_vcs_url="${DOCKER_LABEL_VCS_URL}" \
45 --build-arg org_label_schema_vcs_ref="${DOCKER_LABEL_VCS_REF}" \
46 --build-arg org_label_schema_build_date="${DOCKER_LABEL_BUILD_DATE}" \
47 --build-arg org_opencord_vcs_commit_date="${DOCKER_LABEL_COMMIT_DATE}" \
48 --build-arg org_opencord_vcs_dirty="${DOCKER_LABEL_VCS_DIRTY}"
49
50DOCKER_BUILD_ARGS_LOCAL ?= ${DOCKER_BUILD_ARGS} \
51 --build-arg LOCAL_PYVOLTHA=${LOCAL_PYVOLTHA} \
52 --build-arg LOCAL_PROTOS=${LOCAL_PROTOS}
53
Scott Bakerb3a288a2019-10-02 14:57:29 -070054# Default is GO111MODULE=auto, which will refuse to use go mod if running
55# go less than 1.13.0 and this repository is checked out in GOPATH. For now,
56# force module usage. This affects commands executed from this Makefile, but
57# not the environment inside the Docker build (which does not build from
58# inside a GOPATH).
59export GO111MODULE=on
60
Scott Bakere7144bc2019-10-01 14:16:47 -070061.PHONY: rw_core ro_core afrouter afrouterd local-protos local-pyvoltha
62
63# This should to be the first and default target in this Makefile
64help:
65 @echo "Usage: make [<target>]"
66 @echo "where available targets are:"
67 @echo
68 @echo "build : Build the docker images."
69 @echo " - If this is the first time you are building, choose 'make build' option."
70 @echo "afrouter : Build the afrouter docker image"
71 @echo "afrouterd : Build the afrouterd docker image"
72 @echo "clean : Remove files created by the build and tests"
73 @echo "distclean : Remove venv directory"
74 @echo "docker-push : Push the docker images to an external repository"
75 @echo "lint-dockerfile : Perform static analysis on Dockerfiles"
76 @echo "lint-style : Verify code is properly gofmt-ed"
77 @echo "lint-sanity : Verify that 'go vet' doesn't report any issues"
Scott Bakerb3a288a2019-10-02 14:57:29 -070078 @echo "lint-mod : Verify the integrity of the 'mod' files"
Scott Bakere7144bc2019-10-01 14:16:47 -070079 @echo "lint : Shorthand for lint-style & lint-sanity"
80 @echo "sca : Runs various SCA through golangci-lint tool"
81 @echo "test : Generate reports for all go tests"
82 @echo
83
84## Local Development Helpers
85local-protos:
86ifdef LOCAL_PROTOS
Scott Bakerb3a288a2019-10-02 14:57:29 -070087 mkdir -p vendor/github.com/opencord/voltha-protos
88 cp -r ${GOPATH}/src/github.com/opencord/voltha-protos/voltha.pb vendor/github.com/opencord/voltha-protos/
Scott Bakere7144bc2019-10-01 14:16:47 -070089endif
90
91## Docker targets
92
93build: docker-build
94
95docker-build: afrouter afrouterd
96
97afrouter: local-protos
98 docker build $(DOCKER_BUILD_ARGS) -t ${AFROUTER_IMAGENAME}:${DOCKER_TAG} -t ${AFROUTER_IMAGENAME}:latest -f docker/Dockerfile.afrouter .
99
100afrouterd: local-protos
101 docker build $(DOCKER_BUILD_ARGS) -t ${AFROUTERD_IMAGENAME}:${DOCKER_TAG} -t ${AFROUTERD_IMAGENAME}:latest -f docker/Dockerfile.afrouterd .
102
103docker-push:
104 docker push ${AFROUTER_IMAGENAME}:${DOCKER_TAG}
105 docker push ${AFROUTERD_IMAGENAME}:${DOCKER_TAG}
106
107## lint and unit tests
108
109PATH:=$(GOPATH)/bin:$(PATH)
110HADOLINT=$(shell PATH=$(GOPATH):$(PATH) which hadolint)
111lint-dockerfile:
112ifeq (,$(shell PATH=$(GOPATH):$(PATH) which hadolint))
113 mkdir -p $(GOPATH)/bin
114 curl -o $(GOPATH)/bin/hadolint -sNSL https://github.com/hadolint/hadolint/releases/download/v1.17.1/hadolint-$(shell uname -s)-$(shell uname -m)
115 chmod 755 $(GOPATH)/bin/hadolint
116endif
117 @echo "Running Dockerfile lint check ..."
118 @hadolint $$(find . -name "Dockerfile.*")
119 @echo "Dockerfile lint check OK"
120
121lint-style:
122ifeq (,$(shell which gofmt))
123 go get -u github.com/golang/go/src/cmd/gofmt
124endif
125 @echo "Running style check..."
126 @gofmt_out="$$(gofmt -l $$(find . -name '*.go' -not -path './vendor/*'))" ;\
127 if [ ! -z "$$gofmt_out" ]; then \
128 echo "$$gofmt_out" ;\
129 echo "Style check failed on one or more files ^, run 'go fmt' to fix." ;\
130 exit 1 ;\
131 fi
132 @echo "Style check OK"
133
134lint-sanity:
135 @echo "Running sanity check..."
Scott Bakerb3a288a2019-10-02 14:57:29 -0700136 @go vet -mod=vendor ./...
Scott Bakere7144bc2019-10-01 14:16:47 -0700137 @echo "Sanity check OK"
138
Scott Bakerb3a288a2019-10-02 14:57:29 -0700139lint-mod:
Scott Bakere7144bc2019-10-01 14:16:47 -0700140 @echo "Running dependency check..."
Scott Bakerb3a288a2019-10-02 14:57:29 -0700141 @go mod verify
Scott Bakere7144bc2019-10-01 14:16:47 -0700142 @echo "Dependency check OK"
143
Scott Bakerb3a288a2019-10-02 14:57:29 -0700144lint: lint-style lint-sanity lint-mod lint-dockerfile
Scott Bakere7144bc2019-10-01 14:16:47 -0700145
Scott Baker1e75f5b2019-10-15 13:03:19 -0700146# Rules to automatically install golangci-lint
147GOLANGCI_LINT_TOOL?=$(shell which golangci-lint)
Scott Baker4989fe92019-10-09 17:03:06 -0700148ifeq (,$(GOLANGCI_LINT_TOOL))
Scott Baker1e75f5b2019-10-15 13:03:19 -0700149GOLANGCI_LINT_TOOL=$(GOPATH)/bin/golangci-lint
150golangci_lint_tool_install:
151 # Same version as installed by Jenkins ci-management
152 # Note that install using `go get` is not recommended as per https://github.com/golangci/golangci-lint
153 curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b $(GOPATH)/bin v1.17.0
154else
155golangci_lint_tool_install:
Scott Baker4989fe92019-10-09 17:03:06 -0700156endif
Scott Baker1e75f5b2019-10-15 13:03:19 -0700157
158# Rules to automatically install go-junit-report
159GO_JUNIT_REPORT?=$(shell which go-junit-report)
160ifeq (,$(GO_JUNIT_REPORT))
161GO_JUNIT_REPORT=$(GOPATH)/bin/go-junit-report
162go_junit_install:
163 go get -u github.com/jstemmer/go-junit-report
164else
165go_junit_install:
166endif
167
168# Rules to automatically install gocover-covertura
169GOCOVER_COBERTURA?=$(shell which gocover-cobertura)
170ifeq (,$(GOCOVER_COBERTURA))
171 @GOCOVER_COBERTURA=$(GOPATH)/bin/gocover-cobertura
172gocover_cobertura_install:
173 go get -u github.com/t-yuki/gocover-cobertura
174else
175gocover_cobertura_install:
176endif
177
178sca: golangci_lint_tool_install
Scott Baker4989fe92019-10-09 17:03:06 -0700179 rm -rf ./sca-report
Scott Bakere7144bc2019-10-01 14:16:47 -0700180 @mkdir -p ./sca-report
Scott Baker1e75f5b2019-10-15 13:03:19 -0700181 $(GOLANGCI_LINT_TOOL) run --out-format junit-xml ./... 2>&1 | tee ./sca-report/sca-report.xml
Scott Bakere7144bc2019-10-01 14:16:47 -0700182
Scott Baker1e75f5b2019-10-15 13:03:19 -0700183test: go_junit_install gocover_cobertura_install
Scott Bakere7144bc2019-10-01 14:16:47 -0700184 @mkdir -p ./tests/results
Scott Bakerb3a288a2019-10-02 14:57:29 -0700185 @go test -mod=vendor -v -coverprofile ./tests/results/go-test-coverage.out -covermode count ./... 2>&1 | tee ./tests/results/go-test-results.out ;\
Scott Bakere7144bc2019-10-01 14:16:47 -0700186 RETURN=$$? ;\
187 $(GO_JUNIT_REPORT) < ./tests/results/go-test-results.out > ./tests/results/go-test-results.xml ;\
188 $(GOCOVER_COBERTURA) < ./tests/results/go-test-coverage.out > ./tests/results/go-test-coverage.xml ;\
189 exit $$RETURN
190
191clean:
192
193distclean: clean
Scott Baker4989fe92019-10-09 17:03:06 -0700194 rm -rf ./sca_report
Scott Bakere7144bc2019-10-01 14:16:47 -0700195
196# end file