blob: 2b0c15a90796dd3fb335edc8087065b38865af7a [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 \
Suraj Gour33651272020-05-04 10:10:16 +053024 --configure TooManyTestSteps:50 -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 \
Suchitra Vemuri5ba33442020-05-25 22:43:40 -070028 --configure FileTooLong:1000 -e FileTooLong \
Zack Williamsa8fe75a2020-01-10 14:25:27 -070029 -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
TorstenThiemebccd3ae2020-02-20 12:56:44 +000039ROBOT_SANITY_MULTIPLE_OLT_FILE ?= $(ROOT_DIR)/tests/data/multiple-bbsim-kind.yaml
Zack Williamsa8fe75a2020-01-10 14:25:27 -070040ROBOT_FAIL_SINGLE_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind.yaml
41ROBOT_SANITY_MULT_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind-2x2.yaml
42ROBOT_SCALE_SINGLE_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind-16.yaml
43ROBOT_SCALE_MULT_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind-8x2.yaml
TorstenThiemeffb33922020-06-18 08:41:17 +000044ROBOT_SCALE_MULT_ONU_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind-8x8.yaml
Zack Williamsa8fe75a2020-01-10 14:25:27 -070045ROBOT_DEBUG_LOG_OPT ?=
46ROBOT_MISC_ARGS ?=
47
Gilles Depatie45fbe042019-11-11 17:10:06 -050048# for backwards compatibility
49sanity-kind: sanity-single-kind
50
Matteo Scandolo142e6272020-04-29 17:36:59 -070051# for scale pipeline
52voltha-scale: ROBOT_MISC_ARGS += -i activation $(ROBOT_DEBUG_LOG_OPT)
53voltha-scale: voltha-scale-test
54
Hardik Windlassa3d04b92020-02-17 15:06:05 +000055# target to invoke DT Workflow Sanity
56sanity-kind-dt: ROBOT_MISC_ARGS += -i sanityDt $(ROBOT_DEBUG_LOG_OPT)
57sanity-kind-dt: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_DT_SINGLE_PON_FILE)
58sanity-kind-dt: ROBOT_FILE := Voltha_DT_PODTests.robot
59sanity-kind-dt: voltha-dt-test
60
Hardik Windlassd6aa0822020-06-29 20:18:12 +053061functional-single-kind: ROBOT_MISC_ARGS += -i sanityORfunctional -e PowerSwitch $(ROBOT_DEBUG_LOG_OPT)
Andy Bavier33e6dd32020-01-16 13:35:20 -070062functional-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
63functional-single-kind: bbsim-kind
64
Hardik Windlass35706ba2020-02-20 08:16:42 +000065# target to invoke DT Workflow Functional scenarios
Hardik Windlassd6aa0822020-06-29 20:18:12 +053066functional-single-kind-dt: ROBOT_MISC_ARGS += -i sanityDtORfunctionalDt -e PowerSwitch $(ROBOT_DEBUG_LOG_OPT)
Hardik Windlass35706ba2020-02-20 08:16:42 +000067functional-single-kind-dt: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_DT_SINGLE_PON_FILE)
68functional-single-kind-dt: ROBOT_FILE := Voltha_DT_PODTests.robot
69functional-single-kind-dt: voltha-dt-test
70
TorstenThiemebccd3ae2020-02-20 12:56:44 +000071# target to invoke multiple OLTs Functional scenarios
72functional-multi-olt: ROBOT_MISC_ARGS += -i sanityMultiOLT $(ROBOT_DEBUG_LOG_OPT)
73functional-multi-olt: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_MULTIPLE_OLT_FILE)
74functional-multi-olt: ROBOT_FILE := Voltha_multipleOLTTests.robot
75functional-multi-olt: voltha-test
76
TorstenThieme1619db22020-04-03 12:01:15 +000077# target to invoke openonu go adapter
TorstenThieme94e4ae42020-05-18 13:01:42 +000078openonu-go-adapter-test: ROBOT_MISC_ARGS += -v state2test:4 -v testmode:SingleStateTime -v timeout:180s
TorstenThiemeffb33922020-06-18 08:41:17 +000079openonu-go-adapter-test: ROBOT_MISC_ARGS += -i onutest $(ROBOT_DEBUG_LOG_OPT)
TorstenThieme1619db22020-04-03 12:01:15 +000080openonu-go-adapter-test: ROBOT_MISC_ARGS += -X
81openonu-go-adapter-test: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
82openonu-go-adapter-test: ROBOT_FILE := Voltha_ONUStateTests.robot
83openonu-go-adapter-test: openonu-go-adapter-statetest
84
TorstenThiemeffb33922020-06-18 08:41:17 +000085# target to invoke multiple openonu go adapter
86multi-openonu-go-adapter-test: ROBOT_MISC_ARGS += -v state2test:4 -v testmode:SingleStateTime -v timeout:180s
87multi-openonu-go-adapter-test: ROBOT_MISC_ARGS += -i onutest $(ROBOT_DEBUG_LOG_OPT)
88multi-openonu-go-adapter-test: ROBOT_MISC_ARGS += -X
89multi-openonu-go-adapter-test: ROBOT_CONFIG_FILE := $(ROBOT_SCALE_MULT_ONU_FILE)
90multi-openonu-go-adapter-test: ROBOT_FILE := Voltha_ONUStateTests.robot
91multi-openonu-go-adapter-test: openonu-go-adapter-statetest
92
David Bainbridgef81cd642019-11-20 00:14:47 +000093sanity-single-kind: ROBOT_MISC_ARGS += -i sanity $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -050094sanity-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
95sanity-single-kind: bbsim-kind
96
David Bainbridge32c45632020-04-13 08:47:09 -070097rwcore-restart-single-kind: ROBOT_MISC_ARGS += -X -i functionalANDrwcore-restart $(ROBOT_DEBUG_LOG_OPT)
David Bainbridgef81cd642019-11-20 00:14:47 +000098rwcore-restart-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_FAIL_SINGLE_PON_FILE)
ubuntu6b6e7d42020-03-02 12:35:42 -080099rwcore-restart-single-kind: ROBOT_FILE := Voltha_FailureScenarios.robot
David Bainbridgef81cd642019-11-20 00:14:47 +0000100rwcore-restart-single-kind: voltha-test
101
David Bainbridge3d6d5d32019-12-17 19:05:35 +0000102single-kind: ROBOT_MISC_ARGS += -X -i $(TEST_TAGS) $(ROBOT_DEBUG_LOG_OPT)
103single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
104single-kind: ROBOT_FILE := Voltha_PODTests.robot
105single-kind: voltha-test
106
David Bainbridgef81cd642019-11-20 00:14:47 +0000107sanity-multi-kind: ROBOT_MISC_ARGS += -i sanity $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -0500108sanity-multi-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_MULT_PON_FILE)
109sanity-multi-kind: bbsim-kind
Andy Bavierba9866b2019-10-11 07:11:53 -0700110
Andy Bavier8da0e132020-04-13 10:25:16 -0700111functional-multi-kind: ROBOT_MISC_ARGS += -i sanityORfunctional $(ROBOT_DEBUG_LOG_OPT)
112functional-multi-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_MULT_PON_FILE)
113functional-multi-kind: bbsim-kind
114
Suchitra Vemuri8a9c3782019-10-23 12:43:01 -0700115bbsim-kind: ROBOT_MISC_ARGS += -X
Gilles Depatie45fbe042019-11-11 17:10:06 -0500116bbsim-kind: ROBOT_FILE := Voltha_PODTests.robot
117bbsim-kind: voltha-test
118
David Bainbridgef81cd642019-11-20 00:14:47 +0000119scale-single-kind: ROBOT_MISC_ARGS += -i active $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -0500120scale-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SCALE_SINGLE_PON_FILE)
121scale-single-kind: bbsim-scale-kind
122
David Bainbridgef81cd642019-11-20 00:14:47 +0000123scale-multi-kind: ROBOT_MISC_ARGS += -i active $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -0500124scale-multi-kind: ROBOT_CONFIG_FILE := $(ROBOT_SCALE_MULT_PON_FILE)
125scale-multi-kind: bbsim-scale-kind
126
David Bainbridgef81cd642019-11-20 00:14:47 +0000127bbsim-scale-kind: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -0500128bbsim-scale-kind: ROBOT_FILE := Voltha_ScaleFunctionalTests.robot
129bbsim-scale-kind: voltha-test
Zack Williamsec53a1b2019-09-16 15:50:52 -0700130
hwchiuab524f02020-02-03 23:24:19 +0000131#Only supported in full mode
132system-scale-test: ROBOT_FILE := K8S_SystemTest.robot
hwchiu56eb85c2020-02-05 01:05:53 +0000133system-scale-test: ROBOT_MISC_ARGS += -X -i functional $(ROBOT_DEBUG_LOG_OPT)
hwchiuab524f02020-02-03 23:24:19 +0000134system-scale-test: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_MULT_PON_FILE)
135system-scale-test: voltha-test
hwchiu11289122019-11-27 16:20:15 +0000136
hwchiu85695932019-12-18 08:05:25 +0000137failure-test: ROBOT_MISC_ARGS += -X -i FailureTest $(ROBOT_DEBUG_LOG_OPT)
hwchiu3d9a0982020-02-06 00:19:19 +0000138failure-test: ROBOT_FILE := K8S_SystemTest.robot
hwchiu85695932019-12-18 08:05:25 +0000139failure-test: ROBOT_CONFIG_FILE := $(ROBOT_FAIL_SINGLE_PON_FILE)
140failure-test: voltha-test
141
Scott Baker60e570d2020-02-02 22:10:13 -0800142bbsim-alarms-kind: ROBOT_MISC_ARGS += -X -i active
143bbsim-alarms-kind: ROBOT_FILE := Voltha_AlarmTests.robot
Andy Baviere118e052020-03-06 12:49:24 -0700144bbsim-alarms-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
Scott Baker60e570d2020-02-02 22:10:13 -0800145bbsim-alarms-kind: voltctl-docker-image-build voltctl-docker-image-install-kind voltha-test
146
Andy Bavierc1904dc2020-03-20 11:39:15 -0700147bbsim-errorscenarios: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT)
148bbsim-errorscenarios: ROBOT_FILE := Voltha_ErrorScenarios.robot
149bbsim-errorscenarios: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
150bbsim-errorscenarios: voltha-test
151
Hardik Windlasscbcca312020-04-20 21:46:11 +0530152bbsim-errorscenarios-dt: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT)
153bbsim-errorscenarios-dt: ROBOT_FILE := Voltha_ErrorScenarios.robot
154bbsim-errorscenarios-dt: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_DT_SINGLE_PON_FILE)
155bbsim-errorscenarios-dt: voltha-test
156
Hardik Windlasse05e4712020-04-29 10:40:42 +0530157bbsim-failurescenarios: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT) -e PowerSwitch -e PhysicalOLTReboot
Andy Bavier8da0e132020-04-13 10:25:16 -0700158bbsim-failurescenarios: ROBOT_FILE := Voltha_FailureScenarios.robot
159bbsim-failurescenarios: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
160bbsim-failurescenarios: voltha-test
161
Hardik Windlass9df139e2020-04-24 14:54:54 +0530162bbsim-failurescenarios-dt: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT) -e PowerSwitchOnuRebootDt -e PhysicalOltRebootDt
163bbsim-failurescenarios-dt: ROBOT_FILE := Voltha_DT_FailureScenarios.robot
164bbsim-failurescenarios-dt: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_DT_SINGLE_PON_FILE)
165bbsim-failurescenarios-dt: voltha-dt-test
166
Andy Bavier70eab042019-12-14 14:16:26 -0700167voltha-test: ROBOT_MISC_ARGS += -e notready
hwchiu11289122019-11-27 16:20:15 +0000168
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700169voltha-test: vst_venv
170 source ./$</bin/activate ; set -u ;\
171 cd tests/functional ;\
172 robot -V $(ROBOT_CONFIG_FILE) $(ROBOT_MISC_ARGS) $(ROBOT_FILE)
173
Hardik Windlass79b40ff2020-06-11 22:55:47 +0530174voltha-dt-test: ROBOT_MISC_ARGS += -e notready
175
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000176voltha-dt-test: vst_venv
177 source ./$</bin/activate ; set -u ;\
178 cd tests/dt-workflow ;\
179 robot -V $(ROBOT_CONFIG_FILE) $(ROBOT_MISC_ARGS) $(ROBOT_FILE)
180
Matteo Scandolo142e6272020-04-29 17:36:59 -0700181voltha-scale-test: vst_venv
182 source ./$</bin/activate ; set -u ;\
183 cd tests/scale ;\
184 robot $(ROBOT_MISC_ARGS) Voltha_Scale_Tests.robot
185
TorstenThieme1619db22020-04-03 12:01:15 +0000186openonu-go-adapter-statetest: vst_venv
187 source ./$</bin/activate ; set -u ;\
188 cd tests/openonu-go-adapter ;\
189 robot -V $(ROBOT_CONFIG_FILE) $(ROBOT_MISC_ARGS) $(ROBOT_FILE)
190
191
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700192# self-test, lint, and setup targets
193
194# virtualenv for the robot tools
Andy Bavier952b95b2020-03-06 09:53:42 -0700195# VOL-2724 Invoke pip via python3 to avoid pathname too long on QA jobs
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700196vst_venv:
197 virtualenv -p python3 $@ ;\
198 source ./$@/bin/activate ;\
Andy Baviere118e052020-03-06 12:49:24 -0700199 python -m pip install -r requirements.txt
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700200
201test: lint
202
203lint: lint-robot lint-python lint-yaml lint-json
204
205lint-robot: vst_venv
206 source ./$</bin/activate ; set -u ;\
207 rflint $(LINT_ARGS) $(ROBOT_FILES)
208
209# check deps for format and python3 cleanliness
210lint-python: vst_venv
211 source ./$</bin/activate ; set -u ;\
212 pylint --py3k $(PYTHON_FILES) ;\
213 flake8 --max-line-length=99 --count $(PYTHON_FILES)
214
215lint-yaml: vst_venv
216 source ./$</bin/activate ; set -u ;\
217 yamllint -s $(YAML_FILES)
218
219lint-json: vst_venv
220 source ./$</bin/activate ; set -u ;\
221 for jsonfile in $(JSON_FILES); do \
222 echo "Validating json file: $$jsonfile" ;\
223 python -m json.tool $$jsonfile > /dev/null ;\
224 done
225
226# tidy target will be more useful once issue with removing leading comments
227# is resolved: https://github.com/robotframework/robotframework/issues/3263
228tidy-robot: vst_venv
229 source ./$</bin/activate ; set -u ;\
230 python -m robot.tidy --inplace $(ROBOT_FILES);
231
Andy Bavier4a8450e2020-02-04 08:58:37 -0700232# Install the 'kail' tool if needed: https://github.com/boz/kail
233KAIL_PATH ?= /usr/local/bin
234$(KAIL_PATH)/kail:
235 bash <( curl -sfL https://raw.githubusercontent.com/boz/kail/master/godownloader.sh) -b /tmp
236 mv /tmp/kail $(KAIL_PATH)
237
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700238## Variables for gendocs
239TEST_SOURCE := $(wildcard tests/*/*.robot)
240TEST_BASENAME := $(basename $(TEST_SOURCE))
241TEST_DIRS := $(dir $(TEST_SOURCE))
242
243LIB_SOURCE := $(wildcard libraries/*.robot)
244LIB_BASENAME := $(basename $(LIB_SOURCE))
245LIB_DIRS := $(dir $(LIB_SOURCE))
246
247.PHONY: gendocs lint test
248# In future explore use of --docformat REST - integration w/Sphinx?
Zack Williamsec53a1b2019-09-16 15:50:52 -0700249gendocs: vst_venv
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700250 source ./$</bin/activate ; set -u ;\
hwchiu0601ec72019-10-08 00:04:43 +0000251 mkdir -p $@ ;\
252 for dir in ${LIB_DIRS}; do mkdir -p $@/$$dir; done;\
253 for dir in ${LIB_BASENAME}; do\
254 python -m robot.libdoc --format HTML $$dir.robot $@/$$dir.html ;\
255 done ;\
256 for dir in ${TEST_DIRS}; do mkdir -p $@/$$dir; done;\
257 for dir in ${TEST_BASENAME}; do\
258 python -m robot.testdoc $$dir.robot $@/$$dir.html ;\
259 done
Zack Williamsec53a1b2019-09-16 15:50:52 -0700260
Zack Williamsec53a1b2019-09-16 15:50:52 -0700261clean:
262 find . -name output.xml -print
263
264clean-all: clean
265 rm -rf vst_venv gendocs
Scott Baker60e570d2020-02-02 22:10:13 -0800266
267voltctl-docker-image-build:
268 cd docker && docker build -t opencord/voltctl:local -f Dockerfile.voltctl .
269
270voltctl-docker-image-install-kind:
271 @if [ "`kind get clusters | grep voltha`" = '' ]; then echo "no voltha cluster found" && exit 1; fi
272 kind load docker-image --name `kind get clusters | grep voltha` opencord/voltctl:local