Fix behave hooks reporting (via #623)

Author: sseliverstov

allure-behave/features/hook.feature

@@ -21,10 +21,10 @@ Feature: Hook
         """
      When I run behave with allure formatter
      Then allure report has a scenario with name "Scenario with "<when> <where>" hook"
-      And this scenario has <when> fixture "<when>_<where>"
+      And this scenario has <when> fixture "<when> <where>"
 
      Then allure report has a scenario with name "Another scenario with "<when> <where>" hook"
-      And this scenario has <when> fixture "<when>_<where>"
+      And this scenario has <when> fixture "<when> <where>"
 
     Examples: fixtures
             | when   | where    |
@@ -55,10 +55,10 @@ Feature: Hook
         """
      When I run behave with allure formatter
      Then allure report has a scenario with name "Scenario with "<when> <where>" hook"
-      And this scenario has <when> fixture "<when>_<where>"
+      And this scenario has <when> fixture "<when> <where> @tag_for_hook"
 
      Then allure report has a scenario with name "Another scenario without "<when> <where>" hook"
-      And this scenario has not <when> fixture "<when>_<where>"
+      And this scenario has not <when> fixture "<when> <where> @tag_for_hook"
 
     Examples: fixtures
             | when   | where |
@@ -89,10 +89,10 @@ Feature: Hook
         """
      When I run behave with allure formatter
      Then allure report has a scenario with name "Scenario with "<when> <where>" hook"
-      And this scenario has <when> fixture "<when>_<where>"
+      And this scenario has <when> fixture "<when> <where> @tag_for_hook"
 
      Then allure report has a scenario with name "Another scenario with "<when> <where>" hook"
-      And this scenario has <when> fixture "<when>_<where>"
+      And this scenario has <when> fixture "<when> <where> @tag_for_hook"
 
     Examples: fixtures
             | when   | where |
@@ -121,10 +121,10 @@ Feature: Hook
         """
      When I run behave with allure formatter
      Then allure report has a scenario with name "Scenario with "<when> <where>" hook"
-      And this scenario has <when> fixture "<when>_<where>"
+      And this scenario has <when> fixture "<when> <where>"
 
      Then allure report has a scenario with name "Another scenario with "<when> <where>" hook"
-      And this scenario has <when> fixture "<when>_<where>"
+      And this scenario has <when> fixture "<when> <where>"
 
     Examples: fixtures
             | when   | where   |
@@ -153,10 +153,10 @@ Feature: Hook
         """
      When I run behave with allure formatter
      Then allure report has a scenario with name "Scenario with "<when> <where>" hook"
-      And this scenario has <when> fixture "<when>_<where>"
+      And this scenario has <when> fixture "<when> <where>"
 
      Then allure report has a scenario with name "Another scenario with "<when> <where>" hook"
-      And this scenario has <when> fixture "<when>_<where>"
+      And this scenario has <when> fixture "<when> <where>"
 
     Examples: fixtures
             | when   | where |
@@ -183,7 +183,7 @@ Feature: Hook
         """
      When I run behave with allure formatter
      Then allure report has a scenario with name "Scenario with "before_feature" hook and attachment"
-      And this scenario has before fixture "before_feature"
+      And this scenario has before fixture "before feature"
       And this before has attachment
 
 
@@ -207,7 +207,7 @@ Feature: Hook
         """
      When I run behave with allure formatter
      Then allure report has a scenario with name "Scenario with "<when> <where>" hook and step inside"
-      And this scenario has <when> fixture "<when>_<where>"
+      And this scenario has <when> fixture "<when> <where>"
       And this <when> contains step "Step inside fixture"
 
     Examples: fixtures
@@ -238,7 +238,7 @@ Feature: Hook
         """
      When I run behave with allure formatter
      Then allure report has a scenario with name "Scenario with "<when> <where>" hook and step as function inside"
-      And this scenario has <when> fixture "<when>_<where>"
+      And this scenario has <when> fixture "<when> <where>"
       And this <when> contains step "Step function"
 
     Examples: fixtures

allure-behave/features/steps/behave_steps.py

@@ -49,10 +49,8 @@ def run_behave_with_allure(context, **kwargs):
         stream_opener = StreamOpener(filename=result_tmp_dir)
         model_runner = ModelRunner(config, context.feature_definition)
         model_runner.formatters = make_formatters(config, [stream_opener])
-        model_runner.formatters[0].listener.fixture_context.enter()
         model_runner.hooks = getattr(context, 'globals', dict())
         model_runner.run()
-        model_runner.formatters[0].listener.__del__()
         context.allure_report = AllureReport(result_tmp_dir)
 
     os.environ.pop("ALLURE_TESTPLAN_PATH", None)

allure-behave/src/formatter.py

@@ -27,9 +27,11 @@ def _wrap_scenario(self, scenarios):
                 scenario.run = allure_commons.test(scenario.run, context={'scenario': scenario})
             is_planned_scenario(scenario, self.testplan)
 
+    def uri(self, uri):
+        self.listener.start_file()
+
     def feature(self, feature):
         self._wrap_scenario(feature.scenarios)
-        self.listener.start_feature()
 
     def step(self, step):
         self.listener.schedule_step(step)
@@ -42,3 +44,6 @@ def result(self, result):
 
     def eof(self):
         self.listener.stop_feature()
+
+    def close_stream(self):
+        self.listener.stop_session()

allure-behave/src/listener.py

@@ -23,11 +23,7 @@
 from allure_behave.utils import scenario_labels
 from allure_behave.utils import get_fullname
 from allure_behave.utils import TEST_PLAN_SKIP_REASON
-
-
-BEFORE_FIXTURES = ['before_all', 'before_tag', 'before_feature', 'before_scenario']
-AFTER_FIXTURES = ['after_all', 'after_tag', 'after_feature', 'after_scenario']
-FIXTURES = BEFORE_FIXTURES + AFTER_FIXTURES
+from allure_behave.utils import get_hook_name
 
 
 class AllureListener(object):
@@ -39,62 +35,46 @@ def __init__(self, behave_config):
         self.logger = AllureReporter()
         self.current_step_uuid = None
         self.current_scenario_uuid = None
-        self.execution_context = Context()
-        self.fixture_context = Context()
+        self.group_context = GroupContext(self.logger)
+        self.group_context.enter()
         self.steps = deque()
 
-    def __del__(self):
-        for group in self.fixture_context.exit():
-            group.children.extend(self.execution_context)
-            self.logger.stop_group(group.uuid)
+    def start_file(self):
+        self.group_context.enter()
 
     @allure_commons.hookimpl
     def start_fixture(self, parent_uuid, uuid, name, parameters):
-        parameters = [Parameter(name=param_name, value=param_value) for param_name, param_value in parameters.items()]
-
-        if name in FIXTURES and not self.fixture_context:
-            group = TestResultContainer(uuid=uuid4())
-            self.logger.start_group(group.uuid, group)
-            self.fixture_context.append(group)
+        # parameters = [Parameter(name=param_name, value=param_value) for param_name, param_value in parameters.items()]
 
-        if name in BEFORE_FIXTURES:
-            fixture = TestBeforeResult(name=name, start=now(), parameters=parameters)
-            for group in self.fixture_context:
-                self.logger.start_before_fixture(group.uuid, uuid, fixture)
+        if name.startswith("before_"):
+            name = get_hook_name(name, parameters)
+            fixture = TestBeforeResult(name=name, start=now(), parameters=None)
+            group = self.group_context.current_group()
+            self.logger.start_before_fixture(group.uuid, uuid, fixture)
 
-        elif name in AFTER_FIXTURES:
-            fixture = TestAfterResult(name=name, start=now(), parameters=parameters)
-            for group in self.fixture_context:
-                self.logger.start_after_fixture(group.uuid, uuid, fixture)
+        elif name.startswith("after_"):
+            name = get_hook_name(name, parameters)
+            fixture = TestAfterResult(name=name, start=now(), parameters=None)
+            group = self.group_context.current_group()
+            self.logger.start_after_fixture(group.uuid, uuid, fixture)
 
     @allure_commons.hookimpl
     def stop_fixture(self, parent_uuid, uuid, name, exc_type, exc_val, exc_tb):
-        if name in FIXTURES:
-            self.logger.stop_before_fixture(uuid=uuid,
-                                            stop=now(),
-                                            status=get_status(exc_val),
-                                            statusDetails=get_status_details(exc_type, exc_val, exc_tb))
-
-    def start_feature(self):
-        self.execution_context.enter()
-        self.fixture_context.enter()
+        self.logger.stop_before_fixture(uuid=uuid,
+                                        stop=now(),
+                                        status=get_status(exc_val),
+                                        statusDetails=get_status_details(exc_type, exc_val, exc_tb))
 
     def stop_feature(self):
-        uuids = self.execution_context.exit()
-        for group in self.fixture_context.exit():
-            group.children.extend(uuids)
-            self.logger.stop_group(group.uuid)
-        self.execution_context.extend(uuids)
+        self.group_context.exit()
 
     @allure_commons.hookimpl
     def start_test(self, parent_uuid, uuid, name, parameters, context):
         self.start_scenario(context['scenario'])
 
     def start_scenario(self, scenario):
         self.current_scenario_uuid = uuid4()
-        self.fixture_context.enter()
-        self.execution_context.enter()
-        self.execution_context.append(self.current_scenario_uuid)
+        self.group_context.enter()
 
         test_case = TestResult(uuid=self.current_scenario_uuid, start=now())
         test_case.name = scenario_name(scenario)
@@ -137,13 +117,9 @@ def stop_scenario(self, scenario):
             test_result.statusDetails = status_details
             self.logger.close_test(self.current_scenario_uuid)
             self.current_step_uuid = None
+            self.group_context.append_test(self.current_scenario_uuid)
+            self.group_context.exit()
 
-            for group in self.fixture_context.exit():
-                group.children.append(self.current_scenario_uuid)
-                self.logger.stop_group(group.uuid)
-
-        self.execution_context.exit()
-        self.execution_context.append(self.current_scenario_uuid)
         self.current_scenario_uuid = None
 
     def schedule_step(self, step):
@@ -229,17 +205,30 @@ def add_link(self, url, link_type, name):
 
             test_result.links.append(new_link)
 
+    def stop_session(self):
+        self.group_context.exit()
 
-class Context(list):
-    def __init__(self, _list=list()):
-        super(Context, self).__init__(_list)
-        self._stack = [_list]
 
-    def enter(self, _list=list()):
-        self._stack.append(self[:])
-        self[:] = _list
-        return self
+class GroupContext(object):
+    def __init__(self, logger):
+        self._logger = logger
+        self._groups = []
+
+    def enter(self):
+        group = TestResultContainer(uuid=uuid4())
+        self._logger.start_group(group.uuid, group)
+        self._groups.append(group)
 
     def exit(self):
-        gone, self[:] = self[:], self._stack.pop()
-        return gone
+        group = self._groups.pop()
+        if group.befores or group.afters:
+            self._logger.stop_group(group.uuid)
+        else:
+            self._logger._items.pop(group.uuid)
+
+    def current_group(self):
+        return self._groups[-1]
+
+    def append_test(self, uuid):
+        for group in self._groups:
+            group.children.append(uuid)

allure-behave/src/utils.py

@@ -98,6 +98,21 @@ def get_fullname(scenario):
     return "{filename}: {name}".format(filename=scenario.feature.name, name=name)
 
 
+def get_hook_name(name, parameters):
+    tag = None
+    if name in ["before_tag", "after_tag"]:
+        param_list = list(parameters.items())
+        if len(param_list) > 1:
+            tag = param_list[1][1]
+        else:
+            tag = param_list[0][1][1]
+    name = name.replace("_", " ")
+    if tag:
+        tag = tag.replace("'", "")
+        name = f"{name} @{tag}"
+    return name
+
+
 def step_status_details(result):
     if result.exception:
         # workaround for https://github.com/behave/behave/pull/616

allure-behave/tox.ini

@@ -26,7 +26,7 @@ commands =
 # https://github.com/allure-framework/allure-python/issues/321
 passenv = HOME
 
-basepython = python3.6
+#basepython = python3.6
 
 setenv =
     TEST_TMP={envtmpdir}