Guides

Welcome to the gRPC Testify guides! This comprehensive documentation will help you master gRPC testing from basics to advanced patterns.

🚀 Getting Started

Start your journey with these fundamental guides:

• Installation Guide - Set up gRPC Testify on your system
• Your First Test - Write and run your first gRPC test
• Basic Concepts - Understand core gRPC testing principles

🎯 Testing Patterns

gRPC supports four main communication patterns. Each requires different testing approaches:

Unary RPC (Request-Response)

• Pattern: One request → One response
• Use Case: Simple operations like CRUD, data retrieval
• Testing: Validate single request/response pair
• Testing Patterns - Universal testing principles

Server Streaming (One-to-Many)

• Pattern: One request → Multiple responses
• Use Case: Real-time data, monitoring, live feeds
• Testing: Validate stream of responses from single request
• Coming soon: Server Streaming Testing

Client Streaming (Many-to-One)

• Pattern: Multiple requests → One response
• Use Case: File uploads, batch operations, data collection
• Testing: Validate multiple requests result in single response
• Coming soon: Client Streaming Testing

Bidirectional Streaming (Many-to-Many)

• Pattern: Multiple requests ↔ Multiple responses
• Use Case: Chat applications, real-time collaboration
• Testing: Validate complex request/response sequences
• Coming soon: Bidirectional Streaming Testing

🔧 Advanced Features

• Parallel Execution - Run tests concurrently
• Plugin System - Extend functionality with custom plugins
• Performance Testing - Optimize test execution

🏗️ Real-World Examples

• Real-time Chat Testing - Messaging patterns and real-time communication

🔒 Security Testing

• Security Testing Patterns - Authentication, TLS, and access control

📊 Reporting & Monitoring

• Report Formats - JUnit XML and JSON output formats

🛠️ Troubleshooting

• Common Issues - Solutions to frequent problems
• Debug Techniques - Advanced debugging methods
• Performance Optimization - Speed up your tests

Learning Path

We recommend following this learning path:

1. Start with Installation → Get gRPC Testify running
2. Write Your First Test → Understand basic concepts
3. Master Unary Testing → Learn the foundation
4. Explore Advanced Patterns → Handle complex scenarios
5. Integrate with CI/CD → Automate your testing
6. Optimize Performance → Scale your test suite

Ready to begin? Start with the Installation Guide!