Improved description for the glob argument in @parametrize_with_cases. Also made the implementation escape all regex special characters so that they can't be used. Finally a pattern should now match the entire case id (previously, a partial match would work if it was at the beginning of the string). Added tests. One simple step towards #147

Author: Sylvain MARIE

docs/api_reference.md

@@ -72,7 +72,7 @@ argvalues = get_parametrize_args(host_class_or_module_of_f, cases_funs)
 
  - `prefix`: the prefix for case functions. Default is 'case_' but you might wish to use different prefixes to denote different kind of cases, for example 'data_', 'algo_', 'user_', etc.
 
- - `glob`: an optional glob-like pattern for case ids, for example "*_success" or "*_failure". Note that this is applied on the case id, and therefore if it is customized through [`@case(id=...)`](#case) it should be taken into account.
+ - `glob`: a matching pattern for case ids, for example `*_success` or `*_failure`. The only special character that can be used for now in this pattern is `*`, it can not be escaped, and it can be used several times in the same expression. The pattern should match the entire case id for the case to be selected. Note that this is applied on the case id, and therefore if it is customized through [`@case(id=...)`](#case) it will be taken into account.
 
  - `has_tag`: a single tag or a tuple, set, list of tags that should be matched by the ones set with the [`@case`](#case) decorator on the case function(s) to be selected.
 

pytest_cases/case_parametrizer_new.py

@@ -126,11 +126,16 @@ def create_glob_name_filter(glob_str  # type: str
                             ):
     """
     Creates a glob-like matcher for the name of case functions
+    The only special character that is supported is `*` and it can not be
+    escaped. However it can be used multiple times in an expression.
 
-    :param case_fun:
+    :param glob_str: for example `*_success` or `*_*`
     :return:
     """
-    name_matcher = re.compile(glob_str.replace("*", ".*"))
+    # escape all special regex characters, then find the (escaped) stars and turn them into the regex star .*
+    re_str = re.escape(glob_str).replace("\\*", ".*")
+    # add "end" special regex char
+    name_matcher = re.compile(re_str + "$")
 
     def _glob_name_filter(case_fun):
         case_fun_id = case_fun._pytestcase.id
@@ -162,8 +167,10 @@ def get_all_cases(parametrization_target,  # type: Callable
         explicitly provided in the list, they can have any name and do not need to follow this `*Case*` pattern.
     :param prefix: the prefix for case functions. Default is 'case_' but you might wish to use different prefixes to
         denote different kind of cases, for example 'data_', 'algo_', 'user_', etc.
-    :param glob: an optional glob-like pattern for case ids, for example "*_success" or "*_failure". Note that this
-        is applied on the case id, and therefore if it is customized through `@case(id=...)` it should be taken into
+    :param glob: a matching pattern for case ids, for example `*_success` or `*_failure`. The only special character
+        that can be used for now in this pattern is `*`, it can not be escaped, and it can be used several times in the
+        same expression. The pattern should match the entire case id for the case to be selected. Note that this is
+        applied on the case id, and therefore if it is customized through `@case(id=...)` it will be taken into
         account.
     :param has_tag: a single tag or a tuple, set, list of tags that should be matched by the ones set with the `@case`
         decorator on the case function(s) to be selected.

pytest_cases/tests/cases/others/__init__.py

@@ -0,0 +1,30 @@
+from pytest_cases import case
+
+from pytest_cases.case_parametrizer_new import create_glob_name_filter
+
+
+def test_glob_low_level():
+    """Tests that the glob-like filtering mechanism for case ids works"""
+
+    def case_fun_with_id(id):
+        @case(id=id)
+        def _f():
+            pass
+        # CaseInfo(id=id).attach_to(_f)
+        return _f
+
+    filtr = create_glob_name_filter("o*_success")
+    assert filtr(case_fun_with_id("oooh_success"))
+    assert not filtr(case_fun_with_id("oh_no"))
+    # beginning and end: no match
+    assert not filtr(case_fun_with_id("oh_success2"))
+    assert not filtr(case_fun_with_id("yoh_success"))
+
+    filtr = create_glob_name_filter("*_*")
+    assert filtr(case_fun_with_id("oh_success"))
+    assert filtr(case_fun_with_id("oh_no"))
+    assert not filtr(case_fun_with_id("ohno"))
+
+    filtr = create_glob_name_filter("*_$[ab]+")
+    assert filtr(case_fun_with_id("oh_$[ab]+"))
+    assert not filtr(case_fun_with_id("oh_$"))