spl2-testing-framework 1.2.2__tar.gz → 1.3.0__tar.gz

{spl2_testing_framework-1.2.2 → spl2_testing_framework-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spl2-testing-framework
-Version: 1.2.2
+Version: 1.3.0
 Summary: SPL2 Testing Framework
 Home-page: https://github.com/splunk/spl2-testing-framework
 Keywords: SPL2 testing framework
@@ -180,6 +180,8 @@ It is possible to pass more options to the command, which works also with pytest
   the samples in module.json file of the corresponding template file
 * `--sample_delimiter` - Separator for separating the samples provided in the sample file. If not provided, it will use
   newline as a default separator.
+* `--limit_tests` - Limit number of tests to execute from the unit, sample file or module.json. If not provided, all will be executed.
+  This can be used for quick testing of spl2 files during development.
 
 * ... and much more, whatever is supported by pytest
 

{spl2_testing_framework-1.2.2 → spl2_testing_framework-1.3.0}/README.md

@@ -148,6 +148,8 @@ It is possible to pass more options to the command, which works also with pytest
   the samples in module.json file of the corresponding template file
 * `--sample_delimiter` - Separator for separating the samples provided in the sample file. If not provided, it will use
   newline as a default separator.
+* `--limit_tests` - Limit number of tests to execute from the unit, sample file or module.json. If not provided, all will be executed.
+  This can be used for quick testing of spl2 files during development.
 
 * ... and much more, whatever is supported by pytest
 

{spl2_testing_framework-1.2.2 → spl2_testing_framework-1.3.0}/pyproject.toml

@@ -16,7 +16,7 @@
 
 [tool.poetry]
 name = "spl2-testing-framework"
-version = "1.2.2"
+version = "1.3.0"
 description = "SPL2 Testing Framework"
 authors = ["mgazda-splunk <mgazda@splunk.com>"]
 readme = "README.md"

{spl2_testing_framework-1.2.2 → spl2_testing_framework-1.3.0}/spl2_testing_framework/conftest.py

@@ -51,6 +51,7 @@ CREATE_COMPARISON_SHEET = "create_comparison_sheet"
 PERFORMANCE_CHECK = "performance_check"
 TEST_TYPE = "type"
 TEST_DIR = "test_dir"
+LIMIT_TESTS = "limit_tests"
 
 import logging
 
@@ -62,7 +63,7 @@ _LOGGER = logging.getLogger(__name__)
 
 
 def pytest_addoption(parser):
-    parser.addoption(f"--{TEST_TYPE}", action="store", default="local")
+    parser.addoption(f"--{TEST_TYPE}", action="store", default="cli")
     parser.addoption(f"--{TEST_DIR}", action="store", default=".")
     parser.addoption(
         f"--{PERFORMANCE_CHECK}",
@@ -75,6 +76,7 @@ def pytest_addoption(parser):
     parser.addoption("--sample_delimiter", action="store", default="\n")
     parser.addoption(f"--{CREATE_COMPARISON_SHEET}", action="store_true", default=False)
     parser.addoption(f"--{IGNORE_EMPTY_STRINGS}", action="store_true")
+    parser.addoption(f"--{LIMIT_TESTS}", action="store", type=int, default=None)
 
 
 def pytest_generate_tests(metafunc):
@@ -82,11 +84,12 @@ def pytest_generate_tests(metafunc):
     --test_dir option"""
     test_dir = metafunc.config.getoption(TEST_DIR)
     performance_check = metafunc.config.getoption(PERFORMANCE_CHECK)
+    limit_tests = metafunc.config.getoption(LIMIT_TESTS)
     _set_results_options(metafunc)
 
     if BOX_TEST in metafunc.fixturenames:
         _LOGGER.info("Collecting Box Tests")
-        module_tests = BoxTestDiscovery(test_dir, performance_check)
+        module_tests = BoxTestDiscovery(test_dir, performance_check, limit_tests)
         module_tests.discover_tests()
         metafunc.parametrize(
             "%s" % BOX_TEST, module_tests.tests, ids=module_tests.tests.get_ids()
@@ -105,6 +108,7 @@ def pytest_generate_tests(metafunc):
             sample_file,
             sample_delimiter,
             performance_check=performance_check,
+            limit_tests=limit_tests,
         )
         try:
             spl2_pipelines.discover_tests()
@@ -118,7 +122,7 @@ def pytest_generate_tests(metafunc):
 
     if UNIT_TEST in metafunc.fixturenames:
         _LOGGER.info("Collecting Unit Tests")
-        unit_tests = UTDiscovery(test_dir)
+        unit_tests = UTDiscovery(test_dir, limit_tests)
         unit_tests.discover_tests()
         metafunc.parametrize(
             UNIT_TEST, unit_tests.tests, ids=unit_tests.tests.get_ids()

{spl2_testing_framework-1.2.2 → spl2_testing_framework-1.3.0}/spl2_testing_framework/tools/test_discovery.py

@@ -41,9 +41,10 @@ class SamplesNotFoundException(Exception):
 class TestDiscovery(abc.ABC):
     """Base class for test discovery classes"""
 
-    def __init__(self, path: str, performance_check: str):
+    def __init__(self, path: str, performance_check: str, limit_tests: int = None):
         self.path = pathlib.Path(path)
         self._performance_check = performance_check
+        self.limit_tests = limit_tests
         self.tests = TestSuite()
 
     def _read_tests(self, test_name: str) -> None:
@@ -56,8 +57,8 @@ class TestDiscovery(abc.ABC):
 class BoxTestDiscovery(TestDiscovery):
     """Discovers tests for box tests, looking into module.test.json files"""
 
-    def __init__(self, path: str, performance_check: str):
-        super().__init__(path, performance_check)
+    def __init__(self, path: str, performance_check: str, limit_tests: int = None):
+        super().__init__(path, performance_check, limit_tests)
 
     def discover_tests(self) -> None:
         self._read_tests("module.test.json")
@@ -70,7 +71,13 @@ class BoxTestDiscovery(TestDiscovery):
 
         for module_path, content in self._parsed_modules.items():
             path = module_path.parent
+            tests_added = 0
             for test in content:
+                if self.limit_tests is not None and tests_added >= self.limit_tests:
+                    _LOGGER.info(
+                        f"Limit of {self.limit_tests} tests reached for {module_path}. Stopping."
+                    )
+                    break
                 name = test["filename"].replace(".spl2", "")
                 test_input = test["test"]["source"]
                 code_module_path = path / test["filename"]
@@ -92,6 +99,7 @@ class BoxTestDiscovery(TestDiscovery):
                 )
                 test.meta["performance"] = self._performance_check
                 self.tests.add(test)
+                tests_added += 1
 
 
 class SingleSPL2Discovery(TestDiscovery):
@@ -104,8 +112,9 @@ class SingleSPL2Discovery(TestDiscovery):
         sample_file=None,
         sample_delimiter="\n",
         performance_check="no",
+        limit_tests: int = None,
     ):
-        super().__init__(path, performance_check)
+        super().__init__(path, performance_check, limit_tests)
         self.template_file = template_file
         self.sample_file = sample_file
         self.sample_delimiter = sample_delimiter
@@ -188,8 +197,8 @@ class SingleSPL2Discovery(TestDiscovery):
 class UTDiscovery(TestDiscovery):
     """Discovers tests for unit tests, looking into .test.spl2 files"""
 
-    def __init__(self, path: str):
-        super().__init__(path, performance_check="no")
+    def __init__(self, path: str, limit_tests: int = None):
+        super().__init__(path, performance_check="no", limit_tests=limit_tests)
 
     def discover_tests(self) -> None:
         self._read_tests("*.test.spl2")
@@ -208,7 +217,13 @@ class UTDiscovery(TestDiscovery):
             code_module_name = file_name.replace(".test.", ".")
             code_module_path = path.parent / code_module_name
 
+            tests_added = 0
             for test in tests:
+                if self.limit_tests is not None and tests_added >= self.limit_tests:
+                    _LOGGER.info(
+                        f"Limit of {self.limit_tests} tests reached for {file}. Stopping."
+                    )
+                    break
                 self.tests.add(
                     UnitTest(
                         name=test,
@@ -218,3 +233,4 @@ class UTDiscovery(TestDiscovery):
                         code_module_path=code_module_path,
                     )
                 )
+                tests_added += 1