blob: fd2e1e537549e12a63208981a0741a0ecaafe835 [file] [log] [blame]
Dinesh Belwalkar6c0bc752020-04-24 23:47:53 +00001# Copyright 2019-present Open Networking Foundation
2# Copyright 2019-present Edgecore Networks Corporation
Dinesh Belwalkar01217962019-05-23 21:51:16 +00003#
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# Configure shell
17SHELL = bash -eu -o pipefail
18
Scott Baker5d03e172020-04-10 14:56:20 -070019ROOT_DIR := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
20
Dinesh Belwalkar01217962019-05-23 21:51:16 +000021# Variables
22VERSION ?= $(shell cat ./VERSION)
23CONTAINER_NAME ?= $(notdir $(abspath .))
24
25## Docker related
26DOCKER_REGISTRY ?=
27DOCKER_REPOSITORY ?=
28DOCKER_BUILD_ARGS ?=
29DOCKER_TAG ?= ${VERSION}
30DOCKER_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}${CONTAINER_NAME}:${DOCKER_TAG}
31
32## Docker labels. Only set ref and commit date if committed
33DOCKER_LABEL_VCS_URL ?= $(shell git remote get-url $(shell git remote))
34DOCKER_LABEL_VCS_REF ?= $(shell git diff-index --quiet HEAD -- && git rev-parse HEAD || echo "unknown")
35DOCKER_LABEL_COMMIT_DATE ?= $(shell git diff-index --quiet HEAD -- && git show -s --format=%cd --date=iso-strict HEAD || echo "unknown" )
36DOCKER_LABEL_BUILD_DATE ?= $(shell date -u "+%Y-%m-%dT%H:%M:%SZ")
37
Scott Baker5d03e172020-04-10 14:56:20 -070038ROBOT_MOCK_OLT_FILE ?= $(ROOT_DIR)/demo_test/functional_test/robot-mock-olt.yaml
39ROBOT_DEBUG_LOG_OPT ?=
40ROBOT_MISC_ARGS ?=
41
Dinesh Belwalkar0bc4ace2019-11-14 21:41:50 +000042help:
43 @echo "Usage: make [<target>]"
44 @echo "where available targets are:"
45 @echo
Dinesh Belwalkare63f7f92019-11-22 23:11:16 +000046 @echo "proto/importer.pb.go : Build importer.pb.go for go build ./.."
Dinesh Belwalkar0bc4ace2019-11-14 21:41:50 +000047 @echo "build : Build the docker images."
48 @echo " - If this is the first time you are building, choose 'make build' option."
49 @echo "clean : Remove files created by the build and tests"
50 @echo "docker-push : Push the docker images to an external repository"
51 @echo "lint-dockerfile : Perform static analysis on Dockerfiles"
52 @echo "lint-style : Verify code is properly gofmt-ed"
Dinesh Belwalkare63f7f92019-11-22 23:11:16 +000053 @echo "lint-sanity : Verify that 'go vet' doesn't report any issues"
54 @echo "lint-mod : Verify the integrity of the 'mod' files"
Dinesh Belwalkar0bc4ace2019-11-14 21:41:50 +000055 @echo "lint : Shorthand for lint-style & lint-sanity"
56 @echo "test : Generate reports for all go tests"
57 @echo
58
Dinesh Belwalkar01217962019-05-23 21:51:16 +000059all: test
Scott Baker5d03e172020-04-10 14:56:20 -070060
61# target to invoke mock-olt robot tests
62functional-mock-test: ROBOT_MISC_ARGS += $(ROBOT_DEBUG_LOG_OPT)
63functional-mock-test: ROBOT_CONFIG_FILE := $(ROBOT_MOCK_OLT_FILE)
64functional-mock-test: ROBOT_FILE := $(ROOT_DIR)/demo_test/functional_test/importer.robot
65functional-mock-test: importer-functional-test
66
Dinesh Belwalkare63f7f92019-11-22 23:11:16 +000067proto/importer.pb.go: proto/importer.proto
68 mkdir -p proto
69 protoc --proto_path=proto \
70 -I${GOPATH}/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
71 --go_out=plugins=grpc:proto/ \
72 proto/importer.proto
73
Dinesh Belwalkar0bc4ace2019-11-14 21:41:50 +000074build: docker-build
75
Scott Bakerbdb962b2020-04-03 10:53:36 -070076docker-build: docker-build-importer
77 make -C demo_test docker-build
78 make -C mock-redfish-server docker-build
Dinesh Belwalkar0bc4ace2019-11-14 21:41:50 +000079
Scott Bakerbdb962b2020-04-03 10:53:36 -070080docker-push: docker-push-importer
81 make -C demo_test docker-push
82 make -C mock-redfish-server docker-push
83
84docker-build-importer:
Dinesh Belwalkar01217962019-05-23 21:51:16 +000085 docker build $(DOCKER_BUILD_ARGS) \
86 -t ${DOCKER_IMAGENAME} \
87 --build-arg org_label_schema_version="${VERSION}" \
88 --build-arg org_label_schema_vcs_url="${DOCKER_LABEL_VCS_URL}" \
89 --build-arg org_label_schema_vcs_ref="${DOCKER_LABEL_VCS_REF}" \
90 --build-arg org_label_schema_build_date="${DOCKER_LABEL_BUILD_DATE}" \
91 --build-arg org_opencord_vcs_commit_date="${DOCKER_LABEL_COMMIT_DATE}" \
92 -f Dockerfile .
Scott Bakerbdb962b2020-04-03 10:53:36 -070093
94docker-push-importer:
Dinesh Belwalkar01217962019-05-23 21:51:16 +000095 docker push ${DOCKER_IMAGENAME}
96
Scott Bakerbdb962b2020-04-03 10:53:36 -070097
Dinesh Belwalkar0bc4ace2019-11-14 21:41:50 +000098PATH:=$(GOPATH)/bin:$(PATH)
99HADOLINT=$(shell PATH=$(GOPATH):$(PATH) which hadolint)
100
101lint-dockerfile:
102ifeq (,$(shell PATH=$(GOPATH):$(PATH) which hadolint))
103 mkdir -p $(GOPATH)/bin
104 curl -o $(GOPATH)/bin/hadolint -sNSL https://github.com/hadolint/hadolint/releases/download/v1.17.1/hadolint-$(shell uname -s)-$(shell uname -m)
105 chmod 755 $(GOPATH)/bin/hadolint
106endif
107 @echo "Running Dockerfile lint check ..."
Dinesh Belwalkar72ecafb2019-12-12 00:08:56 +0000108 @hadolint $$(find . -type f -not -path "./vendor/*" -name "Dockerfile")
Dinesh Belwalkar0bc4ace2019-11-14 21:41:50 +0000109 @echo "Dockerfile lint check OK"
110
111lint-style:
112ifeq (,$(shell which gofmt))
113 go get -u github.com/golang/go/src/cmd/gofmt
114endif
115 @echo "Running style check..."
116 @gofmt_out="$$(gofmt -l $$(find . -name '*.go' -not -path './vendor/*'))" ;\
117 if [ ! -z "$$gofmt_out" ]; then \
118 echo "$$gofmt_out" ;\
119 echo "Style check failed on one or more files ^, run 'go fmt' to fix." ;\
120 exit 1 ;\
121 fi
122 @echo "Style check OK"
123
Dinesh Belwalkara6ba07d2020-01-10 23:22:34 +0000124lint-sanity:proto/importer.pb.go
Dinesh Belwalkare63f7f92019-11-22 23:11:16 +0000125 @echo "Running sanity check..."
126 @go vet -mod=vendor ./...
127 @echo "Sanity check OK"
Dinesh Belwalkar0bc4ace2019-11-14 21:41:50 +0000128
Dinesh Belwalkare63f7f92019-11-22 23:11:16 +0000129lint-mod:
130 @echo "Running dependency check..."
131 @go mod verify
132 @echo "Dependency check OK"
133lint: lint-style lint-dockerfile lint-sanity lint-mod
Dinesh Belwalkar0bc4ace2019-11-14 21:41:50 +0000134
135# Rules to automatically install golangci-lint
136GOLANGCI_LINT_TOOL?=$(shell which golangci-lint)
137ifeq (,$(GOLANGCI_LINT_TOOL))
138GOLANGCI_LINT_TOOL=$(GOPATH)/bin/golangci-lint
139golangci_lint_tool_install:
140 # Same version as installed by Jenkins ci-management
141 # Note that install using `go get` is not recommended as per https://github.com/golangci/golangci-lint
142 curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b $(GOPATH)/bin v1.17.0
143else
144golangci_lint_tool_install:
145endif
146
147sca: golangci_lint_tool_install
148 rm -rf ./sca-report
149 @mkdir -p ./sca-report
150 $(GOLANGCI_LINT_TOOL) run --out-format junit-xml ./... 2>&1 | tee ./sca-report/sca-report.xml
151
Dinesh Belwalkar01217962019-05-23 21:51:16 +0000152test: docker-build
153
154clean:
155 @echo "No cleanup available"
Scott Baker5d03e172020-04-10 14:56:20 -0700156
157# Check out a copy of voltha-system-tests. We will reuse its robot configuration
158# and its robot libraries
159voltha-system-tests:
160 git clone https://github.com/opencord/voltha-system-tests.git
161
162# virtualenv for the robot tools
163# VOL-2724 Invoke pip via python3 to avoid pathname too long on QA jobs
164vst_venv: voltha-system-tests
165 virtualenv -p python3 $@ && \
166 VIRTUAL_ENV_DISABLE_PROMPT=true source ./$@/bin/activate && \
167 python -m pip install -r voltha-system-tests/requirements.txt
168
169importer-functional-test: vst_venv
170 VIRTUAL_ENV_DISABLE_PROMPT=true source ./$</bin/activate ; set -u ;\
171 cd demo_test/functional_test ;\
172 robot -V $(ROBOT_CONFIG_FILE) $(ROBOT_MISC_ARGS) $(ROBOT_FILE)