今日のひとこと

FessのJUnitテスト実行時に、X Window（ディスプレイ）にアクセスしようとしてテストが失敗するケースがありました。CI/CD環境やDockerコンテナなど、GUIのない環境でも安定してテストを実行できるよう、headlessモードを有効化する設定を追加しました。

問題の背景

Javaアプリケーションでは、AWTやSwingなどのGUIコンポーネントを使用するコードがあると、テスト実行時にディスプレイ環境へのアクセスが発生することがあります。以下のような環境では、X11サーバーが存在しないためテストが失敗します。

• CI/CDパイプライン（GitHub Actions、Jenkinsなど）
• Dockerコンテナ
• X11転送なしのSSH接続先サーバー

変更内容

pom.xmlのテストプロファイル設定で、JVMの起動引数に-Djava.awt.headless=trueを追加しました。

<test.command.args>--illegal-access=permit -Djava.awt.headless=true</test.command.args>

この設定により、テスト実行時にJavaがheadlessモードで動作し、ディスプレイなしの環境でもAWT関連の処理が正常に動作するようになります。

headlessモードとは

Javaのheadlessモードは、キーボード、ディスプレイ、マウスといった入出力デバイスがない環境でもJavaアプリケーションを動作させるための機能です。headlessモードでは、以下のような処理が可能です。

• フォントの読み込みとレンダリング
• 画像の生成・加工
• 印刷処理

一方で、ウィンドウの表示やユーザー入力の受付など、実際のディスプレイが必要な操作は利用できません。

まとめ

-Djava.awt.headless=trueオプションの追加により、Fessのテストがヘッドレス環境でも安定して実行できるようになりました。CI/CD環境でのビルドやテストの信頼性が向上します。

Fess 15.5で、管理画面のウィザード機能でWebクロール設定を作成する際に、デフォルトの除外パターンが適用されるように改善しました。

これまで、Webクロール設定をウィザードから作成した場合、除外URLのフィールドが空の状態で作成されていました。一方、Webクロール設定画面から作成した場合は、(?i).*(css|js|jpeg|jpg|gif|png|bmp|wmv|xml|ico|exe)というデフォルトの除外パターンが設定されていました。この不一致により、ウィザードで作成した設定では、検索対象としては不要なCSSやJavaScript、画像ファイルなどもクロール対象に含まれてしまう状態でした。

今回の修正で、ウィザードから作成した場合でも同じデフォルト除外パターンが適用されるようになり、一貫した動作となりました。これにより、ウィザードを使ったクロール設定でも、最初から適切なファイルが除外されるので、効率的なクロールが可能になります。

Fessのテストコードを JUnit 4 から JUnit 5（Jupiter）へ移行しました。4000以上のテストケースがあるため、かなりの作業量になりましたが、無事に完了しました。

移行の背景

JUnit 4は長らくJavaのテストフレームワークのデファクトスタンダードでしたが、JUnit 5では以下のような改善が行われています。

• アノテーションの刷新（@Before → @BeforeEach、@After → @AfterEach など）
• より柔軟な拡張モデル
• ネストしたテストのサポート
• パラメータ化テストの改善

Fessでも最新のテスト環境を維持するため、移行を実施しました。

移行作業の内容

@AfterEachアノテーションの追加

JUnit 5では、テストメソッドの後処理に@AfterEachアノテーションが必要です。従来のtearDown()メソッドに対して、このアノテーションを追加しました。

import org.junit.jupiter.api.AfterEach;

public class SampleTest extends UnitFessTestCase {

    @AfterEach
    public void tearDown() throws Exception {
        // クリーンアップ処理
    }
}

この変更だけで6000行以上の修正が必要でした。テストクラスの数が多いため、すべてのtearDown()メソッドにアノテーションを追加し、importステートメントも更新しました。

• PR #3012: fix(test): add @AfterEach annotation for JUnit 5 compatibility

テストカバレッジの向上

移行に合わせて、これまでテストが不足していた箇所にも新規テストを追加しました。

追加したテストの内容:

• Service層: FessAppServiceTestでベースサービス機能をテスト
• Storage関連: StorageItemTest、StorageTypeTestでストレージクラスをテスト
• Pagerクラス: 24個の新規Pagerテスト（GroupPager、RolePager、UserPager、SchedulerPager、PathMapPager、KeyMatchPager、ElevateWordPager、FailureUrlPager、JobLogPager、FileConfigPager、WebConfigPager、RelatedContentPager、RelatedQueryPager、RoleTypePager、SearchLogPager、WebAuthPager、FileAuthPager、ReqHeaderPager、SynonymPager、KuromojiPager、StopwordsPager、ProtwordsPager、StemmerOverridePager、LabelTypePager）
• Jobクラス: AllJobSchedulerTest、ScriptExecutorJobTestでジョブスケジューリングをテスト

これらの追加により、以下のカバレッジギャップを解消しました。

対象	移行前カバレッジ	移行後
Service層	0%	テスト追加
Pagerクラス	22.6%	大幅に向上
Storageクラス	0%	テスト追加
App Jobクラス	0%	テスト追加

• PR #3011: test: add unit tests for improved test coverage

まとめ

4000以上のテストケースを持つFessのJUnit 5移行を完了しました。移行作業は主にアノテーションの置き換えとimport文の更新でしたが、テストクラスの数が多いため手間のかかる作業でした。また、移行を機にテストカバレッジも改善し、これまで手薄だった箇所にテストを追加しました。