behave: do not report tests with --no-skipped option (fixes #211 fixes #142 via #249)

Author: sseliverstov

allure-behave/features/no_skipped.feature

@@ -0,0 +1,38 @@
+Feature: Behave cmd options
+
+  Scenario: Tags in scenario with options "--tags=tag"
+    Given feature definition
+        """
+        Feature: Tags filtering
+
+        @tag
+        Scenario: Scenario with tag
+          Given simple passed step
+
+        Scenario: Scenario without tag
+          Given simple passed step
+        """
+     When I run behave with allure formatter with options "--tags=tag"
+     Then allure report has a scenario with name "Scenario with tag"
+      And this scenario has "passed" status
+
+     Then allure report has a scenario with name "Scenario without tag"
+      And this scenario has "skipped" status
+
+  Scenario: Tags in scenario with options "--tags=tag --no-skipped"
+    Given feature definition
+        """
+        Feature: Tags filtering
+
+        @tag
+        Scenario: Scenario with tag
+          Given simple passed step
+
+        Scenario: Scenario without tag
+          Given simple passed step
+        """
+     When I run behave with allure formatter with options "--tags=tag --no-skipped"
+     Then allure report has a scenario with name "Scenario with tag"
+      And this scenario has "passed" status
+
+     Then allure report has not a scenario with name "Scenario without tag"

allure-behave/features/steps/report_steps.py

@@ -31,6 +31,13 @@ def step_scenario(context, scenario):
     assert_that(context.allure_report, matcher())
 
 
+@then(u'allure report has not a scenario with name "{scenario}"')
+def step_scenario(context, scenario):
+    matcher = partial(match, not_, has_test_case, scenario)
+    context.scenario = matcher
+    assert_that(context.allure_report, matcher())
+
+
 @then(u'scenario has before fixture "{fixture}"')
 @then(u'this scenario has before fixture "{fixture}"')
 def step_before_fixture(context, fixture):

allure-behave/src/formatter.py

@@ -1,3 +1,5 @@
+from __future__ import print_function
+
 from behave.model import ScenarioOutline
 from behave.formatter.base import Formatter
 import allure_commons
@@ -9,7 +11,12 @@ class AllureFormatter(Formatter):
     def __init__(self, stream_opener, config):
         super(AllureFormatter, self).__init__(stream_opener, config)
 
-        self.listener = AllureListener()
+        self.config = config
+
+        with open("debug-runner", "a") as debugfile:
+            print(config.show_skipped, file=debugfile)
+
+        self.listener = AllureListener(config)
         file_logger = AllureFileLogger(self.stream_opener.name)
 
         allure_commons.plugin_manager.register(self.listener)

allure-behave/src/listener.py

@@ -29,7 +29,8 @@
 
 
 class AllureListener(object):
-    def __init__(self):
+    def __init__(self, behave_config):
+        self.behave_config = behave_config
         self.logger = AllureReporter()
         self.current_step_uuid = None
         self.execution_context = Context()
@@ -102,19 +103,23 @@ def start_test(self, parent_uuid, uuid, name, parameters, context):
     @allure_commons.hookimpl
     def stop_test(self, parent_uuid, uuid, name, context, exc_type, exc_val, exc_tb):
         scenario = context['scenario']
-        self.flush_steps()
-        status = scenario_status(scenario)
-        status_details = scenario_status_details(scenario)
-        test_result = self.logger.get_test(uuid)
-        test_result.stop = now()
-        test_result.status = status
-        test_result.statusDetails = status_details
-        self.logger.close_test(uuid)
-        self.current_step_uuid = None
-
-        for group in self.fixture_context.exit():
-            group.children.append(uuid)
-            self.logger.stop_group(group.uuid)
+        if scenario.status == 'skipped' and not self.behave_config.show_skipped:
+            self.logger.drop_test(uuid)
+        else:
+            status = scenario_status(scenario)
+            status_details = scenario_status_details(scenario)
+
+            self.flush_steps()
+            test_result = self.logger.get_test(uuid)
+            test_result.stop = now()
+            test_result.status = status
+            test_result.statusDetails = status_details
+            self.logger.close_test(uuid)
+            self.current_step_uuid = None
+
+            for group in self.fixture_context.exit():
+                group.children.append(uuid)
+                self.logger.stop_group(group.uuid)
 
         self.execution_context.exit()
         self.execution_context.append(uuid)

allure-python-commons/src/reporter.py

@@ -75,6 +75,9 @@ def close_test(self, uuid):
         test_case = self._items.pop(uuid)
         plugin_manager.hook.report_result(result=test_case)
 
+    def drop_test(self, uuid):
+        self._items.pop(uuid)
+
     def start_step(self, parent_uuid, uuid, step):
         parent_uuid = parent_uuid if parent_uuid else self._last_executable()
         if parent_uuid is None: