spl2-testing-framework 1.8.4__tar.gz → 1.8.6__tar.gz

{spl2_testing_framework-1.8.4 → spl2_testing_framework-1.8.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spl2-testing-framework
-Version: 1.8.4
+Version: 1.8.6
 Summary: SPL2 Testing Framework
 Home-page: https://github.com/splunk/spl2-testing-framework
 Keywords: SPL2 testing framework
@@ -142,6 +142,7 @@ Additionally, the following options are supported:
 * `--reduction_stats` - when set, **box tests** record a reduction rate per run: input `_raw` vs output `_raw` (after pairing input/output events). Rates are grouped by **pipeline** (the `.spl2` code module stem) and **sourcetype** (from the input event if set, else the output event, else `UNKNOWN`). Off by default.
 * `--reduction_stats_file` - path to a JSON file written at the **end of the pytest session** with collected rates (default `reduction_stats.json`). Only used when `--reduction_stats` is set.
 * `--reduction_stats_full` - when set together with `--reduction_stats`, each pipeline’s JSON payload also includes a pandas **`describe()`** summary (count, mean, std, min, quartiles, max) per sourcetype column. Only used when `--reduction_stats` is set.
+* `--include_placeholder_tests` - include tests whose source contains unresolved `##name##` placeholders. By default such tests are skipped with a warning.
 
 * Note: The `pytest.ini.sample` file allows you to define command parameters. Just update the configurations, rename the
 file by removing the `.sample` extension, and execute the command.

{spl2_testing_framework-1.8.4 → spl2_testing_framework-1.8.6}/README.md

@@ -109,6 +109,7 @@ Additionally, the following options are supported:
 * `--reduction_stats` - when set, **box tests** record a reduction rate per run: input `_raw` vs output `_raw` (after pairing input/output events). Rates are grouped by **pipeline** (the `.spl2` code module stem) and **sourcetype** (from the input event if set, else the output event, else `UNKNOWN`). Off by default.
 * `--reduction_stats_file` - path to a JSON file written at the **end of the pytest session** with collected rates (default `reduction_stats.json`). Only used when `--reduction_stats` is set.
 * `--reduction_stats_full` - when set together with `--reduction_stats`, each pipeline’s JSON payload also includes a pandas **`describe()`** summary (count, mean, std, min, quartiles, max) per sourcetype column. Only used when `--reduction_stats` is set.
+* `--include_placeholder_tests` - include tests whose source contains unresolved `##name##` placeholders. By default such tests are skipped with a warning.
 
 * Note: The `pytest.ini.sample` file allows you to define command parameters. Just update the configurations, rename the
 file by removing the `.sample` extension, and execute the command.

{spl2_testing_framework-1.8.4 → spl2_testing_framework-1.8.6}/pyproject.toml

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

{spl2_testing_framework-1.8.4 → spl2_testing_framework-1.8.6}/spl2_testing_framework/conftest.py

@@ -62,6 +62,7 @@ LIMIT_TESTS = "limit_tests"
 CLI_BENCH = "cli_bench"
 LOOKUPS_ROOT_DIR = "lookups_root_dir"
 REDUCTION_STATS = "reduction_stats"
+INCLUDE_PLACEHOLDER_TESTS = "include_placeholder_tests"
 
 setup_logging()
 
@@ -114,6 +115,12 @@ def pytest_addoption(parser):
         default=False,
         help="Include full dataframe stats (count, mean, std, min, 25%%, 50%%, 75%%, max) in the saved file. Used only when --reduction_stats is set.",
     )
+    parser.addoption(
+        f"--{INCLUDE_PLACEHOLDER_TESTS}",
+        action="store_true",
+        default=False,
+        help="Include tests whose source contains unresolved ##name## placeholders. By default such tests are skipped with a warning.",
+    )
 
 
 def pytest_generate_tests(metafunc):
