TestBench Defect Service
Introduction
A lightweight REST API service for imbus TestBench that provides a unified interface for creating and synchronising defects with external defect tracking systems.
Features
- Multiple clients: JSONL files for testing/offline use, or Jira Cloud and Data Center via REST API
- Unified REST API: a single API surface regardless of the underlying defect tracker
- Interactive setup wizard:
testbench-defect-service initgenerates a complete config in seconds - Swagger UI: built-in interactive API docs at
/docs - Per-project overrides: field mappings and configuration per project key
- Pre/post sync hooks: run shell commands before or after sync operations
- HTTPS & mTLS: optional TLS and mutual TLS for production deployments
- Extensible: implement
AbstractDefectClientto connect any defect tracker
Installation
With pip (Python 3.10–3.14 required):
pip install testbench-defect-service
Optional extras for additional clients:
| Client | Data source | Install command |
|---|---|---|
| JSONL (default) | .jsonl files |
included in base install |
| Jira | Jira Cloud / Data Center REST API | pip install testbench-defect-service[jira] |
Standalone executable (no Python required): download the pre-built binary from the GitHub releases page.
Quickstart
# 1. Create a configuration interactively
testbench-defect-service init
# 2. Start the service
testbench-defect-service start
The service runs at http://127.0.0.1:8030 by default. Open /docs for the interactive Swagger UI.
Documentation
Full documentation is available on the TestBench Ecosystem documentation site:
- Introduction
- Installation
- Quickstart
- Configuration
- CLI Commands
- Clients overview
- TestBench Integration
Contributing
Contributions are welcome. See CONTRIBUTING.md for setup instructions and guidelines.
Changelog
See CHANGELOG.md for release history.
License
Apache 2.0 — see LICENSE for details.
Release files for testbench-defect-service 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| testbench_defect_service-0.3.0.tar.gz | 649.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| testbench_defect_service-0.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.2 MB
Release files / testbench_defect_service-0.3.0.tar.gz
| Download URL | testbench_defect_service-0.3.0.tar.gz |
|---|---|
| Size | 649.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7fae07f0cd6aa94076d65f58479e4be6d41bb51e796f2f759600e490862cab81
|
|
BLAKE2b-256 checksum How to use checksums |
3d1f4625e288a590644049b9c863506534d11a0cec916a5137bd342eef99724d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.34.2
|
Release files / testbench_defect_service-0.3.0-py3-none-any.whl
| Download URL | testbench_defect_service-0.3.0-py3-none-any.whl |
|---|---|
| Size | 583.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0918fbcfe85d13935c6427590625dadbc7ddc97aeea461eda666b53dd1e1e530
|
|
BLAKE2b-256 checksum How to use checksums |
0a90bd31e1dec3c38bcede10dc81cde132cfd2202304b774dfa940f70e814a97
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.34.2
|
