blob: dc15d720c79c59e80b527c48d42baec2e2d6e43e [file] [log] [blame]
Scott Baker2d897982019-09-24 11:50:08 -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)
32SIMULATEDOLT_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-adapter-simulated-olt
33
34## Docker labels. Only set ref and commit date if committed
35DOCKER_LABEL_VCS_URL ?= $(shell git remote get-url $(shell git remote))
36DOCKER_LABEL_VCS_REF = $(shell git rev-parse HEAD)
37DOCKER_LABEL_BUILD_DATE ?= $(shell date -u "+%Y-%m-%dT%H:%M:%SZ")
38DOCKER_LABEL_COMMIT_DATE = $(shell git show -s --format=%cd --date=iso-strict HEAD)
39
Scott Bakerf8f97fa2019-09-30 13:07:01 -070040# Default is GO111MODULE=auto, which will refuse to use go mod if running
41# go less than 1.13.0 and this repository is checked out in GOPATH. For now,
42# force module usage. This affects commands executed from this Makefile, but
43# not the environment inside the Docker build (which does not build from
44# inside a GOPATH).
45export GO111MODULE=on
46
Scott Baker2d897982019-09-24 11:50:08 -070047DOCKER_BUILD_ARGS ?= \
48 ${DOCKER_EXTRA_ARGS} \
49 --build-arg org_label_schema_version="${VERSION}" \
50 --build-arg org_label_schema_vcs_url="${DOCKER_LABEL_VCS_URL}" \
51 --build-arg org_label_schema_vcs_ref="${DOCKER_LABEL_VCS_REF}" \
52 --build-arg org_label_schema_build_date="${DOCKER_LABEL_BUILD_DATE}" \
53 --build-arg org_opencord_vcs_commit_date="${DOCKER_LABEL_COMMIT_DATE}" \
54 --build-arg org_opencord_vcs_dirty="${DOCKER_LABEL_VCS_DIRTY}"
55
56DOCKER_BUILD_ARGS_LOCAL ?= ${DOCKER_BUILD_ARGS} \
57 --build-arg LOCAL_PYVOLTHA=${LOCAL_PYVOLTHA} \
58 --build-arg LOCAL_PROTOS=${LOCAL_PROTOS}
59
Scott Baker5d389402019-10-25 14:55:13 -070060.PHONY: simulated_olt simulated_onu local-protos local-lib-go
Scott Baker2d897982019-09-24 11:50:08 -070061
62# This should to be the first and default target in this Makefile
63help:
64 @echo "Usage: make [<target>]"
65 @echo "where available targets are:"
66 @echo
67 @echo "build : Build the docker images."
68 @echo " - If this is the first time you are building, choose 'make build' option."
69 @echo "simulated_olt : Build the simulated_olt docker image"
70 @echo "clean : Remove files created by the build and tests"
71 @echo "docker-push : Push the docker images to an external repository"
72 @echo "lint-dockerfile : Perform static analysis on Dockerfiles"
73 @echo "lint-style : Verify code is properly gofmt-ed"
74 @echo "lint-sanity : Verify that 'go vet' doesn't report any issues"
Scott Bakerf8f97fa2019-09-30 13:07:01 -070075 @echo "lint-mod : Verify the integrity of the 'mod' files"
Scott Baker2d897982019-09-24 11:50:08 -070076 @echo "lint : Shorthand for lint-style & lint-sanity"
Scott Baker5d389402019-10-25 14:55:13 -070077 @echo "local-lib-go : Copies a local version of the VOTLHA dependencies into the vendor directory"
78 @echo "local-protos : Copies a local verison of the VOLTHA protos into the vendor directory"
Scott Baker2d897982019-09-24 11:50:08 -070079 @echo "test : Generate reports for all go tests"
80 @echo
81
82## Local Development Helpers
83local-protos:
84ifdef LOCAL_PROTOS
Scott Baker5d389402019-10-25 14:55:13 -070085 rm -rf vendor/github.com/opencord/voltha-protos/go
Scott Baker2d897982019-09-24 11:50:08 -070086 mkdir -p vendor/github.com/opencord/voltha-protos/go
Scott Baker5d389402019-10-25 14:55:13 -070087 cp -r ${LOCAL_PROTOS}/go/* vendor/github.com/opencord/voltha-protos/go
88 rm -rf vendor/github.com/opencord/voltha-protos/go/vendor
89endif
90
91## Local Development Helpers
92local-lib-go:
93ifdef LOCAL_LIB_GO
94 rm -rf vendor/github.com/opencord/voltha-lib-go
95 mkdir -p vendor/github.com/opencord/voltha-lib-go/v2/pkg
96 cp -r ${LOCAL_LIB_GO}/pkg/* vendor/github.com/opencord/voltha-lib-go/v2/pkg/
Scott Baker2d897982019-09-24 11:50:08 -070097endif
98
99## Docker targets
100
101build: docker-build
102
103docker-build: simulated_olt
104
Scott Baker5d389402019-10-25 14:55:13 -0700105simulated_olt: local-protos local-lib-go
Scott Baker2d897982019-09-24 11:50:08 -0700106 docker build $(DOCKER_BUILD_ARGS) -t ${SIMULATEDOLT_IMAGENAME}:${DOCKER_TAG} -t ${SIMULATEDOLT_IMAGENAME}:latest -f docker/Dockerfile.simulated_olt .
107
108docker-push:
109 docker push ${SIMULATEDOLT_IMAGENAME}:${DOCKER_TAG}
110
111## lint and unit tests
112
113PATH:=$(GOPATH)/bin:$(PATH)
114HADOLINT=$(shell PATH=$(GOPATH):$(PATH) which hadolint)
115lint-dockerfile:
116ifeq (,$(shell PATH=$(GOPATH):$(PATH) which hadolint))
117 mkdir -p $(GOPATH)/bin
118 curl -o $(GOPATH)/bin/hadolint -sNSL https://github.com/hadolint/hadolint/releases/download/v1.17.1/hadolint-$(shell uname -s)-$(shell uname -m)
119 chmod 755 $(GOPATH)/bin/hadolint
120endif
121 @echo "Running Dockerfile lint check ..."
122 @hadolint $$(find . -name "Dockerfile.*")
123 @echo "Dockerfile lint check OK"
124
125lint-style:
126ifeq (,$(shell which gofmt))
127 go get -u github.com/golang/go/src/cmd/gofmt
128endif
129 @echo "Running style check..."
130 @gofmt_out="$$(gofmt -l $$(find . -name '*.go' -not -path './vendor/*'))" ;\
131 if [ ! -z "$$gofmt_out" ]; then \
132 echo "$$gofmt_out" ;\
133 echo "Style check failed on one or more files ^, run 'go fmt' to fix." ;\
134 exit 1 ;\
135 fi
136 @echo "Style check OK"
137
138lint-sanity:
139 @echo "Running sanity check..."
Scott Bakerf8f97fa2019-09-30 13:07:01 -0700140 @go vet -mod=vendor ./...
Scott Baker2d897982019-09-24 11:50:08 -0700141 @echo "Sanity check OK"
142
Scott Bakerf8f97fa2019-09-30 13:07:01 -0700143lint-mod:
Scott Baker2d897982019-09-24 11:50:08 -0700144 @echo "Running dependency check..."
Scott Bakerf8f97fa2019-09-30 13:07:01 -0700145 @go mod verify
Scott Baker2d897982019-09-24 11:50:08 -0700146 @echo "Dependency check OK"
147
Scott Bakerf8f97fa2019-09-30 13:07:01 -0700148lint: lint-style lint-sanity lint-mod lint-dockerfile
Scott Baker2d897982019-09-24 11:50:08 -0700149
150GO_JUNIT_REPORT:=$(shell which go-junit-report)
151GOCOVER_COBERTURA:=$(shell which gocover-cobertura)
152
153test:
154ifeq (,$(GO_JUNIT_REPORT))
155 go get -u github.com/jstemmer/go-junit-report
156 @GO_JUNIT_REPORT=$(GOPATH)/bin/go-junit-report
157endif
158ifeq (,$(GOCOVER_COBERTURA))
159 go get -u github.com/t-yuki/gocover-cobertura
160 @GOCOVER_COBERTURA=$(GOPATH)/bin/gocover-cobertura
161endif
162 @mkdir -p ./tests/results
Scott Bakerf8f97fa2019-09-30 13:07:01 -0700163 @go test --mod=vendor -v -coverprofile ./tests/results/go-test-coverage.out -covermode count ./... 2>&1 | tee ./tests/results/go-test-results.out ;\
Scott Baker2d897982019-09-24 11:50:08 -0700164 RETURN=$$? ;\
165 $(GO_JUNIT_REPORT) < ./tests/results/go-test-results.out > ./tests/results/go-test-results.xml ;\
166 $(GOCOVER_COBERTURA) < ./tests/results/go-test-coverage.out > ./tests/results/go-test-coverage.xml ;\
167 exit $$RETURN
168
169clean:
170
171distclean: clean
172
173# end file