Quarkus 驗證循環

Quarkus 驗證循環 是做什麼的？

在 Pull Request 前、重大變更後與部署前執行。

何時啟用

• 在為 Quarkus 服務開啟 Pull Request 之前
• 在重大重構或依賴升級之後
• 部署前驗證（用於暫存或正式環境）
• 執行完整建置 → 語法檢查 → 測試 → 安全掃描 → 原生編譯流程
• 驗證測試涵蓋率達到門檻（80%+）
• 測試原生映像檔相容性

階段 1：建置

# Maven
mvn clean verify -DskipTests

# Gradle
./gradlew clean assemble -x test

如果建置失敗，請停止並修正編譯錯誤。

階段 2：靜態分析

Checkstyle、PMD、SpotBugs（Maven）

mvn checkstyle:check pmd:check spotbugs:check

SonarQube（如果已設定）

mvn sonar:sonar \
  -Dsonar.projectKey=my-quarkus-project \
  -Dsonar.host.url=http://localhost:9000 \
  -Dsonar.login=${SONAR_TOKEN}

需要處理的常見問題

• 未使用的 import 或變數
• 複雜的方法（高循環複雜度）
• 潛在的空指標解參考
• SpotBugs 標記的安全性問題

階段 3：測試 + 涵蓋率

# 執行所有測試
mvn clean test

# 產生涵蓋率報告
mvn jacoco:report

# 強制檢查涵蓋率門檻（80%）
mvn jacoco:check

# 或使用 Gradle
./gradlew test jacocoTestReport jacocoTestCoverageVerification

測試類別

單元測試

使用模擬依賴項測試服務邏輯：

@ExtendWith(MockitoExtension.class)
class UserServiceTest {
  @Mock UserRepository userRepository;
  @InjectMocks UserService userService;

  @Test
  void createUser_validInput_returnsUser() {
    var dto = new CreateUserDto("Alice", "[email protected]");

    // Panache persist() 回傳 void — 使用 doNothing + verify
    doNothing().when(userRepository).persist(any(User.class));

    User result = userService.create(dto);

    assertThat(result.name).isEqualTo("Alice");
    verify(userRepository).persist(any(User.class));
  }
}

整合測試

使用真實資料庫進行測試（Testcontainers）：

@QuarkusTest
@QuarkusTestResource(PostgresTestResource.class)
class UserRepositoryIntegrationTest {

  @Inject
  UserRepository userRepository;

  @Test
  @Transactional
  void findByEmail_existingUser_returnsUser() {
    User user = new User();
    user.name = "Alice";
    user.email = "[email protected]";
    userRepository.persist(user);

    Optional<User> found = userRepository.findByEmail("[email protected]");

    assertThat(found).isPresent();
    assertThat(found.get().name).isEqualTo("Alice");
  }
}

API 測試

使用 REST Assured 測試 REST 端點：

@QuarkusTest
class UserResourceTest {

  @Test
  void createUser_validInput_returns201() {
    given()
        .contentType(ContentType.JSON)
        .body("""
            {"name": "Alice", "email": "[email protected]"}
            """)
        .when().post("/api/users")
        .then()
        .statusCode(201)
        .body("name", equalTo("Alice"));
  }

  @Test
  void createUser_invalidEmail_returns400() {
    given()
        .contentType(ContentType.JSON)
        .body("""
            {"name": "Alice", "email": "invalid"}
            """)
        .when().post("/api/users")
        .then()
        .statusCode(400);
  }
}

涵蓋率報告

查看 target/site/jacoco/index.html 取得詳細涵蓋率資訊：

• 整體行涵蓋率（目標：80%+）
• 分支涵蓋率（目標：70%+）
• 找出未涵蓋的關鍵路徑

階段 4：安全掃描

依賴漏洞（Maven）

mvn org.owasp:dependency-check-maven:check

查看 target/dependency-check-report.html 中的 CVE。

Quarkus 安全審計

# 檢查有漏洞的擴充套件
mvn quarkus:audit

# 列出所有擴充套件
mvn quarkus:list-extensions

OWASP ZAP（API 安全測試）

docker run -t ghcr.io/zaproxy/zaproxy:stable zap-api-scan.py \
  -t http://localhost:8080/q/openapi \
  -f openapi

常見安全檢查

• 所有機密資訊放在環境變數中（而非程式碼中）
• 所有端點都有輸入驗證
• 已設定身分驗證/授權
• CORS 已正確設定
• 已設定安全標頭
• 密碼使用 BCrypt 雜湊
• SQL 注入防護（參數化查詢）
• 公開端點有速率限制

階段 5：原生編譯

測試 GraalVM 原生映像檔相容性：

# 建置原生執行檔
mvn package -Dnative

# 或使用容器
mvn package -Dnative -Dquarkus.native.container-build=true

