cds-ai/atvm/docs/automation/status-template.md

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 | Kernel | Status | Detail |
|---|---|---|---|
| <host-name> | <kernel-version or unknown> | ✅ PASS | completed |
| <host-name> | <kernel-version or unknown> | ⚠️ FAIL | <useful failure description> |
| <host-name> | <kernel-version or unknown> | ⏳ RUN | in progress |
| <host-name> | <kernel-version or unknown> | ⏭️ 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:, and NOTES: in that order.
• Use the title format:
  • ## ATVM Run Status
  • ### <build_name>
• Use flat bullet lists for COVERAGE: and FUNCTIONALLY:.
• Use Markdown tables for SUMMARY:, HOSTS:, and TIMING:.
• Use one host per row in the HOSTS: section.
• Include a Kernel column immediately after Host in the HOSTS: table.
• For completed hosts, prefer:
  • ✅ PASS
  • ⚠️ FAIL
• For in-progress or skipped hosts, use:
  • ⏳ RUN
  • ⏭️ SKIP
• Keep Detail concise.
• 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.
• Resolve kernel values by cross-referencing hostnames against /home/aw/code/cds/atvm/inventory/vm-inventory.md.
• If no kernel value can be verified from vm-inventory.md, use unknown.
• Use the same template for Mattermost and local operator-visible status output.