blob: 70cf221712f432c495a77143c45f80788e0114c0 [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 \
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
44ROBOT_DEBUG_LOG_OPT ?=
45ROBOT_MISC_ARGS ?=
46
Gilles Depatie45fbe042019-11-11 17:10:06 -050047# for backwards compatibility
48sanity-kind: sanity-single-kind
49
Matteo Scandolo142e6272020-04-29 17:36:59 -070050# for scale pipeline
51voltha-scale: ROBOT_MISC_ARGS += -i activation $(ROBOT_DEBUG_LOG_OPT)
52voltha-scale: voltha-scale-test
53
Hardik Windlassa3d04b92020-02-17 15:06:05 +000054# target to invoke DT Workflow Sanity
55sanity-kind-dt: ROBOT_MISC_ARGS += -i sanityDt $(ROBOT_DEBUG_LOG_OPT)
56sanity-kind-dt: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_DT_SINGLE_PON_FILE)
57sanity-kind-dt: ROBOT_FILE := Voltha_DT_PODTests.robot
58sanity-kind-dt: voltha-dt-test
59
Andy Bavier8da0e132020-04-13 10:25:16 -070060functional-single-kind: ROBOT_MISC_ARGS += -i sanityORfunctional $(ROBOT_DEBUG_LOG_OPT)
Andy Bavier33e6dd32020-01-16 13:35:20 -070061functional-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
62functional-single-kind: bbsim-kind
63
Hardik Windlass35706ba2020-02-20 08:16:42 +000064# target to invoke DT Workflow Functional scenarios
Andy Bavier8da0e132020-04-13 10:25:16 -070065functional-single-kind-dt: ROBOT_MISC_ARGS += -i sanityDtORfunctionalDt $(ROBOT_DEBUG_LOG_OPT)
Hardik Windlass35706ba2020-02-20 08:16:42 +000066functional-single-kind-dt: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_DT_SINGLE_PON_FILE)
67functional-single-kind-dt: ROBOT_FILE := Voltha_DT_PODTests.robot
68functional-single-kind-dt: voltha-dt-test
69
TorstenThiemebccd3ae2020-02-20 12:56:44 +000070# target to invoke multiple OLTs Functional scenarios
71functional-multi-olt: ROBOT_MISC_ARGS += -i sanityMultiOLT $(ROBOT_DEBUG_LOG_OPT)
72functional-multi-olt: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_MULTIPLE_OLT_FILE)
73functional-multi-olt: ROBOT_FILE := Voltha_multipleOLTTests.robot
74functional-multi-olt: voltha-test
75
TorstenThieme1619db22020-04-03 12:01:15 +000076# target to invoke openonu go adapter
TorstenThieme94e4ae42020-05-18 13:01:42 +000077openonu-go-adapter-test: ROBOT_MISC_ARGS += -v state2test:4 -v testmode:SingleStateTime -v timeout:180s
TorstenThieme1619db22020-04-03 12:01:15 +000078openonu-go-adapter-test: ROBOT_MISC_ARGS += -i statetest $(ROBOT_DEBUG_LOG_OPT)
79openonu-go-adapter-test: ROBOT_MISC_ARGS += -X
80openonu-go-adapter-test: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
81openonu-go-adapter-test: ROBOT_FILE := Voltha_ONUStateTests.robot
82openonu-go-adapter-test: openonu-go-adapter-statetest
83
David Bainbridgef81cd642019-11-20 00:14:47 +000084sanity-single-kind: ROBOT_MISC_ARGS += -i sanity $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -050085sanity-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
86sanity-single-kind: bbsim-kind
87
David Bainbridge32c45632020-04-13 08:47:09 -070088rwcore-restart-single-kind: ROBOT_MISC_ARGS += -X -i functionalANDrwcore-restart $(ROBOT_DEBUG_LOG_OPT)
David Bainbridgef81cd642019-11-20 00:14:47 +000089rwcore-restart-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_FAIL_SINGLE_PON_FILE)
ubuntu6b6e7d42020-03-02 12:35:42 -080090rwcore-restart-single-kind: ROBOT_FILE := Voltha_FailureScenarios.robot
David Bainbridgef81cd642019-11-20 00:14:47 +000091rwcore-restart-single-kind: voltha-test
92
David Bainbridge3d6d5d32019-12-17 19:05:35 +000093single-kind: ROBOT_MISC_ARGS += -X -i $(TEST_TAGS) $(ROBOT_DEBUG_LOG_OPT)
94single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
95single-kind: ROBOT_FILE := Voltha_PODTests.robot
96single-kind: voltha-test
97
David Bainbridgef81cd642019-11-20 00:14:47 +000098sanity-multi-kind: ROBOT_MISC_ARGS += -i sanity $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -050099sanity-multi-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_MULT_PON_FILE)
100sanity-multi-kind: bbsim-kind
Andy Bavierba9866b2019-10-11 07:11:53 -0700101
Andy Bavier8da0e132020-04-13 10:25:16 -0700102functional-multi-kind: ROBOT_MISC_ARGS += -i sanityORfunctional $(ROBOT_DEBUG_LOG_OPT)
103functional-multi-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_MULT_PON_FILE)
104functional-multi-kind: bbsim-kind
105
Suchitra Vemuri8a9c3782019-10-23 12:43:01 -0700106bbsim-kind: ROBOT_MISC_ARGS += -X
Gilles Depatie45fbe042019-11-11 17:10:06 -0500107bbsim-kind: ROBOT_FILE := Voltha_PODTests.robot
108bbsim-kind: voltha-test
109
David Bainbridgef81cd642019-11-20 00:14:47 +0000110scale-single-kind: ROBOT_MISC_ARGS += -i active $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -0500111scale-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SCALE_SINGLE_PON_FILE)
112scale-single-kind: bbsim-scale-kind
113
David Bainbridgef81cd642019-11-20 00:14:47 +0000114scale-multi-kind: ROBOT_MISC_ARGS += -i active $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -0500115scale-multi-kind: ROBOT_CONFIG_FILE := $(ROBOT_SCALE_MULT_PON_FILE)
116scale-multi-kind: bbsim-scale-kind
117
David Bainbridgef81cd642019-11-20 00:14:47 +0000118bbsim-scale-kind: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -0500119bbsim-scale-kind: ROBOT_FILE := Voltha_ScaleFunctionalTests.robot
120bbsim-scale-kind: voltha-test
Zack Williamsec53a1b2019-09-16 15:50:52 -0700121
hwchiuab524f02020-02-03 23:24:19 +0000122#Only supported in full mode
123system-scale-test: ROBOT_FILE := K8S_SystemTest.robot
hwchiu56eb85c2020-02-05 01:05:53 +0000124system-scale-test: ROBOT_MISC_ARGS += -X -i functional $(ROBOT_DEBUG_LOG_OPT)
hwchiuab524f02020-02-03 23:24:19 +0000125system-scale-test: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_MULT_PON_FILE)
126system-scale-test: voltha-test
hwchiu11289122019-11-27 16:20:15 +0000127
hwchiu85695932019-12-18 08:05:25 +0000128failure-test: ROBOT_MISC_ARGS += -X -i FailureTest $(ROBOT_DEBUG_LOG_OPT)
hwchiu3d9a0982020-02-06 00:19:19 +0000129failure-test: ROBOT_FILE := K8S_SystemTest.robot
hwchiu85695932019-12-18 08:05:25 +0000130failure-test: ROBOT_CONFIG_FILE := $(ROBOT_FAIL_SINGLE_PON_FILE)
131failure-test: voltha-test
132
Scott Baker60e570d2020-02-02 22:10:13 -0800133bbsim-alarms-kind: ROBOT_MISC_ARGS += -X -i active
134bbsim-alarms-kind: ROBOT_FILE := Voltha_AlarmTests.robot
Andy Baviere118e052020-03-06 12:49:24 -0700135bbsim-alarms-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
Scott Baker60e570d2020-02-02 22:10:13 -0800136bbsim-alarms-kind: voltctl-docker-image-build voltctl-docker-image-install-kind voltha-test
137
Andy Bavierc1904dc2020-03-20 11:39:15 -0700138bbsim-errorscenarios: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT)
139bbsim-errorscenarios: ROBOT_FILE := Voltha_ErrorScenarios.robot
140bbsim-errorscenarios: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
141bbsim-errorscenarios: voltha-test
142
Hardik Windlasscbcca312020-04-20 21:46:11 +0530143bbsim-errorscenarios-dt: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT)
144bbsim-errorscenarios-dt: ROBOT_FILE := Voltha_ErrorScenarios.robot
145bbsim-errorscenarios-dt: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_DT_SINGLE_PON_FILE)
146bbsim-errorscenarios-dt: voltha-test
147
Hardik Windlasse05e4712020-04-29 10:40:42 +0530148bbsim-failurescenarios: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT) -e PowerSwitch -e PhysicalOLTReboot
Andy Bavier8da0e132020-04-13 10:25:16 -0700149bbsim-failurescenarios: ROBOT_FILE := Voltha_FailureScenarios.robot
150bbsim-failurescenarios: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
151bbsim-failurescenarios: voltha-test
152
Hardik Windlass9df139e2020-04-24 14:54:54 +0530153bbsim-failurescenarios-dt: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT) -e PowerSwitchOnuRebootDt -e PhysicalOltRebootDt
154bbsim-failurescenarios-dt: ROBOT_FILE := Voltha_DT_FailureScenarios.robot
155bbsim-failurescenarios-dt: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_DT_SINGLE_PON_FILE)
156bbsim-failurescenarios-dt: voltha-dt-test
157
Andy Bavier70eab042019-12-14 14:16:26 -0700158voltha-test: ROBOT_MISC_ARGS += -e notready
hwchiu11289122019-11-27 16:20:15 +0000159
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700160voltha-test: vst_venv
161 source ./$</bin/activate ; set -u ;\
162 cd tests/functional ;\
163 robot -V $(ROBOT_CONFIG_FILE) $(ROBOT_MISC_ARGS) $(ROBOT_FILE)
164
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000165voltha-dt-test: vst_venv
166 source ./$</bin/activate ; set -u ;\
167 cd tests/dt-workflow ;\
168 robot -V $(ROBOT_CONFIG_FILE) $(ROBOT_MISC_ARGS) $(ROBOT_FILE)
169
Matteo Scandolo142e6272020-04-29 17:36:59 -0700170voltha-scale-test: vst_venv
171 source ./$</bin/activate ; set -u ;\
172 cd tests/scale ;\
173 robot $(ROBOT_MISC_ARGS) Voltha_Scale_Tests.robot
174
TorstenThieme1619db22020-04-03 12:01:15 +0000175openonu-go-adapter-statetest: vst_venv
176 source ./$</bin/activate ; set -u ;\
177 cd tests/openonu-go-adapter ;\
178 robot -V $(ROBOT_CONFIG_FILE) $(ROBOT_MISC_ARGS) $(ROBOT_FILE)
179
180
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700181# self-test, lint, and setup targets
182
183# virtualenv for the robot tools
Andy Bavier952b95b2020-03-06 09:53:42 -0700184# VOL-2724 Invoke pip via python3 to avoid pathname too long on QA jobs
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700185vst_venv:
186 virtualenv -p python3 $@ ;\
187 source ./$@/bin/activate ;\
Andy Baviere118e052020-03-06 12:49:24 -0700188 python -m pip install -r requirements.txt
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700189
190test: lint
191
192lint: lint-robot lint-python lint-yaml lint-json
193
194lint-robot: vst_venv
195 source ./$</bin/activate ; set -u ;\
196 rflint $(LINT_ARGS) $(ROBOT_FILES)
197
198# check deps for format and python3 cleanliness
199lint-python: vst_venv
200 source ./$</bin/activate ; set -u ;\
201 pylint --py3k $(PYTHON_FILES) ;\
202 flake8 --max-line-length=99 --count $(PYTHON_FILES)
203
204lint-yaml: vst_venv
205 source ./$</bin/activate ; set -u ;\
206 yamllint -s $(YAML_FILES)
207
208lint-json: vst_venv
209 source ./$</bin/activate ; set -u ;\
210 for jsonfile in $(JSON_FILES); do \
211 echo "Validating json file: $$jsonfile" ;\
212 python -m json.tool $$jsonfile > /dev/null ;\
213 done
214
215# tidy target will be more useful once issue with removing leading comments
216# is resolved: https://github.com/robotframework/robotframework/issues/3263
217tidy-robot: vst_venv
218 source ./$</bin/activate ; set -u ;\
219 python -m robot.tidy --inplace $(ROBOT_FILES);
220
Andy Bavier4a8450e2020-02-04 08:58:37 -0700221# Install the 'kail' tool if needed: https://github.com/boz/kail
222KAIL_PATH ?= /usr/local/bin
223$(KAIL_PATH)/kail:
224 bash <( curl -sfL https://raw.githubusercontent.com/boz/kail/master/godownloader.sh) -b /tmp
225 mv /tmp/kail $(KAIL_PATH)
226
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700227## Variables for gendocs
228TEST_SOURCE := $(wildcard tests/*/*.robot)
229TEST_BASENAME := $(basename $(TEST_SOURCE))
230TEST_DIRS := $(dir $(TEST_SOURCE))
231
232LIB_SOURCE := $(wildcard libraries/*.robot)
233LIB_BASENAME := $(basename $(LIB_SOURCE))
234LIB_DIRS := $(dir $(LIB_SOURCE))
235
236.PHONY: gendocs lint test
237# In future explore use of --docformat REST - integration w/Sphinx?
Zack Williamsec53a1b2019-09-16 15:50:52 -0700238gendocs: vst_venv
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700239 source ./$</bin/activate ; set -u ;\
hwchiu0601ec72019-10-08 00:04:43 +0000240 mkdir -p $@ ;\
241 for dir in ${LIB_DIRS}; do mkdir -p $@/$$dir; done;\
242 for dir in ${LIB_BASENAME}; do\
243 python -m robot.libdoc --format HTML $$dir.robot $@/$$dir.html ;\
244 done ;\
245 for dir in ${TEST_DIRS}; do mkdir -p $@/$$dir; done;\
246 for dir in ${TEST_BASENAME}; do\
247 python -m robot.testdoc $$dir.robot $@/$$dir.html ;\
248 done
Zack Williamsec53a1b2019-09-16 15:50:52 -0700249
Zack Williamsec53a1b2019-09-16 15:50:52 -0700250clean:
251 find . -name output.xml -print
252
253clean-all: clean
254 rm -rf vst_venv gendocs
Scott Baker60e570d2020-02-02 22:10:13 -0800255
256voltctl-docker-image-build:
257 cd docker && docker build -t opencord/voltctl:local -f Dockerfile.voltctl .
258
259voltctl-docker-image-install-kind:
260 @if [ "`kind get clusters | grep voltha`" = '' ]; then echo "no voltha cluster found" && exit 1; fi
261 kind load docker-image --name `kind get clusters | grep voltha` opencord/voltctl:local