pytest-splunk-addon 5.2.6__tar.gz → 5.3.0__tar.gz

{pytest_splunk_addon-5.2.6 → pytest_splunk_addon-5.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pytest-splunk-addon
-Version: 5.2.6
+Version: 5.3.0
 Summary: A Dynamic test tool for Splunk Apps and Add-ons
 License: Apache-2.0
 Author: Splunk

{pytest_splunk_addon-5.2.6 → pytest_splunk_addon-5.3.0}/pyproject.toml

@@ -16,7 +16,7 @@
 
 [tool.poetry]
 name = "pytest-splunk-addon"
-version = "5.2.6"
+version = "5.3.0"
 description = "A Dynamic test tool for Splunk Apps and Add-ons"
 authors = ["Splunk <addonfactory@splunk.com>"]
 license = "APACHE-2.0"
@@ -59,9 +59,9 @@ pytz = "^2024.1"
 pytest11 = { plugin = "pytest_splunk_addon.plugin", "splunk" = "pytest_splunk_addon.splunk" }
 
 [tool.poetry.scripts]
-cim-report = 'pytest_splunk_addon.standard_lib.utilities.junit_parser:main'
+cim-report = 'pytest_splunk_addon.utilities.junit_parser:main'
 cim-field-report = 'pytest_splunk_addon.tools.cim_field_report:main'
-sample_splitter = 'pytest_splunk_addon.standard_lib.utilities.sample_splitter:main'
+sample_splitter = 'pytest_splunk_addon.utilities.sample_splitter:main'
 
 [build-system]
 requires = ["poetry>=1.0.2"]

{pytest_splunk_addon-5.2.6 → pytest_splunk_addon-5.3.0}/pytest_splunk_addon/__init__.py

@@ -18,4 +18,4 @@
 
 __author__ = """Splunk Inc."""
 __email__ = "addonfactory@splunk.com"
-__version__ = "5.2.6"
+__version__ = "5.3.0"

{pytest_splunk_addon-5.2.6/pytest_splunk_addon/standard_lib → pytest_splunk_addon-5.3.0/pytest_splunk_addon}/addon_parser/props_parser.py

@@ -28,6 +28,7 @@ import addonfactory_splunk_conf_parser_lib as conf_parser
 
 from .fields import convert_to_fields
 from .transforms_parser import TransformsParser
+from pytest_splunk_addon import utils
 
 LOGGER = logging.getLogger("pytest-splunk-addon")
 
@@ -110,7 +111,8 @@ class PropsParser(object):
                 LOGGER.info(f"Matched method of type={each_type}")
                 return method_mapping[each_type]
         else:
-            LOGGER.warning(f"No parser available for {class_name}. Skipping...")
+            if utils.check_first_worker():
+                LOGGER.warning(f"No parser available for {class_name}. Skipping...")
 
     def _get_props_stanzas(self) -> Optional[Generator]:
         """

{pytest_splunk_addon-5.2.6 → pytest_splunk_addon-5.3.0}/pytest_splunk_addon/plugin.py

@@ -15,10 +15,11 @@
 #
 import logging
 import pytest
-from .standard_lib.sample_generation.sample_xdist_generator import SampleXdistGenerator
+
+from .app_test_generator import AppTestGenerator
+from .sample_generation.sample_xdist_generator import SampleXdistGenerator
 import traceback
-from .standard_lib import AppTestGenerator
-from .standard_lib.cim_compliance import CIMReportPlugin
+from .cim_compliance import CIMReportPlugin
 from filelock import FileLock
 
 LOG_FILE = "pytest_splunk_addon.log"

{pytest_splunk_addon-5.2.6/pytest_splunk_addon/standard_lib → pytest_splunk_addon-5.3.0/pytest_splunk_addon}/sample_generation/rule.py

@@ -934,6 +934,8 @@ class UrlRule(Rule):
                         url = self.fake.url()
 
                     if bool(set(["full", "path"]).intersection(value_list)):
+                        if value_list == ["path"]:
+                            url = ""
                         url = (
                             url
                             + "/"
@@ -944,8 +946,9 @@ class UrlRule(Rule):
                                 ]
                             )
                         )
-
                     if bool(set(["full", "query"]).intersection(value_list)):
+                        if value_list == ["query"]:
+                            url = ""
                         url = url + self.generate_url_query_params()
                     yield self.token_value(*([str(url)] * 2))
         else:

{pytest_splunk_addon-5.2.6/pytest_splunk_addon/standard_lib → pytest_splunk_addon-5.3.0/pytest_splunk_addon}/sample_generation/sample_xdist_generator.py

@@ -20,6 +20,8 @@ from filelock import FileLock
 import json
 import pytest
 
+from pytest_splunk_addon import utils
+
 
 class SampleXdistGenerator:
     def __init__(self, addon_path, config_path=None, process_count=4):
@@ -28,14 +30,10 @@ class SampleXdistGenerator:
         self.config_path = config_path
 
     def get_samples(self, store_events):
-
         if self.tokenized_event_source == "pregenerated":
             with open(self.event_path, "rb") as file_obj:
                 store_sample = pickle.load(file_obj)
-                if store_events and (
-                    "PYTEST_XDIST_WORKER" not in os.environ
-                    or os.environ.get("PYTEST_XDIST_WORKER") == "gw0"
-                ):
+                if store_events and utils.check_first_worker():
                     try:
                         tokenized_events = store_sample.get("tokenized_events")
                         self.store_events(tokenized_events)

{pytest_splunk_addon-5.2.6/pytest_splunk_addon/standard_lib → pytest_splunk_addon-5.3.0/pytest_splunk_addon}/sample_generation/schema.xsd

@@ -83,6 +83,7 @@
                   </xs:sequence>
                 </xs:complexType>
               </xs:element>
+              <xs:element type="xs:string" name="note" minOccurs="0" />
               <xs:element type="xs:string" name="raw"/>
               <xs:element name="cim">
                 <xs:complexType>
@@ -103,6 +104,7 @@
                                 <xs:extension base="xs:string">
                                   <xs:attribute type="xs:string" name="name" use="optional"/>
                                   <xs:attribute type="xs:string" name="value" use="optional"/>
+                                  <xs:attribute type="xs:string" name="note" use="optional"/>
                                 </xs:extension>
                               </xs:simpleContent>
                             </xs:complexType>

{pytest_splunk_addon-5.2.6 → pytest_splunk_addon-5.3.0}/pytest_splunk_addon/splunk.py

@@ -26,12 +26,14 @@ import splunklib.client as client
 from splunksplwrapper.manager.jobs import Jobs
 from splunksplwrapper.splunk.cloud import CloudSplunk
 from splunksplwrapper.SearchUtil import SearchUtil
-from .standard_lib.event_ingestors import IngestorHelper
+from .event_ingestors import IngestorHelper
 from .docker_class import Services
-from .standard_lib.CIM_Models.datamodel_definition import datamodels
+from .CIM_Models.datamodel_definition import datamodels
 import configparser
 from filelock import FileLock
 
+from pytest_splunk_addon import utils
+
 RESPONSIVE_SPLUNK_TIMEOUT = 300  # seconds
 
 LOGGER = logging.getLogger("pytest-splunk-addon")
@@ -637,6 +639,7 @@ def splunk_external(request):
             "Could not connect to Splunk HEC"
             "Please check the log file for possible errors."
         )
+    is_valid_hec(request, splunk_info)
     return splunk_info
 
 
@@ -732,10 +735,7 @@ def splunk_ingest_data(request, splunk_hec_uri, sc4s, uf, splunk_events_cleanup)
     if request.config.getoption("ingest_events").lower() in ["n", "no", "false", "f"]:
         return
     global PYTEST_XDIST_TESTRUNUID
-    if (
-        "PYTEST_XDIST_WORKER" not in os.environ
-        or os.environ.get("PYTEST_XDIST_WORKER") == "gw0"
-    ):
+    if utils.check_first_worker():
         addon_path = request.config.getoption("splunk_app")
         config_path = request.config.getoption("splunk_data_generator")
         ingest_meta_data = {
@@ -783,10 +783,7 @@ def splunk_events_cleanup(request, splunk_search_util):
 
     """
     if request.config.getoption("splunk_cleanup"):
-        if (
-            "PYTEST_XDIST_WORKER" not in os.environ
-            or os.environ.get("PYTEST_XDIST_WORKER") == "gw0"
-        ):
+        if utils.check_first_worker():
             LOGGER.info("Running the old events cleanup")
             splunk_search_util.deleteEventsFromIndex()
     else:
@@ -801,10 +798,7 @@ def file_system_prerequisite():
     """
     UF_FILE_MONTOR_DIR = "uf_files"
     monitor_dir = os.path.join(os.getcwd(), UF_FILE_MONTOR_DIR)
-    if (
-        "PYTEST_XDIST_WORKER" not in os.environ
-        or os.environ.get("PYTEST_XDIST_WORKER") == "gw0"
-    ):
+    if utils.check_first_worker():
         if os.path.exists(monitor_dir):
             shutil.rmtree(monitor_dir, ignore_errors=True)
         os.mkdir(monitor_dir)
@@ -842,6 +836,16 @@ def splunk_dm_recommended_fields():
     return update_recommended_fields
 
 
+@pytest.hookimpl(hookwrapper=True)
+def pytest_runtest_makereport(item):
+    """
+    Show user properties in report only in case of failure
+    """
+    output = yield
+    if output.get_result().outcome == "passed":
+        item.user_properties = []
+
+
 @pytest.fixture(scope="session")
 def docker_ip():
     """Determine IP address for TCP connections to Docker containers."""
@@ -1013,6 +1017,36 @@ def is_responsive(url):
         return False
 
 
+def is_valid_hec(request, splunk):
+    """
+    Verify if provided hec token is valid by sending simple post request.
+
+    Args:
+        splunk (dict): details of the Splunk instance
+
+    Returns:
+        None
+    """
+
+    LOGGER.info(
+        "Validating HEC token...  splunk=%s",
+        json.dumps(splunk),
+    )
+    response = requests.post(
+        url=f'{request.config.getoption("splunk_hec_scheme")}://{splunk["forwarder_host"]}:{splunk["port_hec"]}/services/collector/raw',
+        headers={
+            "Authorization": f'Splunk {request.config.getoption("splunk_hec_token")}'
+        },
+        data={"event": "test_hec", "sourcetype": "hec_token_test"},
+        verify=False,
+    )
+    LOGGER.debug("Status code: {}".format(response.status_code))
+    if response.status_code == 200:
+        LOGGER.info("Splunk HEC is valid.")
+    else:
+        pytest.exit("Exiting pytest due to invalid HEC token value.")
+
+
 def pytest_unconfigure(config):
     if PYTEST_XDIST_TESTRUNUID:
         if os.path.exists(PYTEST_XDIST_TESTRUNUID + "_wait"):

{pytest_splunk_addon-5.2.6 → pytest_splunk_addon-5.3.0}/pytest_splunk_addon/standard_lib/addon_basic.py

@@ -19,10 +19,10 @@ Base class for test cases. Provides test cases to verify
 field extractions and CIM compatibility.
 """
 
-from .fields_tests import FieldTestTemplates
-from .cim_tests import CIMTestTemplates
-from .index_tests import IndexTimeTestTemplate
-from .utilities.log_helper import get_table_output
+from ..fields_tests import FieldTestTemplates
+from ..cim_tests import CIMTestTemplates
+from ..index_tests import IndexTimeTestTemplate
+from ..utilities.log_helper import get_table_output
 import pytest
 
 

{pytest_splunk_addon-5.2.6 → pytest_splunk_addon-5.3.0}/pytest_splunk_addon/tools/cim_field_report.py

@@ -25,7 +25,7 @@ sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", ".."))
 
 from splunksplwrapper.manager.jobs import Jobs
 from splunksplwrapper.splunk.cloud import CloudSplunk
-from pytest_splunk_addon.standard_lib.addon_parser import AddonParser
+from pytest_splunk_addon.addon_parser import AddonParser
 
 from splunklib import binding
 

pytest_splunk_addon-5.3.0/pytest_splunk_addon/utils.py

@@ -0,0 +1,26 @@
+#
+# Copyright 2024 Splunk Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+import os
+
+
+def check_first_worker() -> bool:
+    """
+    returns True if the current execution is under gw0 (first worker)
+    """
+    return (
+        "PYTEST_XDIST_WORKER" not in os.environ
+        or os.environ.get("PYTEST_XDIST_WORKER") == "gw0"
+    )

pytest_splunk_addon-5.2.6/pytest_splunk_addon/standard_lib/__init__.py

@@ -1,37 +0,0 @@
-#
-# Copyright 2024 Splunk Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-# -*- coding: utf-8 -*-
-"""
-There are 3 types of tests included:
-
-1. Knowledge objects test cases
-2. CIM Compatibility test cases
-3. Index Time test cases
-
-
-The test generation mechanism is divided into 3 types of class
-
-1. Tests: Test templates
-2. TestGenerator: Generates the test cases using pytest.params
-3. SampleGenerator: Generates the data for which the test cases will be executed.
-4. EventIngestor: Ingests the generated data to Splunk.
-5. Other utility classes like Add-on parser & Data model handlers.
-
-"""
-
-from .app_test_generator import AppTestGenerator
-from .addon_basic import Basic
-from .utilities import escape_char_event