blob: 13b5d0de3732edf7d67c0caa5c888c8f903bb9ca [file] [log] [blame]
Scott Baker2c1c4822019-10-16 11:02:41 -07001#
Joey Armstrong26245a32022-12-17 21:49:06 -05002# Copyright 2016-2022 Open Networking Foundation (ONF) and the ONF Contributors
Scott Baker2c1c4822019-10-16 11:02:41 -07003#
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
Kent Hagermanfac11d42020-01-28 12:18:55 -050023# tool containers
David K. Bainbridgec50d88c2021-04-08 15:47:03 +000024VOLTHA_TOOLS_VERSION ?= 2.4.0
Kent Hagermanfac11d42020-01-28 12:18:55 -050025
Kent Hagerman08d15ab2020-02-14 14:54:52 -050026GO = docker run --rm --user $$(id -u):$$(id -g) -v ${CURDIR}:/app $(shell test -t 0 && echo "-it") -v gocache:/.cache -v gocache-${VOLTHA_TOOLS_VERSION}:/go/pkg voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-golang go
Kent Hagermanfac11d42020-01-28 12:18:55 -050027GO_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
khenaidoo26721882021-08-11 17:42:52 -040028GOCOVER_COBERTURA = docker run --rm --user $$(id -u):$$(id -g) -v ${CURDIR}:/app/src/github.com/opencord/voltha-lib-go/v7 -i voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-gocover-cobertura gocover-cobertura
Kent Hagerman08d15ab2020-02-14 14:54:52 -050029GOLANGCI_LINT = docker run --rm --user $$(id -u):$$(id -g) -v ${CURDIR}:/app $(shell test -t 0 && echo "-it") -v gocache:/.cache -v gocache-${VOLTHA_TOOLS_VERSION}:/go/pkg voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-golangci-lint golangci-lint
Scott Baker2c1c4822019-10-16 11:02:41 -070030
31.PHONY: local-protos
32
33# This should to be the first and default target in this Makefile
34help:
35 @echo "Usage: make [<target>]"
36 @echo "where available targets are:"
37 @echo
38 @echo "build : Build the library"
39 @echo "clean : Remove files created by the build"
40 @echo "distclean : Remove build and testing artifacts and reports"
Scott Baker2c1c4822019-10-16 11:02:41 -070041 @echo "lint-mod : Verify the integrity of the 'mod' files"
42 @echo "lint : Shorthand for lint-style & lint-sanity"
43 @echo "mod-update : Update go.mod and the vendor directory"
44 @echo "test : Generate reports for all go tests"
45 @echo
46
47## Local Development Helpers
48local-protos:
49 @mkdir -p python/local_imports
50ifdef LOCAL_PROTOS
Joey Armstrong26245a32022-12-17 21:49:06 -050051 $(RM) -r vendor/github.com/opencord/voltha-protos
khenaidoo26721882021-08-11 17:42:52 -040052 mkdir -p vendor/github.com/opencord/voltha-protos/v5/go
53 cp -r ${LOCAL_PROTOS}/go/* vendor/github.com/opencord/voltha-protos/v5/go
Joey Armstrong26245a32022-12-17 21:49:06 -050054 $(RM) -r python/local_imports/voltha-protos
Scott Baker2c1c4822019-10-16 11:02:41 -070055 mkdir -p python/local_imports/voltha-protos/dist
Scott Bakerf1b096c2019-11-01 12:36:30 -070056 cp ${LOCAL_PROTOS}/dist/*.tar.gz python/local_imports/voltha-protos/dist/
Scott Baker2c1c4822019-10-16 11:02:41 -070057endif
58
59## build the library
Scott Bakerf1b096c2019-11-01 12:36:30 -070060build: local-protos
khenaidoo26721882021-08-11 17:42:52 -040061## ${GO} build -mod=vendor ./...
Kent Hagermanfac11d42020-01-28 12:18:55 -050062 ${GO} build -mod=vendor ./...
Scott Baker2c1c4822019-10-16 11:02:41 -070063
64## lint and unit tests
65
Scott Baker2c1c4822019-10-16 11:02:41 -070066lint-mod:
67 @echo "Running dependency check..."
Kent Hagermanfac11d42020-01-28 12:18:55 -050068 @${GO} mod verify
Scott Bakera36b4982019-11-26 08:09:23 -080069 @echo "Dependency check OK. Running vendor check..."
70 @git status > /dev/null
Kent Hagerman3da1fd02020-02-26 10:54:07 -050071 @git diff-index --quiet HEAD -- go.mod go.sum vendor || (echo "ERROR: Staged or modified files must be committed before running this test" && git status -- go.mod go.sum vendor && exit 1)
72 @[[ `git ls-files --exclude-standard --others go.mod go.sum vendor` == "" ]] || (echo "ERROR: Untracked files must be cleaned up before running this test" && git status -- go.mod go.sum vendor && exit 1)
Kent Hagermanfac11d42020-01-28 12:18:55 -050073 ${GO} mod tidy
74 ${GO} mod vendor
Scott Bakera36b4982019-11-26 08:09:23 -080075 @git status > /dev/null
Kent Hagerman3da1fd02020-02-26 10:54:07 -050076 @git diff-index --quiet HEAD -- go.mod go.sum vendor || (echo "ERROR: Modified files detected after running go mod tidy / go mod vendor" && git status -- go.mod go.sum vendor && git checkout -- go.mod go.sum vendor && exit 1)
77 @[[ `git ls-files --exclude-standard --others go.mod go.sum vendor` == "" ]] || (echo "ERROR: Untracked files detected after running go mod tidy / go mod vendor" && git status -- go.mod go.sum vendor && git checkout -- go.mod go.sum vendor && exit 1)
Scott Bakera36b4982019-11-26 08:09:23 -080078 @echo "Vendor check OK."
Scott Baker2c1c4822019-10-16 11:02:41 -070079
Kent Hagerman3da1fd02020-02-26 10:54:07 -050080lint: lint-mod
Scott Baker2c1c4822019-10-16 11:02:41 -070081
Kent Hagermanfac11d42020-01-28 12:18:55 -050082sca:
Joey Armstrong26245a32022-12-17 21:49:06 -050083 @$(RM) -r ./sca-report
Scott Baker2c1c4822019-10-16 11:02:41 -070084 @mkdir -p ./sca-report
Kent Hagerman3da1fd02020-02-26 10:54:07 -050085 @echo "Running static code analysis..."
86 @${GOLANGCI_LINT} run --deadline=4m --out-format junit-xml ./... | tee ./sca-report/sca-report.xml
87 @echo ""
88 @echo "Static code analysis OK"
Scott Baker2c1c4822019-10-16 11:02:41 -070089
Matteo Scandolod58eaef2020-03-30 12:30:02 -070090test: local-protos
Scott Baker2c1c4822019-10-16 11:02:41 -070091 @mkdir -p ./tests/results
Kent Hagermanfac11d42020-01-28 12:18:55 -050092 @${GO} test -mod=vendor -v -coverprofile ./tests/results/go-test-coverage.out -covermode count ./... 2>&1 | tee ./tests/results/go-test-results.out ;\
Scott Baker2c1c4822019-10-16 11:02:41 -070093 RETURN=$$? ;\
Kent Hagermanfac11d42020-01-28 12:18:55 -050094 ${GO_JUNIT_REPORT} < ./tests/results/go-test-results.out > ./tests/results/go-test-results.xml ;\
95 ${GOCOVER_COBERTURA} < ./tests/results/go-test-coverage.out > ./tests/results/go-test-coverage.xml ;\
Scott Baker2c1c4822019-10-16 11:02:41 -070096 exit $$RETURN
97
Kent Hagermanfac11d42020-01-28 12:18:55 -050098clean: distclean
Scott Baker2c1c4822019-10-16 11:02:41 -070099
Joey Armstrong26245a32022-12-17 21:49:06 -0500100distclean sterile:
101 $(RM) -r ./sca-report ./tests
Scott Baker2c1c4822019-10-16 11:02:41 -0700102
Kent Hagermanfac11d42020-01-28 12:18:55 -0500103mod-update:
104 ${GO} mod tidy
105 ${GO} mod vendor
Joey Armstrong26245a32022-12-17 21:49:06 -0500106
107# [EOF]