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 init generates 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 AbstractDefectClient to 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.