Gradle test task in JUnit - Test Execution Trace

Test Overview

This test runs a simple JUnit test class using the Gradle test task. It verifies that the test method executes and passes successfully.

Test Code - JUnit 5

JUnit

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

public class SimpleTest {
    @Test
    void testAlwaysPasses() {
        assertTrue(true);
    }
}

// Gradle build file snippet (build.gradle):
//
// plugins {
//     id 'java'
// }
//
// repositories {
//     mavenCentral()
// }
//
// dependencies {
//     testImplementation 'org.junit.jupiter:junit-jupiter:5.9.3'
// }
//
// test {
//     useJUnitPlatform()
// }

// Command to run test:
// ./gradlew test

Execution Trace - 5 Steps

Step	Action	System State	Assertion	Result
1	Gradle test task starts execution	Gradle initializes and loads the project with JUnit 5 dependency	—	PASS
2	Gradle compiles the SimpleTest.java test class	Compiled test class is ready for execution	—	PASS
3	Gradle runs the test method testAlwaysPasses() using JUnit Platform	JUnit test runner executes the test method	assertTrue(true) is verified	PASS
4	Gradle collects test results and generates test report	Test report shows 1 test executed, 0 failed	Test execution result is PASS	PASS
5	Gradle test task finishes successfully	Build completes with test success status	—	PASS

Failure Scenario

Failing Condition: The test method throws an AssertionError or exception

Execution Trace Quiz - 3 Questions

What does the Gradle test task do first when running tests?

A It compiles the test classes

B It generates the test report

C It runs the test methods

D It cleans the build directory

Key Result

Always ensure your build.gradle file includes the correct test dependencies and configures the test task to use the appropriate test platform to run your tests successfully.

Practice

1. What is the primary purpose of the Gradle test task in a JUnit project?

easy

A. To compile the Java source code into bytecode

B. To run automated tests and check if the code works correctly

C. To deploy the application to a server

D. To clean the build directory before building

Solution

1. Step 1: Understand the Gradle test task role

   The test task in Gradle is designed to run automated tests, such as those written with JUnit, to verify code correctness.

2. Step 2: Differentiate from other Gradle tasks

   Tasks like compileJava compile code, clean removes build files, and deployment is separate. Only test runs tests.

3. Final Answer:

   To run automated tests and check if the code works correctly -> Option B

4. Quick Check:

   Gradle test = run tests [OK]

Hint: Remember: 'gradle test' runs your tests [OK]

Common Mistakes:

• Confusing test task with compile or clean tasks
• Thinking test deploys the app
• Assuming test cleans build files

2. Which of the following is the correct command to run JUnit tests using Gradle from the terminal?

easy

A. gradle checkTests

B. gradle runTests

C. gradle executeTests

D. gradle test

Solution

1. Step 1: Recall the standard Gradle test command

   The official Gradle command to run tests is gradle test. This triggers the test task which runs JUnit tests.

2. Step 2: Verify other options are invalid

   Commands like runTests, executeTests, and checkTests are not standard Gradle commands and will cause errors.

3. Final Answer:

   gradle test -> Option D

4. Quick Check:

   Run tests with gradle test [OK]

Hint: Use exactly 'gradle test' to run tests [OK]

Common Mistakes:

• Adding extra words like run or execute
• Using non-existent Gradle commands
• Confusing test with build or run

3. Given this snippet in build.gradle:

test {
    useJUnitPlatform()
    testLogging {
        events "passed", "failed"
    }
}

What will be the output when you run gradle test and all tests pass?

medium

A. Both passed and failed test events are shown in the console

B. Only failed tests are shown in the output

C. No output because logging is disabled

D. Only passed tests are shown, failed tests are ignored

Solution

1. Step 1: Understand the testLogging configuration

   The testLogging block with events "passed", "failed" means Gradle will log passed and failed test events when they occur.

2. Step 2: Predict output when all tests pass

   Since all tests pass, passed test events are shown. Failed events do not occur, so they are not shown. Therefore, only passed test events appear in the console.

3. Final Answer:

   Both passed and failed test events are shown in the console -> Option A

4. Quick Check:

   Passed and failed events configured to show; failed events absent if none fail [OK]

Hint: Check testLogging events to know what shows [OK]

Common Mistakes:

• Assuming no output if tests pass
• Thinking only failed tests show by default
• Ignoring testLogging configuration

4. You added this to your build.gradle:

test {
    useJUnitPlatform()
    testLogging {
        events "passed", "failed"
    }
    include '**/MyTests.java'
}

But running gradle test runs no tests. What is the likely problem?

medium

A. The include pattern should use forward slashes and match class files, not source files

B. You forgot to add useJUnit() instead of useJUnitPlatform()

C. The testLogging block disables test execution

D. Gradle test task cannot filter tests by include patterns

Solution

1. Step 1: Understand the include pattern usage

   The include pattern filters test classes by their compiled class file names, not source files. It should match **/MyTests.class or use package style with forward slashes.

2. Step 2: Identify why no tests run

   Using **/MyTests.java does not match any compiled test classes, so no tests run.

3. Final Answer:

   The include pattern should use forward slashes and match class files, not source files -> Option A

4. Quick Check:

   Include matches class files, not .java [OK]

Hint: Include filters need class file patterns, not source files [OK]

Common Mistakes:

• Using .java instead of .class in include patterns
• Confusing useJUnitPlatform with test execution
• Thinking testLogging disables tests

5. You want to customize the Gradle test task to run only tests tagged with @Tag("fast") in JUnit 5. Which build.gradle snippet correctly configures this?

hard

A. test {
includeTags 'fast'
}

B. test {
useJUnitPlatform()
includeTags 'fast'
}

C. test {
useJUnitPlatform {
includeTags 'fast'
}
}

D. test {
useJUnitPlatform()
testLogging {
includeTags 'fast'
}
}

Solution

1. Step 1: Recall how to filter tests by tags in Gradle

   Gradle's useJUnitPlatform accepts a configuration block where you can specify includeTags to run only tests with certain tags.

2. Step 2: Check each option for correct syntax

   test { useJUnitPlatform { includeTags 'fast' } } correctly places includeTags 'fast' inside the useJUnitPlatform block. Other options place it incorrectly or omit useJUnitPlatform.

3. Final Answer:

   test { useJUnitPlatform { includeTags 'fast' } } -> Option C

4. Quick Check:

   Tag filtering goes inside useJUnitPlatform block [OK]

Hint: Put includeTags inside useJUnitPlatform block [OK]

Common Mistakes:

• Placing includeTags outside useJUnitPlatform
• Adding includeTags inside testLogging
• Omitting useJUnitPlatform call