testbench-defect-service 0.1.0__tar.gz

testbench_defect_service-0.1.0/.github/workflows/release.yaml

@@ -0,0 +1,79 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build_wheel:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: "pip"
+
+      - name: Install Flit
+        run: pip install flit
+
+      - name: Build wheel
+        run: flit build --format wheel
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheel
+          path: dist/*.whl
+          if-no-files-found: error
+
+  build_binaries:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: windows-2022
+          - os: ubuntu-22.04
+          - os: macos-14
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: "pip"
+
+      - name: Build binary
+        run: python build_binary.py
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: binary-${{ matrix.os }}
+          path: dist/*.zip
+          if-no-files-found: error
+
+  create_release:
+    needs: [build_wheel, build_binaries]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          path: release-assets
+          merge-multiple: true
+
+      - name: Upload assets to release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: release-assets/*
+          fail_on_unmatched_files: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

testbench_defect_service-0.1.0/.github/workflows/trigger-docs-release.yml

@@ -0,0 +1,49 @@
+name: Trigger Documentation Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  trigger-docs:
+    name: Trigger ecosystem docs versioning
+    runs-on: ubuntu-latest
+    steps:
+      - name: Derive tool metadata
+        id: meta
+        run: |
+          # Tool ID = repository name (must match tools.config.json in ecosystem-docs)
+          TOOL_ID="${{ github.event.repository.name }}"
+
+          # Version = release tag, strip leading 'v' if present
+          RAW_TAG="${{ github.event.release.tag_name }}"
+          VERSION="${RAW_TAG#v}"
+
+          echo "tool_id=${TOOL_ID}" >> $GITHUB_OUTPUT
+          echo "version=${VERSION}" >> $GITHUB_OUTPUT
+          echo "tag=${RAW_TAG}" >> $GITHUB_OUTPUT
+
+          echo "Tool: ${TOOL_ID}"
+          echo "Version: ${VERSION}"
+          echo "Tag: ${RAW_TAG}"
+
+      - name: Trigger ecosystem documentation workflow
+        run: |
+          jq -n \
+            --arg tool_id "${{ steps.meta.outputs.tool_id }}" \
+            --arg version "${{ steps.meta.outputs.version }}" \
+            --arg tag "${{ steps.meta.outputs.tag }}" \
+            --arg source_repo "${{ github.repository }}" \
+            '{
+              event_type: "tool-docs-release",
+              client_payload: {
+                tool_id: $tool_id,
+                version: $version,
+                tag: $tag,
+                source_repo: $source_repo
+              }
+            }' | gh api repos/${{ github.repository_owner }}/testbench-ecosystem-documentation/dispatches \
+              --method POST \
+              --input -
+        env:
+          GH_TOKEN: ${{ secrets.ECOSYSTEM_DOCS_TOKEN }}

testbench_defect_service-0.1.0/.gitignore

@@ -0,0 +1,217 @@
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# pyenv version file
+.python-version
+
+# Temporary directories and files
+temp/
+tmp*/
+*.tmp
+
+# Backup files
+*backup*
+*.backup
+
+# Application log files
+*.log
+*.log.*
+*.log.lck
+
+# Test result artifacts
+results/
+logs/
+
+# TLS certificates and keys
+certs/
+*.pem
+*.key
+*.crt
+*.p12
+*.pfx
+*.p8
+
+# Configuration files with sensitive data
+# Block all config files by default to prevent accidental commits of credentials
+config.py
+*.toml
+*.properties
+
+# Allow project configuration files
+!pyproject.toml
+
+# Allow example configs
+!examples/config.py
+!examples/*.toml
+!examples/*.properties
+
+# Allow config files in tests
+!tests/**/config.py
+!tests/**/*.toml
+!tests/**/*.properties
+
+# Allow internal config.py files (not user configs)
+!src/testbench_defect_service/**/config.py
+!src/testbench_defect_service/clients/**/config.py
+
+# Environment files (contain Jira credentials, etc.)
+.env
+.env.*
+!.env.example
+
+# VS Code settings
+.vscode/
+
+# Robot Framework results
+results/
+
+# Defect files
+defects/

