Test File Format

Specification of .gctf files for the Rust CLI.

Minimal Example

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

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

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

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

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

See also: Assertions, Type Validation.