# 測試原生執行檔
./target/*-runner

# 執行基本冒煙測試
curl http://localhost:8080/q/health/live
curl http://localhost:8080/q/health/ready

原生映像檔疑難排解

常見問題：

• 反射：為動態類別加入反射設定
• 資源：使用 quarkus.native.resources.includes 納入資源
• JNI：如果使用原生函式庫，請註冊 JNI 類別

反射設定範例：

@RegisterForReflection(targets = {MyDynamicClass.class})
public class ReflectionConfiguration {}

階段 6：效能測試

使用 K6 進行負載測試

// load-test.js
import http from 'k6/http';
import { check } from 'k6';

export const options = {
  stages: [
    { duration: '30s', target: 50 },
    { duration: '1m', target: 100 },
    { duration: '30s', target: 0 },
  ],
};

export default function () {
  const res = http.get('http://localhost:8080/api/markets');
  check(res, {
    'status is 200': (r) => r.status === 200,
    'response time < 200ms': (r) => r.timings.duration < 200,
  });
}

執行：

k6 run load-test.js

需要監控的指標

• 回應時間（p50、p95、p99）
• 吞吐量（請求/秒）
• 錯誤率
• 記憶體使用量
• CPU 使用率

階段 7：健康檢查

# 活動性檢查
curl http://localhost:8080/q/health/live

# 就緒性檢查
curl http://localhost:8080/q/health/ready

# 所有健康檢查
curl http://localhost:8080/q/health

# 指標（如果已啟用）
curl http://localhost:8080/q/metrics

預期回應：

{
  "status": "UP",
  "checks": [
    {
      "name": "Database connection",
      "status": "UP"
    }
  ]
}

階段 8：容器映像建置

# 建置容器映像
mvn package -Dquarkus.container-image.build=true

# 或指定 Registry
mvn package \
  -Dquarkus.container-image.build=true \
  -Dquarkus.container-image.registry=docker.io \
  -Dquarkus.container-image.group=myorg \
  -Dquarkus.container-image.tag=1.0.0

# 測試容器
docker run -p 8080:8080 myorg/my-quarkus-app:1.0.0

容器安全掃描

# Trivy
trivy image myorg/my-quarkus-app:1.0.0

# Grype
grype myorg/my-quarkus-app:1.0.0

階段 9：組態驗證

# 檢查所有組態屬性
mvn quarkus:info

# 列出所有組態來源
curl http://localhost:8080/q/dev/io.quarkus.quarkus-vertx-http/config

環境特定檢查

• 資料庫 URL 已針對各環境設定
• 機密資訊已外部化（Vault、環境變數）
• 紀錄層級適當
• CORS 來源設定正確
• 已設定速率限制
• 已啟用監控/追蹤

階段 10：文件審查

• OpenAPI/Swagger 文件是最新的（/q/swagger-ui）
• README 包含設定說明
• API 變更已記錄
• 重大變更的遷移指南
• 組態屬性已記錄

產生 OpenAPI 規格：

curl http://localhost:8080/q/openapi -o openapi.json

驗證檢查清單

程式碼品質

• 建置成功，無警告
• 靜態分析通過（無高/中風險問題）
• 程式碼遵循團隊慣例
• PR 中無註解掉的程式碼或 TODO

測試

• 所有測試通過
• 程式碼涵蓋率 ≥ 80%
• 使用真實資料庫的整合測試
• 安全測試通過
• 效能在可接受範圍內

安全性

• 無依賴漏洞
• 身分驗證/授權已測試
• 輸入驗證完整
• 機密資訊不在原始碼中
• 已設定安全標頭

部署

• 原生編譯成功
• 容器映像建置成功
• 健康檢查正確回應
• 組態適用於目標環境

原生映像

• 原生執行檔建置成功
• 原生測試通過
• 啟動時間 < 100ms
• 記憶體使用量可接受

自動化驗證腳本

#!/bin/bash
set -e

echo "=== 階段 1：建置 ==="
mvn clean verify -DskipTests

echo "=== 階段 2：靜態分析 ==="
mvn checkstyle:check pmd:check spotbugs:check

echo "=== 階段 3：測試 + 涵蓋率 ==="
mvn test jacoco:report jacoco:check

echo "=== 階段 4：安全掃描 ==="
mvn org.owasp:dependency-check-maven:check

echo "=== 階段 5：原生編譯 ==="
mvn package -Dnative -Dquarkus.native.container-build=true

echo "=== 所有階段完成 ==="
echo "檢閱報告："
echo "  - 涵蓋率：target/site/jacoco/index.html"
echo "  - 安全性：target/dependency-check-report.html"
echo "  - 原生：target/*-runner"

CI/CD 整合

GitHub Actions 範例

name: Verification

on: [push, pull_request]

jobs:
  verify:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

      - name: Set up JDK 21
        uses: actions/setup-java@v5
        with:
          java-version: '21'
          distribution: 'temurin'

      - name: Cache Maven packages
        uses: actions/cache@v6
        with:
          path: ~/.m2
          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}

      - name: Build
        run: mvn clean verify -DskipTests

      - name: Test with Coverage
        run: mvn test jacoco:report jacoco:check

      - name: Security Scan
        run: mvn org.owasp:dependency-check-maven:check

      - name: Upload Coverage
        uses: codecov/codecov-action@v7
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          files: target/site/jacoco/jacoco.xml

最佳實務

• 在每次 PR 前執行驗證循環
• 在 CI/CD 管道中自動化
• 立即修復問題；不要累積技術債
• 保持涵蓋率在 80% 以上
• 定期更新依賴項
• 定期測試原生編譯
• 監控效能趨勢
• 記錄重大變更
• 檢閱安全掃描結果
• 為每個環境驗證組態