refactor: remove standard_lib nested folder (#850)

Moved modules from standard_lib folder to its parent folder
Kept addon_basic.py in standard_lib folder for backward compatibility.

.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

@@ -1,41 +1,41 @@
 # AddonParser
 
-::: pytest_splunk_addon.standard_lib.addon_parser
+::: pytest_splunk_addon.addon_parser
     handler: python
 
 
 ## PropsParser
 
-::: pytest_splunk_addon.standard_lib.addon_parser.props_parser
+::: pytest_splunk_addon.addon_parser.props_parser
     handler: python
 
 
 ## EventtypeParser
 
-::: pytest_splunk_addon.standard_lib.addon_parser.eventtype_parser
+::: pytest_splunk_addon.addon_parser.eventtype_parser
     handler: python
 
 
 ## Field
 
-::: pytest_splunk_addon.standard_lib.addon_parser.fields
+::: pytest_splunk_addon.addon_parser.fields
     handler: python
 
 
 ## TagsParser
 
-::: pytest_splunk_addon.standard_lib.addon_parser.tags_parser
+::: pytest_splunk_addon.addon_parser.tags_parser
     handler: python
 
 
 ## TransformsParser
 
-::: pytest_splunk_addon.standard_lib.addon_parser.transforms_parser
+::: pytest_splunk_addon.addon_parser.transforms_parser
     handler: python
 
 
 ## SavedsearchesParser
 
-::: pytest_splunk_addon.standard_lib.addon_parser.savedsearches_parser
+::: pytest_splunk_addon.addon_parser.savedsearches_parser
     handler: python
 

docs/api_reference/api_reference.md

@@ -1,6 +1,6 @@
 # API Documentation
 
-::: pytest_splunk_addon.standard_lib
+::: pytest_splunk_addon
     handler: python
 
 

docs/api_reference/app_test_generator.md

@@ -1,4 +1,4 @@
 # AppTestGenerator
 
-::: pytest_splunk_addon.standard_lib.app_test_generator
+::: pytest_splunk_addon.app_test_generator
     handler: python

docs/api_reference/cim_tests.md

@@ -1,57 +1,57 @@
 # CimTests
 
-::: pytest_splunk_addon.standard_lib.cim_tests
+::: pytest_splunk_addon.cim_tests
     handler: python
 
 ## TestTemplates
 
-::: pytest_splunk_addon.standard_lib.cim_tests.test_templates
+::: pytest_splunk_addon.cim_tests.test_templates
     handler: python
 
 
 ## TestGenerator
 
-::: pytest_splunk_addon.standard_lib.cim_tests.test_generator
+::: pytest_splunk_addon.cim_tests.test_generator
     handler: python
 
 
 ## DataModelHandler
 
-::: pytest_splunk_addon.standard_lib.cim_tests.data_model_handler
+::: pytest_splunk_addon.cim_tests.data_model_handler
     handler: python
 
 
 ## DataModel
 
-::: pytest_splunk_addon.standard_lib.cim_tests.data_model
+::: pytest_splunk_addon.cim_tests.data_model
     handler: python
 
 
 ## DataSet
 
-::: pytest_splunk_addon.standard_lib.cim_tests.data_set
+::: pytest_splunk_addon.cim_tests.data_set
     handler: python
 
 
 ## FieldTestAdapter
 
-::: pytest_splunk_addon.standard_lib.cim_tests.field_test_adapter
+::: pytest_splunk_addon.cim_tests.field_test_adapter
     handler: python
 
 
 ## FieldTestHelper
 
-::: pytest_splunk_addon.standard_lib.cim_tests.field_test_helper
+::: pytest_splunk_addon.cim_tests.field_test_helper
     handler: python
 
 
 ## JsonSchema
 
-::: pytest_splunk_addon.standard_lib.cim_tests.json_schema
+::: pytest_splunk_addon.cim_tests.json_schema
     handler: python
 
 
 ## BaseSchema
 
-::: pytest_splunk_addon.standard_lib.cim_tests.base_schema
+::: pytest_splunk_addon.cim_tests.base_schema
     handler: python

docs/api_reference/event_ingestion.md

@@ -2,25 +2,25 @@
 
 ## HEC Event Ingestor
 
-::: pytest_splunk_addon.standard_lib.event_ingestors.hec_event_ingestor
+::: pytest_splunk_addon.event_ingestors.hec_event_ingestor
     handler: python
 
 
 ## HEC Raw Ingestor
 
-::: pytest_splunk_addon.standard_lib.event_ingestors.hec_raw_ingestor
+::: pytest_splunk_addon.event_ingestors.hec_raw_ingestor
     handler: python
 
 
 ## SC4S Event Ingestor
 
-::: pytest_splunk_addon.standard_lib.event_ingestors.sc4s_event_ingestor
+::: pytest_splunk_addon.event_ingestors.sc4s_event_ingestor
     handler: python
 
 
 ## File Monitor Ingestor
 
-::: pytest_splunk_addon.standard_lib.event_ingestors.file_monitor_ingestor
+::: pytest_splunk_addon.event_ingestors.file_monitor_ingestor
     handler: python
 
 

docs/api_reference/fields_tests.md

@@ -1,23 +1,23 @@
 # FieldsTests
 
-::: pytest_splunk_addon.standard_lib.fields_tests
+::: pytest_splunk_addon.fields_tests
     handler: python
 
 
 ## TestTemplates
 
-::: pytest_splunk_addon.standard_lib.fields_tests.test_templates
+::: pytest_splunk_addon.fields_tests.test_templates
     handler: python
 
 
 ## TestGenerator
 
-::: pytest_splunk_addon.standard_lib.fields_tests.test_generator
+::: pytest_splunk_addon.fields_tests.test_generator
     handler: python
 
 
 ## FieldBank
 
-::: pytest_splunk_addon.standard_lib.fields_tests.field_bank
+::: pytest_splunk_addon.fields_tests.field_bank
     handler: python
 

docs/api_reference/index_time_tests.md

@@ -1,17 +1,17 @@
 # IndexTimeTests
 
-::: pytest_splunk_addon.standard_lib.index_tests
+::: pytest_splunk_addon.index_tests
     handler: python
 
 
 ## TestTemplates
 
-::: pytest_splunk_addon.standard_lib.index_tests.test_templates
+::: pytest_splunk_addon.index_tests.test_templates
     handler: python
 
 
 ## TestGenerator
 
-::: pytest_splunk_addon.standard_lib.index_tests.test_generator
+::: pytest_splunk_addon.index_tests.test_generator
     handler: python
 

docs/api_reference/sample_generation.md

@@ -2,22 +2,22 @@
 
 ## PytestSplunkAddonDataParser
 
-::: pytest_splunk_addon.standard_lib.sample_generation.pytest_splunk_addon_data_parser
+::: pytest_splunk_addon.sample_generation.pytest_splunk_addon_data_parser
     handler: python
 
 ## SampleStanza
 
-::: pytest_splunk_addon.standard_lib.sample_generation.sample_stanza
+::: pytest_splunk_addon.sample_generation.sample_stanza
     handler: python
 
 
 ## SampleEvent
 
-::: pytest_splunk_addon.standard_lib.sample_generation.sample_event
+::: pytest_splunk_addon.sample_generation.sample_event
     handler: python
 
 
 ## Rule
 
-::: pytest_splunk_addon.standard_lib.sample_generation.rule
+::: pytest_splunk_addon.sample_generation.rule
     handler: python

pyproject.toml

@@ -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/standard_lib/addon_parser/props_parser.py → pytest_splunk_addon/addon_parser/props_parser.py

@@ -28,7 +28,7 @@
 
 from .fields import convert_to_fields
 from .transforms_parser import TransformsParser
-from pytest_splunk_addon.standard_lib import utils
+from pytest_splunk_addon import utils
 
 LOGGER = logging.getLogger("pytest-splunk-addon")
 

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/standard_lib/sample_generation/sample_xdist_generator.py → pytest_splunk_addon/sample_generation/sample_xdist_generator.py

@@ -20,7 +20,7 @@
 import json
 import pytest
 
-from pytest_splunk_addon.standard_lib import utils
+from pytest_splunk_addon import utils
 
 
 class SampleXdistGenerator:

pytest_splunk_addon/splunk.py

@@ -26,13 +26,13 @@
 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.standard_lib import utils
+from pytest_splunk_addon import utils
 
 RESPONSIVE_SPLUNK_TIMEOUT = 300  # seconds
 

pytest_splunk_addon/standard_lib/addon_basic.py

@@ -19,10 +19,10 @@
 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/tools/cim_field_report.py

@@ -25,7 +25,7 @@
 
 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
 

tests/e2e/test_cim_report.py

@@ -1,7 +1,7 @@
 import pytest
 import os
 
-from pytest_splunk_addon.standard_lib.cim_compliance import CIMReportGenerator
+from pytest_splunk_addon.cim_compliance import CIMReportGenerator
 
 
 class TestCIMReport(object):

tests/e2e/test_splunk_addon.py

@@ -4,7 +4,7 @@
 import logging
 import pytest
 from tests.e2e import constants
-from pytest_splunk_addon.standard_lib.sample_generation import SampleGenerator, Rule
+from pytest_splunk_addon.sample_generation import SampleGenerator, Rule
 
 logger = logging.getLogger("test_pytest_splunk_addon")
 

tests/unit/tests_standard_lib/test_addon_parser/test_eventtype_parser.py

@@ -1,5 +1,5 @@
 from unittest.mock import patch, mock_open
-from pytest_splunk_addon.standard_lib.addon_parser.eventtype_parser import (
+from pytest_splunk_addon.addon_parser.eventtype_parser import (
     EventTypeParser,
 )