Merge pull request #270 from splunk/develop

Merge develop into Main

Author: seanmalloy-crest

.github/workflows/black-style-check.yml

@@ -0,0 +1,14 @@
+name: Python Code Style Check
+
+on: [push]
+
+jobs:
+  style-check:
+    runs-on: ubuntu-latest
+    container: python:latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: |
+          pip install black
+          black --check ./tests/unit
+        name: Install and run black style checker

.github/workflows/test_matrix.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Test with pytest
         run: |
           export PATH="~/.pyenv/bin:$PATH"
-          eval "$(pyenv init -)"          
+          eval "$(pyenv init -)"
           source ~/.poetry/env
           poetry install -E docker
           poetry run pytest -v --splunk-version=${{ matrix.splunk-version }} -m docker

.github/workflows/unit_tests.yml

@@ -0,0 +1,41 @@
+name: Unit tests
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.7
+      - name: Install dependencies
+        run: |
+          sudo apt-get install -y build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev libffi-dev liblzma-dev python-openssl git
+          curl https://pyenv.run | bash
+          export PATH="~/.pyenv/bin:$PATH"
+          eval "$(pyenv init -)"
+          pyenv install 3.7.8
+          pyenv local 3.7.8
+          curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
+          source ~/.poetry/env
+      - name: Test with pytest
+        run: |
+          export PATH="~/.pyenv/bin:$PATH"
+          eval "$(pyenv init -)"
+          source ~/.poetry/env
+          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
+        with:
+          name: code-coverage-report-unit-tests
+          path: htmlcov

.gitignore

@@ -79,3 +79,6 @@ venv
 # Vs Code Settings
 .vscode
 test_report.md
+
+# Pycharm
+.idea/

docs/how_to_use.rst

@@ -300,4 +300,4 @@ Extending pytest-splunk-addon
 
    <hr width=100%>
 
-.. [#] xfail indicates that you expect a test to fail for some reason. A common example is a test for a feature not yet implemented, or a bug not yet fixed. When a test passes despite being expected to fail, it's an xpass and will be reported in the test summary.
+.. [#] xfail indicates that you expect a test to fail for some reason. A common example is a test for a feature not yet implemented, or a bug not yet fixed. When a test passes despite being expected to fail, it's an xpass and will be reported in the test summary.