grpctestify 1.8.6

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
77
78
79
80

# Plugin System

Built-in assertion plugins available in `ASSERTS`.

## Validation plugins

| Plugin | Checks | Returns |
| --- | --- | --- |
| `@is_uuid(value)` | valid UUID format | bool |
| `@is_email(value)` | valid email address | bool |
| `@is_ip(value)` | valid IP address (v4/v6) | bool |
| `@is_url(value)` | valid URL | bool |
| `@is_timestamp(value)` | valid timestamp | bool |
| `@is_base64(value)` | valid base64 string | bool |
| `@is_json(value)` | valid JSON string | bool |

## State plugins

| Plugin | Checks | Returns |
| --- | --- | --- |
| `@is_empty(value)` | value is null/empty string/empty array/empty object | bool |
| `@has_value(value)` | value is non-null and non-empty | bool |

## Metadata plugins

| Plugin | Returns |
| --- | --- |
| `@header("name")` | header value (string or null) |
| `@has_header("name")` | bool |
| `@trailer("name")` | trailer value (string or null) |
| `@has_trailer("name")` | bool |

## Utility plugins

| Plugin | Returns |
| --- | --- |
| `@len(value)` | non-negative integer |
| `@regex(value, pattern)` | bool |
| `@env("NAME")` | environment variable value (string or null) |

## Timing plugins

| Plugin | Returns |
| --- | --- |
| `@elapsed_ms()` | non-negative integer |
| `@total_elapsed_ms()` | non-negative integer |
| `@scope.message_count()` | non-negative integer |
| `@scope.index()` | non-negative integer |

## Type methods (`@type.method`)

Extract parts from typed values:

| Method | Returns | Example |
| --- | --- | --- |
| `@url.scheme(url)` | `:string` | `"https"` |
| `@url.host(url)` | `:string` | `"example.com"` |
| `@url.port(url)` | `:string` | `"443"` |
| `@url.path(url)` | `:string` | `"/api/v1"` |
| `@url.query(url)` | `:string` | `"?page=1"` |
| `@url.fragment(url)` | `:string` | `"section"` |
| `@email.local_part(email)` | `:string` | `"user"` |
| `@email.domain(email)` | `:string` | `"example.com"` |
| `@ip.version(ip)` | `:uint` | `4` or `6` |
| `@uuid.version(uuid)` | `:uint` | `4` |
| `@json.key(json, "key")` | `:any` | extracted value |

## Quick choice

- Metadata checks: `@header`, `@trailer`, `@has_header`, `@has_trailer`
- Format checks: `@is_uuid`, `@is_email`, `@is_url`, `@is_ip`, `@is_timestamp`, `@is_base64`, `@is_json`
- State checks: `@is_empty`, `@has_value`
- Type methods: `@url.*`, `@email.*`, `@json.*`
- Utility checks: `@len`, `@regex`, `@env`
- Timing checks: `@elapsed_ms`, `@total_elapsed_ms`, `@scope.message_count`, `@scope.index`

## Related

- [Assertion Reference](../reference/api/assertions)
- [ASSERTS section](../reference/sections/asserts)