Kailash | 9276492 | 2019-07-25 08:21:39 -0700 | [diff] [blame] | 1 | # 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 Williams | ec53a1b | 2019-09-16 15:50:52 -0700 | [diff] [blame] | 15 | # use bash for pushd/popd, and to fail quickly. virtualenv's activate |
| 16 | # has undefined variables, so no -u |
Zack Williams | a8fe75a | 2020-01-10 14:25:27 -0700 | [diff] [blame] | 17 | SHELL := bash -e -o pipefail |
Kailash | 9276492 | 2019-07-25 08:21:39 -0700 | [diff] [blame] | 18 | |
Zack Williams | a8fe75a | 2020-01-10 14:25:27 -0700 | [diff] [blame] | 19 | ROOT_DIR := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST)))) |
Kailash | 9276492 | 2019-07-25 08:21:39 -0700 | [diff] [blame] | 20 | |
Zack Williams | a8fe75a | 2020-01-10 14:25:27 -0700 | [diff] [blame] | 21 | # Configuration and lists of files for linting/testing |
| 22 | VERSION ?= $(shell cat ./VERSION) |
| 23 | LINT_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 | |
| 31 | PYTHON_FILES := $(wildcard libraries/*.py) |
| 32 | ROBOT_FILES := $(shell find . -name *.robot -print) |
| 33 | YAML_FILES := $(shell find ./tests -type f \( -name *.yaml -o -name *.yml \) -print) |
| 34 | JSON_FILES := $(shell find ./tests -name *.json -print) |
| 35 | |
| 36 | # Robot config |
| 37 | ROBOT_SANITY_SINGLE_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind.yaml |
| 38 | ROBOT_FAIL_SINGLE_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind.yaml |
| 39 | ROBOT_SANITY_MULT_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind-2x2.yaml |
| 40 | ROBOT_SCALE_SINGLE_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind-16.yaml |
| 41 | ROBOT_SCALE_MULT_PON_FILE ?= $(ROOT_DIR)/tests/data/bbsim-kind-8x2.yaml |
| 42 | ROBOT_DEBUG_LOG_OPT ?= |
| 43 | ROBOT_MISC_ARGS ?= |
| 44 | |
| 45 | ROBOT_SYSTEM_SETUP_MISC_ARGS ?= -i scaledown -l systemup_log.html -r systemup_report.html -o systemup_output.xml |
hwchiu | 1128912 | 2019-11-27 16:20:15 +0000 | [diff] [blame] | 46 | ROBOT_SYSTEM_TEARDOWN_MISC_ARGS ?= -i scaleup -l systemdown_log.html -r systemdown_report.html -o sysstemdown_output.xml |
Zack Williams | a8fe75a | 2020-01-10 14:25:27 -0700 | [diff] [blame] | 47 | ROBOT_SYSTEM_FILE ?= K8S_SystemTest.robot |
hwchiu | 0601ec7 | 2019-10-08 00:04:43 +0000 | [diff] [blame] | 48 | |
Gilles Depatie | 45fbe04 | 2019-11-11 17:10:06 -0500 | [diff] [blame] | 49 | # for backwards compatibility |
| 50 | sanity-kind: sanity-single-kind |
| 51 | |
David Bainbridge | f81cd64 | 2019-11-20 00:14:47 +0000 | [diff] [blame] | 52 | sanity-single-kind: ROBOT_MISC_ARGS += -i sanity $(ROBOT_DEBUG_LOG_OPT) |
Gilles Depatie | 45fbe04 | 2019-11-11 17:10:06 -0500 | [diff] [blame] | 53 | sanity-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE) |
| 54 | sanity-single-kind: bbsim-kind |
| 55 | |
David Bainbridge | f81cd64 | 2019-11-20 00:14:47 +0000 | [diff] [blame] | 56 | rwcore-restart-single-kind: ROBOT_MISC_ARGS += -X -i bbsimANDrwcore-restart $(ROBOT_DEBUG_LOG_OPT) |
| 57 | rwcore-restart-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_FAIL_SINGLE_PON_FILE) |
| 58 | rwcore-restart-single-kind: ROBOT_FILE := Voltha_PODTests.robot |
| 59 | rwcore-restart-single-kind: voltha-test |
| 60 | |
| 61 | sanity-multi-kind: ROBOT_MISC_ARGS += -i sanity $(ROBOT_DEBUG_LOG_OPT) |
Gilles Depatie | 45fbe04 | 2019-11-11 17:10:06 -0500 | [diff] [blame] | 62 | sanity-multi-kind: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_MULT_PON_FILE) |
| 63 | sanity-multi-kind: bbsim-kind |
Andy Bavier | ba9866b | 2019-10-11 07:11:53 -0700 | [diff] [blame] | 64 | |
Suchitra Vemuri | 8a9c378 | 2019-10-23 12:43:01 -0700 | [diff] [blame] | 65 | bbsim-kind: ROBOT_MISC_ARGS += -X |
Gilles Depatie | 45fbe04 | 2019-11-11 17:10:06 -0500 | [diff] [blame] | 66 | bbsim-kind: ROBOT_FILE := Voltha_PODTests.robot |
| 67 | bbsim-kind: voltha-test |
| 68 | |
David Bainbridge | f81cd64 | 2019-11-20 00:14:47 +0000 | [diff] [blame] | 69 | scale-single-kind: ROBOT_MISC_ARGS += -i active $(ROBOT_DEBUG_LOG_OPT) |
Gilles Depatie | 45fbe04 | 2019-11-11 17:10:06 -0500 | [diff] [blame] | 70 | scale-single-kind: ROBOT_CONFIG_FILE := $(ROBOT_SCALE_SINGLE_PON_FILE) |
| 71 | scale-single-kind: bbsim-scale-kind |
| 72 | |
David Bainbridge | f81cd64 | 2019-11-20 00:14:47 +0000 | [diff] [blame] | 73 | scale-multi-kind: ROBOT_MISC_ARGS += -i active $(ROBOT_DEBUG_LOG_OPT) |
Gilles Depatie | 45fbe04 | 2019-11-11 17:10:06 -0500 | [diff] [blame] | 74 | scale-multi-kind: ROBOT_CONFIG_FILE := $(ROBOT_SCALE_MULT_PON_FILE) |
| 75 | scale-multi-kind: bbsim-scale-kind |
| 76 | |
David Bainbridge | f81cd64 | 2019-11-20 00:14:47 +0000 | [diff] [blame] | 77 | bbsim-scale-kind: ROBOT_MISC_ARGS += -X $(ROBOT_DEBUG_LOG_OPT) |
Gilles Depatie | 45fbe04 | 2019-11-11 17:10:06 -0500 | [diff] [blame] | 78 | bbsim-scale-kind: ROBOT_FILE := Voltha_ScaleFunctionalTests.robot |
| 79 | bbsim-scale-kind: voltha-test |
Zack Williams | ec53a1b | 2019-09-16 15:50:52 -0700 | [diff] [blame] | 80 | |
hwchiu | 1128912 | 2019-11-27 16:20:15 +0000 | [diff] [blame] | 81 | system-scale-test: ROBOT_FILE := Voltha_PODTests.robot |
| 82 | system-scale-test: ROBOT_MISC_ARGS += -X -i sanity |
| 83 | system-scale-test: ROBOT_CONFIG_FILE := $(ROBOT_SANITY_SINGLE_PON_FILE) |
| 84 | system-scale-test: k8s-system-test |
| 85 | |
hwchiu | 8569593 | 2019-12-18 08:05:25 +0000 | [diff] [blame] | 86 | failure-test: ROBOT_MISC_ARGS += -X -i FailureTest $(ROBOT_DEBUG_LOG_OPT) |
| 87 | failure-test: ROBOT_FILE := $(ROBOT_SYSTEM_FILE) |
| 88 | failure-test: ROBOT_CONFIG_FILE := $(ROBOT_FAIL_SINGLE_PON_FILE) |
| 89 | failure-test: voltha-test |
| 90 | |
Andy Bavier | 70eab04 | 2019-12-14 14:16:26 -0700 | [diff] [blame] | 91 | voltha-test: ROBOT_MISC_ARGS += -e notready |
| 92 | k8s-system-test: ROBOT_MISC_ARGS += -e notready |
| 93 | |
hwchiu | 1128912 | 2019-11-27 16:20:15 +0000 | [diff] [blame] | 94 | #bbsim-only |
| 95 | k8s-system-test: vst_venv |
Zack Williams | a8fe75a | 2020-01-10 14:25:27 -0700 | [diff] [blame] | 96 | source ./$</bin/activate ; set -u ;\ |
hwchiu | 1128912 | 2019-11-27 16:20:15 +0000 | [diff] [blame] | 97 | cd tests/functional ;\ |
| 98 | robot $(ROBOT_SYSTEM_SETUP_MISC_ARGS) $(ROBOT_MISC_ARGS) $(ROBOT_SYSTEM_FILE) && \ |
| 99 | robot -V $(ROBOT_CONFIG_FILE) $(ROBOT_MISC_ARGS) $(ROBOT_FILE) && \ |
| 100 | robot $(ROBOT_SYSTEM_TEARDOWN_MISC_ARGS) $(ROBOT_MISC_ARGS) $(ROBOT_SYSTEM_FILE) |
| 101 | |
Zack Williams | a8fe75a | 2020-01-10 14:25:27 -0700 | [diff] [blame] | 102 | voltha-test: vst_venv |
| 103 | source ./$</bin/activate ; set -u ;\ |
| 104 | cd tests/functional ;\ |
| 105 | robot -V $(ROBOT_CONFIG_FILE) $(ROBOT_MISC_ARGS) $(ROBOT_FILE) |
| 106 | |
| 107 | # self-test, lint, and setup targets |
| 108 | |
| 109 | # virtualenv for the robot tools |
| 110 | vst_venv: |
| 111 | virtualenv -p python3 $@ ;\ |
| 112 | source ./$@/bin/activate ;\ |
| 113 | pip install -r requirements.txt |
| 114 | |
| 115 | test: lint |
| 116 | |
| 117 | lint: lint-robot lint-python lint-yaml lint-json |
| 118 | |
| 119 | lint-robot: vst_venv |
| 120 | source ./$</bin/activate ; set -u ;\ |
| 121 | rflint $(LINT_ARGS) $(ROBOT_FILES) |
| 122 | |
| 123 | # check deps for format and python3 cleanliness |
| 124 | lint-python: vst_venv |
| 125 | source ./$</bin/activate ; set -u ;\ |
| 126 | pylint --py3k $(PYTHON_FILES) ;\ |
| 127 | flake8 --max-line-length=99 --count $(PYTHON_FILES) |
| 128 | |
| 129 | lint-yaml: vst_venv |
| 130 | source ./$</bin/activate ; set -u ;\ |
| 131 | yamllint -s $(YAML_FILES) |
| 132 | |
| 133 | lint-json: vst_venv |
| 134 | source ./$</bin/activate ; set -u ;\ |
| 135 | for jsonfile in $(JSON_FILES); do \ |
| 136 | echo "Validating json file: $$jsonfile" ;\ |
| 137 | python -m json.tool $$jsonfile > /dev/null ;\ |
| 138 | done |
| 139 | |
| 140 | # tidy target will be more useful once issue with removing leading comments |
| 141 | # is resolved: https://github.com/robotframework/robotframework/issues/3263 |
| 142 | tidy-robot: vst_venv |
| 143 | source ./$</bin/activate ; set -u ;\ |
| 144 | python -m robot.tidy --inplace $(ROBOT_FILES); |
| 145 | |
| 146 | ## Variables for gendocs |
| 147 | TEST_SOURCE := $(wildcard tests/*/*.robot) |
| 148 | TEST_BASENAME := $(basename $(TEST_SOURCE)) |
| 149 | TEST_DIRS := $(dir $(TEST_SOURCE)) |
| 150 | |
| 151 | LIB_SOURCE := $(wildcard libraries/*.robot) |
| 152 | LIB_BASENAME := $(basename $(LIB_SOURCE)) |
| 153 | LIB_DIRS := $(dir $(LIB_SOURCE)) |
| 154 | |
| 155 | .PHONY: gendocs lint test |
| 156 | # In future explore use of --docformat REST - integration w/Sphinx? |
Zack Williams | ec53a1b | 2019-09-16 15:50:52 -0700 | [diff] [blame] | 157 | gendocs: vst_venv |
Zack Williams | a8fe75a | 2020-01-10 14:25:27 -0700 | [diff] [blame] | 158 | source ./$</bin/activate ; set -u ;\ |
hwchiu | 0601ec7 | 2019-10-08 00:04:43 +0000 | [diff] [blame] | 159 | mkdir -p $@ ;\ |
| 160 | for dir in ${LIB_DIRS}; do mkdir -p $@/$$dir; done;\ |
| 161 | for dir in ${LIB_BASENAME}; do\ |
| 162 | python -m robot.libdoc --format HTML $$dir.robot $@/$$dir.html ;\ |
| 163 | done ;\ |
| 164 | for dir in ${TEST_DIRS}; do mkdir -p $@/$$dir; done;\ |
| 165 | for dir in ${TEST_BASENAME}; do\ |
| 166 | python -m robot.testdoc $$dir.robot $@/$$dir.html ;\ |
| 167 | done |
Zack Williams | ec53a1b | 2019-09-16 15:50:52 -0700 | [diff] [blame] | 168 | |
Zack Williams | ec53a1b | 2019-09-16 15:50:52 -0700 | [diff] [blame] | 169 | clean: |
| 170 | find . -name output.xml -print |
| 171 | |
| 172 | clean-all: clean |
| 173 | rm -rf vst_venv gendocs |