imbi-plugin-sonarqube 0.0.0__tar.gz

imbi_plugin_sonarqube-0.0.0/.github/workflows/publish.yml

@@ -0,0 +1,45 @@
+name: Publish to PyPI
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install 3.14
+
+      - name: Build
+        run: uv build
+
+      - name: Upload dist
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - name: Download dist
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1

imbi_plugin_sonarqube-0.0.0/.github/workflows/test.yml

@@ -0,0 +1,54 @@
+name: Testing
+on:
+  pull_request:
+  push:
+    branches: [ "main" ]
+    paths-ignore:
+      - 'docs/**'
+      - '*.md'
+    tags-ignore: [ "*" ]
+
+jobs:
+  lint:
+    name: "Static Analysis"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+      - name: Install just
+        uses: extractions/setup-just@v2
+        with:
+          just-version: '1.47.1'
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+      - name: Run linters
+        run: just lint
+
+  test:
+    name: "Automated Tests"
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: [ "3.14" ]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+      - name: Install just
+        uses: extractions/setup-just@v2
+        with:
+          just-version: '1.47.1'
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: "${{ matrix.python }}"
+          enable-cache: true
+      - name: Test with python ${{ matrix.python }}
+        run: just test
+      - name: Upload Coverage
+        uses: codecov/codecov-action@v5
+        with:
+          files: ./build/coverage.xml
+          flags: unittests

imbi_plugin_sonarqube-0.0.0/.gitignore

@@ -0,0 +1,9 @@
+.*
+!/.coderabbit.yaml
+!/.github
+!/.gitignore
+!/.pre-commit-config.yaml
+!/.python-version
+/build
+/dist
+/coverage.xml

imbi_plugin_sonarqube-0.0.0/.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0  # unrelated to the pre-commit utility version
+    hooks:
+      - id: check-executables-have-shebangs
+      - id: check-json
+      - id: check-shebang-scripts-are-executable
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.0
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/tombi-toml/tombi-pre-commit
+    rev: v0.7.27
+    hooks:
+      - id: tombi-format

imbi_plugin_sonarqube-0.0.0/.python-version

@@ -0,0 +1 @@
+3.14

imbi_plugin_sonarqube-0.0.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, AWeber
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

imbi_plugin_sonarqube-0.0.0/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: imbi-plugin-sonarqube
+Version: 0.0.0
+Summary: SonarQube webhook-action plugin for Imbi
+Author-email: Dave Shawley <daves@aweber.com>
+License: BSD-3-Clause
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.14
+Requires-Dist: httpx>=0.27
+Requires-Dist: imbi-common~=2.5
+Requires-Dist: pydantic>=2
+Description-Content-Type: text/markdown
+
+# imbi-plugin-sonarqube
+
+SonarQube webhook-action plugin for Imbi.
+
+The plugin registers a `sonarqube` entry in the Imbi plugin registry
+(plugin type: `webhook`). When a SonarQube webhook arrives at
+`imbi-gateway` and a matching `WebhookRule` dispatches to
+`imbi_plugin_sonarqube.actions.update_project_from_webhook`, the
+handler:
+
+1. Reads the metric→JSONPointer mapping from `WebhookRule.handler_config`.
+2. Fetches `/api/measures/component` from SonarQube using the plugin's
+   stored API token and the `ThirdPartyService.api_endpoint`.
+3. Patches the matched Imbi project's facts.
+
+## Configuration
+
+Operators attach a `sonarqube` plugin instance to the SonarQube
+`ThirdPartyService` and store the SonarQube API token in the plugin's
+encrypted credentials.
+
+A typical webhook rule:
+
+```
+Handler: imbi_plugin_sonarqube.actions.update_project_from_webhook
+Filter:  /branch/is_main==true
+Config:  [
+           {"metric": "coverage", "path": "/test_coverage"},
+           {"metric": "ncloc",    "path": "/lines_of_code"}
+         ]
+```

imbi_plugin_sonarqube-0.0.0/README.md

