You can test your Guild file by creating an operation that uses
steps to run the operations you’d like to test. Steps support various checks that Guild performs to validate run output.
When testing your operations, it’s a good idea to use flag values to keep run time to a minimum. In some cases you may want to modify your scripts to support flags that indicate “test mode” or “run quickly” mode.
When creating test operations, you can an underscore prefix with the operation name to indicate the operation is private. Private operations are not shown by
guild operations by default. You can see these operations when using the
--all option however.
You can similarly name models using underscore prefixes to indicate they are private.
Consider using the name
_check as a standard naming convention for your check-related operations and models. The
gpkg.hello package uses this pattern. It creates a
_check model that defines various test-related operations.
Alternatively, you can define a separate
_check operation for each model. Guild does not impose any particular scheme for your tests. Tests are simply operations.
gpkg.hello package, you can test the entire package by running:
guild run _check:all
If any of the checks fail, the run will fail. Use this to perform any variety of tests — e.g. a quick “smoke test” or a more thorough end-to-end test.