Feature/unit tests/infra 29960 (#268)

Initial unit tests

Author: uoboda-splunk

.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

poetry.lock

@@ -39,6 +39,10 @@ poetry-dynamic-versioning = "0.12.1"
 sphinx_rtd_theme = "0.5.0"
 sphinx-panels = "*"
 lovely-pytest-docker = "*"
+pytest-mock = "^3.5.1"
+pytest-cov = "^2.11.1"
+requests-mock = "^1.8.0"
+recordtype = "^1.3"
 
 [tool.poetry.plugins]
 pytest11 = { plugin = "pytest_splunk_addon.plugin", "splunk" = "pytest_splunk_addon.splunk" }
@@ -53,4 +57,4 @@ enable = true
 
 [build-system]
 requires = ["poetry>=1.0.2", "poetry-dynamic-versioning"]
-build-backend = "poetry.masonry.api"
+build-backend = "poetry.masonry.api"

pyproject.toml

@@ -301,6 +301,6 @@ def update_metadata(self, event, metadata, key_fields):
 
             return event, metadata, key_fields
 
-        except IndexError as error:
+        except KeyError as error:
             LOGGER.error(f"Unexpected data found. Error: {error}")
-            raise Exception(error)
+            raise error

pytest_splunk_addon/standard_lib/sample_generation/sample_event.py

@@ -0,0 +1,5 @@
+[pytest]
+addopts = -v --tb=long --log-level=INFO
+#    --force-flaky --max-runs=3 --min-passes=1
+filterwarnings =
+    ignore::DeprecationWarning

tests/unit/pytest.ini

@@ -0,0 +1,58 @@
+import pytest
+from collections import namedtuple
+from unittest.mock import Mock
+
+
+@pytest.fixture
+def parser(configuration_file):
+    def create_parser(
+        parser_class, func_to_be_mocked, parsed_output, headers=None, props_conf=None
+    ):
+        headers = headers if headers else []
+        FakeApp = Mock()
+        attrs = {
+            "{}.return_value".format(func_to_be_mocked): configuration_file(
+                headers=headers, sects=parsed_output, errors=[]
+            )
+        }
+        FakeApp.configure_mock(**attrs)
+        if props_conf is not None:
+            FakeApp.props_conf.return_value = props_conf
+        return parser_class("fake_path", FakeApp)
+
+    return create_parser
+
+
+@pytest.fixture
+def configuration_file():
+    def func(headers, sects, errors):
+        ConfigurationFile = namedtuple(
+            "ConfigurationFile", ["headers", "sects", "errors"]
+        )
+        return ConfigurationFile(headers, sects, errors)
+
+    return func
+
+
+@pytest.fixture(scope="session")
+def build_parsed_output():
+    def parsed_output(output_elements):
+        """
+        builds expected parser output from provided dict
+        :param output_elements: dictionary with {stanza: {option: value, ...}, ...}
+        :return: parsed_output
+        """
+        parsed_output = {}
+        for stanza, stanza_value in output_elements.items():
+            fake_section = Mock()
+            fake_section.options = {}
+            fake_section.name = stanza
+            parsed_output.update({stanza: fake_section})
+            for option, value in stanza_value.items():
+                fake_setting = Mock()
+                fake_setting.name = option
+                fake_setting.value = value
+                parsed_output[stanza].options.update({option: fake_setting})
+        return parsed_output
+
+    return parsed_output