Merge branch 'master' of github.com:Koen1999/suricata-check-extension-example

Author: Koen1999

.github/workflows/python-pr.yml

@@ -13,7 +13,7 @@ concurrency:
 jobs:
   test:
     name: Quick Test
-    runs-on: ubuntu-latest
+    runs-on: self-hosted
 
     strategy:
       fail-fast: true
@@ -49,7 +49,7 @@ jobs:
 
   build:
     name: Build
-    runs-on: ubuntu-latest
+    runs-on: self-hosted
     needs:
       - test
 
@@ -77,7 +77,7 @@ jobs:
 
   lint:
     name: Lint
-    runs-on: ubuntu-latest
+    runs-on: self-hosted
     needs:
       - build
 
@@ -103,7 +103,6 @@ jobs:
 
       - name: Lint with flake8
         run: |
-          # stop the build if there are Python syntax errors or undefined names
           flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
 
       - name: Type checking with Pyright
@@ -117,3 +116,32 @@ jobs:
       - name: Lint with Ruff
         run: |
           ruff check --output-format=github .
+
+  docs:
+    name: Docs
+    runs-on: self-hosted
+    needs:
+      - lint
+
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: "pip"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools wheel build
+          pip install -r requirements.txt
+
+      - name: Generate docs with sphinx
+        run: |
+          cd docs
+          make clean
+          make html

.github/workflows/python-release.yml

@@ -7,7 +7,7 @@ on:
 jobs:
   test:
     name: Test Release
-    runs-on: ubuntu-latest
+    runs-on: self-hosted
 
     strategy:
       fail-fast: true
@@ -33,7 +33,7 @@ jobs:
 
       - name: Test with pytest (slow)
         run: |
-          pytest -m "slow"
+          pytest -m "slow" --cov-fail-under=0
 
   release-build:
     name: Build Release
@@ -43,20 +43,61 @@ jobs:
 
     strategy:
       fail-fast: true
-      matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout release code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - uses: actions/setup-python@v5
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: "3.x"
 
       - name: Install most recent build dependencies
         run: |
-          python -m pip install --upgrade build --upgrade-strategy eager
+          python -m pip install --upgrade pip --upgrade-strategy eager
+          python -m pip install --upgrade build pipdeptree --upgrade-strategy eager
 
-      - name: build release distributions
+      - name: Output installed packages
+        run: |
+          pip freeze --all
+
+      - name: Output dependency tree
+        run: |
+          pipdeptree
+
+      - name: Build release distributions
         run: |
           python -m build
+
+      - name: Upload windows dists
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    environment:
+      name: pypi
+    permissions:
+      id-token: write
+
+    strategy:
+      fail-fast: true
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          print-hash: true

docs/conf.py

@@ -13,7 +13,7 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "suricata-check-application-example"
+project = "suricata-check-extension-example"
 copyright = "2024, Koen Teuwen"
 author = "Koen Teuwen"
 
@@ -26,7 +26,6 @@
 
 extensions = [
     "myst_parser",
-    "sphinx.ext.autodoc",
     "autoapi.extension",
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
@@ -39,51 +38,31 @@
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3/", None),
     "sphinx": ("https://www.sphinx-doc.org/en/master", None),
+    "suricata-check": ("https://suricata-check.teuwen.net/", None),
     "idstools": ("https://idstools.readthedocs.io/en/latest/", None),
-    "suricata-check": ("https://suricata-check.readthedocs.io/en/latest/", None),
 }
 
 root_doc = "index"
 master_doc = "index"
 
+suppress_warnings = []
+
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "sphinx_rtd_theme"
-html_static_path = ["static"]
+html_theme_options = {
+    "prev_next_buttons_location": "both",
+    "style_external_links": True,
+}
+html_favicon = "https://docs.readthedocs.io/favicon.ico"
 
 # -- Options for MyST     -------------------------------------------------
 # https://myst-parser.readthedocs.io/en/latest/
 
 myst_enable_extensions = ["linkify"]
 myst_heading_anchors = 5
 
