Add comprehensive detailed design documents
This commit is contained in:
95
src-python/docs/details/backend_test.md
Normal file
95
src-python/docs/details/backend_test.md
Normal file
@@ -0,0 +1,95 @@
|
||||
# backend_test.py - APIエンドポイントテストモジュール
|
||||
|
||||
## 概要
|
||||
VRCTアプリケーションのAPIエンドポイントを包括的にテストするためのモジュールです。メインループの各種機能をランダムアクセスでテストし、システムの安定性と堅牢性を検証します。
|
||||
|
||||
## 主要機能
|
||||
|
||||
### Color クラス
|
||||
- ANSIエスケープシーケンスを使用したコンソール出力色彩管理
|
||||
- テスト結果の視覚的表示(成功・失敗・スキップ等)
|
||||
|
||||
### TestMainloop クラス
|
||||
- APIエンドポイントの包括的テスト実行
|
||||
- ランダムアクセステスト
|
||||
- テスト結果の記録・分析
|
||||
- VRCTメインループとの統合テスト
|
||||
|
||||
## 主要メソッド
|
||||
|
||||
### テスト実行メソッド
|
||||
- `test_endpoints_on_off_all()`: ON/OFF系エンドポイントの全テスト
|
||||
- `test_set_data_endpoints_all()`: データ設定系エンドポイントの全テスト
|
||||
- `test_run_endpoints_all()`: 実行系エンドポイントの全テスト
|
||||
- `test_endpoints_all_random()`: 全エンドポイントのランダムアクセステスト
|
||||
|
||||
### 特定機能テスト
|
||||
- `test_translate_all_language_pairs()`: 全言語ペアでの翻訳テスト
|
||||
- `test_endpoints_on_off_continuous()`: ON/OFF連続切り替えテスト
|
||||
- `test_endpoints_specific_random()`: 特定エンドポイントのランダムテスト
|
||||
|
||||
### 結果分析
|
||||
- `generate_summary()`: テスト結果のサマリー生成
|
||||
- `record_test_result()`: テスト結果の記録
|
||||
|
||||
## 使用方法
|
||||
|
||||
### 基本的な使い方
|
||||
```python
|
||||
# テストインスタンスを作成
|
||||
test = TestMainloop()
|
||||
|
||||
# 各種テストを実行
|
||||
test.test_endpoints_on_off_all()
|
||||
test.test_set_data_endpoints_all()
|
||||
test.test_run_endpoints_all()
|
||||
|
||||
# テスト結果のサマリー表示
|
||||
test.generate_summary()
|
||||
```
|
||||
|
||||
### ランダムテストの実行
|
||||
```python
|
||||
# 全エンドポイントのランダムアクセステスト
|
||||
test.test_endpoints_all_random()
|
||||
|
||||
# 特定エンドポイントのランダムテスト
|
||||
test.test_endpoints_specific_random()
|
||||
```
|
||||
|
||||
## 依存関係
|
||||
- `mainloop`: VRCTメインループモジュール
|
||||
- `random`: ランダムテストデータ生成
|
||||
- `time`: テスト間隔制御
|
||||
|
||||
## テスト対象エンドポイント
|
||||
|
||||
### 制御系
|
||||
- `/set/enable/*`: 機能有効化
|
||||
- `/set/disable/*`: 機能無効化
|
||||
|
||||
### データ設定系
|
||||
- `/set/data/*`: 各種設定データの更新
|
||||
|
||||
### 実行系
|
||||
- `/run/*`: 各種機能の実行
|
||||
|
||||
### データ削除系
|
||||
- `/delete/data/*`: データの削除
|
||||
|
||||
## 注意事項
|
||||
- テスト実行前に`config.json`を削除して初期化
|
||||
- 重いAIモデルを使用するテストは実行時間に注意
|
||||
- ランダムテストは指定回数(デフォルト1000-10000回)実行される
|
||||
- テスト終了時は自動的にすべての機能を無効化する
|
||||
|
||||
## エラーハンドリング
|
||||
- 各テストは独立して実行され、一つの失敗が全体に影響しない
|
||||
- 期待されるステータスコードと実際の結果を比較
|
||||
- VRAM不足等のリソースエラーも適切にハンドリング
|
||||
|
||||
## テスト結果の分類
|
||||
- **PASS**: 期待されるステータスコードと一致
|
||||
- **ERROR**: 期待されるステータスコードと不一致
|
||||
- **SKIP**: テスト実行不可(401ステータス)
|
||||
- **Invalid**: 無効なエンドポイント(404ステータス)
|
||||
Reference in New Issue
Block a user