added tuples for adding new test flags

Author: charlesworth

tests/conftest.py

@@ -3,17 +3,41 @@
 import logging
 
 
+# each tuple contains (flag, mark, reason) where:
+# - flag: the cli flag used to enable the tests with that mark
+# - mark: the pytest mark to label a test with to enable skipping
+# - reason: the description of why that mark exists
+test_skip_marks = [
+    ("--runslow", "slow", "are long running"),
+    ("--runrobot", "robot_required", "require a connected Eva"),
+    ("--io_loopback", "io_loopback_required", "require head and base IO loopback cables connected to Eva"),
+]
+
+
 def pytest_addoption(parser):
     parser.addoption("--ip", default='172.16.16.2', help="IP of the test robot, defaults to 172.16.16.2")
     parser.addoption("--token", default='', help="API token of the test robot")
-    parser.addoption("--runslow", action="store_true", default=False, help="run slow tests")
-    parser.addoption("--runrobot", action="store_true", default=False, help="run tests that require a connected Eva")
-    parser.addoption(
-        "--io_loopback",
-        action="store_true",
-        default=False,
-        help="run tests that require head and base IO loopback cables connected to Eva",
-    )
+    for (flag, _, reason) in test_skip_marks:
+        parser.addoption(
+            flag,
+            action="store_true",
+            default=False,
+            help=f'run tests that {reason}',
+        )
+
+
+def pytest_configure(config):
+    for (_, mark, reason) in test_skip_marks:
+        config.addinivalue_line("markers", f'{mark}: marked tests {reason}')
+
+
+def pytest_collection_modifyitems(config, items):
+    for (flag, mark, _) in test_skip_marks:
+        if not config.getoption(flag):
+            skip_mark = pytest.mark.skip(reason=f'needs {flag} option to run')
+            for item in items:
+                if mark in item.keywords:
+                    item.add_marker(skip_mark)
 
 
 @pytest.fixture(scope="session")
@@ -26,39 +50,6 @@ def token(request):
     return request.config.getoption("--token")
 
 
-def pytest_configure(config):
-    config.addinivalue_line("markers", "slow: mark test as slow to run")
-    config.addinivalue_line("markers", "robot_required: no mocks, needs a connected Eva to run")
-    config.addinivalue_line(
-        "markers",
-        "io_loopback_required: require head and base IO loopback cables connected to Eva",
-    )
-
-
-def pytest_collection_modifyitems(config, items):
-    # --runslow given in cli: do not skip slow tests
-    if not config.getoption("--runslow"):
-        skip_slow = pytest.mark.skip(reason="need --runslow option to run")
-        for item in items:
-            if "slow" in item.keywords:
-                item.add_marker(skip_slow)
-
-    # --runrobot given in cli: do not skip tests where a connected Eva is required
-    if not config.getoption("--runrobot"):
-        skip_robot_required = pytest.mark.skip(reason="need --runrobot option to run")
-        for item in items:
-            if "robot_required" in item.keywords:
-                item.add_marker(skip_robot_required)
-
-    # --io_loopback given in cli: do not skip tests requiring
-    # attached base and ee IO loopback cables
-    if not config.getoption("--io_loopback"):
-        skip_io_loopback_required = pytest.mark.skip(reason="need --io_loopback option to run")
-        for item in items:
-            if "io_loopback_required" in item.keywords:
-                item.add_marker(skip_io_loopback_required)
-
-
 @pytest.fixture(scope="module")
 def eva(ip, token):
     e = Eva(ip, token, request_timeout=10, renew_period=2 * 60)