blob: 10376151ae9b8c0f156831bbf99d1d50c539736b [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 Bavier8da0e132020-04-13 10:25:16 -070055functional-single-kind: ROBOT_MISC_ARGS += -i sanityORfunctional $(ROBOT_DEBUG_LOG_OPT)
Andy Bavier33e6dd32020-01-16 13:35:20 -070056functional-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
Andy Bavier8da0e132020-04-13 10:25:16 -070060functional-single-kind-dt: ROBOT_MISC_ARGS += -i sanityDtORfunctionalDt $(ROBOT_DEBUG_LOG_OPT)
Hardik Windlass35706ba2020-02-20 08:16:42 +000061functional-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 Bainbridge32c45632020-04-13 08:47:09 -070069rwcore-restart-single-kind: ROBOT_MISC_ARGS += -X -i functionalANDrwcore-restart $(ROBOT_DEBUG_LOG_OPT)
David Bainbridgef81cd642019-11-20 00:14:47 +000070rwcore-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
Andy Bavier8da0e132020-04-13 10:25:16 -070083functional-multi-kind: ROBOT_MISC_ARGS += -i sanityORfunctional $(ROBOT_DEBUG_LOG_OPT)
84functional-multi-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_MULT_PON_FILE)
85functional-multi-kind: bbsim-kind
86
Suchitra Vemuri8a9c3782019-10-23 12:43:01 -070087bbsim-kind: ROBOT_MISC_ARGS += -X
Gilles Depatie45fbe042019-11-11 17:10:06 -050088bbsim-kind: ROBOT_FILE := Voltha_PODTests.robot
89bbsim-kind: voltha-test
90
David Bainbridgef81cd642019-11-20 00:14:47 +000091scale-single-kind: ROBOT_MISC_ARGS += -i active $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -050092scale-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SCALE_SINGLE_PON_FILE)
93scale-single-kind: bbsim-scale-kind
94
David Bainbridgef81cd642019-11-20 00:14:47 +000095scale-multi-kind: ROBOT_MISC_ARGS += -i active $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -050096scale-multi-kind: ROBOT_CONFIG_FILE := $(ROBOT_SCALE_MULT_PON_FILE)
97scale-multi-kind: bbsim-scale-kind
98
David Bainbridgef81cd642019-11-20 00:14:47 +000099bbsim-scale-kind: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -0500100bbsim-scale-kind: ROBOT_FILE := Voltha_ScaleFunctionalTests.robot
101bbsim-scale-kind: voltha-test
Zack Williamsec53a1b2019-09-16 15:50:52 -0700102
hwchiuab524f02020-02-03 23:24:19 +0000103#Only supported in full mode
104system-scale-test: ROBOT_FILE := K8S_SystemTest.robot
hwchiu56eb85c2020-02-05 01:05:53 +0000105system-scale-test: ROBOT_MISC_ARGS += -X -i functional $(ROBOT_DEBUG_LOG_OPT)
hwchiuab524f02020-02-03 23:24:19 +0000106system-scale-test: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_MULT_PON_FILE)
107system-scale-test: voltha-test
hwchiu11289122019-11-27 16:20:15 +0000108
hwchiu85695932019-12-18 08:05:25 +0000109failure-test: ROBOT_MISC_ARGS += -X -i FailureTest $(ROBOT_DEBUG_LOG_OPT)
hwchiu3d9a0982020-02-06 00:19:19 +0000110failure-test: ROBOT_FILE := K8S_SystemTest.robot
hwchiu85695932019-12-18 08:05:25 +0000111failure-test: ROBOT_CONFIG_FILE := $(ROBOT_FAIL_SINGLE_PON_FILE)
112failure-test: voltha-test
113
Scott Baker60e570d2020-02-02 22:10:13 -0800114bbsim-alarms-kind: ROBOT_MISC_ARGS += -X -i active
115bbsim-alarms-kind: ROBOT_FILE := Voltha_AlarmTests.robot
Andy Baviere118e052020-03-06 12:49:24 -0700116bbsim-alarms-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
Scott Baker60e570d2020-02-02 22:10:13 -0800117bbsim-alarms-kind: voltctl-docker-image-build voltctl-docker-image-install-kind voltha-test
118
Andy Bavierc1904dc2020-03-20 11:39:15 -0700119bbsim-errorscenarios: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT)
120bbsim-errorscenarios: ROBOT_FILE := Voltha_ErrorScenarios.robot
121bbsim-errorscenarios: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
122bbsim-errorscenarios: voltha-test
123
Andy Bavier8da0e132020-04-13 10:25:16 -0700124bbsim-failurescenarios: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT) -e PowerSwitch
125bbsim-failurescenarios: ROBOT_FILE := Voltha_FailureScenarios.robot
126bbsim-failurescenarios: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
127bbsim-failurescenarios: voltha-test
128
Andy Bavier70eab042019-12-14 14:16:26 -0700129voltha-test: ROBOT_MISC_ARGS += -e notready
hwchiu11289122019-11-27 16:20:15 +0000130
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700131voltha-test: vst_venv
132 source ./$</bin/activate ; set -u ;\
133 cd tests/functional ;\
134 robot -V $(ROBOT_CONFIG_FILE) $(ROBOT_MISC_ARGS) $(ROBOT_FILE)
135
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000136voltha-dt-test: vst_venv
137 source ./$</bin/activate ; set -u ;\
138 cd tests/dt-workflow ;\
139 robot -V $(ROBOT_CONFIG_FILE) $(ROBOT_MISC_ARGS) $(ROBOT_FILE)
140
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700141# self-test, lint, and setup targets
142
143# virtualenv for the robot tools
Andy Bavier952b95b2020-03-06 09:53:42 -0700144# VOL-2724 Invoke pip via python3 to avoid pathname too long on QA jobs
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700145vst_venv:
146 virtualenv -p python3 $@ ;\
147 source ./$@/bin/activate ;\
Andy Baviere118e052020-03-06 12:49:24 -0700148 python -m pip install -r requirements.txt
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700149
150test: lint
151
152lint: lint-robot lint-python lint-yaml lint-json
153
154lint-robot: vst_venv
155 source ./$</bin/activate ; set -u ;\
156 rflint $(LINT_ARGS) $(ROBOT_FILES)
157
158# check deps for format and python3 cleanliness
159lint-python: vst_venv
160 source ./$</bin/activate ; set -u ;\
161 pylint --py3k $(PYTHON_FILES) ;\
162 flake8 --max-line-length=99 --count $(PYTHON_FILES)
163
164lint-yaml: vst_venv
165 source ./$</bin/activate ; set -u ;\
166 yamllint -s $(YAML_FILES)
167
168lint-json: vst_venv
169 source ./$</bin/activate ; set -u ;\
170 for jsonfile in $(JSON_FILES); do \
171 echo "Validating json file: $$jsonfile" ;\
172 python -m json.tool $$jsonfile > /dev/null ;\
173 done
174
175# tidy target will be more useful once issue with removing leading comments
176# is resolved: https://github.com/robotframework/robotframework/issues/3263
177tidy-robot: vst_venv
178 source ./$</bin/activate ; set -u ;\
179 python -m robot.tidy --inplace $(ROBOT_FILES);
180
Andy Bavier4a8450e2020-02-04 08:58:37 -0700181# Install the 'kail' tool if needed: https://github.com/boz/kail
182KAIL_PATH ?= /usr/local/bin
183$(KAIL_PATH)/kail:
184 bash <( curl -sfL https://raw.githubusercontent.com/boz/kail/master/godownloader.sh) -b /tmp
185 mv /tmp/kail $(KAIL_PATH)
186
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700187## Variables for gendocs
188TEST_SOURCE := $(wildcard tests/*/*.robot)
189TEST_BASENAME := $(basename $(TEST_SOURCE))
190TEST_DIRS := $(dir $(TEST_SOURCE))
191
192LIB_SOURCE := $(wildcard libraries/*.robot)
193LIB_BASENAME := $(basename $(LIB_SOURCE))
194LIB_DIRS := $(dir $(LIB_SOURCE))
195
196.PHONY: gendocs lint test
197# In future explore use of --docformat REST - integration w/Sphinx?
Zack Williamsec53a1b2019-09-16 15:50:52 -0700198gendocs: vst_venv
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700199 source ./$</bin/activate ; set -u ;\
hwchiu0601ec72019-10-08 00:04:43 +0000200 mkdir -p $@ ;\
201 for dir in ${LIB_DIRS}; do mkdir -p $@/$$dir; done;\
202 for dir in ${LIB_BASENAME}; do\
203 python -m robot.libdoc --format HTML $$dir.robot $@/$$dir.html ;\
204 done ;\
205 for dir in ${TEST_DIRS}; do mkdir -p $@/$$dir; done;\
206 for dir in ${TEST_BASENAME}; do\
207 python -m robot.testdoc $$dir.robot $@/$$dir.html ;\
208 done
Zack Williamsec53a1b2019-09-16 15:50:52 -0700209
Zack Williamsec53a1b2019-09-16 15:50:52 -0700210clean:
211 find . -name output.xml -print
212
213clean-all: clean
214 rm -rf vst_venv gendocs
Scott Baker60e570d2020-02-02 22:10:13 -0800215
216voltctl-docker-image-build:
217 cd docker && docker build -t opencord/voltctl:local -f Dockerfile.voltctl .
218
219voltctl-docker-image-install-kind:
220 @if [ "`kind get clusters | grep voltha`" = '' ]; then echo "no voltha cluster found" && exit 1; fi
221 kind load docker-image --name `kind get clusters | grep voltha` opencord/voltctl:local