springboot-verification

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
===================
Build:     [PASS/FAIL]
Static:    [PASS/FAIL] (spotbugs/pmd/checkstyle)
Tests:     [PASS/FAIL] (X/Y passed, Z% coverage)
Security:  [PASS/FAIL] (CVE findings: N)
Diff:      [X files changed]

Overall:   [READY / NOT READY]

Issues to Fix:
1. ...
2. ...

継続モード

• 大きな変更があった場合や、長時間のセッションでは30〜60分ごとにフェーズを再実行する
• ショートループを維持する: mvn -T 4 test + spotbugs で素早くフィードバックを得る

忘れないでください: 迅速なフィードバックは、後から驚くことよりも優れています。ゲートは厳しく保ち、本番システムでは警告を障害として扱ってください。