操作
リファクタ #178
完了
Smoke / experimental 検証コードを保守対象として整理する
リファクタ #178:
Smoke / experimental 検証コードを保守対象として整理する
説明
Redmine #165 のコードベースレビューとユーザー確認からの派生タスクです。
背景¶
*Smoke.java や experimental パッケージは検証で使用するため削除せず、保守対象として残す方針になりました。一方で通常テストとの境界や実行方法が分かりにくい状態です。
対応内容¶
-
PortAudio*Smoke、Lwjgl3*Smoke、Ffm*Smoke、experimentalパッケージの用途を整理する。 - Gradle タスクから使われる検証コードと通常 unit test の境界を明確にする。
- 必要に応じて README、docs、またはコードコメントで実行方法・前提条件を明記する。
- 通常の
./gradlew.bat testで環境依存の検証が誤って走らないことを確認する。
確認観点¶
- 検証用途の入口が保守者に分かること。
- ネイティブ依存やデバイス依存の失敗が通常テストに混入しないこと。
- 削除候補と誤認されにくい状態になること。
いづ さん さんが25日前に更新
- 関連している リファクタ #165: コードベースの棚卸 を追加
エージェント ちゃん さんが7日前に更新
- ステータス を 未着手 から 実装中 に変更
- 進捗率 を 0 から 10 に変更
実装に着手しました。
- ブランチ:
feature/178 - 対応方針: 検証用
*Smoke(Gradleverify*タスク用 main エントリ)を*Verificationへリネームして JUnit スモークテストと名前で区別し、各クラス・Gradle タスクに用途/前提/実行方法のコメントを付与。さらに検証コード全体(検証エントリ/JUnit スモーク/experimentalの@DisabledPoC)の地図となるdocs/verification.mdを新設し、README・関連 docs から参照する。
エージェント ちゃん さんが7日前に更新
- ステータス を 実装中 から 完了 に変更
- 進捗率 を 10 から 100 に変更
対応が完了しました。
概要¶
検証コードが性質の異なる3種類「Smoke」名で混在し境界が分かりにくかった問題を、命名規約とドキュメントで整理。削除候補と誤認されにくく、保守者に用途が分かる状態にした（ロジック変更・ソースセット分離はなし）。
変更点¶
-
A群（Gradle
verify*タスク用 main エントリ）をリネーム:PortAudioDevicesSmoke/PortAudioPlaybackSmoke/Lwjgl3BackendSmoke/FfmFfmpegDecoderSmoke→ それぞれ*Verification。本文ロジックは無変更。build.gradleの4タスクのmainClassも更新。 - A群各クラスに Javadoc（用途・非JUnit・実行タスク名・引数/前提・保守対象）を付与。
verify*タスクに「手動/ローカル検証用でtestには含まれない」コメントを追加。 -
B群（
testで常時走る JUnit スモーク）:LauncherFxmlLoadSmokeTest/SQLiteDependencySmokeTestに「A群とは別物」のクラスコメントを追加（リネームなし）。 -
C群（
experimentalの@DisabledPoC）:package-info.javaを新設、FfmApiSmokeTestに docs 参照コメントを追加。 -
ドキュメント: 新規
docs/verification.md（A/B/C 3層の地図・検証エントリ一覧表・命名規約*SmokeTestvs*Verification・通常testに環境依存が混入しない保証）。README.md/docs/audio-testing.md/docs/codebase-overview.mdをクラス名整合・クロスリンク更新。 - 変更ファイル: リネーム4・新規3（
docs/verification.md,experimental/package-info.javaほか）・更新7、計16件。
テスト¶
-
.\gradlew.bat test: 成功（BUILD SUCCESSFUL、全スイート通過） - net-new テスト追加なし（機械的リネーム＋コメント＋ドキュメントのみ＝TDD例外）
関連 MR¶
- !133 (feature/178 → develop)
操作