Fox Documentation¶
Everything about Fox, the property-based testing tool for Objective-C and Swift.
Besides this documentation, you can also view the source on GitHub.
Getting Started¶
New to Fox? Or just wanting to have a taste of it? Start here.
- Overview - What is Fox? How is it different from other unit testing frameworks?
- Installing Fox - How to get set up to use Fox.
- Basic Tutorial - Get a feel for using Fox.
Generators¶
Generators are semi-random data producers that are the core to Fox’s capabilities. Follow the links below to learn more in detail.
- Overview - What are generators?
- Built-in Generators Reference - What generators does fox provide?
- Building Custom Generators - How do you build your own generators?
- Writing Generators with Custom Shrinking - How do you customize how generators shrink values it generates?
The Runner¶
All the guts around configuring and executing Fox’s verification of properties.
- Overview - How Fox runs properties and generators.
- Configuring Test Generation - How to customize how Fox generates tests.
- Random Number Generators - The abstraction Fox uses to control random number generation.
- Reporters - The abstraction Fox uses to report test results.
Parallel Testing¶
Warning
This section and its API is ALPHA and is subject to change. Alpha APIs are not under semantic versioning and can change freely between versions.
How to use Fox to test stateful code that executes in parallel (across multiple threads). This does not encompass async testing.
- Installing the Foxling Compiler - How to install Fox’s Compiler for parallel testing.
- Parallel Testing Tutorial - A run-through of parallel testing in Fox.
- Fox’s Thread Scheduler - Technical details of Fox’s cooperative threads runtime.
- Foxling Compiler - Technical details of Fox’s cooperative threads compiler.