testbox-listeners

Provide lifecycle callbacks for TestBox run and runRaw test events.

1|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/ColdBox/skills --skill testbox-listeners
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: testbox-listeners
Source: https://github.com/ColdBox/skills/tree/main/testbox/listeners
Command: npx skills add https://github.com/ColdBox/skills --skill testbox-listeners

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides structured, event-driven hooks into TestBox test runs so you can monitor progress, capture failures, and react to lifecycle events without invasive changes to test suites or reporters.

Core Features & Use Cases

  • Lifecycle Callbacks: Receive onBundleStart, onBundleEnd, onSuiteStart, onSuiteEnd, onSpecStart, and onSpecEnd events with detailed results structs for real-time reaction.
  • Integrations & Reporting: Build progress bars, live dashboards, CI annotations, or custom loggers that respond to each spec or suite as it executes.
  • Reusable Patterns: Use closures or class-based listeners to aggregate failures, profile timings, or emit external notifications (webhooks, Slack, observability systems).
  • Use Case: Stream test run events to a CI pipeline to generate immediate GitHub Actions annotations for failing specs and a summary report at bundle end.

Quick Start

Use the testbox-listeners skill to capture onSpecEnd failures and emit GitHub Actions annotations in real time.

Frequently Asked Questions about testbox-listeners

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I monitor TestBox test run progress in real time?▼

TestBox run monitoring is achieved through lifecycle callbacks that trigger onBundleStart, onSuiteStart, and onSpecStart events. These handlers receive a results struct containing bundle, suite, spec, and testbox statistics for live progress tracking.

Can I generate CI annotations for failing TestBox specs automatically?▼

Yes, CI annotations for failing TestBox specs are generated by applying onSpecEnd callbacks to capture failures and emit GitHub Actions annotations. Bundle end events can then trigger a summary report for the pipeline.

What TestBox lifecycle events are available for custom listeners?▼

Available TestBox lifecycle events include onBundleStart, onBundleEnd, onSuiteStart, onSuiteEnd, onSpecStart, and onSpecEnd. Each handler receives a results struct with bundle, suite, spec, and testbox statistics for custom logging.

How do I build a live dashboard for TestBox test automation?▼

A live dashboard for TestBox test automation is built by passing a callbacks struct to the run or runRaw workflow. The listener closures capture suite and spec events in real time to update dashboard widgets as tests execute.

Do I need to modify my test suites to add TestBox listeners?▼

No, test suites require no invasive changes to add TestBox listeners. The event-driven hooks attach to the run workflow externally, intercepting bundle, suite, and spec lifecycle events without altering existing test code.

Can I send TestBox test results to external observability systems?▼

TestBox test results are sent to external observability systems by using class-based listeners or closures to aggregate failures and profile timings. The onSpecEnd and onBundleEnd handlers emit webhook or Slack notifications with run statistics.