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

# Assertions

Use `ASSERTS` to validate responses.

## Basic examples

```gctf
--- ASSERTS ---
.status == "ok"
.count > 0
.items | length > 0
.user.email | test("@")
```

## Metadata helpers

```gctf
--- ASSERTS ---
@header("x-request-id") != null
@trailer("x-processing-time") != null
```

## Timing helpers

Timing helpers are available inside `ASSERTS` and are most useful with `RESPONSE 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()` - elapsed for current assertion scope.
- `@total_elapsed_ms()` - cumulative elapsed across completed assertion scopes.
- `@scope_message_count()` - number of response messages in current scope.
- `@scope_index()` - current scope index (1-based).

Scope behavior:

- Single message in `RESPONSE` section -> single-message scope.
- Multiple messages in one `RESPONSE` section -> batch scope for the whole section.

## Type helpers

```gctf
--- ASSERTS ---
@uuid(.user.id, "v4")
@email(.user.email)
@url(.profile.website, "https")
@ip(.client_ip, "v4")
@timestamp(.created_at, "rfc3339")
```

## Notes

- `ASSERTS` can be used alone or together with `RESPONSE with_asserts=true`
- For unary tests, prefer either strict `RESPONSE` matching or `ASSERTS`

## Preferred style

- Use boolean plugin calls directly: `@has_header("x-id")` instead of `@has_header("x-id") == true`
- Use negation for false checks: `!@has_trailer("grpc-status-details-bin")`
- Use canonical operators: `startsWith` and `endsWith`