Merge pull request #14 from npilon/invoke-test-by-name

Add Support to Invoke Tests By Name

Author: wholewheattoast

README.rst

@@ -132,3 +132,25 @@ scenario multiple times with different values. For example:
 
 Your ``'before'`` and ``'after'`` ``'scenario'`` hooks will only run
 once for the entire scenario outline.
+
+Invoking Tests
+--------------
+
+You can run tests by allowing nose2's autodiscovery to find all of your tests,
+or you can specify specific tests to be run on the command line. When
+specifying specific tests, you can either specify an entire package,
+an entire feature, or individual scenarios. Individual scenarios can be
+specified either by index (from 0) or by name.
+
+.. code::
+
+    nose2 planterbox.tests.test_feature
+    nose2 planterbox.tests.test_feature:basic.feature planterbox.tests.test_hooks:hooks.feature
+    nose2 planterbox.tests.test_feature:basic.feature:1
+    nose2 planterbox.tests.test_feature:basic.feature:0
+    nose2 planterbox.tests.test_feature:basic.feature:"I need to verify basic arithmetic"
+    nose2 planterbox.tests.test_feature:basic.feature:"I need to verify basic arithmetic."
+
+If your feature includes multiple scenarios with the same name, all will be
+run when that name is given. Names with a trailing period can be specified with
+or without the trailing period.

planterbox/feature.py

@@ -1,5 +1,7 @@
 """TestCase subclass for executing the scenarios from a feature"""
 
+from cStringIO import StringIO
+import csv
 import codecs
 from importlib import import_module
 from itertools import (
@@ -53,11 +55,11 @@ def from_exc_info(cls, exc_info, scenario_index,
 class FeatureTestCase(TestCase):
     """A test case generated from the scenarios in a feature file."""
 
-    def __init__(self, feature_path, scenario_indexes=None, feature_text=None,
+    def __init__(self, feature_path, scenarios_to_run=None, feature_text=None,
                  config=None):
         super(FeatureTestCase, self).__init__('nota')
         self.feature_path = feature_path
-        self.scenario_indexes = scenario_indexes
+        self.scenarios_to_run = scenarios_to_run
         self.config = config
 
         if feature_text is None:
@@ -71,10 +73,12 @@ def __init__(self, feature_path, scenario_indexes=None, feature_text=None,
         self.feature_doc = [doc.strip() for doc in header_text[1:]]
 
     def id(self):
-        if self.scenario_indexes:
-            return self.feature_id() + ':' + ','.join(
-                [unicode(i) for i in self.scenario_indexes]
-            )
+        if self.scenarios_to_run:
+            scenario_string = StringIO()
+            csv.writer(
+                scenario_string, quoting=csv.QUOTE_NONNUMERIC
+            ).writerow(list(self.scenarios_to_run))
+            return self.feature_id() + ':' + scenario_string.getvalue().strip()
         else:
             return self.feature_id()
 
@@ -133,8 +137,8 @@ def run(self, result=None):
             try:
                 for i, scenario in enumerate(self.scenarios):
                     if (
-                        self.scenario_indexes and
-                        i not in self.scenario_indexes
+                        self.scenarios_to_run and
+                        not self.should_run_scenario(i, scenario)
                     ):
                         continue
 
@@ -177,6 +181,22 @@ def run(self, result=None):
         except HookFailedException:
             return  # Failure already registered.
 
+    def should_run_scenario(self, i, scenario):
+        """Decide whether to run this scenario when running a subset"""
+        scenario_name = scenario[0].partition(':')[2].strip()
+
+        no_trailing_period = (
+            scenario_name[:-1]
+            if scenario_name[-1] == '.'
+            else scenario_name
+        )
+
+        return (
+            scenario_name in self.scenarios_to_run or
+            no_trailing_period in self.scenarios_to_run or
+            i in self.scenarios_to_run
+        )
+
     def run_scenario(self, module, index, scenario, result):
         completed_steps = []
         self.scenario_index = index

planterbox/plugin.py

@@ -1,6 +1,7 @@
 """nose2 plugin for discovering and running planterbox features as tests"""
 
 from collections import defaultdict
+import csv
 from datetime import datetime
 from functools import partial
 from itertools import (
@@ -31,7 +32,7 @@
 
 
 EXAMPLE_TO_FORMAT = re.compile(r'<(.+?)>')
-FEATURE_NAME = re.compile(r'\.feature(?:\:[\d,]+)?$')
+FEATURE_NAME = re.compile(r'\.feature(?:\:.+)?$')
 
 
 class Planterbox(Plugin):
@@ -55,7 +56,7 @@ def register(self):
                                        start_datetime.strftime("%H_%M_%S")))
 
     def makeSuiteFromFeature(self, module, feature_path,
-                             scenario_indexes=None):
+                             scenarios_to_run=None):
         MyTestSuite = transplant_class(TestSuite, module.__name__)
 
         MyFeatureTestCase = transplant_class(FeatureTestCase, module.__name__)
@@ -64,7 +65,7 @@ def makeSuiteFromFeature(self, module, feature_path,
             tests=[
                 MyFeatureTestCase(
                     feature_path=feature_path,
-                    scenario_indexes=scenario_indexes,
+                    scenarios_to_run=scenarios_to_run,
                     config=self.config,
                 ),
             ],
@@ -121,7 +122,7 @@ def _from_names(self, names):
 
         for (
             feature_package_name, feature_filename
-        ), scenario_indexes in sorted(by_feature.iteritems()):
+        ), scenarios_to_run in sorted(by_feature.iteritems()):
             feature_module = object_from_name(feature_package_name)[1]
             feature_path = os.path.join(
                 os.path.dirname(feature_module.__file__), feature_filename
@@ -130,7 +131,7 @@ def _from_names(self, names):
             suite = self.makeSuiteFromFeature(
                 module=feature_module,
                 feature_path=feature_path,
-                scenario_indexes=scenario_indexes,
+                scenarios_to_run=scenarios_to_run,
             )
             yield suite
 
@@ -148,15 +149,36 @@ def normalize_names(names):
     for name in sorted(names):
         name_parts = name.split(':')
         if len(name_parts) == 3:
-            scenario_indexes = {int(s) for s in name_parts.pop(-1).split(',')}
+            scenario_string = name_parts.pop(-1)
+            scenarios_to_run = resolve_scenarios(scenario_string)
             name_parts = tuple(name_parts)
             if name_parts not in by_feature or by_feature[name_parts]:
-                by_feature[name_parts].update(scenario_indexes)
+                # Avoid adding specific scenarios if we've explicitly listed
+                #  an entire feature
+                by_feature[name_parts].update(scenarios_to_run)
         elif len(name_parts) == 2:
             name_parts = tuple(name_parts)
-            scenario_indexes = None
+            scenarios_to_run = None  # So... All!
             by_feature[name_parts] = set()
         else:
             continue
 
     return by_feature
+
+
+def resolve_scenarios(scenario_string):
+    """Convert a comma-separated string of scenarios into a set of scenarios
+
+    Scenarios can be specified as either scenario names (optionally quoted)
+    or scenario indexes."""
+
+    scenario_string = scenario_string.strip()
+    if not scenario_string:
+        return []
+
+    scenario_parser = csv.reader([scenario_string])
+    scenarios = scenario_parser.next()
+    scenarios = {
+        int(s) if s.isdigit() else s for s in scenarios
+    }
+    return scenarios