Merge pull request #17 from ltamshen/feature/add-feature-tag

Add tag feature

Author: npilon

planterbox/feature.py

@@ -62,7 +62,7 @@ class FeatureTestCase(TestCase):
     """A test case generated from the scenarios in a feature file."""
 
     def __init__(self, feature_path, scenarios_to_run=None, feature_text=None,
-                 config=None):
+                 config=None, tag_list=()):
         super(FeatureTestCase, self).__init__('nota')
         self.feature_path = feature_path
         self.scenarios_to_run = scenarios_to_run
@@ -79,6 +79,8 @@ def __init__(self, feature_path, scenarios_to_run=None, feature_text=None,
         self.feature_doc = [doc.strip() for doc in header_text[1:]]
         self.step_inventory = list(self.harvest_steps())
         self.check_scenarios()
+        self.tag_list = check_tag_list(tag_list)
+
 
     def id(self):
         if self.scenarios_to_run:
@@ -144,16 +146,22 @@ def run(self, result=None):
             run_hooks(module, self, result, 'before', 'feature')
             try:
                 for i, scenario in enumerate(self.scenarios):
-                    if (
-                        self.scenarios_to_run and
-                        not self.should_run_scenario(i, scenario)
-                    ):
-                        continue
+
                     (
                         self.scenario_name,
                         scenario_steps,
                         scenario_examples,
+                        scenario_tags,
                     ) = scenario
+
+                    if (not matches_tag(scenario_tags, self.tag_list) or
+                        (
+                            self.scenarios_to_run and
+                            not self.should_run_scenario(i, scenario)
+                        )):
+                         continue
+
+
                     if scenario_examples:
                         scenario_examples = list(
                             self.load_examples(scenario_examples))
@@ -208,6 +216,7 @@ def check_scenarios(self):
                 self.scenario_name,
                 scenario_steps,
                 scenario_examples,
+                scenario_tags,
             ) = scenario
             if scenario_examples:
                 # Do the example thing
@@ -402,3 +411,20 @@ def run_hook(tester, result, hook):
     except Exception as e:
         result.addError(tester, sys.exc_info())
         raise HookFailedException('Error')
+
+
+def matches_tag(scenario_tags, tag_list):
+    ''' If tags indicated on command line, returns True if a Scenario_tag matches
+    one given on the command line'''
+    if not tag_list:
+        return True
+    else:
+        return set(scenario_tags).intersection(tag_list)
+
+
+def check_tag_list(tag_list):
+    ''' Makes a list of any tags entered on the command line. '''
+    tags = []
+    if len(tag_list) !=0:
+        tags = tag_list[0].split(',')
+    return tags

planterbox/parsing.py

@@ -5,6 +5,7 @@
 
 INDENT = re.compile(r'^\s+')
 SCENARIO = re.compile(r'^\s+Scenario(?: Outline)?:')
+SCENARIO_TAG = re.compile(r'^\s+Scenario Tag:')
 EXAMPLES = re.compile(r'^\s+Examples:')
 
 
@@ -32,6 +33,11 @@ def starts_scenario(line):
     return SCENARIO.match(line)
 
 
+def starts_scenario_tag(line):
+    """Determine if a line signals the start of a scenario."""
+    return SCENARIO_TAG.match(line)
+
+
 def starts_examples(line):
     """Determine if a line signals the start of an example block."""
     return EXAMPLES.match(line)
@@ -57,6 +63,7 @@ def parse_feature(feature_text):
     scenarios = []
     scenario = None
     append_index = 1
+    scenario_tag_index = 3
     scenario_indent = 0
     in_multiline = False
 
@@ -83,11 +90,16 @@ def parse_feature(feature_text):
             elif starts_examples(line):
                 append_index = 2
             else:
-                scenario[append_index].append(line)
+                if starts_scenario_tag(line):
+                    scenario[scenario_tag_index] += list(
+                        line.replace(' ','').split('ScenarioTag:')[1].split(','))
+                    continue
+                else:
+                    scenario[append_index].append(line)
 
         if scenario is None:  # Not elif - want to handle end-of-scenario
             if starts_scenario(line):
-                scenario = [line, [], []]
+                scenario = [line, [], [], []]
                 append_index = 1
                 scenario_indent = indent_level(line)
                 scenarios.append(scenario)

planterbox/plugin.py

@@ -36,6 +36,7 @@ class Planterbox(Plugin):
     commandLineSwitch = (None, 'with-planterbox',
                          'Load tests from .feature files')
     checkOnly = False
+    tag_list=[]
 
     def __init__(self):
         super(Plugin, self).__init__()
@@ -46,6 +47,14 @@ def __init__(self):
             Don't run planterbox tests.""",
         )
 
+        self.addOption(
+            self.tag_list, None, 'tag',
+            help_text="""tag allows selective running of scenarios
+            Examples: tag=abc or tag=abc,def""",
+            nargs=1
+        )
+        
+        
     def register(self):
         super(Planterbox, self).register()
 
@@ -65,6 +74,7 @@ def register(self):
     def setCheckOnly(self, *args):
         self.checkOnly = True
 
+
     def makeSuiteFromFeature(self, module, feature_path,
                              scenarios_to_run=None):
         MyTestSuite = transplant_class(TestSuite, module.__name__)
@@ -85,6 +95,7 @@ def makeSuiteFromFeature(self, module, feature_path,
                         feature_path=feature_path,
                         scenarios_to_run=scenarios_to_run,
                         config=self.config,
+                        tag_list=self.tag_list,
                     ),
                 ],
             )

planterbox/tests/test_feature/basic.feature

@@ -1,7 +1,9 @@
 Feature: Basic Tests
     I want to exercise generation of a simple test from a feature.
 
+
     Scenario: I need to verify basic arithmetic.
+        Scenario Tag: math1, math2
         Given I add 1 and 1
         Then the result should be 2
 

planterbox/tests/test_scenario_test_case.py

@@ -305,3 +305,54 @@ def mock_addFailure(result, exc):
             self.fail(formatted)
 
         self.assertEqual(mock_world.test_thing.call_count, 2)
+
+
+    def test_scenario_tag(self):
+        from planterbox.feature import FeatureTestCase
+        from planterbox import step
+
+        test_feature = """Feature: A Scenario Tag Feature
+
+            Scenario: A Test Scenario.
+                Scenario Tag: math2
+                When I test a thing
+
+            Scenario: An Untagged Test Scenario.
+                When I test a thing
+        """
+
+        @step(r'I test a thing')
+        def test_thing(test):
+            pass
+
+        mock_world = Mock(
+            spec=['test_thing'],
+            return_value=None,
+        )
+        mock_world.__name__ = 'mock'
+        mock_world.test_thing = step(r'I test a thing')(Mock(
+            planterbox_patterns=[],
+        ))
+
+
+        def mock_addFailure(result, exc):
+            self.exc_info = exc
+
+        mock_result = Mock(addFailure=Mock(side_effect=mock_addFailure))
+
+        with patch('planterbox.feature.import_module',
+                   Mock(return_value=mock_world)):
+            test_case = FeatureTestCase(
+               feature_path='foobar.feature',
+                feature_text=test_feature,
+                tag_list = ("math2",)
+            )
+
+            test_case.__module__ = 'mock'
+            test_case.run(mock_result)
+
+        if hasattr(self, 'exc_info'):
+            formatted = test_case.formatTraceback(self.exc_info)
+            self.fail(formatted)
+
+        mock_world.test_thing.assert_called_once()