blob: e8e9f6b5418f6a4b187a9a5e6b5a39e9198c6f0a [file] [log] [blame]
Kailash92764922019-07-25 08:21:39 -07001# Copyright 2017-present Open Networking Foundation
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
Zack Williamsec53a1b2019-09-16 15:50:52 -070015# use bash for pushd/popd, and to fail quickly. virtualenv's activate
16# has undefined variables, so no -u
Zack Williamsa8fe75a2020-01-10 14:25:27 -070017SHELL := bash -e -o pipefail
Kailash92764922019-07-25 08:21:39 -070018
Zack Williamsa8fe75a2020-01-10 14:25:27 -070019ROOT_DIR := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
Kailash92764922019-07-25 08:21:39 -070020
Zack Williamsa8fe75a2020-01-10 14:25:27 -070021# Configuration and lists of files for linting/testing
22VERSION ?= $(shell cat ./VERSION)
23LINT_ARGS ?= --verbose --configure LineTooLong:120 -e LineTooLong \
Hardik Windlass8f2aadc2020-03-16 20:16:39 +053024 --configure TooManyTestSteps:40 -e TooManyTestSteps \
Scott Baker27d04db2020-02-06 18:03:21 -080025 --configure TooManyTestCases:50 -e TooManyTestCases \
Zack Williamsa8fe75a2020-01-10 14:25:27 -070026 --configure TooFewTestSteps:1 \
27 --configure TooFewKeywordSteps:1 \
28 --configure FileTooLong:600 -e FileTooLong \
29 -e TrailingWhitespace
30
31PYTHON_FILES := $(wildcard libraries/*.py)
32ROBOT_FILES := $(shell find . -name *.robot -print)
33YAML_FILES := $(shell find ./tests -type f \( -name *.yaml -o -name *.yml \) -print)
34JSON_FILES := $(shell find ./tests -name *.json -print)
35
36# Robot config
37ROBOT_SANITY_SINGLE_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind.yaml
Hardik Windlassa3d04b92020-02-17 15:06:05 +000038ROBOT_SANITY_DT_SINGLE_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind-dt.yaml
Zack Williamsa8fe75a2020-01-10 14:25:27 -070039ROBOT_FAIL_SINGLE_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind.yaml
40ROBOT_SANITY_MULT_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind-2x2.yaml
41ROBOT_SCALE_SINGLE_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind-16.yaml
42ROBOT_SCALE_MULT_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind-8x2.yaml
43ROBOT_DEBUG_LOG_OPT ?=
44ROBOT_MISC_ARGS ?=
45
Gilles Depatie45fbe042019-11-11 17:10:06 -050046# for backwards compatibility
47sanity-kind: sanity-single-kind
48
Hardik Windlassa3d04b92020-02-17 15:06:05 +000049# target to invoke DT Workflow Sanity
50sanity-kind-dt: ROBOT_MISC_ARGS += -i sanityDt $(ROBOT_DEBUG_LOG_OPT)
51sanity-kind-dt: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_DT_SINGLE_PON_FILE)
52sanity-kind-dt: ROBOT_FILE := Voltha_DT_PODTests.robot
53sanity-kind-dt: voltha-dt-test
54
Andy Bavier33e6dd32020-01-16 13:35:20 -070055functional-single-kind: ROBOT_MISC_ARGS += -i sanity -i functional $(ROBOT_DEBUG_LOG_OPT)
56functional-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
57functional-single-kind: bbsim-kind
58
Hardik Windlass35706ba2020-02-20 08:16:42 +000059# target to invoke DT Workflow Functional scenarios
60functional-single-kind-dt: ROBOT_MISC_ARGS += -i sanityDt -i functionalDt $(ROBOT_DEBUG_LOG_OPT)
61functional-single-kind-dt: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_DT_SINGLE_PON_FILE)
62functional-single-kind-dt: ROBOT_FILE := Voltha_DT_PODTests.robot
63functional-single-kind-dt: voltha-dt-test
64
David Bainbridgef81cd642019-11-20 00:14:47 +000065sanity-single-kind: ROBOT_MISC_ARGS += -i sanity $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -050066sanity-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
67sanity-single-kind: bbsim-kind
68
David Bainbridgef81cd642019-11-20 00:14:47 +000069rwcore-restart-single-kind: ROBOT_MISC_ARGS += -X -i bbsimANDrwcore-restart $(ROBOT_DEBUG_LOG_OPT)
70rwcore-restart-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_FAIL_SINGLE_PON_FILE)
ubuntu6b6e7d42020-03-02 12:35:42 -080071rwcore-restart-single-kind: ROBOT_FILE := Voltha_FailureScenarios.robot
David Bainbridgef81cd642019-11-20 00:14:47 +000072rwcore-restart-single-kind: voltha-test
73
David Bainbridge3d6d5d32019-12-17 19:05:35 +000074single-kind: ROBOT_MISC_ARGS += -X -i $(TEST_TAGS) $(ROBOT_DEBUG_LOG_OPT)
75single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
76single-kind: ROBOT_FILE := Voltha_PODTests.robot
77single-kind: voltha-test
78
David Bainbridgef81cd642019-11-20 00:14:47 +000079sanity-multi-kind: ROBOT_MISC_ARGS += -i sanity $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -050080sanity-multi-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_MULT_PON_FILE)
81sanity-multi-kind: bbsim-kind
Andy Bavierba9866b2019-10-11 07:11:53 -070082
Suchitra Vemuri8a9c3782019-10-23 12:43:01 -070083bbsim-kind: ROBOT_MISC_ARGS += -X
Gilles Depatie45fbe042019-11-11 17:10:06 -050084bbsim-kind: ROBOT_FILE := Voltha_PODTests.robot
85bbsim-kind: voltha-test
86
David Bainbridgef81cd642019-11-20 00:14:47 +000087scale-single-kind: ROBOT_MISC_ARGS += -i active $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -050088scale-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SCALE_SINGLE_PON_FILE)
89scale-single-kind: bbsim-scale-kind
90
David Bainbridgef81cd642019-11-20 00:14:47 +000091scale-multi-kind: ROBOT_MISC_ARGS += -i active $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -050092scale-multi-kind: ROBOT_CONFIG_FILE := $(ROBOT_SCALE_MULT_PON_FILE)
93scale-multi-kind: bbsim-scale-kind
94
David Bainbridgef81cd642019-11-20 00:14:47 +000095bbsim-scale-kind: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -050096bbsim-scale-kind: ROBOT_FILE := Voltha_ScaleFunctionalTests.robot
97bbsim-scale-kind: voltha-test
Zack Williamsec53a1b2019-09-16 15:50:52 -070098
hwchiuab524f02020-02-03 23:24:19 +000099#Only supported in full mode
100system-scale-test: ROBOT_FILE := K8S_SystemTest.robot
hwchiu56eb85c2020-02-05 01:05:53 +0000101system-scale-test: ROBOT_MISC_ARGS += -X -i functional $(ROBOT_DEBUG_LOG_OPT)
hwchiuab524f02020-02-03 23:24:19 +0000102system-scale-test: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_MULT_PON_FILE)
103system-scale-test: voltha-test
hwchiu11289122019-11-27 16:20:15 +0000104
hwchiu85695932019-12-18 08:05:25 +0000105failure-test: ROBOT_MISC_ARGS += -X -i FailureTest $(ROBOT_DEBUG_LOG_OPT)
hwchiu3d9a0982020-02-06 00:19:19 +0000106failure-test: ROBOT_FILE := K8S_SystemTest.robot
hwchiu85695932019-12-18 08:05:25 +0000107failure-test: ROBOT_CONFIG_FILE := $(ROBOT_FAIL_SINGLE_PON_FILE)
108failure-test: voltha-test
109
Scott Baker60e570d2020-02-02 22:10:13 -0800110bbsim-alarms-kind: ROBOT_MISC_ARGS += -X -i active
111bbsim-alarms-kind: ROBOT_FILE := Voltha_AlarmTests.robot
Andy Baviere118e052020-03-06 12:49:24 -0700112bbsim-alarms-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
Scott Baker60e570d2020-02-02 22:10:13 -0800113bbsim-alarms-kind: voltctl-docker-image-build voltctl-docker-image-install-kind voltha-test
114
Andy Bavierc1904dc2020-03-20 11:39:15 -0700115bbsim-errorscenarios: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT)
116bbsim-errorscenarios: ROBOT_FILE := Voltha_ErrorScenarios.robot
117bbsim-errorscenarios: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
118bbsim-errorscenarios: voltha-test
119
120
Andy Bavier70eab042019-12-14 14:16:26 -0700121voltha-test: ROBOT_MISC_ARGS += -e notready
hwchiu11289122019-11-27 16:20:15 +0000122
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700123voltha-test: vst_venv
124 source ./$</bin/activate ; set -u ;\
125 cd tests/functional ;\
126 robot -V $(ROBOT_CONFIG_FILE) $(ROBOT_MISC_ARGS) $(ROBOT_FILE)
127
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000128voltha-dt-test: vst_venv
129 source ./$</bin/activate ; set -u ;\
130 cd tests/dt-workflow ;\
131 robot -V $(ROBOT_CONFIG_FILE) $(ROBOT_MISC_ARGS) $(ROBOT_FILE)
132
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700133# self-test, lint, and setup targets
134
135# virtualenv for the robot tools
Andy Bavier952b95b2020-03-06 09:53:42 -0700136# VOL-2724 Invoke pip via python3 to avoid pathname too long on QA jobs
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700137vst_venv:
138 virtualenv -p python3 $@ ;\
139 source ./$@/bin/activate ;\
Andy Baviere118e052020-03-06 12:49:24 -0700140 python -m pip install -r requirements.txt
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700141
142test: lint
143
144lint: lint-robot lint-python lint-yaml lint-json
145
146lint-robot: vst_venv
147 source ./$</bin/activate ; set -u ;\
148 rflint $(LINT_ARGS) $(ROBOT_FILES)
149
150# check deps for format and python3 cleanliness
151lint-python: vst_venv
152 source ./$</bin/activate ; set -u ;\
153 pylint --py3k $(PYTHON_FILES) ;\
154 flake8 --max-line-length=99 --count $(PYTHON_FILES)
155
156lint-yaml: vst_venv
157 source ./$</bin/activate ; set -u ;\
158 yamllint -s $(YAML_FILES)
159
160lint-json: vst_venv
161 source ./$</bin/activate ; set -u ;\
162 for jsonfile in $(JSON_FILES); do \
163 echo "Validating json file: $$jsonfile" ;\
164 python -m json.tool $$jsonfile > /dev/null ;\
165 done
166
167# tidy target will be more useful once issue with removing leading comments
168# is resolved: https://github.com/robotframework/robotframework/issues/3263
169tidy-robot: vst_venv
170 source ./$</bin/activate ; set -u ;\
171 python -m robot.tidy --inplace $(ROBOT_FILES);
172
Andy Bavier4a8450e2020-02-04 08:58:37 -0700173# Install the 'kail' tool if needed: https://github.com/boz/kail
174KAIL_PATH ?= /usr/local/bin
175$(KAIL_PATH)/kail:
176 bash <( curl -sfL https://raw.githubusercontent.com/boz/kail/master/godownloader.sh) -b /tmp
177 mv /tmp/kail $(KAIL_PATH)
178
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700179## Variables for gendocs
180TEST_SOURCE := $(wildcard tests/*/*.robot)
181TEST_BASENAME := $(basename $(TEST_SOURCE))
182TEST_DIRS := $(dir $(TEST_SOURCE))
183
184LIB_SOURCE := $(wildcard libraries/*.robot)
185LIB_BASENAME := $(basename $(LIB_SOURCE))
186LIB_DIRS := $(dir $(LIB_SOURCE))
187
188.PHONY: gendocs lint test
189# In future explore use of --docformat REST - integration w/Sphinx?
Zack Williamsec53a1b2019-09-16 15:50:52 -0700190gendocs: vst_venv
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700191 source ./$</bin/activate ; set -u ;\
hwchiu0601ec72019-10-08 00:04:43 +0000192 mkdir -p $@ ;\
193 for dir in ${LIB_DIRS}; do mkdir -p $@/$$dir; done;\
194 for dir in ${LIB_BASENAME}; do\
195 python -m robot.libdoc --format HTML $$dir.robot $@/$$dir.html ;\
196 done ;\
197 for dir in ${TEST_DIRS}; do mkdir -p $@/$$dir; done;\
198 for dir in ${TEST_BASENAME}; do\
199 python -m robot.testdoc $$dir.robot $@/$$dir.html ;\
200 done
Zack Williamsec53a1b2019-09-16 15:50:52 -0700201
Zack Williamsec53a1b2019-09-16 15:50:52 -0700202clean:
203 find . -name output.xml -print
204
205clean-all: clean
206 rm -rf vst_venv gendocs
Scott Baker60e570d2020-02-02 22:10:13 -0800207
208voltctl-docker-image-build:
209 cd docker && docker build -t opencord/voltctl:local -f Dockerfile.voltctl .
210
211voltctl-docker-image-install-kind:
212 @if [ "`kind get clusters | grep voltha`" = '' ]; then echo "no voltha cluster found" && exit 1; fi
213 kind load docker-image --name `kind get clusters | grep voltha` opencord/voltctl:local