Add TestCaseFilter class

Author: bjoern-otto

aas_test_engines/config.py

@@ -1,9 +1,40 @@
 from typing import Optional
 from dataclasses import dataclass
+import fnmatch
+import re
+from .exception import InvalidFilterException
+
+
+# Implement gtest-like test filter:
+#    https://google.github.io/googletest/advanced.html#running-a-subset-of-the-tests
+class TestCaseFilter:
+    FILTER_SEP = "~"
+    PATTERN_SEP = ":"
+
+    def __init__(self, filter_pattern: str):
+        tokens = filter_pattern.split(self.FILTER_SEP)
+        if len(tokens) == 1:
+            include_pattern = tokens[0]
+            exclude_pattern = ""
+        elif len(tokens) == 2:
+            include_pattern = tokens[0]
+            exclude_pattern = tokens[1]
+        else:
+            raise InvalidFilterException(f"Separator {self.FILTER_SEP} must only occur once")
+        self.includes = [re.compile(fnmatch.translate(i)) for i in include_pattern.split(self.PATTERN_SEP) if i.strip()]
+        self.excludes = [re.compile(fnmatch.translate(i)) for i in exclude_pattern.split(self.PATTERN_SEP) if i.strip()]
+
+    def selects(self, test_case: str) -> bool:
+        if self.includes and not any(i.match(test_case) for i in self.includes):
+            return False
+        if self.excludes and any(i.match(test_case) for i in self.excludes):
+            return False
+        return True
 
 
 @dataclass
 class CheckApiConfig:
     suite: str
     version: Optional[str] = None
     dry: bool = False
+    filter: Optional[TestCaseFilter] = None

aas_test_engines/exception.py

@@ -1,2 +1,6 @@
 class AasTestToolsException(Exception):
     pass
+
+
+class InvalidFilterException(AasTestToolsException):
+    pass

test/test_config.py

@@ -0,0 +1,79 @@
+from unittest import TestCase
+from aas_test_engines.config import TestCaseFilter
+from aas_test_engines.exception import InvalidFilterException
+
+
+class TestFilter(TestCase):
+
+    def test_empty(self):
+        filter = TestCaseFilter("")
+        self.assertEqual(len(filter.includes), 0)
+        self.assertEqual(len(filter.excludes), 0)
+        self.assertTrue(filter.selects("I am a test"))
+
+    def test_accept_all(self):
+        filter = TestCaseFilter("*")
+        self.assertEqual(len(filter.includes), 1)
+        self.assertEqual(len(filter.excludes), 0)
+        self.assertTrue(filter.selects("I am a test"))
+
+    def test_reject_all(self):
+        filter = TestCaseFilter("~*")
+        self.assertEqual(len(filter.includes), 0)
+        self.assertEqual(len(filter.excludes), 1)
+        self.assertFalse(filter.selects("I am a test"))
+
+    def test_accept_and_reject_all(self):
+        filter = TestCaseFilter("*:~*")
+        self.assertEqual(len(filter.includes), 1)
+        self.assertEqual(len(filter.excludes), 1)
+        self.assertFalse(filter.selects("I am a test"))
+
+    def test_accept_single(self):
+        filter = TestCaseFilter("I am a test")
+        self.assertEqual(len(filter.includes), 1)
+        self.assertEqual(len(filter.excludes), 0)
+        self.assertTrue(filter.selects("I am a test"))
+
+    def test_accept_multiple(self):
+        filter = TestCaseFilter("I am a test:Test2")
+        self.assertEqual(len(filter.includes), 2)
+        self.assertEqual(len(filter.excludes), 0)
+        self.assertTrue(filter.selects("I am a test"))
+        self.assertTrue(filter.selects("Test2"))
+
+    def test_reject_multiple(self):
+        filter = TestCaseFilter("~I am a test:Test2")
+        self.assertEqual(len(filter.includes), 0)
+        self.assertEqual(len(filter.excludes), 2)
+        self.assertFalse(filter.selects("I am a test"))
+        self.assertFalse(filter.selects("Test2"))
+
+    def test_accept_glob(self):
+        filter = TestCaseFilter("*test*")
+        self.assertEqual(len(filter.includes), 1)
+        self.assertEqual(len(filter.excludes), 0)
+        self.assertTrue(filter.selects("I am a test"))
+        self.assertTrue(filter.selects("test2"))
+        self.assertFalse(filter.selects("Test2"))  # case sensitive
+
+    def test_reject_glob(self):
+        filter = TestCaseFilter("~*test*")
+        self.assertEqual(len(filter.includes), 0)
+        self.assertEqual(len(filter.excludes), 1)
+        self.assertFalse(filter.selects("I am a test"))
+        self.assertFalse(filter.selects("test2"))
+        self.assertTrue(filter.selects("Test2"))  # case sensitive
+
+    def test_complex(self):
+        filter = TestCaseFilter("GetAll*:*Submodels~GetAllSubmodels:*Post*")
+        self.assertEqual(len(filter.includes), 2)
+        self.assertEqual(len(filter.excludes), 2)
+        self.assertTrue(filter.selects("GetAllShells"))
+        self.assertFalse(filter.selects("GetAllSubmodels"))
+        self.assertFalse(filter.selects("PostSubmodels"))
+        self.assertTrue(filter.selects("PutSubmodels"))
+
+    def test_invalid(self):
+        with self.assertRaises(InvalidFilterException):
+            TestCaseFilter("a~b~c")