blob: 45ec35fccd12e71d3abc86468a0932140ad55b4e [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 \
24 --configure TooManyTestSteps:30 -e TooManyTestSteps \
25 --configure TooManyTestCases:12 -e TooManyTestCases \
26 --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
38ROBOT_FAIL_SINGLE_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind.yaml
39ROBOT_SANITY_MULT_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind-2x2.yaml
40ROBOT_SCALE_SINGLE_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind-16.yaml
41ROBOT_SCALE_MULT_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind-8x2.yaml
42ROBOT_DEBUG_LOG_OPT ?=
43ROBOT_MISC_ARGS ?=
44
45ROBOT_SYSTEM_SETUP_MISC_ARGS ?= -i scaledown -l systemup_log.html -r systemup_report.html -o systemup_output.xml
hwchiu11289122019-11-27 16:20:15 +000046ROBOT_SYSTEM_TEARDOWN_MISC_ARGS ?= -i scaleup -l systemdown_log.html -r systemdown_report.html -o sysstemdown_output.xml
Zack Williamsa8fe75a2020-01-10 14:25:27 -070047ROBOT_SYSTEM_FILE ?= K8S_SystemTest.robot
hwchiu0601ec72019-10-08 00:04:43 +000048
Gilles Depatie45fbe042019-11-11 17:10:06 -050049# for backwards compatibility
50sanity-kind: sanity-single-kind
51
Andy Bavier33e6dd32020-01-16 13:35:20 -070052functional-single-kind: ROBOT_MISC_ARGS += -i sanity -i functional $(ROBOT_DEBUG_LOG_OPT)
53functional-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
54functional-single-kind: bbsim-kind
55
David Bainbridgef81cd642019-11-20 00:14:47 +000056sanity-single-kind: ROBOT_MISC_ARGS += -i sanity $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -050057sanity-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
58sanity-single-kind: bbsim-kind
59
David Bainbridgef81cd642019-11-20 00:14:47 +000060rwcore-restart-single-kind: ROBOT_MISC_ARGS += -X -i bbsimANDrwcore-restart $(ROBOT_DEBUG_LOG_OPT)
61rwcore-restart-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_FAIL_SINGLE_PON_FILE)
62rwcore-restart-single-kind: ROBOT_FILE := Voltha_PODTests.robot
63rwcore-restart-single-kind: voltha-test
64
David Bainbridge3d6d5d32019-12-17 19:05:35 +000065single-kind: ROBOT_MISC_ARGS += -X -i $(TEST_TAGS) $(ROBOT_DEBUG_LOG_OPT)
66single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
67single-kind: ROBOT_FILE := Voltha_PODTests.robot
68single-kind: voltha-test
69
David Bainbridgef81cd642019-11-20 00:14:47 +000070sanity-multi-kind: ROBOT_MISC_ARGS += -i sanity $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -050071sanity-multi-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_MULT_PON_FILE)
72sanity-multi-kind: bbsim-kind
Andy Bavierba9866b2019-10-11 07:11:53 -070073
Suchitra Vemuri8a9c3782019-10-23 12:43:01 -070074bbsim-kind: ROBOT_MISC_ARGS += -X
Gilles Depatie45fbe042019-11-11 17:10:06 -050075bbsim-kind: ROBOT_FILE := Voltha_PODTests.robot
76bbsim-kind: voltha-test
77
David Bainbridgef81cd642019-11-20 00:14:47 +000078scale-single-kind: ROBOT_MISC_ARGS += -i active $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -050079scale-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SCALE_SINGLE_PON_FILE)
80scale-single-kind: bbsim-scale-kind
81
David Bainbridgef81cd642019-11-20 00:14:47 +000082scale-multi-kind: ROBOT_MISC_ARGS += -i active $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -050083scale-multi-kind: ROBOT_CONFIG_FILE := $(ROBOT_SCALE_MULT_PON_FILE)
84scale-multi-kind: bbsim-scale-kind
85
David Bainbridgef81cd642019-11-20 00:14:47 +000086bbsim-scale-kind: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT)
Gilles Depatie45fbe042019-11-11 17:10:06 -050087bbsim-scale-kind: ROBOT_FILE := Voltha_ScaleFunctionalTests.robot
88bbsim-scale-kind: voltha-test
Zack Williamsec53a1b2019-09-16 15:50:52 -070089
hwchiu11289122019-11-27 16:20:15 +000090system-scale-test: ROBOT_FILE := Voltha_PODTests.robot
hwchiu01e51172020-01-16 22:29:13 +000091system-scale-test: ROBOT_MISC_ARGS += -X -i sanity $(ROBOT_DEBUG_LOG_OPT)
hwchiu11289122019-11-27 16:20:15 +000092system-scale-test: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE)
93system-scale-test: k8s-system-test
94
hwchiu85695932019-12-18 08:05:25 +000095failure-test: ROBOT_MISC_ARGS += -X -i FailureTest $(ROBOT_DEBUG_LOG_OPT)
96failure-test: ROBOT_FILE := $(ROBOT_SYSTEM_FILE)
97failure-test: ROBOT_CONFIG_FILE := $(ROBOT_FAIL_SINGLE_PON_FILE)
98failure-test: voltha-test
99
Andy Bavier70eab042019-12-14 14:16:26 -0700100voltha-test: ROBOT_MISC_ARGS += -e notready
101k8s-system-test: ROBOT_MISC_ARGS += -e notready
102
hwchiu11289122019-11-27 16:20:15 +0000103#bbsim-only
104k8s-system-test: vst_venv
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700105 source ./$</bin/activate ; set -u ;\
hwchiu11289122019-11-27 16:20:15 +0000106 cd tests/functional ;\
107 robot $(ROBOT_SYSTEM_SETUP_MISC_ARGS) $(ROBOT_MISC_ARGS) $(ROBOT_SYSTEM_FILE) && \
108 robot -V $(ROBOT_CONFIG_FILE) $(ROBOT_MISC_ARGS) $(ROBOT_FILE) && \
109 robot $(ROBOT_SYSTEM_TEARDOWN_MISC_ARGS) $(ROBOT_MISC_ARGS) $(ROBOT_SYSTEM_FILE)
110
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700111voltha-test: vst_venv
112 source ./$</bin/activate ; set -u ;\
113 cd tests/functional ;\
114 robot -V $(ROBOT_CONFIG_FILE) $(ROBOT_MISC_ARGS) $(ROBOT_FILE)
115
116# self-test, lint, and setup targets
117
118# virtualenv for the robot tools
119vst_venv:
120 virtualenv -p python3 $@ ;\
121 source ./$@/bin/activate ;\
122 pip install -r requirements.txt
123
124test: lint
125
126lint: lint-robot lint-python lint-yaml lint-json
127
128lint-robot: vst_venv
129 source ./$</bin/activate ; set -u ;\
130 rflint $(LINT_ARGS) $(ROBOT_FILES)
131
132# check deps for format and python3 cleanliness
133lint-python: vst_venv
134 source ./$</bin/activate ; set -u ;\
135 pylint --py3k $(PYTHON_FILES) ;\
136 flake8 --max-line-length=99 --count $(PYTHON_FILES)
137
138lint-yaml: vst_venv
139 source ./$</bin/activate ; set -u ;\
140 yamllint -s $(YAML_FILES)
141
142lint-json: vst_venv
143 source ./$</bin/activate ; set -u ;\
144 for jsonfile in $(JSON_FILES); do \
145 echo "Validating json file: $$jsonfile" ;\
146 python -m json.tool $$jsonfile > /dev/null ;\
147 done
148
149# tidy target will be more useful once issue with removing leading comments
150# is resolved: https://github.com/robotframework/robotframework/issues/3263
151tidy-robot: vst_venv
152 source ./$</bin/activate ; set -u ;\
153 python -m robot.tidy --inplace $(ROBOT_FILES);
154
155## Variables for gendocs
156TEST_SOURCE := $(wildcard tests/*/*.robot)
157TEST_BASENAME := $(basename $(TEST_SOURCE))
158TEST_DIRS := $(dir $(TEST_SOURCE))
159
160LIB_SOURCE := $(wildcard libraries/*.robot)
161LIB_BASENAME := $(basename $(LIB_SOURCE))
162LIB_DIRS := $(dir $(LIB_SOURCE))
163
164.PHONY: gendocs lint test
165# In future explore use of --docformat REST - integration w/Sphinx?
Zack Williamsec53a1b2019-09-16 15:50:52 -0700166gendocs: vst_venv
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700167 source ./$</bin/activate ; set -u ;\
hwchiu0601ec72019-10-08 00:04:43 +0000168 mkdir -p $@ ;\
169 for dir in ${LIB_DIRS}; do mkdir -p $@/$$dir; done;\
170 for dir in ${LIB_BASENAME}; do\
171 python -m robot.libdoc --format HTML $$dir.robot $@/$$dir.html ;\
172 done ;\
173 for dir in ${TEST_DIRS}; do mkdir -p $@/$$dir; done;\
174 for dir in ${TEST_BASENAME}; do\
175 python -m robot.testdoc $$dir.robot $@/$$dir.html ;\
176 done
Zack Williamsec53a1b2019-09-16 15:50:52 -0700177
Zack Williamsec53a1b2019-09-16 15:50:52 -0700178clean:
179 find . -name output.xml -print
180
181clean-all: clean
182 rm -rf vst_venv gendocs