feat: remove splunk-appinspect dependency (#499)

* feat: remove splunk-appinspect dependency (#464) BREAKING CHANGE: eventgen.conf is not supported anymore, please migrate to pytest-splunk-addon-data.conf * refactor: use conf-parser in EventtypeParser instead of splunk-appinspect * refactor: use conf-parser in SavedsearchesParser instead of splunk-appinspect * refactor: use conf-parser in TransformsParser instead of splunk-appinspect * refactor: use conf-parser in PropsParser instead of splunk-appinspect * refactor: remove splunk-appinspect from AddonParser * docs: remove splunk-appinspect mentions from PropsParser * test: empty stanza in savedsearches.conf * refactor: use new EventtypeParser in cim_field_report * refactor: use conf-parser in eventgen.conf parser * chore: remove create_new_eventgen * feat: remove splunk_appinspect dependency * chore: rename to pytest_splunk_addon_data * chore: style the docs pagee * ci: restructure tests * ci: not run tests with Splunk 8.0 * refactor: move some public methods to be private * ci: add debug-statements to pre-commit configuration * docs: remove release_history page * ci: upload coverage to codecov * chore: remove all eventgen signs
splunk · Feb 18, 2022 · a56e9d1 · a56e9d1
1 parent 23deab5
commit a56e9d1
Show file tree

Hide file tree

Showing 49 changed files with 1,123 additions and 2,970 deletions.
diff --git a/.github/workflows/build-test-release.yml b/.github/workflows/build-test-release.yml
@@ -180,6 +180,15 @@ jobs:
 
   test-splunk-matrix:
     name: Test Matrix
+    needs:
+      - pre-commit
+      - compliance-dependencies
+      - compliance-copyrights
+      - test-splunk-external
+      - test-splunk-doc
+      - test-splunk-unit
+      - review_secrets
+      - review-dog-misspell
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -213,25 +222,20 @@ jobs:
           curl -sSL https://install.python-poetry.org | python3 -
           poetry install
           poetry run coverage run --source=./pytest_splunk_addon/standard_lib -m pytest -v tests/unit
-          poetry run coverage html
-      - name: Archive test coverage results
-        uses: actions/upload-artifact@v2
+          poetry run coverage xml
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
         with:
-          name: code-coverage-report-unit-tests
-          path: htmlcov
-
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          directory: ./coverage/reports/
+          env_vars: OS,PYTHON
+          fail_ci_if_error: true
+          verbose: true
   publish:
     name: publish
     needs:
-      - pre-commit
-      - compliance-dependencies
-      - compliance-copyrights
-      - test-splunk-external
-      - test-splunk-doc
       - test-splunk-matrix
-      - test-splunk-unit
-      - review_secrets
-      - review-dog-misspell
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -18,6 +18,7 @@ repos:
     rev: v4.1.0
     hooks:
     -   id: check-merge-conflict
+    -   id: debug-statements
 -   repo: https://github.com/psf/black
     rev: 21.12b0
     hooks:

diff --git a/README.rst b/README.rst
@@ -42,13 +42,11 @@ Developing
 
 Note: Must install docker desktop, vscode or pycharm pro optional
 
-Note2: Appinspect requires libmagic verify this has been installed correctly each time a new workstation/vm is used https://dev.splunk.com/enterprise/docs/releaseapps/appinspect/splunkappinspectclitool/installappinspect
-
 .. code:: bash
 
     $ git clone --recurse-submodules -j8 git@github.com:splunk/pytest-splunk-addon.git
 
-    $ #setup python venv must be 3.7    
+    $ #setup python venv must be 3.7
     $ /Library/Frameworks/Python.framework/Versions/3.7/bin/python3 -m venv .venv
 
     $ source .venv/bin/activate
@@ -57,8 +55,6 @@ Note2: Appinspect requires libmagic verify this has been installed correctly eac
     
     $ pip3 install -r requirements.txt
 
-    $ pip3 install https://download.splunk.com/misc/appinspect/splunk-appinspect-latest.tar.gz
-
     $ python setup.py develop
     
 

diff --git a/docs/api_reference/sample_generation.rst b/docs/api_reference/sample_generation.rst
@@ -1,9 +1,9 @@
 DataGenerator
 ------------------
 
-EventgenParser
-~~~~~~~~~~~~~~~~~~
-.. automodule:: standard_lib.sample_generation.eventgen_parser
+PytestSplunkAddonDataParser
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: standard_lib.sample_generation.pytest_splunk_addon_data_parser
    :members:
    :show-inheritance:
 

diff --git a/docs/generate_conf.rst b/docs/generate_conf.rst
@@ -4,7 +4,11 @@ Generate Conf Utility
 .. _generate_conf:
 
 Overview
-""""""""""
+""""""""
+
+.. note::
+
+    This is deprecated since `pytest-splunk-addon` v1.12.0 and latest available version is v1.11.4.
 
 * The utility helps in creating the `pytest-splunk-addon-data.conf` from the existing `eventgen.conf` of the add-on.
 * The utility adds the following metadata required for the index-times tests in the new conf file:

diff --git a/docs/index.rst b/docs/index.rst
@@ -19,7 +19,6 @@ pytest-splunk-addon documentation
    index_time_tests
    sample_generator
    generate_conf
-   release_history
    api_reference/api_reference
    troubleshoot
 

diff --git a/docs/overview.rst b/docs/overview.rst
@@ -23,7 +23,7 @@ Features
 Release notes
 -------------
 
-Find details about all the releases here: :ref:`Release History Page<release_history>`
+Find details about all the releases `here <https://github.com/splunk/pytest-splunk-addon/releases>`_.
 
 Installation
 ------------

diff --git a/docs/release_history.rst b/docs/release_history.rst
diff --git a/docs/sample_generator.rst b/docs/sample_generator.rst
@@ -1,7 +1,7 @@
 Data Generator
 ===============
 
-To ingest samples into Splunk, plugin takes `pytest-splunk-addon-data.conf` or `eventgen.conf` as input. 
+To ingest samples into Splunk, plugin takes `pytest-splunk-addon-data.conf` as input.
 The sample generation & ingestion takes place before executing the testcases. 
 For index-time test cases, there are multiple metadata required about the sample file for which `pytest-splunk-addon-data.conf` must be created and provided to the pytest command.