Time resources

Runtime

Test runtimes are written to .canary/cache/cases. This cache is automatically created when a session is run and can be ignored from source control. However, if the timing cache is kept and updated, the data contained therein can aid in speeding up test runs.

Timeout

A test case’s timeout can be set by the timeout directive. For example, to set a tests timeout to 5 minutes add the following the test file:

import canary
canary.directives.timeout(5 * 60)

If the timeout is not explicitly set, it is set based on the presence of the fast and long keywords in a manner similar to vvtest:

• If a test is marked fast, its timeout defaults to 30 seconds.

• If a test is marked long, its timeout defaults to 10 minutes.

• Otherwise the timeout is 5 minutes.

These values are configurable in the test:timeout configuration setting:

test:
  timeout:
    fast = 30s
    long = 10m
    default = 5m

which can also be set from the command line, eg:

canary -c test:timeout:fast:60s ...

Timeout multiplier

You may also want to increase the timeout applied to tests. Do so by specifying --timeout multiplier=X option:

canary run --timeout multiplier=4 ...

In this case, the timeout for each test will be the 4 times the test’s default timeout.