Merge pull request #15 from drag0sd0g/copilot/add-pit-mutation-testing

Add PIT mutation testing with enforced thresholds

Author: drag0sd0g

.gitignore

@@ -2,6 +2,7 @@
 .idea
 build
 data-server
+data-server-test
 *.class
 *.log
 *.jar

README.ja.md

@@ -32,7 +32,7 @@ Quarkus と Java 21 で構築された、モダンでコンテナ化されたフ
 - 📊 **オブザーバビリティ**: Prometheus メトリクスと構造化ログ
 - 🔒 **セキュリティ**: CodeQL スキャンと Dependabot による依存関係更新
 - ✅ **品質管理**: Checkstyle、PMD、SpotBugs による静的解析
-- 🧪 **テスト済み**: 80% コードカバレッジ + 包括的な統合テスト
+- 🧪 **テスト済み**: 70% コードカバレッジ + 包括的な統合テスト + PIT ミューテーションテスト
 - 📖 **API ドキュメント**: OpenAPI/Swagger UI 同梱
 - 🌐 **REST API**: シンプルで分かりやすいファイルストレージ API
 
@@ -300,8 +300,12 @@ docker-compose logs -f
 
 - **ユニットテスト**: JUnit 5 + Mockito
 - **統合テスト**: Testcontainers + Docker Compose
-- **コードカバレッジ**: Jacoco レポート、80% 閾値設定
+- **コードカバレッジ**: Jacoco レポート、70% 閾値設定
   - テストレポートは _build/jacocoHtml/index.html_ に出力
+- **ミューテーションテスト**: PIT (PITest) による強制的な閾値設定
+  - クライアント: 40% ミューテーションスコア閾値
+  - サーバー: 70% ミューテーションスコア閾値
+  - レポートは _build/reports/pitest/index.html_ に出力
 - **継続的インテグレーション**: GitHub Actions による自動テスト
 
 全てのテストを実行：
@@ -317,6 +321,16 @@ docker-compose logs -f
 # カバレッジレポートを表示: file-storage-server/build/jacocoHtml/index.html を開く
 ```
 
+ミューテーションテストを実行：
+
+```bash
+./gradlew pitest
+# クライアントレポートを表示: file-storage-client/build/reports/pitest/index.html を開く
+# サーバーレポートを表示: file-storage-server/build/reports/pitest/index.html を開く
+```
+
+**注意**: ミューテーションテストはビルドの一部として自動的に実行されます。ミューテーションスコアが設定された閾値を下回ると、ビルドは失敗します。
+
 ---
 
 ## 📚 API ドキュメント

README.md

@@ -32,7 +32,7 @@ A modern, containerized file storage service with REST API, built with Quarkus a
 - 📊 **Observability**: Prometheus metrics and structured logging
 - 🔒 **Security**: CodeQL scanning and dependency updates via Dependabot
 - ✅ **Quality**: Checkstyle, PMD, and SpotBugs static analysis
-- 🧪 **Tested**: 80% code coverage + comprehensive integration tests
+- 🧪 **Tested**: 70% code coverage + comprehensive integration tests + PIT mutation testing
 - 📖 **API Documentation**: OpenAPI/Swagger UI included
 - 🌐 **REST API**: Simple, well-documented file storage API
 
@@ -306,8 +306,12 @@ docker-compose logs -f
 
 - **Unit Tests**: JUnit 5 with Mockito
 - **Integration Tests**: Testcontainers + Docker Compose
-- **Code Coverage**: Jacoco reporting with 80% threshold
+- **Code Coverage**: Jacoco reporting with 70% threshold
   - Test reports visible in _build/jacocoHtml/index.html_
+- **Mutation Testing**: PIT (PITest) with enforced thresholds
+  - Client: 40% mutation score threshold
+  - Server: 70% mutation score threshold
+  - Reports visible in _build/reports/pitest/index.html_
 - **Continuous Integration**: GitHub Actions with automated testing
 
 Run all tests:
@@ -323,6 +327,16 @@ Run with coverage:
 # View coverage report: open file-storage-server/build/jacocoHtml/index.html
 ```
 
+Run mutation testing:
+
+```bash
+./gradlew pitest
+# View client report: open file-storage-client/build/reports/pitest/index.html
+# View server report: open file-storage-server/build/reports/pitest/index.html
+```
+
+**Note**: Mutation testing is automatically run as part of the build. The build will fail if mutation scores drop below the configured thresholds.
+
 ---
 
 ## 📚 API Documentation

file-storage-client/build.gradle

@@ -1,5 +1,6 @@
 plugins {
     id 'java'
+    id 'info.solidsoft.pitest' version '1.15.0'
 }
 
 apply plugin: 'jacoco'
@@ -63,4 +64,20 @@ jacocoTestCoverageVerification {
             }
         }
     }
+}
+
+pitest {
+    junit5PluginVersion = '1.2.1'
+    targetClasses = ['com.tools.fsclient.*']
+    targetTests = ['com.tools.fsclient.*']
+    mutators = ['DEFAULTS']
+    threads = 4
+    outputFormats = ['HTML', 'XML']
+    timestampedReports = false
+    mutationThreshold = 40
+    coverageThreshold = 70
+}
+
+tasks.named('check') {
+    dependsOn tasks.named('pitest')
 }

file-storage-server/build.gradle

@@ -1,6 +1,7 @@
 plugins {
     id 'java'
     id 'io.quarkus'
+    id 'info.solidsoft.pitest' version '1.15.0'
 }
 
 apply plugin: 'jacoco'
@@ -61,4 +62,26 @@ jacocoTestCoverageVerification {
             }
         }
     }
+}
+
+pitest {
+    junit5PluginVersion = '1.2.1'
+    targetClasses = ['com.tools.fsserver.*']
+    targetTests = ['com.tools.fsserver.*']
+    mutators = ['DEFAULTS']
+    threads = 4
+    outputFormats = ['HTML', 'XML']
+    timestampedReports = false
+    mutationThreshold = 70
+    coverageThreshold = 70
+}
+
+// PITest needs to run after Quarkus generates its sources, otherwise it may try to
+// analyze classes before they are fully available, leading to incorrect results
+tasks.named('pitest') {
+    mustRunAfter tasks.named('compileQuarkusGeneratedSourcesJava')
+}
+
+tasks.named('check') {
+    dependsOn tasks.named('pitest')
 }