Reference¶
Authoritative descriptions of every public interface in utest. Each page documents a distinct layer of the framework.
| Page | Description |
|---|---|
| Glossary | Definitions of every term used in this documentation: test, suite, bundle, mock, shim, proxy, layer, behavior override, strict mode, worker, coordinator. |
| CLI and Configuration | Command-line flags, utest.config.uc format, and all recognised configuration keys including the mocks declaration. |
| DSL | All suite-structure and hook functions importable from 'utest': describe, it, skip, xit, xdescribe, beforeEach, afterEach, setup, and teardown. |
| Assertions | Every assertion on the assert object, plus the combinator factories (equals, contains, truthy, falsy, not, pred, regex, any, any_order, starts_with, ends_with, has_length, between, is_type). All imported from 'utest'. |
| Property-based testing | The prop DSL, forall engine, and the gen generator factories. |
| Mock API | The mock object and spy() function from 'utest': scoped injection, global patch/unpatch, snapshot, restore, and call inspection. |
| Proxy Data Models | The data key format accepted by each built-in proxy: fs, uci, ubus, uloop, and uclient. |
Internals¶
Authoritative description of internal protocols and APIs for framework contributors.
| Page | Description |
|---|---|
| Source layout | Map of the repository structure and the role of each source file. |
| Message protocol | Format of JSON messages exchanged between workers and the coordinator. |
| Proxy context API | Registry operations and data-access helpers available to proxy factories. |
| Reporter API | Hook signatures and state data models for implementing custom output formats. |