Testing

Guidelines

This document attempts to capture guidelines and expectations for testing in swift-apis.

Coverage

All public functionality should be tested to ensure correct behavior is maintained over time.

Focused, orthogonal tests

Unit tests should be written such that they test the expected functionality and to minimize additional dependencies. This helps guide maintainers as to the likely cause of the regression, and in practice ensures tests are reliable (not flaky).

Fast tests

In order to keep development velocity high, aim for tests to take no more than a second or two, and ideally take only a few milliseconds.

Performance

While performance is extremely important, for now we do not have effective infrastructure for benchmarking. Stay tuned for updates!