@@ -123,12 +130,17 @@ def pytest_generate_tests(metafunc):
     code_dir = metafunc.config.getoption(CODE_DIR)
     performance_check = metafunc.config.getoption(PERFORMANCE_CHECK)
     limit_tests = metafunc.config.getoption(LIMIT_TESTS)
+    include_placeholder_tests = metafunc.config.getoption(INCLUDE_PLACEHOLDER_TESTS)
     _set_results_options(metafunc)
 
     if BOX_TEST in metafunc.fixturenames:
         _LOGGER.info("Collecting Box Tests")
         module_tests = BoxTestDiscovery(
-            test_dir, performance_check, limit_tests, code_dir=code_dir
+            test_dir,
+            performance_check,
+            limit_tests,
+            code_dir=code_dir,
+            include_placeholder_tests=include_placeholder_tests,
         )
         module_tests.discover_tests()
         metafunc.parametrize(

{spl2_testing_framework-1.8.4 → spl2_testing_framework-1.8.6}/spl2_testing_framework/tools/results.py

@@ -15,10 +15,13 @@
 
 import ast
 import json
+import re
 from collections import UserDict
 from datetime import datetime, timezone
 from typing import Any
 
+_WHOLE_FLOAT_STR_RE = re.compile(r"^(-?\d+)\.0+$")
+
 
 class Results(UserDict):
     _ignore_empty_strings = False
@@ -76,10 +79,20 @@ class Results(UserDict):
         if isinstance(data, bool):
             data = str(data).lower()
         elif isinstance(data, (int, float)):
-            data = str(data)
+            data = (
+                str(int(data))
+                if isinstance(data, float) and data == int(data)
+                else str(data)
+            )
 
-        if isinstance(data, str) and data in ("True", "False"):
-            data = data.lower()
+        if isinstance(data, str):
+            if data in ("True", "False"):
+                data = data.lower()
+            # Normalize "7.0", "7.00", "7.00000" → "7" for whole-number float strings returned by Splunk.
+            else:
+                m = _WHOLE_FLOAT_STR_RE.match(data)
+                if m:
+                    data = m.group(1)
 
         return data
 

{spl2_testing_framework-1.8.4 → spl2_testing_framework-1.8.6}/spl2_testing_framework/tools/test_discovery.py

@@ -50,11 +50,13 @@ class TestDiscovery(abc.ABC):
         performance_check: str,
         limit_tests: Optional[int] = None,
         code_dir: Optional[str] = None,
+        include_placeholder_tests: bool = False,
     ):
         self.path = pathlib.Path(path)
         self.code_dir = pathlib.Path(code_dir) if code_dir else self.path
         self._performance_check = performance_check
         self.limit_tests = limit_tests
+        self.include_placeholder_tests = include_placeholder_tests
         self.tests = TestSuite()
 
     @property
@@ -181,6 +183,7 @@ class BoxTestDiscovery(TestDiscovery):
 
     _IGNORE_FIELDS_IN_DESTINATION_COMPARE_KEY = "ignore_fields_in_destination_compare"
     _VALID_SKIP_ON_VALUES = frozenset({"standard", "splunk_ta", "splunk_cim"})
+    _PLACEHOLDER_PATTERN = re.compile(r"##\w+##")
 
     @classmethod
     def _parse_skip_on(cls, test_block: dict) -> frozenset:
@@ -268,6 +271,18 @@ class BoxTestDiscovery(TestDiscovery):
                 test_block = entry["test"]
                 name = entry["filename"].replace(".spl2", "")
                 test_input = test_block["source"]
+                if (
+                    isinstance(test_input, str)
+                    and self._PLACEHOLDER_PATTERN.search(test_input)
+                    and not self.include_placeholder_tests
+                ):
+                    _LOGGER.warning(
+                        "Skipping test '%s' in '%s': source contains unresolved placeholder(s) (##name##). "
+                        "Use --include_placeholder_tests to force-include these tests.",
+                        name,
+                        module_path,
+                    )
+                    continue
                 code_module_path = self._resolve_code_module(entry["filename"])
                 output = [
                     Results(x)