@@ -0,0 +1,31 @@
+# imbi-plugin-sonarqube
+
+SonarQube webhook-action plugin for Imbi.
+
+The plugin registers a `sonarqube` entry in the Imbi plugin registry
+(plugin type: `webhook`). When a SonarQube webhook arrives at
+`imbi-gateway` and a matching `WebhookRule` dispatches to
+`imbi_plugin_sonarqube.actions.update_project_from_webhook`, the
+handler:
+
+1. Reads the metric→JSONPointer mapping from `WebhookRule.handler_config`.
+2. Fetches `/api/measures/component` from SonarQube using the plugin's
+   stored API token and the `ThirdPartyService.api_endpoint`.
+3. Patches the matched Imbi project's facts.
+
+## Configuration
+
+Operators attach a `sonarqube` plugin instance to the SonarQube
+`ThirdPartyService` and store the SonarQube API token in the plugin's
+encrypted credentials.
+
+A typical webhook rule:
+
+```
+Handler: imbi_plugin_sonarqube.actions.update_project_from_webhook
+Filter:  /branch/is_main==true
+Config:  [
+           {"metric": "coverage", "path": "/test_coverage"},
+           {"metric": "ncloc",    "path": "/lines_of_code"}
+         ]
+```

imbi_plugin_sonarqube-0.0.0/justfile

@@ -0,0 +1,62 @@
+export UV_FROZEN := "1"
+
+[default]
+[private]
+@help:
+    just --list
+
+[private]
+ci: lint test
+
+[doc("Set up your development environment")]
+[group("Environment")]
+setup:
+    uv sync --all-groups --all-extras --frozen
+    uv run pre-commit install --install-hooks --overwrite
+
+[doc("Build packages")]
+[group("Development")]
+build:
+    uv build --clear
+
+[doc("Run tests")]
+[group("Testing")]
+test *ARGS: setup
+    #!/usr/bin/env sh
+    set -eu
+    uv run coverage run -m pytest {{ARGS}}
+    if [ '{{ARGS}}' = '' ]; then
+        uv run coverage report
+        uv run coverage xml
+    fi
+
+[doc("Run linters")]
+[group("Testing")]
+lint: setup
+    uv run pre-commit run --all-files
+    uv run pyrefly check
+
+[doc("Reformat code (optionally pass specific files)")]
+[group("Development")]
+format *FILES: setup
+    #!/usr/bin/env sh
+    set -eu
+    if [ "{{FILES}}" = '' ]; then
+        args='--all-files'
+    else
+        args='--files {{FILES}}'
+    fi
+    uv run pre-commit run ruff-format $args
+    uv run pre-commit run tombi-format $args
+
+[doc("Remove runtime artifacts")]
+[group("Environment")]
+clean:
+    rm -f .coverage .env
+    rm -fR build
+
+[confirm]
+[doc("Remove caches, virtual env, and output files")]
+[group("Environment")]
+real-clean: clean
+    rm -fR .venv .*_cache dist

imbi_plugin_sonarqube-0.0.0/pyproject.toml

