How to run only one unit test class using Gradle?

Question

I am new to Gradle. I use Gradle 1.10 and Ubuntu 13.

I want to know if there's any command to execute only one unit test class, similar to testOnly in SBT.

Given the answers, it should be clear this is about local tests, not instrumented tests. Android / Gradle makes things confusing by calling these local tests "unit" tests. — tir38
– tir38, Commented Jan 27, 2020 at 20:53
Switched wording from "local test" to "unit test", since "local test" seems to be an Android-specific concept, but this question is much more general than that. — M. Justin
– M. Justin, Commented Dec 15, 2020 at 20:00

neu242 · Accepted Answer · 2022-10-10 14:03:50Z

1007

To run a single test class Airborn's answer is good.

With using some command line options, which found here, you can simply do something like this.

gradle test --tests org.gradle.SomeTest.someSpecificFeature
gradle test --tests '*SomeTest.someSpecificFeature'
gradle test --tests '*SomeSpecificTest'
gradle test --tests 'all.in.specific.package*'
gradle test --tests '*IntegTest'
gradle test --tests '*IntegTest*ui*'
gradle test --tests '*IntegTest.singleMethod'
gradle someTestTask --tests '*UiTest' someOtherTestTask --tests '*WebTest*ui'

From version 1.10 of gradle it supports selecting tests, using a test filter. For example,

apply plugin: 'java'

test {
  filter {
    //specific test method
      includeTestsMatching "org.gradle.SomeTest.someSpecificFeature"

     //specific test method, use wildcard for packages
     includeTestsMatching "*SomeTest.someSpecificFeature"

     //specific test class
     includeTestsMatching "org.gradle.SomeTest"

     //specific test class, wildcard for packages
     includeTestsMatching "*.SomeTest"

     //all classes in package, recursively
     includeTestsMatching "com.gradle.tooling.*"

     //all integration tests, by naming convention
      includeTestsMatching "*IntegTest"

     //only ui tests from integration tests, by some naming convention
     includeTestsMatching "*IntegTest*ui"
   }
}

For multi-flavor environments (a common use-case for Android), check this answer, as the --tests argument will be unsupported and you'll get an error.

edited Oct 10, 2022 at 14:03

neu242

16.8k22 gold badges85 silver badges125 bronze badges

answered Jul 17, 2015 at 5:26

Maleen Abewardana

14.8k4 gold badges38 silver badges39 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Matt Whipple Over a year ago

the filter approach could likely also be combined with Task rules for some convenient test selection

arntg Over a year ago

For large test suites, even if using --tests to call a single test method within the class, then we see iteration over all classes even all those not being run, which is too slow. Don't know if that slowness is due to our env or if it would impact others. Can update if finding more.

O.Badr Over a year ago

if you need to test a nested class gradle test --tests org.gradle.SomeTest$NestedClassTest

Sridhar Sarnobat Over a year ago

The singleMethod one doesn't work for me (anymore?).

M. Justin · Accepted Answer · 2020-12-15 19:57:05Z

222

In versions of Gradle prior to 5, the test.single system property can be used to specify a single test.

You can do gradle -Dtest.single=ClassUnderTestTest test if you want to test single class or use regexp like gradle -Dtest.single=ClassName*Test test you can find more examples of filtering classes for tests under this link.

Gradle 5 removed this option, as it was superseded by test filtering using the --tests command line option.

edited Dec 15, 2020 at 19:57

M. Justin

23.1k12 gold badges133 silver badges167 bronze badges

answered Mar 19, 2014 at 13:02

airborn

2,6251 gold badge16 silver badges12 bronze badges

Comments

greperror · Accepted Answer · 2016-06-15 19:05:20Z

184

In case you have a multi-module project :

let us say your module structure is

root-module
 -> a-module
 -> b-module

and the test(testToRun) you are looking to run is in b-module, with full path : com.xyz.b.module.TestClass.testToRun

As here you are interested to run the test in b-module, so you should see the tasks available for b-module.

./gradlew :b-module:tasks

The above command will list all tasks in b-module with description. And in ideal case, you will have a task named test to run the unit tests in that module.

