- update the ATVM status template to include COVERAGE: and FUNCTIONALLY: sections ahead of the existing summary tables - document that COVERAGE: should describe intended run scope without listing target hosts - document that FUNCTIONALLY: should summarize the intended workflow steps at a high level - align the ATVM automation guide so local status output and Mattermost posts use the expanded default format
2.0 KiB
2.0 KiB
ATVM Status Template
Use this as the default ATVM automation run-status template for:
- local status responses in the terminal
- Mattermost status posts after a completed run
Layout
## ATVM Run Status
### <build_name>
**COVERAGE:**
- template: `<template-name>`
- datastore/config family: `<config family>`
- migration style: `<high-level test style>`
- integration/plugin path: `<integration/plugin>`
- scope of this run: `<batch or run scope>`
**FUNCTIONALLY:**
- <intended functional step>
- <intended functional step>
- <intended functional step>
**SUMMARY:**
| Metric | Value |
|---|---:|
| finished | <n> |
| passed | <n> |
| failed | <n> |
| skipped | <n> |
**HOSTS:**
| Host | Status | Detail |
|---|---|---|
| <host-name> | ✅ PASS | completed |
| <host-name> | ⚠️ FAIL | <useful failure description> |
| <host-name> | ⏳ RUN | in progress |
| <host-name> | ⏭️ SKIP | <skip reason> |
**TIMING:**
| Metric | Value |
|---|---|
| start | <start time> |
| end | <end time or n/a> |
| total | <total or elapsed runtime> |
| quickest | <host> - <runtime> or n/a |
| longest | <host> - <runtime> or n/a |
| average | <runtime> or n/a |
**NOTES:**
- <note>
- <note>
Rules
- Keep
COVERAGE:,FUNCTIONALLY:,SUMMARY:,HOSTS:,TIMING:, andNOTES:in that order. - Use the title format:
## ATVM Run Status### <build_name>
- Use flat bullet lists for
COVERAGE:andFUNCTIONALLY:. - Use Markdown tables for
SUMMARY:,HOSTS:, andTIMING:. - Use one host per row in the
HOSTS:section. - For completed hosts, prefer:
✅ PASS⚠️ FAIL
- For in-progress or skipped hosts, use:
⏳ RUN⏭️ SKIP
- Keep
Detailconcise. - Put broader context under
NOTES:, not in the host table. COVERAGE:should describe what the run was intended to cover without listing target hosts.FUNCTIONALLY:should describe the intended workflow steps at a high level, even if the run failed before completing them.- Use the same template for Mattermost and local operator-visible status output.