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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spl2-testing-framework
-Version: 1.8.6
+Version: 1.8.7
 Summary: SPL2 Testing Framework
 Home-page: https://github.com/splunk/spl2-testing-framework
 Keywords: SPL2 testing framework
@@ -135,6 +135,7 @@ Additionally, the following options are supported:
 * `--code_dir` - directory where SPL2 code modules (`.spl2`) are located. Defaults to the current working directory. Falls back to `--test_dir` if the module is not found. See [Separate code and test directories](#separate-code-and-test-directories) for details.
 * `--ignore_empty_strings` - to ignore empty strings in the results
 * `--ignore_additional_fields_in_actual` - to ignore fields present in actual results but not in expected results (useful when actual results contain extra fields that should not affect comparison)
+* `--keep_tag_fields` - by default, fields whose name starts with `tag::` (e.g. `tag::metric_name`) are stripped from **both** the actual and expected rows before the destination compare. Pass `--keep_tag_fields` to disable this behaviour and include `tag::` fields in the comparison.
 * `--create_comparison_sheet` - to create a comparison sheet in `comparison_box_test` folder using actual and expected outputs (works only when running box tests)
 * `--cli_bench` - when running tests with CLI, this option enables benchmarking mode by adding `-b` and `-n` flags to the spl2-processor-cli command. The value specifies the number of events to test (e.g., `--cli_bench=1000` will add `-b -n 1000` to the CLI command). **In bench mode, all tests always succeed and CLI output is printed to logs** - this is useful for performance testing and benchmarking. This is only applicable when using `--type cli`.
 * `--lookups_root_dir` - root directory passed to `spl2-processor-cli` as `--lookupsRootDir` for resolving lookup `transforms.conf`. Defaults to `.` (current working directory). For a standard TA layout use `--lookups_root_dir=package/default`. Only applicable when using `--type cli`.

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

@@ -102,6 +102,7 @@ Additionally, the following options are supported:
 * `--code_dir` - directory where SPL2 code modules (`.spl2`) are located. Defaults to the current working directory. Falls back to `--test_dir` if the module is not found. See [Separate code and test directories](#separate-code-and-test-directories) for details.
 * `--ignore_empty_strings` - to ignore empty strings in the results
 * `--ignore_additional_fields_in_actual` - to ignore fields present in actual results but not in expected results (useful when actual results contain extra fields that should not affect comparison)
+* `--keep_tag_fields` - by default, fields whose name starts with `tag::` (e.g. `tag::metric_name`) are stripped from **both** the actual and expected rows before the destination compare. Pass `--keep_tag_fields` to disable this behaviour and include `tag::` fields in the comparison.
 * `--create_comparison_sheet` - to create a comparison sheet in `comparison_box_test` folder using actual and expected outputs (works only when running box tests)
 * `--cli_bench` - when running tests with CLI, this option enables benchmarking mode by adding `-b` and `-n` flags to the spl2-processor-cli command. The value specifies the number of events to test (e.g., `--cli_bench=1000` will add `-b -n 1000` to the CLI command). **In bench mode, all tests always succeed and CLI output is printed to logs** - this is useful for performance testing and benchmarking. This is only applicable when using `--type cli`.
 * `--lookups_root_dir` - root directory passed to `spl2-processor-cli` as `--lookupsRootDir` for resolving lookup `transforms.conf`. Defaults to `.` (current working directory). For a standard TA layout use `--lookups_root_dir=package/default`. Only applicable when using `--type cli`.

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

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

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

@@ -52,6 +52,7 @@ SINGLE_SPL2_FILE = "single_spl2_file"
 
 IGNORE_EMPTY_STRINGS = "ignore_empty_strings"
 IGNORE_ADDITIONAL_FIELDS_IN_ACTUAL = "ignore_additional_fields_in_actual"
+KEEP_TAG_FIELDS = "keep_tag_fields"
 CREATE_COMPARISON_SHEET = "create_comparison_sheet"
 CHECK_SPLUNK_RESULTS = "check_splunk_results"
 PERFORMANCE_CHECK = "performance_check"
@@ -88,6 +89,12 @@ def pytest_addoption(parser):
     parser.addoption(f"--{CREATE_COMPARISON_SHEET}", action="store_true", default=False)
     parser.addoption(f"--{IGNORE_EMPTY_STRINGS}", action="store_true")
     parser.addoption(f"--{IGNORE_ADDITIONAL_FIELDS_IN_ACTUAL}", action="store_true")
+    parser.addoption(
+        f"--{KEEP_TAG_FIELDS}",
+        action="store_true",
+        default=False,
+        help="Do not strip tag:: fields from destination compare. By default, fields whose name starts with 'tag::' are excluded from the comparison.",
+    )
     parser.addoption(f"--{LIMIT_TESTS}", action="store", type=int, default=None)
     parser.addoption(f"--{CLI_BENCH}", action="store", type=int, default=None)
     parser.addoption(
@@ -445,3 +452,5 @@ def _set_results_options(metafunc):
         IGNORE_ADDITIONAL_FIELDS_IN_ACTUAL
     )
     Results._ignore_additional_fields_in_actual = ignore_fields_in_actual
+    keep_tag_fields = metafunc.config.getoption(KEEP_TAG_FIELDS)
+    Results._ignore_tag_fields = not keep_tag_fields

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

@@ -26,6 +26,7 @@ _WHOLE_FLOAT_STR_RE = re.compile(r"^(-?\d+)\.0+$")
 class Results(UserDict):
     _ignore_empty_strings = False
     _ignore_additional_fields_in_actual = False
+    _ignore_tag_fields = True
     """Class responsible for parsing and storing results from Splunk, IP and CLI.
     It's necessary to parse nested jsons and other python types to strings in order to compare them
     """
@@ -201,6 +202,15 @@ class Results(UserDict):
             self._remove_extra_fields(self.data, expected.data)
         return self
 
+    @staticmethod
+    def is_ignored_in_destination_compare(key: str) -> bool:
+        """Return True if ``key`` should be dropped from destination comparison regardless of
+        the per-test ``ignore_fields_in_destination_compare`` list.  Currently this covers
+        ``tag::*`` fields, which are stripped by default and only kept when
+        ``--keep_tag_fields`` is passed.
+        """
+        return Results._ignore_tag_fields and key.startswith("tag::")
+
     def __lt__(self, other):
         if "_raw" in self.data:
             s = self.data.get("_raw")

{spl2_testing_framework-1.8.6 → spl2_testing_framework-1.8.7}/spl2_testing_framework/tools/spl2test_runner.py

@@ -220,7 +220,7 @@ class SPL2TestRunner:
 
                 if self.create_comparison_sheet:
                     self.comp_obj.create_comparison_sheet(output_result, box_test)
-                if ignore_keys:
+                if ignore_keys or Results.is_ignored_in_destination_compare("tag::"):
                     stripped_actual = [
                         Results(
                             self._strip_ignored_fields_for_destination_compare(
@@ -285,9 +285,11 @@ class SPL2TestRunner:
     def _strip_ignored_fields_for_destination_compare(
         row: dict, ignore_keys: frozenset
     ) -> dict:
-        if not ignore_keys:
-            return row
-        return {k: v for k, v in row.items() if k not in ignore_keys}
+        return {
+            k: v
+            for k, v in row.items()
+            if k not in ignore_keys and not Results.is_ignored_in_destination_compare(k)
+        }
 
     def _splunk_process_event(self, box_test: BoxTest, event):
         try: