Merge branch 'main' into develop

Author: harshilgajera-crest

NOTICE

@@ -7,9 +7,9 @@
 
 The following 3rd-party software packages may be used by or distributed with pytest-splunk-addon. Any information relevant to third-party vendors listed below are collected using common, reasonable means.
 
-Date generated: 2024-7-24
+Date generated: 2024-8-7
 
-Revision ID: b2f6dc5b09c05a3eef5f7973cbf38c55ca498db3
+Revision ID: ec9101152540485a3cc7b35fbea07c1ea7a5e06d
 
 ================================================================================
 ================================================================================
@@ -3005,7 +3005,7 @@ PERFORMANCE OF THIS SOFTWARE.
 
 
 --------------------------------------------------------------------------------
-Package Title: urllib3 (1.26.18)
+Package Title: urllib3 (1.26.19)
 --------------------------------------------------------------------------------
 
 * Declared Licenses *
@@ -6010,10 +6010,10 @@ Copyright (c) JS Foundation and other contributors
 
 Copyright (c) 2008-2020 Andrey Petrov and contributors (see CONTRIBUTORS.txt)
 
-Copyright (c) 2012 Senko Rasic <[email protected]>
-
 Copyright (c) 2015-2016 Will Bond <[email protected]>
 
+Copyright (c) 2012 Senko Rasic <[email protected]>
+
 Copyright (c) 2019 TAHRI Ahmed R.
 
 Copyright (c)  Ahmed TAHRI @Ousret](https://github.com/Ousret).<br
@@ -6327,4 +6327,4 @@ Public Domain
 --------------------------------------------------------------------------------
 --------------------------------------------------------------------------------
 
-Report Generated by FOSSA on 2024-7-24
+Report Generated by FOSSA on 2024-8-7

poetry.lock

@@ -16,7 +16,7 @@
 
 [tool.poetry]
 name = "pytest-splunk-addon"
-version = "5.3.0-beta.10"
+version = "5.3.0"
 description = "A Dynamic test tool for Splunk Apps and Add-ons"
 authors = ["Splunk <[email protected]>"]
 license = "APACHE-2.0"

pyproject.toml

@@ -18,4 +18,4 @@
 
 __author__ = """Splunk Inc."""
 __email__ = "[email protected]"
-__version__ = "5.3.0-beta.10"
+__version__ = "5.3.0"

pytest_splunk_addon/__init__.py

@@ -639,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
 
 
@@ -835,6 +836,16 @@ def update_recommended_fields(model, datasets, cim_version):
     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."""
@@ -1006,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"):