Add status and trace to fixtures (#159)

Author: sseliverstov

.gitignore

@@ -1,7 +1,11 @@
+.DS_Store
 .idea
 .tox
 .cache
 .python-version
 
 *.pyc
-*.egg-info
+*.egg-info
+
+*/build
+*/dist

allure-pytest/src/listener.py

@@ -15,12 +15,13 @@
 from allure_commons.types import LabelType
 from allure_pytest.utils import allure_labels, allure_links, pytest_markers
 from allure_pytest.utils import allure_full_name, allure_package
+from allure_pytest.utils import get_status, get_status_details
+from allure_pytest.utils import get_outcome_status, get_outcome_status_details
 
 
 class AllureListener(object):
 
-    def __init__(self, config):
-        self.config = config
+    def __init__(self):
         self.allure_logger = AllureReporter()
         self._cache = ItemCache()
 
@@ -32,14 +33,10 @@ def start_step(self, uuid, title, params):
 
     @allure_commons.hookimpl
     def stop_step(self, uuid, exc_type, exc_val, exc_tb):
-        status = Status.PASSED
-        if exc_type is not None:
-            if exc_type == pytest.skip.Exception:
-                status = Status.SKIPPED
-            else:
-                status = Status.FAILED
-
-        self.allure_logger.stop_step(uuid, stop=now(), status=status)
+        self.allure_logger.stop_step(uuid,
+                                     stop=now(),
+                                     status=get_status(exc_val),
+                                     statusDetails=get_status_details(exc_type, exc_val, exc_tb))
 
     @allure_commons.hookimpl
     def start_fixture(self, parent_uuid, uuid, name):
@@ -48,7 +45,10 @@ def start_fixture(self, parent_uuid, uuid, name):
 
     @allure_commons.hookimpl
     def stop_fixture(self, parent_uuid, uuid, name, exc_type, exc_val, exc_tb):
-        self.allure_logger.stop_after_fixture(uuid, stop=now())
+        self.allure_logger.stop_after_fixture(uuid,
+                                              stop=now(),
+                                              status=get_status(exc_val),
+                                              statusDetails=get_status_details(exc_type, exc_val, exc_tb))
 
     @pytest.hookimpl(hookwrapper=True, tryfirst=True)
     def pytest_runtest_protocol(self, item, nextitem):
@@ -69,6 +69,9 @@ def pytest_runtest_protocol(self, item, nextitem):
 
         yield
 
+        for name, value in item.callspec.params.items() if hasattr(item, 'callspec') else ():
+            self.allure_logger.update_test(uuid, parameters=Parameter(name, represent(value)))
+
         test_case.labels.extend([Label(name=name, value=value) for name, value in allure_labels(item)])
         test_case.labels.extend([Label(name=LabelType.TAG, value=value) for value in pytest_markers(item)])
         test_case.labels.append(Label(name=LabelType.FRAMEWORK, value='pytest'))
@@ -86,11 +89,10 @@ def pytest_runtest_protocol(self, item, nextitem):
     @pytest.hookimpl(hookwrapper=True)
     def pytest_runtest_call(self, item):
         uuid = self._cache.get(item.nodeid)
-        for name, value in item.callspec.params.items() if hasattr(item, 'callspec') else ():
-            self.allure_logger.update_test(uuid, parameters=Parameter(name, represent(value)))
-
         self.allure_logger.update_test(uuid, start=now())
+
         yield
+
         self.allure_logger.update_test(uuid, stop=now())
 
     @pytest.hookimpl(hookwrapper=True)
@@ -110,12 +112,15 @@ def pytest_fixture_setup(self, fixturedef, request):
         before_fixture = TestBeforeResult(name=fixture_name, start=now())
         self.allure_logger.start_before_fixture(container_uuid, before_fixture_uuid, before_fixture)
 
-        yield
+        outcome = yield
 
-        self.allure_logger.stop_before_fixture(before_fixture_uuid, stop=now())
+        self.allure_logger.stop_before_fixture(before_fixture_uuid,
+                                               stop=now(),
+                                               status=get_outcome_status(outcome),
+                                               statusDetails=get_outcome_status_details(outcome))
 
         for index, finalizer in enumerate(fixturedef._finalizer or ()):
-            name = u'{fixture}::{finalizer}'.format(fixture=fixturedef.argname, finalizer=finalizer.__name__)
+            name = '{fixture}::{finalizer}'.format(fixture=fixturedef.argname, finalizer=finalizer.__name__)
             fixturedef._finalizer[index] = allure_commons.fixture(finalizer, parent_uuid=container_uuid, name=name)
 
     @pytest.hookimpl(hookwrapper=True)

allure-pytest/src/plugin.py

@@ -94,7 +94,7 @@ def pytest_configure(config):
     allure_commons.plugin_manager.register(test_helper)
 
     if report_dir:
-        test_listener = AllureListener(config)
+        test_listener = AllureListener()
         config.pluginmanager.register(test_listener)
         allure_commons.plugin_manager.register(test_listener)
 

allure-pytest/src/utils.py

@@ -2,7 +2,12 @@
 from __future__ import unicode_literals
 
 import os
+import pytest
 from allure_commons.utils import represent
+from allure_commons.utils import format_exception, format_traceback
+from allure_commons.model2 import Status
+from allure_commons.model2 import StatusDetails
+
 
 ALLURE_UNIQUE_LABELS = ['severity', 'thread', 'host']
 ALLURE_LABEL_PREFIX = 'allure_label'
@@ -63,3 +68,30 @@ def allure_full_name(nodeid):
     clazz = '.{clazz}'.format(clazz=parts[1]) if len(parts) > 2 else ''
     test = parts[-1]
     return '{package}{clazz}#{test}'.format(package=package, clazz=clazz, test=test)
+
+
+def get_outcome_status(outcome):
+    _, exception, _ = outcome.excinfo or (None, None, None)
+    return get_status(exception)
+
+
+def get_outcome_status_details(outcome):
+    exception_type, exception, exception_traceback = outcome.excinfo or (None, None, None)
+    return get_status_details(exception_type, exception, exception_traceback)
+
+
+def get_status(exception):
+    if exception:
+        if isinstance(exception, AssertionError):
+            return Status.FAILED
+        elif isinstance(exception, pytest.skip.Exception):
+            return Status.SKIPPED
+    return Status.PASSED
+
+
+def get_status_details(exception_type, exception, exception_traceback):
+    if isinstance(exception, pytest.skip.Exception):
+        return StatusDetails(message=exception.msg)
+    elif exception:
+        return StatusDetails(message=format_exception(exception_type, exception),
+                             trace=format_traceback(exception_traceback))

allure-pytest/test/fixtures/function_scope/finalizers_simple_test.py

@@ -11,17 +11,17 @@
 
 
 @pytest.fixture
-def fixture_with_finalizer_a(request):
-    def finalizer_fixture_a():
+def fixture_with_passed_finalizer(request):
+    def passed_finalizer():
         pass
-    request.addfinalizer(finalizer_fixture_a)
+    request.addfinalizer(passed_finalizer)
 
 
 @pytest.fixture
-def fixture_with_finalizer_b(request):
-    def finalizer_fixture_b():
-        pass
-    request.addfinalizer(finalizer_fixture_b)
+def fixture_failed_finalizer(request):
+    def failed_finalizer():
+        assert False
+    request.addfinalizer(failed_finalizer)
 
 
 @pytest.fixture
@@ -35,22 +35,29 @@ def second_finalizer():
     request.addfinalizer(second_finalizer)
 
 
-def test_two_fixures_with_finalizer(fixture_with_finalizer_a, fixture_with_finalizer_b):
+def test_two_fixures_with_finalizer(fixture_with_passed_finalizer, fixture_failed_finalizer):
     """
     >>> allure_report = getfixture('allure_report')
     >>> assert_that(allure_report,
     ...             has_test_case('test_two_fixures_with_finalizer',
     ...                           has_container(allure_report,
-    ...                                         has_before('fixture_with_finalizer_a'),
+    ...                                         has_before('fixture_with_passed_finalizer'),
     ...                                         has_after('{fixture}::{finalizer}'.format(
-    ...                                                               fixture='fixture_with_finalizer_a',
-    ...                                                               finalizer='finalizer_fixture_a'))
+    ...                                                               fixture='fixture_with_passed_finalizer',
+    ...                                                               finalizer='passed_finalizer'),
+    ...                                                   with_status('passed')
+    ...                                         )
     ...                           ),
     ...                           has_container(allure_report,
+    ...                                         has_before('fixture_failed_finalizer'),
     ...                                         has_after('{fixture}::{finalizer}'.format(
-    ...                                         has_before('fixture_with_finalizer_b'),
-    ...                                                               fixture='fixture_with_finalizer_b',
-    ...                                                               finalizer='finalizer_fixture_b'))
+    ...                                                               fixture='fixture_failed_finalizer',
+    ...                                                               finalizer='failed_finalizer'),
+    ...                                                   with_status('failed'),
+    ...                                                   has_status_details(
+    ...                                                                       with_status_message('AssertionError')
+    ...                                                   )
+    ...                                         )
     ...                           )
     ...             )
     ... )

allure-pytest/test/fixtures/function_scope/fixtures_parametrization_test.py

@@ -12,20 +12,28 @@
 
 @pytest.fixture(params=[True, False])
 def parametrized_fixture(request):
-    return request.param
+    assert request.param
 
 
 def test_function_scope_parametrized_fixture(parametrized_fixture):
     """
     >>> allure_report = getfixture('allure_report')
-    >>> for param in [True, False]:
+    >>> for passed in [True, False]:
     ...     assert_that(allure_report,
-    ...                 has_test_case('test_function_scope_parametrized_fixture[{param}]'.format(param=param),
-    ...                               has_parameter('parametrized_fixture', str(param))
+    ...                 has_test_case('test_function_scope_parametrized_fixture[{param}]'.format(param=passed),
+    ...                               has_parameter('parametrized_fixture', str(passed)),
+    ...                               has_container(allure_report,
+    ...                                         has_before('parametrized_fixture',
+    ...                                                    with_status('passed' if passed else 'failed'),
+    ...                                                    has_status_details(
+    ...                                                                       with_status_message('AssertionError')
+    ...                                                    ) if not passed else anything()
+    ...                                         )
+    ...                               )
     ...                 )
     ...     )
     """
-    assert parametrized_fixture
+    pass
 
 
 @pytest.fixture(params=[True, False], ids=['param_true', 'param_false'])
@@ -60,4 +68,4 @@ def test_two_function_scope_parametrized_fixture(parametrized_fixture, parametri
     ...                     )
     ...         )
     """
-    assert parametrized_fixture_with_ids and parametrized_fixture
+    assert parametrized_fixture_with_ids and parametrized_fixture

allure-pytest/test/status/step_status_test.py

@@ -26,15 +26,18 @@ def test_skip_in_deep_step():
     ...                           has_step('Step1',
     ...                                    with_status('skipped'),
     ...                                    has_step('Step2',
-    ...                                             with_status('skipped')
+    ...                                             with_status('skipped'),
+    ...                                             has_status_details(
+    ...                                                                with_status_message('oops!')
+    ...                                             )
     ...                                    )
     ...                            )
     ...             )
     ... )
     """
     with pytest.allure.step('Step1'):
         with pytest.allure.step('Step2'):
-            pytest.skip()
+            pytest.skip('oops!')
 
 
 def test_fail_in_step_after_step():
@@ -45,6 +48,9 @@ def test_fail_in_step_after_step():
     ...                           with_status('failed'),
     ...                           has_step('Step1',
     ...                                    with_status('failed'),
+    ...                                    has_status_details(
+    ...                                                       with_status_message('AssertionError')
+    ...                                    ),
     ...                                    has_step('Step2',
     ...                                             with_status('passed')
     ...                                    )