Reporting¶
Output formatters for test results.
Terminal Reporter¶
agentprobe.reporting.terminal
¶
Terminal reporter using Rich for formatted output.
Produces colored tables, progress summaries, and status panels for agent test runs.
TerminalReporter
¶
Reporter that outputs formatted results to the terminal.
Uses Rich for colored tables, panels, and progress indicators.
Attributes:
| Name | Type | Description |
|---|---|---|
console |
Rich Console instance for output. |
Source code in src/agentprobe/reporting/terminal.py
name
property
¶
Return the reporter name.
__init__(console=None)
¶
Initialize the terminal reporter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
console
|
Console | None
|
Rich Console to use. Creates a new one if None. |
None
|
HTML Reporter¶
agentprobe.reporting.html
¶
HTML reporter for test results.
Generates a standalone HTML file with embedded CSS for viewing test results in a browser.
HTMLReporter
¶
Reporter that writes results as a standalone HTML file.
Produces a single HTML file with embedded CSS, requiring no external dependencies for viewing.
Attributes:
| Name | Type | Description |
|---|---|---|
output_dir |
Directory to write report files to. |
Source code in src/agentprobe/reporting/html.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 | |
name
property
¶
Return the reporter name.
__init__(output_dir='agentprobe-report')
¶
Initialize the HTML reporter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
output_dir
|
str | Path
|
Directory for report output. |
'agentprobe-report'
|
report(run)
async
¶
Write the agent run as an HTML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
run
|
AgentRun
|
The completed agent run. |
required |
Source code in src/agentprobe/reporting/html.py
JSON Reporter¶
agentprobe.reporting.json_reporter
¶
JSON file reporter for test results.
Writes the complete AgentRun as a JSON file for consumption by CI/CD pipelines and other tools.
JSONReporter
¶
Reporter that writes results to a JSON file.
Attributes:
| Name | Type | Description |
|---|---|---|
output_dir |
Directory to write report files to. |
Source code in src/agentprobe/reporting/json_reporter.py
name
property
¶
Return the reporter name.
__init__(output_dir='agentprobe-report')
¶
Initialize the JSON reporter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
output_dir
|
str | Path
|
Directory for report output. |
'agentprobe-report'
|
report(run)
async
¶
Write the agent run as a JSON file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
run
|
AgentRun
|
The completed agent run. |
required |
Source code in src/agentprobe/reporting/json_reporter.py
JUnit XML Reporter¶
agentprobe.reporting.junit
¶
JUnit XML reporter for test results.
Generates JUnit-compatible XML output suitable for CI/CD systems like Jenkins, GitHub Actions, and GitLab CI.
JUnitReporter
¶
Reporter that writes results as JUnit XML.
Produces a standard JUnit XML file that can be consumed by CI/CD pipelines for test reporting and status visualization.
Attributes:
| Name | Type | Description |
|---|---|---|
output_dir |
Directory to write report files to. |
Source code in src/agentprobe/reporting/junit.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 | |
name
property
¶
Return the reporter name.
__init__(output_dir='agentprobe-report')
¶
Initialize the JUnit reporter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
output_dir
|
str | Path
|
Directory for report output. |
'agentprobe-report'
|
report(run)
async
¶
Write the agent run as a JUnit XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
run
|
AgentRun
|
The completed agent run. |
required |
Source code in src/agentprobe/reporting/junit.py
Markdown Reporter¶
agentprobe.reporting.markdown
¶
Markdown reporter for test results.
Generates a Markdown file with tables and summary sections suitable for rendering in GitHub, GitLab, or documentation systems.
MarkdownReporter
¶
Reporter that writes results as a Markdown file.
Produces a Markdown document with a summary section and a results table, compatible with GitHub, GitLab, and other renderers.
Attributes:
| Name | Type | Description |
|---|---|---|
output_dir |
Directory to write report files to. |
Source code in src/agentprobe/reporting/markdown.py
name
property
¶
Return the reporter name.
__init__(output_dir='agentprobe-report')
¶
Initialize the Markdown reporter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
output_dir
|
str | Path
|
Directory for report output. |
'agentprobe-report'
|
report(run)
async
¶
Write the agent run as a Markdown file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
run
|
AgentRun
|
The completed agent run. |
required |
Source code in src/agentprobe/reporting/markdown.py
CSV Reporter¶
agentprobe.reporting.csv_reporter
¶
CSV reporter for test results.
Writes test results as a CSV file for easy import into spreadsheets and data analysis tools.
CSVReporter
¶
Reporter that writes results as a CSV file.
Produces a CSV file with one row per test result, suitable for import into spreadsheets and data analysis pipelines.
Attributes:
| Name | Type | Description |
|---|---|---|
output_dir |
Directory to write report files to. |
Source code in src/agentprobe/reporting/csv_reporter.py
name
property
¶
Return the reporter name.
__init__(output_dir='agentprobe-report')
¶
Initialize the CSV reporter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
output_dir
|
str | Path
|
Directory for report output. |
'agentprobe-report'
|
report(run)
async
¶
Write the agent run as a CSV file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
run
|
AgentRun
|
The completed agent run. |
required |