HomeGradleCreate gradle project in eclipse and run the build

Create gradle project in eclipse and run the build

February 27, 2020

In this article we will see how to create a java gradle project in eclipse and how to run gradle build and unit tests of the java application using gradle build tasks.

Latest version of Eclipse or STS (Spring tool suite) has the built-in gradle support. You can easily create java gradle project in eclipse without any additional setup.

1. Create java gradle project in eclipse

1.1. Step 1

In eclipse click on File -> click on New -> click on Other option.

create new gradle project in eclipse step1

1.2. Step 2

In wizards box type gradle to filter wizards -> select Gradle Project -> Click on Next.

1.3. Step 3

Simply click on Next button.

1.4. Step 4

Enter the project name in project name text box -> click on Finish button.

1.5 Step 5

You will see following java gradle project structure in eclipse.

2. Auto Generated files for Java gradle project in eclipse

2.1. Library.java

Library.java is a auto generated java file generated Gradle plugin.

public class Library {
    public boolean someLibraryMethod() {
        return true;
    }
}

2.2. LibraryTest.java

Gradle plugin also generates a simple junit test case LibraryTest.java to test the Library.java methods.

public class LibraryTest {
    @Test 
    public void testSomeLibraryMethod() {
        Library classUnderTest = new Library();
        assertTrue("someLibraryMethod should return 'true'", classUnderTest.someLibraryMethod());
    }
}

2.3. Auto generated build.gradle file

Auto generated java gradle project uses junit dependency junit:junit:4.12.

/*
 * This file was generated by the Gradle 'init' task.
 *
 * This generated file contains a sample Java Library project to get you started.
 * For more details take a look at the Java Libraries chapter in the Gradle
 * User Manual available at https://docs.gradle.org/6.1.1/userguide/java_library_plugin.html
 */

plugins {
    id 'java-library'
}

repositories {
    // Use jcenter for resolving dependencies.
    // You can declare any Maven/Ivy/file repository here.
    jcenter()
}

dependencies {
    api 'org.apache.commons:commons-math3:3.6.1' //math library

    implementation 'com.google.guava:guava:28.1-jre' // google guava dependecy

    testImplementation 'junit:junit:4.12' // junit dependency for testing
}

2.4. Synchronize gradle tasks

If you updated source files or build.gradle file, refresh the gradle tasks to synchronize the changes to take effect on build tasks.

3. Run gradle build

In gradle tasks tab -> navigate to the project -> expand build folder -> right click on build -> Select Run Gradle tasks.

Output :

Gradle Tasks: build

> Task :compileJava
> Task :processResources NO-SOURCE
> Task :classes
> Task :jar
> Task :assemble
> Task :compileTestJava
> Task :processTestResources NO-SOURCE
> Task :testClasses
> Task :test
> Task :check
> Task :build

BUILD SUCCESSFUL in 2s
4 actionable tasks: 4 executed

4. Run unit tests using gradle task

Refer to above image, to run unit tests expand verification folder -> right click on test -> Select Run Gradle tasks.

All the unit tests will be executed. you will see output in console.

Gradle Tasks: test

> Task :compileJava
> Task :processResources NO-SOURCE
> Task :classes
> Task :compileTestJava
> Task :processTestResources NO-SOURCE
> Task :testClasses
> Task :test

BUILD SUCCESSFUL in 1s
3 actionable tasks: 3 executed

5. Conclusion

In this article we saw how to create a java gradle project in eclipse and how to run gradle build and unit tests of the java application using gradle build tasks.

References

Gradle