dandi / dandisets-healthstatus

Healthchecks of dandisets and support libraries (pynwb and matnwb)
0 stars 1 forks source link

Proposal: Store more information about assets & test runs in `status.yaml` #83

Closed jwodder closed 1 month ago

jwodder commented 2 months ago

Proposal: Add the following information about each asset/test to the status.yaml files:

(Compare #82, which proposes recording the same information in files that aren't overwritten.)

This would necessitate restructuring the status.yaml files. One possibility would be to replace the tests and untested fields with a single assets field containing lists of objects with the following fields:

(Note to self: If any of an asset's details change, delete any test records for the old details.)

This would result in each test's assets no longer being grouped by outcome, meaning that linking to blocks of test results from the README will no longer be an option.

However, much of the above information seems worth recording regardless, particularly asset size and test duration, which could be used to analyze our timeout issues. It would also allow for listing assets that haven't had any tests run on them yet.

(Also, while we're modifying the status.yaml schema, I'd like to adjust the last_run, last_run_ended, and last_run_duration fields; it would be cleaner if they were renamed to start, end, & duration and were placed within a sub-mapping with the key last_full_run. The use of "full" in the key name is due to the fact that, currently, these fields are only updated for --mode all runs.)

@yarikoptic: Your thoughts?

yarikoptic commented 1 month ago

let's go with

instead