grpctestify 1.4.8

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
105
106
107

# Test File Format

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

## Minimal Example

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

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

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

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

## Supported Sections

- `ADDRESS` - server address (`host:port`)
- `ENDPOINT` - gRPC method (`package.Service/Method`)
- `REQUEST` - JSON payload (multiple allowed)
- `RESPONSE` - expected JSON (multiple allowed)
- `ERROR` - expected error JSON/string
- `ASSERTS` - assertion expressions (multiple allowed)
- `EXTRACT` - variable extraction rules (multiple allowed)
- `REQUEST_HEADERS` (or `HEADERS`) - request metadata
- `TLS` - TLS/mTLS config
- `PROTO` - descriptor/reflection configuration
- `OPTIONS` - parsed, validated, and applied for per-test runtime overrides (`timeout`, `retry`, `retry-delay`, `no-retry`)

## 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

## RESPONSE Inline Options

Inline options use `key=value` in the section header:

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

Supported options for `RESPONSE`:

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

`ERROR` supports only `with_asserts=true|false`.

## TLS Section

```gctf
--- TLS ---
ca_cert: ./certs/ca.pem
cert: ./certs/client.pem
key: ./certs/client-key.pem
server_name: api.example.com
insecure: false
```

Supported keys include:

- `ca_cert` or `ca_file`
- `cert`, `client_cert`, or `cert_file`
- `key`, `client_key`, or `key_file`
- `server_name`
- `insecure`

## PROTO Section

```gctf
--- PROTO ---
descriptor: ./descriptors/api.desc
```

Notes:

- Native mode supports `descriptor=<path>` and server reflection
- `PROTO files=...` is currently not supported in native mode

## Assertion Plugins

Examples of built-in plugins:

```gctf
--- ASSERTS ---
@header("x-request-id") != null
@uuid(.user.id, "v4")
@email(.user.email)
```

See also: [Assertions](./assertions.md), [Type Validation](./type-validation.md).