Gradle dependency setup in JUnit - Build an Automation Script

Verify JUnit dependency setup in Gradle project

Preconditions (2)

Step 1: Open the build.gradle file in the project root

Step 2: Add the JUnit Jupiter dependency under the dependencies block: testImplementation 'org.junit.jupiter:junit-jupiter:5.9.3'

Step 3: Add the test task configuration to use JUnit Platform

Step 4: Save the build.gradle file

Step 5: Run the command 'gradle test' in the project root directory

Step 6: Observe the test execution output

✅ Expected Result: Gradle downloads the JUnit Jupiter dependency, compiles the test classes, and runs the tests using JUnit Platform. The test task completes successfully with test results displayed.

Automation Requirements - JUnit 5 with Gradle

Assertions Needed:

Verify that the build.gradle file contains the correct JUnit Jupiter dependency line

Verify that the Gradle test task runs successfully without errors

Verify that the test report is generated after running tests

Best Practices:

Use explicit version numbers for dependencies

Use testImplementation configuration for test dependencies

Configure the test task to use JUnit Platform explicitly

Keep build.gradle file clean and well formatted

Automated Solution

JUnit

import static org.junit.jupiter.api.Assertions.*;
import org.junit.jupiter.api.Test;
import java.io.*;
import java.nio.file.*;
import java.util.stream.*;

public class GradleDependencySetupTest {

    @Test
    void testBuildGradleContainsJUnitDependency() throws IOException {
        Path buildFile = Paths.get("build.gradle");
        assertTrue(Files.exists(buildFile), "build.gradle file should exist");

        try (Stream<String> lines = Files.lines(buildFile)) {
            boolean containsJUnit = lines.anyMatch(line -> line.contains("testImplementation 'org.junit.jupiter:junit-jupiter:5.9.3'"));
            assertTrue(containsJUnit, "build.gradle must contain JUnit Jupiter dependency");
        }
    }

    @Test
    void testGradleTestTaskRunsSuccessfully() throws IOException, InterruptedException {
        ProcessBuilder builder = new ProcessBuilder();
        builder.command("gradle", "test");
        builder.redirectErrorStream(true);
        Process process = builder.start();

        String output;
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(process.getInputStream()))) {
            output = reader.lines().collect(Collectors.joining("\n"));
        }

        int exitCode = process.waitFor();
        assertEquals(0, exitCode, "Gradle test task should exit with code 0");
        assertTrue(output.contains("BUILD SUCCESSFUL"), "Gradle build should be successful");
        assertTrue(output.contains("Test run finished"), "Test run output should be present");
    }

    @Test
    void testTestReportIsGenerated() {
        Path reportDir = Paths.get("build", "reports", "tests", "test");
        assertTrue(Files.exists(reportDir), "Test report directory should exist");

        try (Stream<Path> files = Files.list(reportDir)) {
            boolean hasHtmlReport = files.anyMatch(path -> path.toString().endsWith(".html"));
            assertTrue(hasHtmlReport, "Test report HTML file should be present");
        } catch (IOException e) {
            fail("Failed to list test report directory");
        }
    }
}

This test class verifies the Gradle dependency setup for JUnit in three ways:

• testBuildGradleContainsJUnitDependency: Reads the build.gradle file and checks if the JUnit Jupiter dependency line is present. This ensures the dependency is declared correctly.
• testGradleTestTaskRunsSuccessfully: Runs the gradle test command as a process, captures the output, and asserts the build is successful and tests run. This confirms Gradle can execute tests using the dependency.
• testTestReportIsGenerated: Checks if the test report directory and HTML report file exist after running tests. This verifies that test results are generated and accessible.

Each test uses clear assertions with helpful messages. The code uses standard Java APIs and JUnit 5 assertions. This approach simulates a real-world verification of Gradle dependency setup and test execution.

Common Mistakes - 5 Pitfalls

{'mistake': 'Not specifying the JUnit version explicitly in build.gradle', 'why_bad': 'This can cause unpredictable builds if Gradle uses an older or incompatible JUnit version.', 'correct_approach': "Always specify the exact JUnit Jupiter version in the dependency line, e.g., 'org.junit.jupiter:junit-jupiter:5.9.3'."}

{'mistake': "Using 'implementation' instead of 'testImplementation' for JUnit dependency", 'why_bad': 'JUnit is only needed for testing, so including it in the main compile classpath increases build size unnecessarily.', 'correct_approach': "Use 'testImplementation' configuration for test dependencies to keep them separate."}

{'mistake': 'Not configuring the test task to use JUnit Platform', 'why_bad': 'Gradle might not run JUnit 5 tests correctly without this configuration.', 'correct_approach': "Add 'useJUnitPlatform()' in the test task configuration in build.gradle."}

Hardcoding file paths without considering OS differences

Ignoring the test task output and exit code

Bonus Challenge

Now add data-driven testing with 3 different Gradle versions to verify compatibility of JUnit dependency setup.

Show Hint

Practice

1. What is the correct Gradle configuration to add JUnit 5 as a test-only dependency?

easy

A. compile 'org.junit.jupiter:junit-jupiter:5.9.3'

B. implementation 'org.junit.jupiter:junit-jupiter:5.9.3'

C. runtimeOnly 'org.junit.jupiter:junit-jupiter:5.9.3'

D. testImplementation 'org.junit.jupiter:junit-jupiter:5.9.3'