-# -- Options for Autodoc     -------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#configuration
-
-autoclass_context = "both"
-autodoc_class_signature = "separated"
-autodoc_member_order = "groupwise"
-autodoc_default_flags = [
-    "members",
-    "special-members",
-    "inherited-members",
-    "show-inheritance",
-    "ignore-module-all",
-    "maxdepth",
-]
-autodoc_default_options = {
-    "member-order": "bysource",
-    "special-members": "__init__",
-    "undoc-members": False,
-    "maxdepth": 2,
-}
-autodoc_typehints = "both"
-autodoc_typehints_description_target = "all"
-
-# -- Options for AutoAPI     -------------------------------------------------
-# https://sphinx-autoapi.readthedocs.io/en/latest/
-
 autoapi_dirs = ["../suricata_check_extension_example"]
 autoapi_options = [
     "members",
@@ -96,3 +75,8 @@
 autoapi_python_class_content = "both"
 autoapi_member_order = "groupwise"
 autoapi_own_page_level = "module"
+
+# -- Options for viewcode     -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html
+
+viewcode_line_numbers = True

docs/index.rst

@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 Welcome to suricata-check-extension-example's documentation!
-==========================================
+============================================================
 
 .. toctree::
    :caption: Documentation

pyproject.toml

@@ -51,7 +51,7 @@ classifiers = [
   "Operating System :: Microsoft :: Windows",
   "Operating System :: MacOS",
   "Framework :: Pytest",
-  "License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)",
+  "License :: OSI Approved :: Apache Software License",
 ]
 requires-python = ">=3.9"
 dependencies = ["suricata-check>=0.3.0beta0", "idstools>=0.6.5",]
@@ -68,7 +68,7 @@ dev = [
   "black>=24.4.2",
   "pyright>=1.1.367",
   "sphinx>=7.3.7",
-  "sphinx-rtd-theme>=2.0.0",
+  "sphinx-rtd-theme>=3.0.0",
   "myst-parser[linkify]>=3.0.1",
   "sphinx-click>=6.0.0",
   "sphinx-autoapi>=3.4.0",

requirements.txt

@@ -10,7 +10,7 @@ ruff>=0.4.9
 black>=24.4.2
 pyright>=1.1.367
 sphinx>=7.3.7
-sphinx-rtd-theme>=2.0.0
+sphinx-rtd-theme>=3.0.0
 myst-parser[linkify]>=3.0.1
 sphinx-click>=6.0.0
 sphinx-autoapi>=3.4.0

suricata_check_extension_example/_version.py

@@ -21,10 +21,23 @@ def get_version() -> str:
 
     git_dir = os.path.join(SURICATA_CHECK_DIR, "..", ".git")
     if os.path.exists(git_dir):
-        v = __get_git_revision_short_hash()
-        _logger.debug(
-            "Detected suricata-check-extension-example version using git: %s", v
-        )
+        try:
+            import setuptools_git_versioning  # noqa: RUF100, PLC0415
+
+            v = str(
+                setuptools_git_versioning.get_version(
+                    root=os.path.join(SURICATA_CHECK_DIR, "..")
+                )
+            )
+            _logger.debug(
+                "Detected suricata-check-extension-example version using setuptools_git_versioning: %s",
+                v,
+            )
+        except:  # noqa: E722
+            v = __get_git_revision_short_hash()
+            _logger.debug(
+                "Detected suricata-check-extension-example version using git: %s", v
+            )
     else:
         try:
             v = version("suricata-check-extension-example")

tests/test_suricata_check.py

@@ -97,7 +97,7 @@ def test_version():
     logging.basicConfig(level=logging.DEBUG)
     if not hasattr(suricata_check, "__version__"):
         pytest.fail("suricata_check has no attribute __version__")
-    from suricata_check._version import __version__
+    from suricata_check._version import __version__  # noqa: RUF100, PLC0415
 
     if __version__ == "unknown":
         warnings.warn(RuntimeWarning("Version is unknown."))