[TEST] Bartek's Lab

.env → .env.test

@@ -1,16 +1,19 @@
+# Access scheme (default: https)
+scheme=https
 # Splunk host (default: localhost)
 host=localhost
 # Splunk admin port (default: 8089)
 port=8089
+
 # Splunk username
 username=admin
 # Splunk password
 password=changed!
-# Access scheme (default: https)
-scheme=https
-# Your version of Splunk (default: 6.2)
-version=9.0
+
+# Your version of Splunk (default: latest)
+version=latest
+
 # Bearer token for authentication
-#splunkToken="<Bearer-token>"
+# splunkToken="<Bearer-token>"
 # Session key for authentication
-#token="<Session-Key>"
+# token="<Session-Key>"

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,17 +1,17 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,14 +24,16 @@ A clear and concise description of what you expected to happen.
 If applicable, add logs or screenshots to help explain your problem.
 
 **Splunk (please complete the following information):**
+
 - Version: [e.g. 8.0.5]
 - OS: [e.g. Ubuntu 20.04.1]
 - Deployment: [e.g. single-instance]
 
 **SDK (please complete the following information):**
- - Version: [e.g. 1.6.14]
- - Language Runtime Version: [e.g. Python 3.7]
- - OS: [e.g. MacOS 10.15.7]
+
+- Version: [e.g. 1.6.14]
+- Language Runtime Version: [e.g. Python 3.7]
+- OS: [e.g. MacOS 10.15.7]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

@@ -1,10 +1,7 @@
 ---
 name: Custom issue template
 about: Describe this issue template's purpose here.
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
-
-

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/PULL_REQUEST_TEMPLATE/pr_template.md

@@ -1,15 +1,14 @@
 ---
 name: Pull Request Template
 about: Create a Pull Request to contribute to the SDK
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 ## Description of PR
 
-Provide the **context and motivation** for this PR. 
+Provide the **context and motivation** for this PR.
 Briefly explain the **type of changes** (bug fix, feature request, doc update, etc.) made in this PR. Provide reference to issue # fixed, if applicable.
 
 Describe the approach to the solution, the changes made, and any resulting change in behavior or impact to the user.

.github/workflows/release.yml

@@ -1,43 +1,45 @@
-name: Release
+name: Publish release
 on:
   release:
     types: [published]
+  workflow_dispatch:
+    inputs:
+      dry-run:
+        type: boolean
+        required: true
+        default: true
 
 jobs:
-  publish:
-    name: Deploy Release to PyPI
-    runs-on: ubuntu-latest
+  release:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.9]
     steps:
-      - name: Checkout source
-        uses: actions/checkout@v3
-      - name: Set up Python
-        uses: actions/setup-python@v4
+      - name: Checkout repo
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065
         with:
-          python-version: 3.7
+          python-version: ${{ matrix.python-version }}
       - name: Install dependencies
-        run: pip install twine
+        run: pip install . --group build
       - name: Build package
-        run: python setup.py sdist
+        run: python -m build
       - name: Publish package to PyPI
-        uses: pypa/[email protected]
+        if: ${{ inputs.dry-run == 'false' }}
+        uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc
         with:
           user: __token__
-          password: ${{ secrets.pypi_password }}
-      - name: Install tox
-        run: pip install tox
-      - name: Generate API docs
+          password: ${{ secrets.PYPI_PASSWORD }}
+      - name: Generate API reference docs
         run: |
           rm -rf ./docs/_build
-          tox -e docs
-      - name : Docs Upload
-        uses: actions/upload-artifact@v3
+          python -m tox -e docs
+      - name: Upload API reference docs
+        if: ${{ inputs.dry-run == 'false' }}
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
         with:
           name: python_sdk_docs
           path: docs/_build/html
-      # Test upload
-      # - name: Publish package to TestPyPI
-      #   uses: pypa/gh-action-pypi-publish@master
-      #   with:
-      #     user: __token__
-      #     password: ${{ secrets.test_pypi_password }}
-      #     repository_url: https://test.pypi.org/legacy/

.github/workflows/test.yml

@@ -1,51 +1,48 @@
-name: Python CI
+name: Run test suite
 
-on:
-  [ push, workflow_dispatch ]
+on: [push, workflow_dispatch]
 
 jobs:
-  build:
-
+  test:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os:
-          - ubuntu-latest
-        python: [ 3.9, 3.13 ]
+        os: [ubuntu-latest]
+        python-version:
+          - 3.7
+          - 3.9
+          # - 3.13
         splunk-version:
-          - "8.1"
           - "8.2"
-          - "latest"
-        include:
-          - os: ubuntu-22.04
-            python: 3.7
-            splunk-version: "8.1"
-          - os: ubuntu-22.04
-            python: 3.7
-            splunk-version: "8.2"
-          - os: ubuntu-22.04
-            python: 3.7
-            splunk-version: "latest"
-
+          - "9.3"
+          # - "9.4"
+          # - "latest"
       fail-fast: false
-
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Run docker compose
-        run: SPLUNK_VERSION=${{matrix.splunk-version}} docker compose up -d
-
-      - name: Setup Python
-        uses: actions/setup-python@v4
+      - name: Checkout repo
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+      - name: Set up environment variables
+        run: cp ./.env.test ./.env
+      - name: Launch Splunk ${{ matrix.splunk-version }}
+        run: SPLUNK_VERSION=${{ matrix.splunk-version }} docker compose up -d
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065
         with:
-          python-version: ${{ matrix.python }}
-
-      - name: Install tox
-        run: pip install tox
-
-      - name: Test Execution
-        run: tox -e py
-  fossa-scan:
-    uses: splunk/oss-scanning-public/.github/workflows/oss-scan.yml@main
-    secrets: inherit
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: type -a python && python -m pip install tox
+      # - name: Run Docker health check
+      #   # This probably solves nothing
+      #   run: |
+      #     timeout 30s make wait_up
+      #     if [ $? -eq 124 ]; then
+      #       echo "Splunk failed to start within 30 seconds."
+      #       docker compose logs
+      #       exit 1
+      #     fi
+      - name: Run test suite
+        run: type -a python && python -m tox -e py
+# [BJ] I'll uncomment this step after I finish fiddling
+#  fossa-scan:
+#    uses: splunk/oss-scanning-public/.github/workflows/oss-scan.yml@main
+#    secrets: inherit

.gitignore

@@ -5,7 +5,6 @@
 *coverage_html_report*
 .coverage
 .coverage.*
-.python-version
 .vscode
 __stdout__
 docs/_build
@@ -17,12 +16,16 @@ coverage_report
 test.log
 tests/searchcommands_data/log/
 tests/searchcommands_data/output/
-Test Results*.html
 tests/searchcommands/data/app/app.log
+tests/searchcommands/apps/app_with_logging_configuration/*.log
+Test Results*.html
 splunk_sdk.egg-info/
+.splunkrc
 dist/
-tests/searchcommands/apps/app_with_logging_configuration/*.log
 *.observed
 venv/
+.venv/
+.mypy_cache/
 .tox
 test-reports/
+.env

.python-version

@@ -0,0 +1 @@
+3.9.23