Solution

1. Step 1: Understand Gradle dependency scopes

   For testing libraries like JUnit, Gradle uses testImplementation to include dependencies only in the test source set.

2. Step 2: Identify the correct dependency declaration

   The correct syntax is testImplementation 'org.junit.jupiter:junit-jupiter:5.9.3' to add JUnit 5 for tests only.

3. Final Answer:

   testImplementation 'org.junit.jupiter:junit-jupiter:5.9.3' -> Option D

4. Quick Check:

   JUnit test dependency = testImplementation [OK]

Hint: Use testImplementation for test-only libraries like JUnit [OK]

Common Mistakes:

• Using implementation instead of testImplementation
• Using compile which is deprecated
• Using runtimeOnly which excludes compile-time access

2. Which of the following is the correct syntax to add JUnit 5 dependency in Gradle's build.gradle file using the Kotlin DSL?

easy

A. testImplementation 'org.junit.jupiter:junit-jupiter:5.9.3'

B. implementation("org.junit.jupiter:junit-jupiter:5.9.3")

C. testImplementation("org.junit.jupiter:junit-jupiter:5.9.3")

D. compile 'org.junit.jupiter:junit-jupiter:5.9.3'

Solution

1. Step 1: Recognize Kotlin DSL syntax

   Gradle Kotlin DSL uses parentheses and double quotes for dependencies, e.g., testImplementation("group:name:version").

2. Step 2: Identify the correct test dependency syntax

   testImplementation("org.junit.jupiter:junit-jupiter:5.9.3") uses the correct Kotlin DSL syntax for test dependencies.

3. Final Answer:

   testImplementation("org.junit.jupiter:junit-jupiter:5.9.3") -> Option C

4. Quick Check:

   Kotlin DSL uses parentheses and quotes [OK]

Hint: Kotlin DSL uses parentheses and quotes for dependencies [OK]

Common Mistakes:

• Using single quotes in Kotlin DSL
• Using compile which is deprecated
• Mixing Groovy and Kotlin syntax

3. Given this Gradle snippet in Groovy DSL:

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter:5.9.3'
    implementation 'com.google.guava:guava:31.1-jre'
}

Which statement is true when running tests?

medium

A. Guava is available only during test runtime.

B. JUnit 5 is available only during test compilation and runtime.

C. JUnit 5 is available during main source compilation.

D. Guava is available only during test compilation.

Solution

1. Step 1: Understand dependency scopes

   testImplementation means the dependency is available only for compiling and running tests, not main code. implementation is for main code and runtime.

2. Step 2: Apply to given dependencies

   JUnit 5 is declared with testImplementation, so it is only for test compilation and runtime. Guava is declared with implementation, so it is available in main code and runtime, not limited to tests.

3. Final Answer:

   JUnit 5 is available only during test compilation and runtime. -> Option B

4. Quick Check:

   testImplementation = test-only scope [OK]

Hint: testImplementation means test-only availability [OK]

Common Mistakes:

• Confusing implementation with testImplementation
• Assuming testImplementation affects main code
• Mixing runtimeOnly with implementation

4. You added this line to your Gradle build file:

testImplementation 'org.junit.jupiter:junit-jupiter:5.9.3'

But your tests fail to run with a "ClassNotFoundException" for JUnit classes. What is the most likely cause?

medium

A. You forgot to apply the 'java' or 'java-library' plugin in build.gradle.

B. You used 'testImplementation' instead of 'implementation'.

C. The JUnit version 5.9.3 does not exist.

D. You need to add 'runtimeOnly' for JUnit.

Solution

1. Step 1: Check plugin application

   Gradle needs the 'java' or 'java-library' plugin to recognize source sets and dependencies properly.

2. Step 2: Understand impact on dependencies

   Without the plugin, Gradle won't configure test source sets, causing ClassNotFoundException even if dependencies are declared.

3. Final Answer:

   You forgot to apply the 'java' or 'java-library' plugin in build.gradle. -> Option A

4. Quick Check:

   Java plugin required for test dependencies [OK]

Hint: Always apply 'java' plugin to enable test dependencies [OK]

Common Mistakes:

• Using implementation instead of testImplementation
• Assuming dependency version is wrong without checking
• Adding runtimeOnly unnecessarily

5. You want to add JUnit 5 and Mockito for testing in your Gradle project. Which is the best way to declare these dependencies to keep your build file organized and efficient?

hard

A. Use testImplementation for both JUnit and Mockito dependencies.

B. Use implementation for JUnit and testImplementation for Mockito.

C. Use runtimeOnly for both JUnit and Mockito.

D. Use compileOnly for JUnit and implementation for Mockito.

Solution

1. Step 1: Understand dependency scopes for testing libraries

   Both JUnit and Mockito are used only during testing, so they should be added with testImplementation to avoid including them in production code.

2. Step 2: Choose consistent and clear dependency declarations

   Using testImplementation for both keeps the build file organized and ensures dependencies are available only for tests.

3. Final Answer:

   Use testImplementation for both JUnit and Mockito dependencies. -> Option A

4. Quick Check:

   Test libraries = testImplementation [OK]

Hint: Put all test libs under testImplementation for clarity [OK]

Common Mistakes:

• Mixing implementation and testImplementation for test libs
• Using runtimeOnly which excludes compile-time access
• Using compileOnly which excludes runtime