1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
# Copyright 2022 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import abc
class BaseSuite(abc.ABC):
"""Class used to define a Mobly suite.
To create a suite, inherit from this class and implement setup_suite.
Use `BaseSuite.add_test_class` to specify which classes to run with which
configs and test selectors.
After defining the sub class, the suite can be executed using
suite_runner.run_suite_class.
Users can use this class if they need to define their own setup and teardown
steps on the suite level. Otherwise, just use suite_runner.run_suite on the
list of test classes.
"""
def __init__(self, runner, config):
self._runner = runner
self._config = config.copy()
@property
def user_params(self):
return self._config.user_params
def add_test_class(self, clazz, config=None, tests=None, name_suffix=None):
"""Adds a test class to the suite.
Args:
clazz: class, a Mobly test class.
config: config_parser.TestRunConfig, the config to run the class with. If
not specified, the default config passed from google3 infra is used.
tests: list of strings, names of the tests to run in this test class, in
the execution order. If not specified, all tests in the class are
executed.
name_suffix: string, suffix to append to the class name for reporting.
This is used for differentiating the same class executed with different
parameters in a suite.
"""
if not config:
config = self._config
self._runner.add_test_class(config, clazz, tests, name_suffix)
@abc.abstractmethod
def setup_suite(self, config):
"""Function used to add test classes, has to be implemented by child class.
Args:
config: config_parser.TestRunConfig, the config provided by google3 infra.
Raises:
Error: when setup_suite is not implemented by child class.
"""
pass
def teardown_suite(self):
"""Function used to add post tests cleanup tasks (optional)."""
pass
|
