grpctestify 1.5.0

gRPC testing utility written in Rust
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
68
69
70
71
72
73
74
75
76

# Plugin System

Rust version includes built-in assertion plugins available in `ASSERTS`.

## Available Plugins

- `@header("name")`
- `@has_header("name")`
- `@trailer("name")`
- `@has_trailer("name")`
- `@uuid(value, "v4")`
- `@email(value)`
- `@ip(value, "v4"|"v6")`
- `@url(value, "https")`
- `@timestamp(value, "iso8601"|"rfc3339"|"unix")`
- `@len(value)`
- `@regex(value, pattern)`
- `@empty(value)`
- `@env("NAME")`
- `@elapsed_ms()`
- `@total_elapsed_ms()`
- `@scope_message_count()`
- `@scope_index()`

## Usage

```gctf
--- ASSERTS ---
@has_header("x-request-id")
@uuid(.user.id, "v4")
@email(.user.email)
@len(.items) > 0
```

Timing assertions (`with_asserts=true`):

```gctf
--- RESPONSE with_asserts=true ---
{
  "status": "NOT_SERVING"
}
{
  "status": "SERVING"
}

--- ASSERTS ---
@scope_message_count() == 2
@elapsed_ms() >= 10
@total_elapsed_ms() >= 10
```

`@elapsed_ms()` uses current assertion scope:

- If `RESPONSE` section has one expected message -> elapsed for that single message scope.
- If `RESPONSE` section has multiple expected messages -> elapsed for the whole section batch scope.

## Notes

- External runtime plugin commands are not part of current CLI
- Plugin support is native and loaded by default

## Development

Built-in plugins are implemented as native Rust modules in this repository.

To add a new built-in plugin:

1. Add a plugin module in `src/plugins/`
2. Register it in `src/plugins/mod.rs`
3. Add parser/execution tests for the new behavior
4. Update docs with a usage example

## Related

- [Assertion Reference](../reference/api/assertions.md)
- [Type Validation](../reference/api/type-validation.md)