reinhardt-test

Testing utilities and test client for the Reinhardt framework

Overview

Comprehensive testing utilities inspired by Django REST Framework's test utilities. This crate provides reusable testing tools including APIClient for making test requests, test case base classes, database fixtures, mock utilities, and TestContainers integration for infrastructure testing.

Supports both unit testing and integration testing with real or test databases.

Installation

Add reinhardt to your Cargo.toml:

[dependencies]
reinhardt = { version = "0.1.0-alpha.1", features = ["test"] }

# Or use a preset:
# reinhardt = { version = "0.1.0-alpha.1", features = ["standard"] }  # Recommended
# reinhardt = { version = "0.1.0-alpha.1", features = ["full"] }      # All features

Then import testing features:

use reinhardt::test::{APIClient, APITestCase, TestResponse};
use reinhardt::test::{FixtureLoader, Factory, MockFunction};

Note: Testing features are included in the standard and full feature presets.

Features

Implemented ✓

API Testing Client

• APIClient: HTTP test client with authentication support
  • HTTP methods: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS
  • Authentication: Force authentication, Basic auth, login/logout
  • Request customization: Headers, cookies, base URL configuration
  • Flexible serialization: JSON and form-encoded data support
• APIRequestFactory: Factory for creating test requests
  • Request builders for all HTTP methods
  • JSON and form data serialization
  • Header and query parameter management
  • Force authentication support

Response Testing

• TestResponse: Response wrapper with assertion helpers
  • Status code assertions: assert_ok(), assert_created(), assert_not_found(), etc.
  • Status range checks: assert_success(), assert_client_error(), assert_server_error()
  • Body parsing: JSON deserialization, text extraction
  • Header access and content type checking

Test Case Base Classes

• APITestCase: Base test case with common setup/teardown
  • Pre-configured APIClient instance
  • Setup and teardown lifecycle hooks
  • Optional TestContainers database integration
• Test macros: Convenience macros for defining test cases
  • test_case!: Standard test case definition
  • authenticated_test_case!: Pre-authenticated test cases
  • test_case_with_db!: Database-backed test cases (requires testcontainers feature)

Fixtures and Factories

• FixtureLoader: JSON-based test data loader
  • Load fixtures from JSON strings
  • Type-safe deserialization
  • Fixture existence checking and listing
• Factory trait: Test data generation
  • Factory<T> trait for creating test objects
  • FactoryBuilder: Simple factory implementation
  • Batch data generation support

Mock and Spy Utilities

• MockFunction: Function call tracking with configurable return values
  • Return value queuing and default values
  • Call count and argument tracking
  • Conditional assertions: was_called(), was_called_with()
• Spy: Method call tracking with optional wrapped objects
  • Call recording with timestamps
  • Argument verification
  • Reset and inspection capabilities

Message Testing (Django-style)

• Message assertions: Test message framework integration
  • assert_message_count(): Verify message count
  • assert_message_exists(): Check for specific messages
  • assert_message_level(): Verify message levels
  • assert_message_tags(): Check message tags
  • assert_messages(): Ordered and unordered message verification
• MessagesTestMixin: Test mixin for message testing utilities
  • Stack trace filtering for cleaner test output
  • Tag-based message assertions

JSON Assertions

• JSON field assertions:
  • assert_json_field_eq(): Field value equality
  • assert_json_has_field(): Field presence
  • assert_json_missing_field(): Field absence
• JSON array assertions:
  • assert_json_array_len(): Array length verification
  • assert_json_array_empty() / assert_json_array_not_empty(): Empty state checks
  • assert_json_array_contains(): Element presence
• JSON pattern matching:
  • assert_json_matches(): Subset matching for complex structures

HTTP Assertions

• Status code assertions:
  • assert_status_eq(): Exact status code matching
  • assert_status_success(): 2xx range verification
  • assert_status_client_error(): 4xx range verification
  • assert_status_server_error(): 5xx range verification
  • assert_status_redirect(): 3xx range verification
  • assert_status_error(): 4xx or 5xx verification
• Content assertions:
  • assert_contains(): Text substring presence
  • assert_not_contains(): Text substring absence

Debug Toolbar

• DebugToolbar: Request/response debugging utilities
  • Timing information tracking (total time, SQL time, cache hits/misses)
  • SQL query recording with duration and stack traces
  • Custom debug panels with various entry types (key-value, table, code, text)
  • HTML rendering for debug output
  • Enable/disable debugging support

TestContainers Integration (optional, requires testcontainers feature)

• Database containers:
  • PostgresContainer: PostgreSQL test container with custom credentials
  • MySqlContainer: MySQL test container with custom credentials
  • RedisContainer: Redis test container
• TestDatabase trait: Common interface for database containers
  • Connection URL generation
  • Database type identification
  • Readiness checking
• Helper functions:
  • with_postgres(): Run tests with PostgreSQL container
  • with_mysql(): Run tests with MySQL container
  • with_redis(): Run tests with Redis container