Gradle – How to run a single unit test class

By mkyong | Updated: February 4, 2021

Viewed: 12,646 (+78 pv/w)

Tags: gradle gradle test unit test

In Gradle, we can pass an --tests option to run a single unit test class. Read this Gradle Test Filtering.

gradle test --test TestClass

P.S Tested with Gradle 6.7.1

1. Run a single test class

Review a simple unit test.

package com.mkyong.security.db;

import org.junit.jupiter.api.Test;

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

public class DummyTest {

    @Test
    void test_a_ok() {
        assertTrue(true);
    }

    @Test
    void test_b_ok() {
        assertTrue(true);
    }

}

To run only the above unit test, try gradle test --tests DummyTest.

gradle test --tests DummyTest

2. Gradle –tests examples

I added the below configuration to display the Gradle test’s output in the console

test {
	testLogging {
		events "passed", "skipped", "failed", "standardOut", "standardError"
	}
}  

2.1 Run all tests from the test class DummyTest.

gradle test --tests DummyTest

> Task :test

DummyTest > test_a_ok() PASSED

DummyTest > test_b_ok() PASSED

By default, Gradle skips the previously passed tests, and we can use cleanTest to force Gradle always to run the previously passed tests, even the tests are unmodified.

gradle cleanTest test --tests DummyTest

2.2 Run a single test method.

gradle test --tests DummyTest.test_b_ok

> Task :test

DummyTest > test_b_ok() PASSED

2.3 Gradle test supports wildcard *, enclose the wildcard with a single quote (bash shell?) or double quotes (zsh shell).

# if single quote not working, try double quotes, depends on shell
gradle test --tests `Dummy*`

gradle test --tests "Dummy*"

> Task :test

DummyTest > test_a_ok() PASSED

DummyTest > test_b_ok() PASSED

2.4 Fully-qualified name pattern.

gradle test --tests com.mkyong.security.db.DummyTest

2.5 Run all tests from a package.

gradle test --tests "com.mkyong.security.*"

2.6 The --tests and the continuous build

gradle test --continuous --tests DummyTest  

References

• Gradle Test Filtering
• Gradle Continuous Build
• Gradle – How to display test result in console
• Gradle – How to exclude some tests