Progress, Statuses, and Completion Values

[jamiebuilds]

A couple things:

• Right now there is no way to report that something has "failed" but is still running (ex: a single test failed, but we're running the rest to see what happens)
• There is no way to report progress, TAP has test plans, but we could do more.
• Completion "events" are confusing:
  • More than one: "passed", "failed"
  • Is "skipped" a completion event? (i.e. can a "started" entity later become "skipped"
  • Should there be more events for completion states like "errored"?

idea:

Here is a vague idea of what we could do: (Note: I don't like this very much atm)

// init state:
{ id: "0",   kind: "item",  event: "started",   status: "running" }

// child success:
{ id: "0.0", kind: "check", event: "started",   status: "running" }
{ id: "0.0", kind: "check", event: "completed", status: "passed"  }

// child fail:
{ id: "0.1", kind: "check", event: "started",   status: "running" }
{ id: "0.1", kind: "check", event: "completed", status: "failed"  }

// notify state change of parent:
{ id: "0",   kind: "item",  event: "progress",  status: "failed"  }

// child success:
{ id: "0.2", kind: "check", event: "started",   status: "running" }
{ id: "0.2", kind: "check", event: "completed", status: "passed"  }

// child errored:
{ id: "0.3", kind: "check", event: "started",   status: "running" }
{ id: "0.3", kind: "check", event: "completed", status: "errored" }

// final state:
{ id: "0",   kind: "item",  event: "completed", status: "failed"  }

There would be 3 "event"'s:

• "started"
• "progress"
• "completed"

There would be 4 "status"'s:

• "running"
• "passed"
• "failed"
• "skipped"
• "errored"

---

We could also add a progress field:

{ ... kind: "group", event: "started", progress: { completed: 4, planned: 20 } ... }