返回

利用 GitHub Actions 和 Maven,为 Java 项目的 JUnit 5 测试注入活力

闲谈

使用 GitHub Actions 和 Maven 在 Java 项目中运行 JUnit 5 测试




Github Actions 是 GitHub 为开发者提供的持续集成和持续交付(CI/CD)服务,旨在帮助他们自动化软件开发流程。对于开源仓库,它是完全免费的。对于私有仓库,每个 GitHub 帐户都可以获得一定数量的免费时间和存储空间,具体取决于帐户类型和使用的产品。

在本教程中,我们将向您展示如何在 Java 项目中使用 GitHub Actions 和 Maven 来运行 JUnit 5 测试。

先决条件

  • Java 8 或更高版本
  • Maven 3 或更高版本
  • GitHub 帐户
  • 一个 GitHub 仓库

设置

  1. 在您的 Java 项目中,创建一个名为 pom.xml 的新文件。

  2. 将以下内容添加到 pom.xml 文件中:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example</groupId>
  <artifactId>junit-5-example</artifactId>
  <version>1.0.0-SNAPSHOT</version>

  <dependencies>
    <dependency>
      <groupId>org.junit.jupiter</groupId>
      <artifactId>junit-jupiter-api</artifactId>
      <version>5.8.2</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>3.0.0-M7</version>
        <configuration>
          <includes>
            <include>**/*Test.java</include>
          </includes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
  1. 在您的 Java 项目中,创建一个名为 src/test/java 的新目录。

  2. src/test/java 目录中,创建一个名为 ExampleTest.java 的新文件。

  3. 将以下内容添加到 ExampleTest.java 文件中:

import org.junit.jupiter.api.Test;

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

public class ExampleTest {

  @Test
  public void testAdd() {
    int a = 1;
    int b = 2;
    int expected = 3;
    int actual = a + b;
    assertEquals(expected, actual);
  }
}
  1. 将您的 Java 项目推送到 GitHub。

创建 GitHub Actions 工作流

  1. 在 GitHub 仓库中,导航到 "Actions" 选项卡。

  2. 单击 "新建工作流" 按钮。

  3. 选择 "Maven" 模板。

  4. 在 "工作流名称" 字段中,输入一个名称。

  5. 在 "Maven 版本" 字段中,选择 "Maven 3"。

  6. 在 "目标" 字段中,输入 verify

  7. 在 "工作流文件" 字段中,单击 "编辑" 按钮。

  8. 将以下内容添加到工作流文件中:

name: Java CI with Maven

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-java@v3
        with:
          java-version: 11
          distribution: 'temurin'
      - run: mvn verify
  1. 单击 "保存" 按钮。

  2. 单击 "启用工作流" 按钮。

运行测试

  1. 将一些更改推送到您的 GitHub 仓库。

  2. 导航到 GitHub 仓库中的 "Actions" 选项卡。

  3. 您应该会看到一个新的工作流运行。

  4. 单击工作流运行以查看结果。

  5. 您应该会看到 JUnit 5 测试已成功运行。

结论

在本教程中,我们向您展示了如何在 Java 项目中使用 GitHub Actions 和 Maven 来运行 JUnit 5 测试。您还可以使用 GitHub Actions 来执行其他任务,例如构建和部署您的 Java 项目。有关更多信息,请参阅 GitHub Actions 文档。