@@ -0,0 +1,116 @@
+[project]
+name = "imbi-plugin-sonarqube"
+version = "0.0.0"
+description = "SonarQube webhook-action plugin for Imbi"
+readme = "README.md"
+requires-python = ">=3.14"
+license = { text = "BSD-3-Clause" }
+authors = [{ name = "Dave Shawley", email = "daves@aweber.com" }]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Natural Language :: English",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+  "httpx>=0.27",
+  "imbi-common~=2.5",
+  "pydantic>=2",
+]
+
+[project.entry-points."imbi.plugins"]
+sonarqube = "imbi_plugin_sonarqube.plugin:SonarqubePlugin"
+
+[dependency-groups]
+dev = [
+  "coverage[toml]",
+  "imbi-common[server,databases]~=2.1",
+  "pre-commit",
+  "pyrefly~=1.0",
+  "pytest",
+  "pytest-asyncio",
+  "respx",
+  "ruff~=0.15.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.coverage.report]
+exclude_also = ["typing.TYPE_CHECKING"]
+fail_under = 90
+show_missing = true
+
+[tool.coverage.run]
+branch = true
+source = ["src/imbi_plugin_sonarqube"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/imbi_plugin_sonarqube"]
+
+[tool.pyrefly]
+min-severity = "warn"
+preset = "strict"
+
+[tool.pyrefly.errors]
+missing-override-decorator = false
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.ruff]
+line-length = 79
+target-version = "py314"
+
+[tool.ruff.format]
+quote-style = "single"
+
+[tool.ruff.lint]
+select = [
+  "ASYNC",
+  "B",
+  "BLE",
+  "C4",
+  "C90",
+  "DTZ",
+  "E",
+  "F",
+  "FURB",
+  "G",
+  "I",
+  "N",
+  "Q",
+  "RUF",
+  "S",
+  "T20",
+  "UP",
+  "W",
+]
+ignore = [
+  "ASYNC109",
+  "N818",
+  "RSE",
+  "S105",
+  "TRY003",
+  "TRY400",
+  "UP047",
+]
+flake8-quotes = { inline-quotes = "single" }
+
+[tool.ruff.lint.mccabe]
+max-complexity = 15
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = ["S"]
+
+[tool.uv]
+constraint-dependencies = ["clickhouse-connect>=0.12rc1"]
+default-groups = ["dev"]
+
+[[tool.uv.index]]
+url = "https://pypi.org/simple"
+default = true

imbi_plugin_sonarqube-0.0.0/src/imbi_plugin_sonarqube/__init__.py

@@ -0,0 +1,6 @@
+from importlib import metadata
+
+from imbi_plugin_sonarqube.plugin import SonarqubePlugin
+
+version = metadata.version('imbi-plugin-sonarqube')
+__all__ = ['SonarqubePlugin', 'version']

imbi_plugin_sonarqube-0.0.0/src/imbi_plugin_sonarqube/actions.py

@@ -0,0 +1,207 @@
+"""Webhook action implementations dispatched from :class:`SonarqubePlugin`."""
+
+import logging
+import typing
+
+import httpx
+import pydantic
+import pydantic_settings
+from imbi_common import json_pointer
+from imbi_common.plugins import base as plugin_base
+
+from imbi_plugin_sonarqube import client
+
+LOGGER = logging.getLogger(__name__)
+
+
+class _ImbiSettings(pydantic_settings.BaseSettings):
+    """Imbi API connection settings.
+
+    Names mirror :class:`imbi_gateway.actions.ActionSettings` so the
+    same operator-managed environment variables drive both the gateway
+    handlers and this plugin's handler.
+    """
+
+    model_config = {'env_prefix': 'ACTIONS_'}
+
+    imbi_url: pydantic.HttpUrl = pydantic.HttpUrl('http://imbi-api:8000')
+    imbi_token: str
+
+
+class MetricMapping(pydantic.BaseModel):
+    """One row of ``WebhookRule.handler_config``.
+
+    ``metric`` is the SonarQube measure metric key
+    (e.g. ``'coverage'``, ``'ncloc'``).  ``path`` is the JSON Pointer
+    target on the Imbi project that receives the metric value.
+    """
+
+    metric: str = pydantic.Field(
+        description='SonarQube measure metric key (e.g. coverage, ncloc).',
+    )
+    path: json_pointer.JsonPointer = pydantic.Field(
+        description=(
+            'JSON Pointer on the Imbi project that receives this metric.'
+        ),
+    )
+
+
+class MetricMappings(pydantic.RootModel[list[MetricMapping]]):
+    """``WebhookRule.handler_config`` for ``update_project_from_webhook``.
+
+    A list of metric -> JSON Pointer mappings. The action fetches each
+    metric from SonarQube's ``/api/measures/component`` endpoint and
+    patches the resolved value to the matching path on the Imbi
+    project.
+    """
+
+    root: list[MetricMapping] = pydantic.Field(
+        default_factory=list,
+        description='Ordered list of metric -> JSON Pointer mappings.',
+    )
+
+
+def _index_measures(
+    response: dict[str, typing.Any],
+) -> dict[str, str]:
+    """Return ``{metric_name: value_str}`` from a measures response."""
+    component_obj: object = response.get('component') or {}
+    if not isinstance(component_obj, dict):
+        return {}
+    measures_obj: object = typing.cast(
+        'dict[str, typing.Any]', component_obj
+    ).get('measures', [])
+    if not isinstance(measures_obj, list):
+        return {}
+    indexed: dict[str, str] = {}
+    for measure_obj in typing.cast('list[object]', measures_obj):
+        if not isinstance(measure_obj, dict):
+            continue
+        measure = typing.cast('dict[str, typing.Any]', measure_obj)
+        metric = measure.get('metric')
+        value = measure.get('value')
+        if isinstance(metric, str) and value is not None:
+            indexed[metric] = str(value)
+    return indexed
+
+
+async def update_project_from_webhook(
+    *,
+    ctx: plugin_base.PluginContext,
+    credentials: dict[str, str],
+    external_identifier: str,
+    action_config: MetricMappings,
+    payload: object,
+) -> None:
+    """Patch Imbi project facts from a SonarQube webhook delivery.
+
+    The webhook ``payload`` is not consulted; the SonarQube component
+    key arrives via ``external_identifier`` (resolved by the gateway
+    from ``IMPLEMENTED_BY.identifier_selector``). Resolves the
+    SonarQube base URL from ``ctx.assignment_options['service_endpoint']``
+    (the gateway stashes the ``ThirdPartyService.api_endpoint`` there
+    before dispatch). Skips silently with a warning when the endpoint
+    or API token is missing so a misconfiguration does not 5xx the
+    webhook. ``action_config`` is a pre-validated :class:`MetricMappings`
+    instance -- the host validates the JSON blob before calling.
+    """
+    del payload
+    mappings = action_config.root
+    if not mappings:
+        LOGGER.debug('No metric mappings configured; nothing to do')
+        return
+
+    api_token = credentials.get('api_token')
+    if not api_token:
+        LOGGER.warning(
+            'SonarQube api_token credential is missing; skipping project '
+            '%s/%s update',
+            ctx.org_slug,
+            ctx.project_id,
+        )
+        return
+    raw_endpoint = ctx.assignment_options.get('service_endpoint')
+    service_endpoint = str(raw_endpoint) if raw_endpoint else None
+    if not service_endpoint:
+        LOGGER.warning(
+            'ThirdPartyService has no api_endpoint configured; skipping '
+            'project %s/%s update',
+            ctx.org_slug,
+            ctx.project_id,
+        )
+        return
+
+    metric_keys = [mapping.metric for mapping in mappings]
+    try:
+        response = await client.fetch_component_measures(
+            base_url=service_endpoint,
+            api_token=api_token,
+            component=external_identifier,
+            metric_keys=metric_keys,
+        )
+    except client.SonarqubeClientError:
+        LOGGER.exception(
+            'Failed to fetch SonarQube measures for component %r',
+            external_identifier,
+        )
+        return
+
+    measures = _index_measures(response)
+    patch: list[dict[str, typing.Any]] = []
+    for mapping in mappings:
+        value = measures.get(mapping.metric)
+        if value is None:
+            LOGGER.warning(
+                'SonarQube measure %r missing for component %r; '
+                'skipping patch %s',
+                mapping.metric,
+                external_identifier,
+                str(mapping.path),
+            )
+            continue
+        patch.append({'op': 'add', 'path': str(mapping.path), 'value': value})
+
+    if not patch:
+        LOGGER.info(
+            'No SonarQube measures resolved for component %r; project %s/%s '
+            'left unchanged',
+            external_identifier,
+            ctx.org_slug,
+            ctx.project_id,
+        )
+        return
+
+    await _patch_imbi_project(ctx.org_slug, ctx.project_id, patch)
+
+
+async def _patch_imbi_project(
+    org_slug: str,
+    project_id: str,
+    patch: list[dict[str, typing.Any]],
+) -> None:
+    """PATCH the Imbi project's facts.
+
+    Reads connection settings from the ``ACTIONS_IMBI_URL`` and
+    ``ACTIONS_IMBI_TOKEN`` environment variables (matching the
+    gateway's own :class:`imbi_gateway.actions.ActionSettings`) so the
+    plugin requires no additional configuration.
+    """
+    settings = _ImbiSettings()  # type: ignore[call-arg]
+    url = (
+        str(settings.imbi_url).rstrip('/')
+        + f'/organizations/{org_slug}/projects/{project_id}'
+    )
+    headers = {
+        'Authorization': f'Bearer {settings.imbi_token}',
+        'Content-Type': 'application/json',
+    }
+    async with httpx.AsyncClient(timeout=30.0) as http_client:
+        response = await http_client.patch(url, headers=headers, json=patch)
+    if response.is_error:
+        LOGGER.warning(
+            'Failed to patch Imbi project %s/%s: %s %s',
+            org_slug,
+            project_id,
+            response.status_code,
+            response.text,
+        )