chore(release): making a new release (#874)

Contains below feature PRs:

- #864
- #862
- #845
- #850
- #875
- #877

Author: artemrys

.licenserc.yaml

@@ -30,8 +30,8 @@ header:
     - "docs/**"
     - "tests/**"
     - ".*"
-    - "pytest_splunk_addon/standard_lib/**/*.json"
-    - "pytest_splunk_addon/standard_lib/**/*.xsd"
+    - "pytest_splunk_addon/**/*.json"
+    - "pytest_splunk_addon/**/*.xsd"
     - "MANIFEST.in"
     - "entrypoint.sh"
     - "renovate.json"

docs/api_reference/addon_parser.md

@@ -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"]

docs/api_reference/api_reference.md

@@ -28,6 +28,7 @@
 
 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 @@ def _get_props_method(self, class_name: str):
                 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]:
         """

docs/api_reference/app_test_generator.md

@@ -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"

docs/api_reference/cim_tests.md

@@ -934,6 +934,8 @@ def replace(self, sample, token_count):
                         url = self.fake.url()
 
                     if bool(set(["full", "path"]).intersection(value_list)):
+                        if value_list == ["path"]:
+                            url = ""
                         url = (
                             url
                             + "/"
@@ -944,8 +946,9 @@ def replace(self, sample, token_count):
                                 ]
                             )
                         )
-
                     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:

docs/api_reference/event_ingestion.md

@@ -20,6 +20,8 @@
 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 @@ def __init__(self, addon_path, config_path=None, process_count=4):
         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)

docs/api_reference/fields_tests.md

@@ -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>