Skip to content

[Feature] Download all project logs via CLI with a single command #1024

Description

@rquidute

Feature description

ATL survey feedback indicates that users would like to retrieve all logs for a project at once, without having to download each test run execution individually. This feature adds a single CLI command that fetches and packages all logs for a given project.

Problem Statement

Currently, CLI users must know each test run execution ID and run the log command separately for each one:

th-cli test-run-execution log --id <id1>
th-cli test-run-execution log --id <id1> --grouped
th-cli test-run-execution log --id <id2>
th-cli test-run-execution log --id <id2> --grouped
...

For large certification projects with many test cases this is time-consuming and error-prone, especially when preparing submission packages.

Proposed Solution

Add a project logs subcommand to the existing th-cli project command group that downloads all logs for a given project in a single step:

# Download flat logs for all executions
th-cli project logs --id <project-id>

# Download grouped logs (zip per execution, organized by test case state)
th-cli project logs --id <project-id> --grouped

# Specify a custom output directory
th-cli project logs --id <project-id> --output-dir ./my-logs
th-cli project logs --id <project-id> --grouped --output-dir ./my-logs
  • Fetches all test run executions belonging to the project.
  • Downloads the log (flat or grouped zip) for each execution.
  • Saves them into an output directory (defaults to <project-name>-logs/).
  • The CLI iterates over executions and calls the existing backend endpoints:
    • Flat: GET /api/v1/test_run_executions/{id}/log
    • Grouped: GET /api/v1/test_run_executions/{id}/grouped-log

Use Cases

  • ATLs preparing full certification submission packages without manually collecting individual execution logs.
  • Engineers archiving a completed project after a batch test run.

Test Cases

No response

Additional Information

Raised as part of ATL survey feedback (Column K — One Improvement).

Metadata

Metadata

Assignees

Labels

CLIMatter Test Harness CLI Application relatedFeature

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions