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.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file testbench_defect_service-0.3.0.tar.gz.
File metadata
- Download URL: testbench_defect_service-0.3.0.tar.gz
- Upload date:
- Size: 649.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.34.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7fae07f0cd6aa94076d65f58479e4be6d41bb51e796f2f759600e490862cab81
|
|
| MD5 |
1c1a14467ad7ecd174bb543517344745
|
|
| BLAKE2b-256 |
3d1f4625e288a590644049b9c863506534d11a0cec916a5137bd342eef99724d
|
File details
Details for the file testbench_defect_service-0.3.0-py3-none-any.whl.
File metadata
- Download URL: testbench_defect_service-0.3.0-py3-none-any.whl
- Upload date:
- Size: 583.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.34.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0918fbcfe85d13935c6427590625dadbc7ddc97aeea461eda666b53dd1e1e530
|
|
| MD5 |
bb63cc2f58d04a4b868e1ebc592f7797
|
|
| BLAKE2b-256 |
0a90bd31e1dec3c38bcede10dc81cde132cfd2202304b774dfa940f70e814a97
|