./gradlew :b-module:test

Now, you have reached the point for running all the tests in b-module, finally you can pass a parameter to the above task to run tests which matches the certain path pattern

./gradlew :b-module:test --tests "com.xyz.b.module.TestClass.testToRun"

Now, instead of this if you run

./gradlew test --tests "com.xyz.b.module.TestClass.testToRun"

It will run the test task for both module a and b, which might result in failure as there is nothing matching the above pattern in a-module.

edited Jun 15, 2016 at 19:05

answered Jun 11, 2016 at 10:45

greperror

5,7663 gold badges23 silver badges31 bronze badges

2 Comments

Ahmed Ashour Over a year ago

Or simply ./gradlew :b-module:test --tests testToRun

Torsten Over a year ago

Is there a way to determine the module in question by its underlying test? I'd like to rerun tests that only fail on our Jenkins. But I also don't get the module information from Jenkins.

Akshay · Accepted Answer · 2019-08-09 06:39:14Z

70

Please note that --tests option may not work if you have different build types/flavors (fails with Unknown command-line option '--tests'). In this case, it's necessary to specify the particular test task (e.g. testProdReleaseUnitTest instead of just test)

edited Aug 9, 2019 at 6:39

Akshay

2,5324 gold badges35 silver badges57 bronze badges

answered Aug 1, 2018 at 9:19

anagaf

2,2501 gold badge20 silver badges15 bronze badges

3 Comments

DanielCuadra Over a year ago

Can you elaborate a full example? I'm trying to run 3 tests that match a wildcard using ./gradlew test --tests *testMyCollectionTake* and I can't tell how should I replace test with the wildcarded test name

M. Justin Over a year ago

Also note that the test task has to be used specifically; the check task cannot be used, for instance.

Blundell Over a year ago

@DanielCuadra try ./gradlew testDebug --tests "*testMyCollectionTake*"

Pratik Khadloya · Accepted Answer · 2018-05-11 22:30:05Z

57

After much figuring out, the following worked for me:

gradle test --tests "a.b.c.MyTestFile.mySingleTest"

answered May 11, 2018 at 22:30

Pratik Khadloya

12.9k12 gold badges86 silver badges106 bronze badges

2 Comments

Tarkik Over a year ago

this command is not working for me. > Error: Unknown command-line option '--tests'

Brian Agnew Over a year ago

@Tarkik - I think the --tests has to follow immediately after 'test'. I got the same...

Felix · Accepted Answer · 2021-08-19 10:45:39Z

21

For multi modules projects it's necessary to use module's name and buildType:

./gradlew :module_name:testDebugUnitTest --tests com.package_name.TestsClass.*

To run some test method the same command, but with test's name:

./gradlew :module_name:testDebugUnitTest --tests com.package_name.TestsClass.test

answered Aug 19, 2021 at 10:45

Felix

1,29613 silver badges22 bronze badges

1 Comment

Sridhar Sarnobat Over a year ago

Strange, the method name used to work but doesn't anymore. I moved from Gradle 4.8.1 to 6.9.

Eric Leschinski · Accepted Answer · 2019-07-25 12:57:35Z

10

Run a single test called MyTest:

./gradlew app:testDebug --tests=com.example.MyTest

edited Jul 25, 2019 at 12:57

Eric Leschinski

155k96 gold badges423 silver badges337 bronze badges

answered Jul 25, 2019 at 11:10

k4dima

6,2875 gold badges44 silver badges42 bronze badges

Comments

toti08 · Accepted Answer · 2018-12-05 14:53:12Z

8

Below is the command to run a single test class using gradlew command line option:

gradlew.bat Connected**your bundleVariant**AndroidTest -Pandroid.testInstrumentationRunnerArguments.class=com.example.TestClass

Below example to run class com.example.TestClass with variant Variant_1:

gradlew.bat ConnectedVariant_1AndroidTest -Pandroid.testInstrumentationRunnerArguments.class=com.example.TestClass

edited Dec 5, 2018 at 14:53

toti08

