API Reference

Complete reference documentation for gRPC Testify.

Overview

gRPC Testify provides a comprehensive testing framework for gRPC services using configuration files. This section documents all available features, syntax, and configuration options.

Reference Sections

Command Line Interface

Complete documentation of all command-line options, flags, and usage patterns.

Test File Format

Detailed specification of the .gctf test file format, including all sections and syntax.

Assertions & Validation

Comprehensive guide to assertion syntax, jq expressions, and validation patterns.

Plugin System

Documentation for the extensible plugin system and custom assertion development.

Report Formats

Complete guide to output formats: console and JUnit XML reports.

Type Validation

Advanced type validators for UUID, timestamps, URLs, emails, and more specialized data types.

Plugin Development

Official guide for developing custom plugins using the Plugin API.

Quick Reference

Basic Test File Structure

php

--- ADDRESS ---
localhost:4770

--- ENDPOINT ---
service.Method

--- REQUEST ---
{
  "field": "value"
}

--- RESPONSE ---
{
  "result": "*"
}

--- ASSERTS ---
.result | length > 0

Common Command Usage

bash

# Run single test
./grpctestify.sh test.gctf

# Run all tests in directory
./grpctestify.sh tests/

# Run with options
./grpctestify.sh --parallel 4 --verbose tests/

API Reference ​

Overview ​

Reference Sections ​

Command Line Interface ​

Test File Format ​

Assertions & Validation ​

Plugin System ​

Report Formats ​

Type Validation ​

Plugin Development ​

Quick Reference ​

Basic Test File Structure ​

Common Command Usage ​

See Also ​