如何通过Gradle API编程执行指定文件及可选测试名的测试？

一、先解决Gradle依赖找不到的问题 #

Gradle官方核心库（比如gradle-core）并不发布到Maven Central，而是托管在Gradle自己的仓库里。如果用Maven管理你的命令行工具项目，得先添加Gradle仓库地址：

<repositories>
    <repository>
        <id>gradle-releases</id>
        <name>Gradle Releases Repository</name>
        <url>https://repo.gradle.org/gradle/libs-releases-local</url>
    </repository>
</repositories>

推荐使用Gradle Tooling API——这是官方专为嵌入Gradle操作设计的API，比直接用gradle-core更稳定。引入依赖的配置如下：

<dependencies>
    <dependency>
        <groupId>org.gradle</groupId>
        <artifactId>gradle-tooling-api</artifactId>
        <version>6.8.3</version>
        <scope>runtime</scope>
    </dependency>
    <!-- 配套的Gradle运行时依赖，也可以让Tooling API自动下载对应版本 -->
    <dependency>
        <groupId>org.gradle</groupId>
        <artifactId>gradle-core</artifactId>
        <version>6.8.3</version>
        <scope>runtime</scope>
    </dependency>
</dependencies>

二、用Gradle Tooling API实现测试调用 #

Tooling API能让Java程序直接连接本地Gradle项目，执行指定任务并传参，和命令行效果一致。核心代码示例如下：

核心实现代码 #

import org.gradle.tooling.GradleConnector;
import org.gradle.tooling.ProjectConnection;

import java.io.File;

public class GradleTestRunner {
    public static void executeTests(String projectDir, String module, String fullTestName) {
        // 初始化连接器，指向目标Gradle项目目录
        GradleConnector connector = GradleConnector.newConnector();
        connector.forProjectDirectory(new File(projectDir));

        // 建立连接并执行任务
        try (ProjectConnection connection = connector.connect()) {
            // 拼接任务名：有模块就用<module>:test，没有直接用test
            String task = module != null && !module.isBlank() ? module + ":test" : "test";
            
            // 构建执行参数：如果有测试名就加上--tests参数
            var build = connection.newBuild().forTasks(task);
            if (fullTestName != null && !fullTestName.isBlank()) {
                build.withArguments("--tests", fullTestName);
            }
            
            // 运行任务
            build.run();
        } catch (Exception e) {
            System.err.println("测试任务执行失败：" + e.getMessage());
            e.printStackTrace();
        }
    }

    public static void main(String[] args) {
        // 示例：当前工作目录作为Gradle项目根目录，指定模块和测试类
        String targetDir = System.getProperty("user.dir");
        executeTests(targetDir, "my-module", "com.example.MyTestClass");
    }
}

关键说明 #

• 自动适配Gradle版本：Tooling API会自动识别目标项目的Gradle版本，如果本地没有对应版本，会自动下载（需要网络）。
• 资源安全：用try-with-resources自动关闭项目连接，避免资源泄漏。
• 参数灵活性：完全兼容命令行的--tests参数规则，支持模糊匹配（比如com.example.*Test、com.example.MyTest#testMethod）。

三、替代方案：直接调用命令行 #

如果觉得Tooling API的依赖配置麻烦，也可以在Java里直接调用gradlew命令，这种方式不需要引入任何Gradle依赖，代码更轻量：

import java.io.IOException;
import java.io.File;

public class CmdTestRunner {
    public static void runTests(String projectDir, String module, String fullTestName) throws IOException, InterruptedException {
        String task = module != null && !module.isBlank() ? module + ":test" : "test";
        ProcessBuilder pb = new ProcessBuilder();

        // 根据系统选择命令：Windows用cmd调用gradlew，Linux/macOS直接调用
        if (System.getProperty("os.name").toLowerCase().contains("win")) {
            pb.command("cmd.exe", "/c", "gradlew", task);
        } else {
            pb.command("./gradlew", task);
        }

        // 添加--tests参数（如果有）
        if (fullTestName != null && !fullTestName.isBlank()) {
            pb.command().add("--tests");
            pb.command().add(fullTestName);
        }

        // 设置工作目录为目标Gradle项目根目录
        pb.directory(new File(projectDir));
        // 把命令行输出重定向到当前控制台，方便查看测试日志
        pb.inheritIO();

        Process process = pb.start();
        int exitCode = process.waitFor();
        if (exitCode != 0) {
            System.err.println("测试任务执行失败，退出码：" + exitCode);
        }
    }

    public static void main(String[] args) throws IOException, InterruptedException {
        String targetDir = System.getProperty("user.dir");
        runTests(targetDir, "my-module", "com.example.MyTestClass");
    }
}

四、注意事项 #

• 版本兼容：Tooling API的版本尽量和目标项目的Gradle版本匹配，比如用6.8.3的Tooling API可以兼容4.x到6.x的Gradle项目。
• 权限问题：确保你的命令行工具对目标项目目录有读写权限，Linux/macOS下要保证gradlew脚本有执行权限（可以用chmod +x gradlew设置）。
• 测试名格式：和命令行用法一致，支持类名、方法名、模糊匹配等多种格式。

内容的提问来源于stack exchange，提问作者ragurney