testbench_defect_service-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+repos:
+  # mypy linter for Python files
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        description: 'Run mypy for static type checking'
+        entry: mypy
+        language: python
+        types_or: [python, pyi]
+        require_serial: true
+
+  # Ruff linter for Python files
+  - repo: local
+    hooks:
+      - id: ruff-format
+        name: ruff-format
+        description: "Run 'ruff format' for extremely fast Python formatting"
+        entry: ruff format --force-exclude
+        language: python
+        types_or: [python, pyi, jupyter]
+        require_serial: true
+
+      - id: ruff
+        name: ruff
+        description: "Run 'ruff' for extremely fast Python linting"
+        entry: ruff check --force-exclude
+        language: python
+        types_or: [python, pyi, jupyter]
+        require_serial: true
+
+  # Robocop for linting and formatting
+  - repo: local
+    hooks:
+      - id: robocop
+        name: robocop
+        description: "Robot Framework linter"
+        entry: robocop check --force-exclude
+        language: python
+        files: '.*\.(robot|resource)$'
+        minimum_pre_commit_version: "2.9.2"
+
+      - id: robocop-format
+        name: robocop-format
+        description: "Robot Framework formatter"
+        entry: robocop format --force-exclude
+        language: python
+        files: '.*\.(robot|resource)$'
+        minimum_pre_commit_version: "2.9.2"

testbench_defect_service-0.1.0/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+## [0.1.0] - 2026-04-20
+
+### Added
+
+- Initial release of TestBench Defect Service.
+- REST API for managing defects backed by Jira or JSONL (file-based) clients.
+- Interactive configuration wizard (`testbench-defect-service init`).
+- HTTP Basic Authentication for API access.
+- OpenAPI / Swagger UI documentation served at `/docs`.
+- Pre/post sync command hooks.
+- Support for multiple projects from a single service instance.
+- CLI entry point (`testbench-defect-service`) with `init`, `start`, and `set-credentials` commands.
+- `jira` optional dependency group for Jira backend support.
+
+[0.1.0]: https://github.com/imbus/testbench-defect-service/releases/tag/v0.1.0

testbench_defect_service-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,112 @@
+# Contributing
+
+Thank you for considering contributing to TestBench Defect Service! We appreciate your help in making this project even better. Please take a moment to read through this guide to understand how you can contribute effectively.
+
+## Development Setup
+
+To get started with development, follow these steps to clone the repository and set up your environment.
+
+**1. Fork the repository**
+
+Start by forking the repository to your own account.
+
+**2.  Clone your forked repository**
+
+After forking, clone your forked version of the repository to your local machine.
+
+**3. Set up the virtual environment**
+
+We provide a script to automatically set up the virtual environment and install all the necessary dependencies.
+
+Run the following command from the project’s root directory:
+
+```bash
+python bootstrap.py
+```
+
+The script `bootstrap.py` creates a virtual environment and installs both development and test dependencies.
+
+**4. Activate the virtual environment**
+
+Once the setup is complete, activate the virtual environment:
+- on macOS/Linux:
+    ```bash
+    source .venv/bin/activate
+    ```
+- on Windows:
+    ```powershell
+    .venv\Scripts\activate
+    ```
+ 
+## Running Tests
+
+If you want to contribute code, it's important to ensure that everything works correctly. You can run the tests to make sure the code passes all the required checks.
+
+**Run the unit tests (pytest):**
+```bash
+pytest tests/unit
+```
+
+**Run the Robot Framework Tests**
+
+To run the tests, simply execute the following from the project’s root directory:
+
+```bash
+robot tests/robot/
+```
+
+This will automatically discover and run all robot tests in the project.
+
+## Code Style & Linting
+
+This project uses [Ruff](https://docs.astral.sh/ruff/) for linting and formatting, and [mypy](https://mypy-lang.org/) for static type checking.
+
+**Check linting:**
+```bash
+ruff check src/
+```
+
+**Check types:**
+```bash
+mypy src/
+```
+
+**Pre-commit hooks** (run automatically on each commit after setup):
+```bash
+pre-commit install
+```
+
+Please ensure `ruff` and `mypy` pass with no errors before opening a pull request.
+
+## Branching & Pull Requests
+
+1. **Create a branch** from `main` with a descriptive name:
+   - `feature/<short-description>` for new features
+   - `fix/<short-description>` for bug fixes
+   - `docs/<short-description>` for documentation changes
+
+2. **Commit** your changes with clear, concise commit messages.
+
+3. **Push** your branch and open a pull request against `main`.
+
+4. Fill in the pull request description, referencing any related issues (e.g. `Closes #42`).
+
+5. Ensure all CI checks pass before requesting a review.
+
+## Reporting Bugs
+
+Please open a [GitHub Issue](https://github.com/imbus/testbench-defect-service/issues) and include:
+
+- **Version** — output of `testbench-defect-service --version`
+- **Python version** — output of `python --version`
+- **Operating system**
+- **Steps to reproduce** the problem (for bugs)
+- **Expected vs actual behavior**
+
+## Requesting Features
+
+Open a [GitHub Issue](https://github.com/imbus/testbench-defect-service/issues) and describe:
+
+- The use case you are trying to solve.
+- How you imagine the feature working.
+- Any alternatives you have considered.