Documentation
¶
Overview ¶
dolphin is octo's companion test runner: it drives the real octo CLI against an integration and checks what comes back, so a flow can have a test suite the way any other unit of code does.
A flow file is tested by the suite beside it, as a Go file is — orders.yaml by orders_test.yaml — and each case in it is one `octo invoke`, run with the mocks and spies the case asked for. main is the command shell; the work is in internal/suite (what a suite is), internal/runner (running one), and internal/assert (judging it).
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
assert
Package assert decides whether a flow did what a case said it would, and says what was wrong when it did not.
|
Package assert decides whether a flow did what a case said it would, and says what was wrong when it did not. |
|
report
Package report renders what a run did — to a terminal, and to the JUnit XML a CI job reads.
|
Package report renders what a run did — to a terminal, and to the JUnit XML a CI job reads. |
|
runner
Package runner runs a case against octo and says what came back.
|
Package runner runs a case against octo and says what came back. |
|
suite
Package suite is what a _test.yaml is: the format, its validation, and the rules for pairing a suite with the flows it exercises.
|
Package suite is what a _test.yaml is: the format, its validation, and the rules for pairing a suite with the flows it exercises. |
Click to show internal directories.
Click to hide internal directories.