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() {
        // 所有测试前执行一次
    }

    @BeforeEach
    void setUp() {
        // 每个测试前执行
    }

    @Test
    void testSomething() {
        // 测试
    }

    @AfterEach
    void tearDown() {
        // 每个测试后执行
    }

    @AfterAll
    static void tearDownClass() {
        // 所有测试后执行一次
    }
}

断言

使用 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

下一步

理解了构建和测试方法后，请参阅以下文档：

开发工作流程 - 开发工作流程
贡献指南 - 贡献指南
架构和代码结构 - 理解代码库