truce-test 0.48.8

Test utilities for truce plugins (render, state, params, GUI snapshots)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

# truce-test

Test harness for truce audio plugins.

## Overview

Helpers for offline rendering, assertion, and validation of truce plugins,
all in-process with no DAW or host simulation needed. Use this crate in
your plugin's integration tests to verify audio output, parameter
behavior, state persistence, and editor lifecycle.

## Entry points

- **`driver!(MyPlugin)`** macro returns a `PluginDriver` builder. Configure
  it (sample rate, block size, MIDI events, parameter overrides, script
  callbacks) and call `.run()` to get back a `DriverResult` with the
  rendered audio, output events, and meter readings.
- **`screenshot!(MyPlugin)`** macro returns a `ScreenshotTest` builder
  for golden-image regression tests on the plugin editor.

## Assertions

Audio-shape assertions live in `truce_test::assertions` and take a
`&DriverResult<P>`:

- `assert_nonzero`, `assert_silence`
- `assert_no_nans`
- `assert_peak_below`
- `assert_silence_after`, `assert_nonzero_after`
- `assert_silence_between`, `assert_nonzero_between`
- `assert_meter_above`, `assert_meter_below`
- `assert_output_event_count`

Whole-plugin contract assertions live at the crate root and take only a
type parameter (the driver is set up internally):

- `assert_state_round_trip`, `assert_corrupt_state_no_crash`,
  `assert_empty_state_no_crash`
- `assert_has_editor`, `assert_editor_lifecycle`,
  `assert_editor_size_consistent`
- `assert_param_defaults_match`, `assert_param_normalized_clamped`,
  `assert_param_normalized_roundtrip`, `assert_param_count_matches`,
  `assert_no_duplicate_param_ids`
- `assert_valid_info`, `assert_au_type_codes_ascii`,
  `assert_fourcc_roundtrip`
- `assert_bus_config_effect`, `assert_bus_config_instrument`

## Usage

```rust
use truce_test::{driver, assertions::*};

#[test]
fn effect_renders_nonzero() {
    let result = driver!(MyEffect).block_size(1024).sample_rate(44_100.0).run();
    assert_no_nans(&result);
    assert_nonzero(&result);
    assert_peak_below(&result, 1.0);
}

#[test]
fn state_round_trips() {
    truce_test::assert_state_round_trip::<MyEffect>();
}
```

Part of [truce](https://github.com/truce-audio/truce).