Dinesh Belwalkar | 6c0bc75 | 2020-04-24 23:47:53 +0000 | [diff] [blame^] | 1 | # Copyright 2019-present Open Networking Foundation |
| 2 | # Copyright 2019-present Edgecore Networks Corporation |
Dinesh Belwalkar | 0121796 | 2019-05-23 21:51:16 +0000 | [diff] [blame] | 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 | # Configure shell |
| 17 | SHELL = bash -eu -o pipefail |
| 18 | |
Scott Baker | 5d03e17 | 2020-04-10 14:56:20 -0700 | [diff] [blame] | 19 | ROOT_DIR := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST)))) |
| 20 | |
Dinesh Belwalkar | 0121796 | 2019-05-23 21:51:16 +0000 | [diff] [blame] | 21 | # Variables |
| 22 | VERSION ?= $(shell cat ./VERSION) |
| 23 | CONTAINER_NAME ?= $(notdir $(abspath .)) |
| 24 | |
| 25 | ## Docker related |
| 26 | DOCKER_REGISTRY ?= |
| 27 | DOCKER_REPOSITORY ?= |
| 28 | DOCKER_BUILD_ARGS ?= |
| 29 | DOCKER_TAG ?= ${VERSION} |
| 30 | DOCKER_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}${CONTAINER_NAME}:${DOCKER_TAG} |
| 31 | |
| 32 | ## Docker labels. Only set ref and commit date if committed |
| 33 | DOCKER_LABEL_VCS_URL ?= $(shell git remote get-url $(shell git remote)) |
| 34 | DOCKER_LABEL_VCS_REF ?= $(shell git diff-index --quiet HEAD -- && git rev-parse HEAD || echo "unknown") |
| 35 | DOCKER_LABEL_COMMIT_DATE ?= $(shell git diff-index --quiet HEAD -- && git show -s --format=%cd --date=iso-strict HEAD || echo "unknown" ) |
| 36 | DOCKER_LABEL_BUILD_DATE ?= $(shell date -u "+%Y-%m-%dT%H:%M:%SZ") |
| 37 | |
Scott Baker | 5d03e17 | 2020-04-10 14:56:20 -0700 | [diff] [blame] | 38 | ROBOT_MOCK_OLT_FILE ?= $(ROOT_DIR)/demo_test/functional_test/robot-mock-olt.yaml |
| 39 | ROBOT_DEBUG_LOG_OPT ?= |
| 40 | ROBOT_MISC_ARGS ?= |
| 41 | |
Dinesh Belwalkar | 0bc4ace | 2019-11-14 21:41:50 +0000 | [diff] [blame] | 42 | help: |
| 43 | @echo "Usage: make [<target>]" |
| 44 | @echo "where available targets are:" |
| 45 | @echo |
Dinesh Belwalkar | e63f7f9 | 2019-11-22 23:11:16 +0000 | [diff] [blame] | 46 | @echo "proto/importer.pb.go : Build importer.pb.go for go build ./.." |
Dinesh Belwalkar | 0bc4ace | 2019-11-14 21:41:50 +0000 | [diff] [blame] | 47 | @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 Belwalkar | e63f7f9 | 2019-11-22 23:11:16 +0000 | [diff] [blame] | 53 | @echo "lint-sanity : Verify that 'go vet' doesn't report any issues" |
| 54 | @echo "lint-mod : Verify the integrity of the 'mod' files" |
Dinesh Belwalkar | 0bc4ace | 2019-11-14 21:41:50 +0000 | [diff] [blame] | 55 | @echo "lint : Shorthand for lint-style & lint-sanity" |
| 56 | @echo "test : Generate reports for all go tests" |
| 57 | @echo |
| 58 | |
Dinesh Belwalkar | 0121796 | 2019-05-23 21:51:16 +0000 | [diff] [blame] | 59 | all: test |
Scott Baker | 5d03e17 | 2020-04-10 14:56:20 -0700 | [diff] [blame] | 60 | |
| 61 | # target to invoke mock-olt robot tests |
| 62 | functional-mock-test: ROBOT_MISC_ARGS += $(ROBOT_DEBUG_LOG_OPT) |
| 63 | functional-mock-test: ROBOT_CONFIG_FILE := $(ROBOT_MOCK_OLT_FILE) |
| 64 | functional-mock-test: ROBOT_FILE := $(ROOT_DIR)/demo_test/functional_test/importer.robot |
| 65 | functional-mock-test: importer-functional-test |
| 66 | |
Dinesh Belwalkar | e63f7f9 | 2019-11-22 23:11:16 +0000 | [diff] [blame] | 67 | proto/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 Belwalkar | 0bc4ace | 2019-11-14 21:41:50 +0000 | [diff] [blame] | 74 | build: docker-build |
| 75 | |
Scott Baker | bdb962b | 2020-04-03 10:53:36 -0700 | [diff] [blame] | 76 | docker-build: docker-build-importer |
| 77 | make -C demo_test docker-build |
| 78 | make -C mock-redfish-server docker-build |
Dinesh Belwalkar | 0bc4ace | 2019-11-14 21:41:50 +0000 | [diff] [blame] | 79 | |
Scott Baker | bdb962b | 2020-04-03 10:53:36 -0700 | [diff] [blame] | 80 | docker-push: docker-push-importer |
| 81 | make -C demo_test docker-push |
| 82 | make -C mock-redfish-server docker-push |
| 83 | |
| 84 | docker-build-importer: |
Dinesh Belwalkar | 0121796 | 2019-05-23 21:51:16 +0000 | [diff] [blame] | 85 | 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 Baker | bdb962b | 2020-04-03 10:53:36 -0700 | [diff] [blame] | 93 | |
| 94 | docker-push-importer: |
Dinesh Belwalkar | 0121796 | 2019-05-23 21:51:16 +0000 | [diff] [blame] | 95 | docker push ${DOCKER_IMAGENAME} |
| 96 | |
Scott Baker | bdb962b | 2020-04-03 10:53:36 -0700 | [diff] [blame] | 97 | |
Dinesh Belwalkar | 0bc4ace | 2019-11-14 21:41:50 +0000 | [diff] [blame] | 98 | PATH:=$(GOPATH)/bin:$(PATH) |
| 99 | HADOLINT=$(shell PATH=$(GOPATH):$(PATH) which hadolint) |
| 100 | |
| 101 | lint-dockerfile: |
| 102 | ifeq (,$(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 |
| 106 | endif |
| 107 | @echo "Running Dockerfile lint check ..." |
Dinesh Belwalkar | 72ecafb | 2019-12-12 00:08:56 +0000 | [diff] [blame] | 108 | @hadolint $$(find . -type f -not -path "./vendor/*" -name "Dockerfile") |
Dinesh Belwalkar | 0bc4ace | 2019-11-14 21:41:50 +0000 | [diff] [blame] | 109 | @echo "Dockerfile lint check OK" |
| 110 | |
| 111 | lint-style: |
| 112 | ifeq (,$(shell which gofmt)) |
| 113 | go get -u github.com/golang/go/src/cmd/gofmt |
| 114 | endif |
| 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 Belwalkar | a6ba07d | 2020-01-10 23:22:34 +0000 | [diff] [blame] | 124 | lint-sanity:proto/importer.pb.go |
Dinesh Belwalkar | e63f7f9 | 2019-11-22 23:11:16 +0000 | [diff] [blame] | 125 | @echo "Running sanity check..." |
| 126 | @go vet -mod=vendor ./... |
| 127 | @echo "Sanity check OK" |
Dinesh Belwalkar | 0bc4ace | 2019-11-14 21:41:50 +0000 | [diff] [blame] | 128 | |
Dinesh Belwalkar | e63f7f9 | 2019-11-22 23:11:16 +0000 | [diff] [blame] | 129 | lint-mod: |
| 130 | @echo "Running dependency check..." |
| 131 | @go mod verify |
| 132 | @echo "Dependency check OK" |
| 133 | lint: lint-style lint-dockerfile lint-sanity lint-mod |
Dinesh Belwalkar | 0bc4ace | 2019-11-14 21:41:50 +0000 | [diff] [blame] | 134 | |
| 135 | # Rules to automatically install golangci-lint |
| 136 | GOLANGCI_LINT_TOOL?=$(shell which golangci-lint) |
| 137 | ifeq (,$(GOLANGCI_LINT_TOOL)) |
| 138 | GOLANGCI_LINT_TOOL=$(GOPATH)/bin/golangci-lint |
| 139 | golangci_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 |
| 143 | else |
| 144 | golangci_lint_tool_install: |
| 145 | endif |
| 146 | |
| 147 | sca: 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 Belwalkar | 0121796 | 2019-05-23 21:51:16 +0000 | [diff] [blame] | 152 | test: docker-build |
| 153 | |
| 154 | clean: |
| 155 | @echo "No cleanup available" |
Scott Baker | 5d03e17 | 2020-04-10 14:56:20 -0700 | [diff] [blame] | 156 | |
| 157 | # Check out a copy of voltha-system-tests. We will reuse its robot configuration |
| 158 | # and its robot libraries |
| 159 | voltha-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 |
| 164 | vst_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 | |
| 169 | importer-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) |