Added Documentation

Added Test Cases
Added Comments
This commit is contained in:
Jan-Peter von Hunnius 2025-10-02 18:33:31 +02:00
parent ac25a1caea
commit 5c271b279f
42 changed files with 5279 additions and 52 deletions

43
core/tests/mod.rs Normal file
View file

@ -0,0 +1,43 @@
//! # Poker API Test Suite
//!
//! Comprehensive test suite for the poker hand evaluation library.
//! Tests are organized into logical groups covering different aspects
//! of the poker evaluation system.
//!
//! ## Test Categories
//!
//! - **Unit Tests**: Test individual components and algorithms
//! - **Integration Tests**: Test complete workflows and interactions
//! - **Performance Tests**: Validate speed and memory characteristics
//! - **Regression Tests**: Ensure compatibility with reference implementations
//!
//! ## Running Tests
//!
//! ```bash
//! # Run all tests
//! cargo test
//!
//! # Run specific test categories
//! cargo test api_integration
//! cargo test hand_eval_integration
//!
//! # Run with performance benchmarks
//! cargo test hand_eval_integration_test -- --nocapture
//! ```
//!
//! ## Test Data
//!
//! Tests use both deterministic test cases and randomized inputs to ensure
//! comprehensive coverage of the evaluation space.
/// Helper modules for test utilities and fixtures
mod helpers;
/// Integration tests for the poker API components
mod api_integration_test;
/// Comprehensive hand evaluation integration tests
mod hand_eval_integration_test;
/// Unit tests for individual components and algorithms
mod unit_tests;