package org.codelibs.fess.app.service;

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.*;

public class SearchServiceTest {

    @Test
    public void testSearch() {
        // Given: テストの前提条件
        SearchService service = new SearchService();
        String query = "test";

        // When: テスト対象の実行
        SearchResponse response = service.search(query);

        // Then: 結果の検証
        assertNotNull(response);
        assertTrue(response.getResultCount() > 0);
    }
}

テストのライフサイクル

import org.junit.jupiter.api.*;

public class MyServiceTest {

    @BeforeAll
    static void setUpClass() {
        // すべてのテストの前に 1 回実行
    }

    @BeforeEach
    void setUp() {
        // 各テストの前に実行
    }

    @Test
    void testSomething() {
        // テスト
    }

    @AfterEach
    void tearDown() {
        // 各テストの後に実行
    }

    @AfterAll
    static void tearDownClass() {
        // すべてのテストの後に 1 回実行
    }
}

アサーション

JUnit 5 のアサーションを使用します：

import static org.junit.jupiter.api.Assertions.*;

// 等価性
assertEquals(expected, actual);
assertNotEquals(unexpected, actual);

// null チェック
assertNull(obj);
assertNotNull(obj);

// 真偽値
assertTrue(condition);
assertFalse(condition);

// 例外
assertThrows(IllegalArgumentException.class, () -> {
    service.doSomething();
});

// コレクション
assertIterableEquals(expectedList, actualList);

テストカバレッジ

JaCoCo でテストカバレッジを測定します：

レポートは target/site/jacoco/index.html に生成されます。

コードフォーマット

Fess では、コードの品質を維持するために以下のツールを使用しています。

コードフォーマッター

コーディングスタイルを統一します：

ライセンスヘッダー

ソースファイルにライセンスヘッダーを追加します：

コミット前のチェック

コミット前に両方を実行してください：

配布パッケージの作成

zip パッケージの作成

配布用の zip パッケージを作成します：

生成される成果物：

RPM パッケージの作成

DEB パッケージの作成

プロファイル

Maven プロファイルを使用して、テストの種類を切り替えることができます。

build（デフォルト）

デフォルトのプロファイルです。単体テスト（*Test.java）を実行します：

integrationTests

統合テスト（*Tests.java）を実行するためのプロファイルです：

CI/CD

Fess では、GitHub Actions を使用して CI/CD を実行しています。

GitHub Actions

.github/workflows/ ディレクトリに設定ファイルがあります。

自動実行されるチェック：

ビルド
単体テスト
パッケージの作成

ローカルでの CI チェック

PR を作成する前に、ローカルで CI と同様のチェックを実行できます：

トラブルシューティング

ビルドエラー

エラー: 依存関係のダウンロード失敗

エラー: メモリ不足

エラー: Java バージョンが古い

Java 21 以降を使用してください：

テストエラー

テストがタイムアウトする

テストのタイムアウト時間を延長：

OpenSearch が起動しない

ポートを確認し、使用中の場合は変更します：

依存関係の問題

依存関係の競合

依存関係ツリーを確認：

特定の依存関係を除外：

<dependency>
    <groupId>org.example</groupId>
    <artifactId>example-lib</artifactId>
    <version>1.0</version>
    <exclusions>
        <exclusion>
            <groupId>conflicting-lib</groupId>
            <artifactId>conflicting-lib</artifactId>
        </exclusion>
    </exclusions>
</dependency>

ビルドのベストプラクティス

定期的なクリーンビルド

定期的にクリーンビルドを実行して、ビルドキャッシュの問題を回避します：

テストの実行

コミット前に必ずテストを実行します：

コードフォーマットの実行

PR を作成する前にコードフォーマットを実行します：

依存関係の更新

定期的に依存関係を更新します：

ビルドキャッシュの活用

ビルド時間を短縮するため、Maven のキャッシュを活用します：

Maven コマンドリファレンス

よく使うコマンド

# クリーン
mvn clean

# コンパイル
mvn compile

# テスト
mvn test

# パッケージ
mvn package

# インストール（ローカルリポジトリに登録）
mvn install

# 検証（統合テストを含む）
mvn verify

# 依存関係の解決
mvn dependency:resolve

# 依存関係ツリーの表示
mvn dependency:tree

# プロジェクト情報の表示
mvn help:effective-pom

# コードフォーマット
mvn formatter:format

# ライセンスヘッダー追加
mvn license:format

次のステップ

ビルドとテストの方法を理解したら、以下のドキュメントを参照してください：

開発ワークフロー - 開発ワークフロー
コントリビューションガイド - コントリビューションガイドライン
アーキテクチャとコード構造 - コードベースの理解