Add --allure-label command line option to filter test cases by custom labels (implements #725) (#690)

Co-authored-by: Sergey Khomutinin <[email protected]>

Author: betapl3b

allure-pytest/examples/label/custom/select_tests_by_label.rst

@@ -0,0 +1,34 @@
+Select test by label
+-----------------------------
+
+By using ``--allure-labels`` commandline option with a ``lablel_name=label1,label2`` format, only tests with
+corresponding labels will be run.
+
+
+For example, if you want to run tests with label 'Application' equals to 'desktop' or 'mobile' only,
+run pytest with ``--allure-labels Application=desktop,mobile`` option.
+
+To filter tests with several different labels multiple ``--allure-labels`` options can be specified:
+
+``--allure-labels Application=desktop,mobile --allure-labels layer=api``
+
+    >>> import allure
+
+    >>> @allure.label("Application", "desktop")
+    ... def test_custom_label_one():
+    ...     pass
+
+    >>> @allure.label("Application", "mobile")
+    ... def test_custom_label_another():
+    ...     pass
+
+    >>> @allure.label("Application", "mobile", "desktop")
+    ... def test_custom_label_both():
+    ...     pass
+
+    >>> @allure.label("layer", "api")
+    ... def test_layer_label():
+    ...     pass
+
+    >>> def test_no_labels():
+    ...     pass

allure-pytest/src/plugin.py

@@ -102,6 +102,20 @@ def a_label_type(string):
                                          help="""Comma-separated list of IDs.
                                          Run tests that have at least one of the specified id labels.""")
 
+    def cf_type(string):
+        type_name, values = string.split("=", 1)
+        atoms = set(values.split(","))
+        return [(type_name, atom) for atom in atoms]
+
+    parser.getgroup("general").addoption('--allure-label',
+                                         action="append",
+                                         dest="allure_labels",
+                                         metavar="LABELS_SET",
+                                         default=[],
+                                         type=cf_type,
+                                         help="""List of labels to run in format label_name=value1,value2.
+                                         "Run tests that have at least one of the specified labels.""")
+
     def link_pattern(string):
         pattern = string.split(':', 1)
         if not pattern[0]:
@@ -165,7 +179,8 @@ def select_by_labels(items, config):
                              config.option.allure_features,
                              config.option.allure_stories,
                              config.option.allure_ids,
-                             config.option.allure_severities)
+                             config.option.allure_severities,
+                             *config.option.allure_labels)
     if arg_labels:
         selected, deselected = [], []
         for item in items:

allure-pytest/test/acceptance/label/custom/select_custom_label_test.py

@@ -0,0 +1,49 @@
+""" ./examples/label/custom/select_tests_by_label.rst """
+
+import pytest
+from hamcrest import assert_that, ends_with, contains_inanyorder
+
+
+@pytest.mark.parametrize(
+    ["labels", "expected_tests"],
+    [
+        (
+            {"Application": ["desktop"]},
+            [
+                "test_custom_label_one",
+                "test_custom_label_both"
+            ]
+        ),
+        (
+            {"Application": ["mobile"]},
+            [
+                "test_custom_label_another",
+                "test_custom_label_both"
+            ]
+        ),
+        (
+            {"Application": ["desktop", "mobile"]},
+            [
+                "test_custom_label_one",
+                "test_custom_label_another",
+                "test_custom_label_both"
+            ]
+        ),
+        (
+            {"Application": ["mobile"], "layer": ["api"]},
+            [
+                "test_custom_label_another",
+                "test_custom_label_both",
+                "test_layer_label"
+            ]
+        )
+    ]
+)
+def test_select_by_custom_label(allured_testdir, labels, expected_tests):
+    allured_testdir.parse_docstring_path()
+    allure_labels = []
+    for label_name, label_values in labels.items():
+        allure_labels.extend(["--allure-label", f"{label_name}={','.join(label_values)}"])
+    allured_testdir.run_with_allure(*allure_labels)
+    test_cases = [test_case["fullName"] for test_case in allured_testdir.allure_report.test_cases]
+    assert_that(test_cases, contains_inanyorder(*[ends_with(name) for name in expected_tests]))