hive icon indicating copy to clipboard operation
hive copied to clipboard

[Feature Request] Customizable output file name for hive results

Open raxhvl opened this issue 4 months ago • 2 comments

Problem

I'm working on a downstream tool that needs to read the results of a hive simulation. Currently, Hive generates test result files with arbitrary, timestamp-based names (e.g., 1756204700-67af2edb7fbce5f0104bde48cd4f87df.json). This makes it difficult to predictably consume results in downstream systems and CI/CD pipelines.

Proposed solution

Add a CLI flag like --results-filename to allow users to specify a custom name for the results JSON file.

Benefits

  1. Predictable Integration: Downstream tools can reliably locate and parse results without scanning directories or implementing filename discovery logic
  2. CI/CD Friendly: Enables clean pipeline chaining where one step runs Hive tests and subsequent steps process results using a known filename

Current workaround

Projects must implement directory scanning to find files with hyphens in the name, excluding hive.json - this is error-prone and adds unnecessary complexity.

Backward compatibility

The feature would be optional, maintaining current behavior when no custom name is specified.

raxhvl avatar Aug 26 '25 11:08 raxhvl

You can have a dedicated folder for each run. I'm for example using it with this parameter: --results-root results/$(date -Iseconds) , but of course you can use any other pattern, like a counter or external ID similarly.

This makes it easy to parse the files, as you will only have one file of each type in the selected directory. You can just use a wildcard and read the file.

cskiraly avatar Aug 28 '25 22:08 cskiraly

One issue with specifying a single output file is that a simulator can produce multiple results, as it can run multiple test suites.

fjl avatar Aug 29 '25 17:08 fjl