2,4745 gold badges28 silver badges38 bronze badges

answered Dec 5, 2018 at 13:36

Naveenprasanth Duraisamy

811 silver badge3 bronze badges

Comments

mutkan · Accepted Answer · 2019-07-05 18:11:15Z

4

You should try to add asteriks (*) to the end.

gradle test --tests "com.a.b.c.*"

answered Jul 5, 2019 at 18:11

mutkan

9548 silver badges12 bronze badges

Comments

Mahozad · Accepted Answer · 2023-07-20 12:14:18Z

1

This is for Kotlin DSL (build.gradle.kts) tested with Gradle 8.2:

tasks.test {
    filter {
        includeTestsMatching("*Util*")
    }
}

Another way (creating a new task):

tasks.register<Test>("MyTests") {
    group = "MyCustomTasks"
    filter {
        includeTestsMatching("ir.mahozad.*Convert*")
    }
}

answered Jul 20, 2023 at 12:14

Mahozad

26.3k19 gold badges163 silver badges200 bronze badges

Comments

Tvisha Raji · Accepted Answer · 2025-01-30 22:24:34Z

1

Yes, you can run a specific test class in Gradle by using the --tests option.

Here's how you can do it:

gradle test --tests com.example.MyTestClass

Explanation: Replace com.example.MyTestClass with the fully qualified name of your test class (including the package). Gradle will execute only the tests in the specified class.

Additional Notes:

If you want to run a specific test method within the class, you can include the method name:

gradle test --tests com.example.MyTestClass.myTestMethod

Gradle 1.10 is quite old. If possible, consider upgrading Gradle to a more recent version for better features, performance, and security.

Also, to save the hassle try using keploy's VS Code extension for unit test generation

edited Jan 30 at 22:24

answered Jan 19 at 5:56

Tvisha Raji

112 bronze badges

Comments

Greg · Accepted Answer · 2018-12-18 17:51:04Z

0

In my case, my eclipse java compiler warnings were set too high, and eclipse was not recognizing my class as valid for execution. Updating my compiler settings fixed the problem. You can read more about it here: annotation-nonnull-cannot-be-resolved

answered Dec 18, 2018 at 17:51

Greg

2,6254 gold badges23 silver badges28 bronze badges

Comments

Noe Adrian Acuña Prado · Accepted Answer · 2021-05-31 20:59:30Z

0

This worked for me

Release case:

gradle testReleaseUnitTest --tests testClass
Debug case:

gradle testDebugUnitTest --tests AsyncExecutorTest

You can see de projects with: gradle -q projects and move to the project where is the class to test

answered May 31, 2021 at 20:59

Noe Adrian Acuña Prado

194 bronze badges

Comments

JSON Derulo · Accepted Answer · 2025-01-16 19:57:52Z

0

To run individual Gradle test in command line,

$ gradle test --tests "com.package.className.testMethodName"

edited Jan 16 at 19:57

JSON Derulo

18.8k11 gold badges62 silver badges85 bronze badges

answered Jan 10 at 7:04

Kaustubha M

313 bronze badges

Comments

Forrest · Accepted Answer · 2025-02-23 22:10:49Z

0

Just in case this helps some other poor soul, my resolution was fixing a directory name that IntelliJ had "automagically" created for me.

When I generated tests, it created the following directory path: src/test/java/com/challenge/company/controller/DataControllerSpec.groovy

After a lot of frustration, I saw that "java" was a dir in the test path automatically created by my IDE. I changed it to "groovy" src/test/groovy/com/challenge/company/controller/DataControllerSpec.groovy

After that dir rename, everything worked as expected.

Project details: Groovy/Spock testing. Java/Spring Boot for project code.

answered Feb 23 at 22:10

Forrest

3,5472 gold badges32 silver badges19 bronze badges

Collectives™ on Stack Overflow

How to run only one unit test class using Gradle?

15 Answers 15

4 Comments

Comments

2 Comments

3 Comments

2 Comments

1 Comment

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

15 Answers 15

4 Comments

Comments

2 Comments

3 Comments

2 Comments

1 Comment

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related