feat(pytest-bdd): Allure API implementation (fixes #726, via #845)

Author: delatrie

allure-behave/setup.py

@@ -12,12 +12,12 @@
     'Topic :: Software Development :: Testing :: BDD',
     'Programming Language :: Python :: 3',
     'Programming Language :: Python :: 3 :: Only',
-    'Programming Language :: Python :: 3.7',
     'Programming Language :: Python :: 3.8',
     'Programming Language :: Python :: 3.9',
     'Programming Language :: Python :: 3.10',
     'Programming Language :: Python :: 3.11',
     'Programming Language :: Python :: 3.12',
+    'Programming Language :: Python :: 3.13',
 ]
 
 setup_requires = [
@@ -66,4 +66,3 @@ def main():
 
 if __name__ == '__main__':
     main()
-

allure-nose2/setup.py

@@ -11,12 +11,12 @@
     'Topic :: Software Development :: Testing',
     'Programming Language :: Python :: 3',
     'Programming Language :: Python :: 3 :: Only',
-    'Programming Language :: Python :: 3.7',
     'Programming Language :: Python :: 3.8',
     'Programming Language :: Python :: 3.9',
     'Programming Language :: Python :: 3.10',
     'Programming Language :: Python :: 3.11',
     'Programming Language :: Python :: 3.12',
+    'Programming Language :: Python :: 3.13',
 ]
 
 setup_requires = [

allure-pytest-bdd/setup.py

@@ -10,14 +10,15 @@
     'License :: OSI Approved :: Apache Software License',
     'Topic :: Software Development :: Quality Assurance',
     'Topic :: Software Development :: Testing',
+    'Topic :: Software Development :: Testing :: BDD',
     'Programming Language :: Python :: 3',
     'Programming Language :: Python :: 3 :: Only',
-    'Programming Language :: Python :: 3.7',
     'Programming Language :: Python :: 3.8',
     'Programming Language :: Python :: 3.9',
     'Programming Language :: Python :: 3.10',
     'Programming Language :: Python :: 3.11',
     'Programming Language :: Python :: 3.12',
+    'Programming Language :: Python :: 3.13',
 ]
 
 setup_requires = [

allure-pytest-bdd/src/allure_api_listener.py

@@ -0,0 +1,119 @@
+import pytest
+
+import allure_commons
+
+from allure_commons.model2 import Label
+from allure_commons.model2 import Link
+from allure_commons.model2 import Parameter
+from allure_commons.utils import represent
+
+from .utils import ALLURE_DESCRIPTION_HTML_MARK
+from .utils import ALLURE_DESCRIPTION_MARK
+from .utils import ALLURE_LABEL_MARK
+from .utils import ALLURE_LINK_MARK
+from .utils import ALLURE_TITLE_ATTR
+
+from .utils import apply_link_pattern
+from .utils import attach_data
+from .utils import attach_file
+from .utils import get_link_patterns
+from .steps import start_step
+from .steps import stop_step
+
+
+class AllurePytestBddApiHooks:
+    def __init__(self, config, lifecycle):
+        self.lifecycle = lifecycle
+        self.__link_patterns = get_link_patterns(config)
+
+    @allure_commons.hookimpl
+    def decorate_as_title(self, test_title):
+
+        def decorator(fn):
+            setattr(fn, ALLURE_TITLE_ATTR, test_title)
+            return fn
+
+        return decorator
+
+    @allure_commons.hookimpl
+    def add_title(self, test_title):
+        with self.lifecycle.update_test_case() as test_result:
+            test_result.name = test_title
+
+    @allure_commons.hookimpl
+    def decorate_as_description(self, test_description):
+        allure_description_mark = getattr(pytest.mark, ALLURE_DESCRIPTION_MARK)
+        return allure_description_mark(test_description)
+
+    @allure_commons.hookimpl
+    def add_description(self, test_description):
+        with self.lifecycle.update_test_case() as test_result:
+            test_result.description = test_description
+
+    @allure_commons.hookimpl
+    def decorate_as_description_html(self, test_description_html):
+        allure_description_html_mark = getattr(pytest.mark, ALLURE_DESCRIPTION_HTML_MARK)
+        return allure_description_html_mark(test_description_html)
+
+    @allure_commons.hookimpl
+    def add_description_html(self, test_description_html):
+        with self.lifecycle.update_test_case() as test_result:
+            test_result.descriptionHtml = test_description_html
+
+    @allure_commons.hookimpl
+    def decorate_as_label(self, label_type, labels):
+        allure_label_mark = getattr(pytest.mark, ALLURE_LABEL_MARK)
+        return allure_label_mark(*labels, label_type=label_type)
+
+    @allure_commons.hookimpl
+    def add_label(self, label_type, labels):
+        with self.lifecycle.update_test_case() as test_result:
+            test_result.labels.extend(
+                Label(name=label_type, value=value) for value in labels or []
+            )
+
+    @allure_commons.hookimpl
+    def decorate_as_link(self, url, link_type, name):
+        url = apply_link_pattern(self.__link_patterns, link_type, url)
+        allure_link_mark = getattr(pytest.mark, ALLURE_LINK_MARK)
+        return allure_link_mark(url, name=name, link_type=link_type)
+
+    @allure_commons.hookimpl
+    def add_link(self, url, link_type, name):
+        url = apply_link_pattern(self.__link_patterns, link_type, url)
+        with self.lifecycle.update_test_case() as test_result:
+            test_result.links.append(Link(url=url, name=name, type=link_type))
+
+    @allure_commons.hookimpl
+    def add_parameter(self, name, value, excluded, mode):
+        with self.lifecycle.update_test_case() as test_result:
+            test_result.parameters.append(
+                Parameter(
+                    name=name,
+                    value=represent(value),
+                    excluded=excluded,
+                    mode=mode.value if mode else None,
+                ),
+            )
+
+    @allure_commons.hookimpl
+    def start_step(self, uuid, title, params):
+        start_step(self.lifecycle, step_uuid=uuid, title=title, params=params)
+
+    @allure_commons.hookimpl
+    def stop_step(self, uuid, exc_type, exc_val, exc_tb):
+        stop_step(
+            self.lifecycle,
+            uuid,
+            exception=exc_val,
+            exception_type=exc_type,
+            traceback=exc_tb,
+        )
+
+    @allure_commons.hookimpl
+    def attach_data(self, body, name, attachment_type, extension):
+        attach_data(self.lifecycle, body, name, attachment_type, extension)
+
+    @allure_commons.hookimpl
+    def attach_file(self, source, name, attachment_type, extension):
+        attach_file(self.lifecycle, source, name, attachment_type, extension)

allure-pytest-bdd/src/plugin.py

@@ -1,8 +1,18 @@
-import allure_commons
+import argparse
 import os
+
+import allure_commons
 from allure_commons.logger import AllureFileLogger
+from allure_commons.lifecycle import AllureLifecycle
+
+from .allure_api_listener import AllurePytestBddApiHooks
 from .pytest_bdd_listener import PytestBDDListener
 
+from .utils import ALLURE_DESCRIPTION_MARK
+from .utils import ALLURE_DESCRIPTION_HTML_MARK
+from .utils import ALLURE_LABEL_MARK
+from .utils import ALLURE_LINK_MARK
+
 
 def pytest_addoption(parser):
     parser.getgroup("reporting").addoption('--alluredir',
@@ -17,6 +27,27 @@ def pytest_addoption(parser):
                                            dest="clean_alluredir",
                                            help="Clean alluredir folder if it exists")
 
+    def link_pattern(string):
+        pattern = string.split(':', 1)
+        if not pattern[0]:
+            raise argparse.ArgumentTypeError("A link type is mandatory")
+
+        if len(pattern) != 2:
+            raise argparse.ArgumentTypeError("A link pattern is mandatory")
+        return pattern
+
+    parser.getgroup("general").addoption(
+        "--allure-link-pattern",
+        action="append",
+        dest="allure_link_pattern",
+        metavar="LINK_TYPE:LINK_PATTERN",
+        default=[],
+        type=link_pattern,
+        help="""A URL pattern for a link type. Allows short links in tests,
+        e.g., 'issue-1'. `pattern.format(short_url)` will be called to get
+        the full URL"""
+    )
+
 
 def cleanup_factory(plugin):
     def clean_up():
@@ -25,18 +56,33 @@ def clean_up():
     return clean_up
 
 
+def register_marks(config):
+    config.addinivalue_line("markers", f"{ALLURE_DESCRIPTION_MARK}: allure description")
+    config.addinivalue_line("markers", f"{ALLURE_DESCRIPTION_HTML_MARK}: allure description in HTML")
+    config.addinivalue_line("markers", f"{ALLURE_LABEL_MARK}: allure label marker")
+    config.addinivalue_line("markers", f"{ALLURE_LINK_MARK}: allure link marker")
+
+
 def pytest_configure(config):
+    register_marks(config)
+
     report_dir = config.option.allure_report_dir
     clean = False if config.option.collectonly else config.option.clean_alluredir
 
     if report_dir:
         report_dir = os.path.abspath(report_dir)
 
-        pytest_bdd_listener = PytestBDDListener()
+        lifecycle = AllureLifecycle()
+
+        pytest_bdd_listener = PytestBDDListener(lifecycle)
         config.pluginmanager.register(pytest_bdd_listener)
         allure_commons.plugin_manager.register(pytest_bdd_listener)
         config.add_cleanup(cleanup_factory(pytest_bdd_listener))
 
+        allure_api_impl = AllurePytestBddApiHooks(config, lifecycle)
+        allure_commons.plugin_manager.register(allure_api_impl)
+        config.add_cleanup(cleanup_factory(allure_api_impl))
+
         file_logger = AllureFileLogger(report_dir, clean)
         allure_commons.plugin_manager.register(file_logger)
         config.add_cleanup(cleanup_factory(file_logger))