grpctestify 1.6.2

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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

# Test File Format

Specification of `.gctf` files for the Rust CLI.

Think of a `.gctf` file as: target + input + expected outcome.

## Minimal Example

```gctf
--- ADDRESS ---
localhost:4770

--- ENDPOINT ---
package.Service/Method

--- REQUEST ---
{
  "id": 1
}

--- ASSERTS ---
.id == 1
```

## Supported Sections

- Core: `META`, `ADDRESS`, `ENDPOINT`, `REQUEST`, `RESPONSE`, `ERROR`, `ASSERTS`
- Supporting: `EXTRACT`, `REQUEST_HEADERS`, `TLS`, `PROTO`, `OPTIONS`

For section details, use [Section Reference](../sections/).

## Execution order

- Preamble sections are read first: `ADDRESS`, `TLS`, `PROTO`, `OPTIONS`, `REQUEST_HEADERS`
- Request/validation flow is processed in-order for each RPC interaction
- Multiple `REQUEST`/`RESPONSE`/`ASSERTS` blocks are allowed depending on RPC pattern

## Validation Rules

- `ENDPOINT` is required
- At least one of `RESPONSE`, `ERROR`, or `ASSERTS` is required
- `RESPONSE` and `ERROR` cannot be used together in one file
- `ADDRESS` may be omitted if `GRPCTESTIFY_ADDRESS` is set
- `META` is optional, but only one is allowed and it must be the first section

## Attributes

Per-section modifiers using `#[name(value)]` syntax:

```gctf
#[timeout(10)]
#[retry(2)]
--- REQUEST ---
{
  "query": "slow search"
}
```

See [Attributes](../sections/attributes) for full reference.

## RESPONSE Inline Options

Inline options use section-header flags and `key=value` pairs:

```gctf
--- RESPONSE with_asserts partial tolerance=0.1 unordered_arrays ---
{
  "status": "ok"
}
```

Supported options for `RESPONSE`:

- `with_asserts` or `with_asserts=true|false`
- `partial` or `partial=true|false`
- `tolerance=<number>`
- `redact=["field1","field2"]`
- `unordered_arrays` or `unordered_arrays=true|false`

`ERROR` supports:

- `with_asserts` or `with_asserts=true|false`
- `partial` or `partial=true|false`

Default `ERROR` matching is strict for top-level fields (`code`, `message`, `details`).
If `details` is not returned by the server, it can be omitted from expected `ERROR`.

## Quick links by section

- [META](../sections/meta)
- [ADDRESS](../sections/address)
- [ENDPOINT](../sections/endpoint)
- [REQUEST](../sections/request)
- [RESPONSE](../sections/response)
- [ERROR](../sections/error)
- [ASSERTS](../sections/asserts)
- [EXTRACT](../sections/extract)
- [REQUEST_HEADERS](../sections/request-headers)
- [TLS](../sections/tls)
- [PROTO](../sections/proto)
- [OPTIONS](../sections/options)
- [Attributes](../sections/attributes)

Related: [Assertions](./assertions), [Plugin System](../../plugins/).