Spring Boot 検証ループ は何をしますか?
PR前、大きな変更後、デプロイ前に実行します。
アクティベーションタイミング
- Spring Boot サービスのプルリクエストを開く前
- 大規模なリファクタリングや依存関係のアップグレード後
- ステージングまたはプロダクションへのデプロイ前検証
- フルビルド→リント→テスト→セキュリティスキャンのパイプライン実行時
- テストカバレッジがしきい値を満たしていることの確認時
フェーズ1: ビルド
mvn -T 4 clean verify -DskipTests
# または
./gradlew clean assemble -x test
ビルドが失敗したら止めて修正します。
フェーズ2: 静的解析
Maven(一般的なプラグイン):
mvn -T 4 spotbugs:check pmd:check checkstyle:check
Gradle(設定済みの場合):
./gradlew checkstyleMain pmdMain spotbugsMain
フェーズ3: テスト + カバレッジ
mvn -T 4 test
mvn jacoco:report # 80%以上のカバレッジを確認
# または
./gradlew test jacocoTestReport
レポート:
- 総テスト数、合格/不合格
- カバレッジ %(行/ブランチ)
単体テスト
依存関係をモックして、サービスのロジックを分離してテスト:
@ExtendWith(MockitoExtension.class)
class UserServiceTest {
@Mock private UserRepository userRepository;
@InjectMocks private UserService userService;
@Test
void createUser_validInput_returnsUser() {
var dto = new CreateUserDto("Alice", "[email protected]");
var expected = new User(1L, "Alice", "[email protected]");
when(userRepository.save(any(User.class))).thenReturn(expected);
var result = userService.create(dto);
assertThat(result.name()).isEqualTo("Alice");
verify(userRepository).save(any(User.class));
}
@Test
void createUser_duplicateEmail_throwsException() {
var dto = new CreateUserDto("Alice", "[email protected]");
when(userRepository.existsByEmail(dto.email())).thenReturn(true);
assertThatThrownBy(() -> userService.create(dto))
.isInstanceOf(DuplicateEmailException.class);
}
}
Testcontainers を使った統合テスト
H2 ではなく実際のデータベースに対してテスト:
@SpringBootTest
@Testcontainers
class UserRepositoryIntegrationTest {
@Container
static PostgreSQLContainer<?> postgres = new PostgreSQLContainer<>("postgres:16-alpine")
.withDatabaseName("testdb");
@DynamicPropertySource
static void configureProperties(DynamicPropertyRegistry registry) {
registry.add("spring.datasource.url", postgres::getJdbcUrl);
registry.add("spring.datasource.username", postgres::getUsername);
registry.add("spring.datasource.password", postgres::getPassword);
}
@Autowired private UserRepository userRepository;
@Test
void findByEmail_existingUser_returnsUser() {
userRepository.save(new User("Alice", "[email protected]"));
var found = userRepository.findByEmail("[email protected]");
assertThat(found).isPresent();
assertThat(found.get().getName()).isEqualTo("Alice");
}
}
MockMvc を使ったAPIテスト
完全なSpringコンテキストでコントローラ層をテスト:
@WebMvcTest(UserController.class)
class UserControllerTest {
@Autowired private MockMvc mockMvc;
@MockBean private UserService userService;
@Test
void createUser_validInput_returns201() throws Exception {
var user = new UserDto(1L, "Alice", "[email protected]");
when(userService.create(any())).thenReturn(user);
mockMvc.perform(post("/api/users")
.contentType(MediaType.APPLICATION_JSON)
.content("""
{"name": "Alice", "email": "[email protected]"}
"""))
.andExpect(status().isCreated())
.andExpect(jsonPath("$.name").value("Alice"));
}
@Test
void createUser_invalidEmail_returns400() throws Exception {
mockMvc.perform(post("/api/users")
.contentType(MediaType.APPLICATION_JSON)
.content("""
{"name": "Alice", "email": "not-an-email"}
"""))
.andExpect(status().isBadRequest());
}
}
フェーズ4: セキュリティスキャン
# 依存関係のCVE
mvn org.owasp:dependency-check-maven:check
# または
./gradlew dependencyCheckAnalyze
# ソース内のシークレット
grep -rn "password\s*=\s*\"" src/ --include="*.java" --include="*.yml" --include="*.properties"
grep -rn "sk-\|api_key\|secret" src/ --include="*.java" --include="*.yml"
# シークレット(Git履歴)
git secrets --scan # 設定済みの場合
よくあるセキュリティ指摘
# System.out.println のチェック(代わりにロガーを使用)
grep -rn "System\.out\.print" src/main/ --include="*.java"
# レスポンス内の生の例外メッセージのチェック
grep -rn "e\.getMessage()" src/main/ --include="*.java"
# ワイルドカードCORSのチェック
grep -rn "allowedOrigins.*\*" src/main/ --include="*.java"
フェーズ5: リント/フォーマット(オプションゲート)
mvn spotless:apply # Spotlessプラグインを使用している場合
./gradlew spotlessApply
フェーズ6: 差分レビュー
git diff --stat
git diff
チェックリスト:
- デバッグログが残っていないこと(
System.out、ガードのないlog.debug) - 意味のあるエラーとHTTPステータスコードが返されていること
- トランザクションとバリデーションが必要な場所に実装されていること
- 設定変更がドキュメント化されていること
出力テンプレート
VERIFICATION REPORT
===================
ビルド: [PASS/FAIL]
静的解析: [PASS/FAIL] (spotbugs/pmd/checkstyle)
テスト: [PASS/FAIL] (X/Y passed, Z% coverage)
セキュリティ: [PASS/FAIL] (CVE findings: N)
差分: [X files changed]
総合: [READY / NOT READY]
修正すべき問題:
1. ...
2. ...
継続モード
- 大きな変更のたび、または長時間セッションでは30〜60分ごとにフェーズを再実行
mvn -T 4 test+ spotbugs の短いループを維持して迅速なフィードバックを得る
注意: 迅速なフィードバックは後からの驚きを防ぎます。ゲートは厳格に保ち、プロダクションシステムでは警告を欠陥として扱ってください。