Gradle Cheatsheet

Try to summarize some common command for gradle:

Run a specific test casePermalink

./gradlew test --tests "abc.test.XyzTest"

Run a specific classPermalink

Basically you can use JavaExec task to achieve this, for example, you can add an execute task in your build.gradle file:

task execute(type:JavaExec) {
   main = mainClass
   classpath = sourceSets.main.runtimeClasspath
}

To run a sepcific class,

gradle -PmainClass=Foo.Bar execute

Note: mainClass is the name of class you want to run and passed in at command line.

./gradlew test --tests "abc.test.XyzTest"

Generate the default folder structurePermalink

# for Java project
gradle init --type java-library

# The default java-library project has the following features enabled:
# Uses the “java” plugin
# Uses the “jcenter” dependency repository
# Uses JUnit for testing
# Has directories in the conventional locations for source code
# Contains a sample class and unit test, if there are no existing source or test files

# more options for java project
gradle init --type java-library --test-framework spock: Uses Spock for testing instead of JUnit

# for scala project
gradle init --type scala-library

gradle init --type java-library --test-framework testng: Uses TestNG for testing instead of JUnit

# for groovy project
gradle init --type groovy-library

# for basic setup
gradle init --type basic

• Reference - gradle build init plugin

show dependencies for your gradle projectPermalink

gradle dependencies
gradle htmlDependencyReport
## for sub-projects
gradle sub-project-name:dependencies
gradle sub-project-name:htmlDependencyReport

or if you want to show the dependencies for all of your sub-projects, add the following into your top level build.gradle

subprojects {
    task listAllDependencies(type: DependencyReportTask) {}
}

Lock dependenciesPermalink

You can use dynamic dependency versions and still lock them to specific versions with the Gradle Dependency Lock Plugin](https://plugins.gradle.org/plugin/nebula.dependency-lock) from Netflix’s Nebula Plugins project.

gradle generateLock saveLock

• Reference - understand gradle dependencies
• Locking Dependency Versions in Gradle

Use artifact from a local projectPermalink

Sometimes you might want to use an artifact from a local project where you may have some local changes that haven’t been pushed to the artifactory yet. Suppose you have two project (A, B), and you want to use a local build from project B in project A.

To do so, you need to:

In both projectPermalink

Make sure you have maven plugin added, and also have mavenLocal in your repository setting.

apply plugin: 'maven'
buildscript {
    repositories {
        mavenLocal()
        maven {
        // your official artifactory config
        }
    }
    ...
}

Note, if you have sub-projects for each project, make sure the above is applied to all sub-projects.

In Project BPermalink

Use gradle publishToMavenLocal to publish the build artifact to your local maven repository. Once it’s done, you should be able to find the build artifact in your local maven repository ${user.home}/.m2/reposistories. NOTE this requires the maven-publish plugin to be added to the projects.

exclude test and/or checkPermalink

gradle clean build -x check -x test

Configure jvm args in gradle.propertiesPermalink

This will configure the jvm args for build tools.

org.gradle.jvmargs=-Xmx2g -XX:MaxMetaspaceSize=1024m -XX:MaxPermSize=1024m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8

For client VMs, you need to use JVM_OPTS

For more information, check this out: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.testing.Test.html

disable gradle daemonPermalink

org.gradle.daemon=false

Enable logging output for gradle testsPermalink

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

Define a gradle task that runs a commandPermalink

task runArtillery(type: Exec) {
    description "Execute Artillery simulation"
    group "Load testing"
    commandLine "cmd", "/c", "artillery", "run", "-o", "report.json", "./src/artillery/artillery-demo.yml"
}

see details here TestLoggingContainer

Pass custom properties to taskPermalink

task printProp << {
    println customProp
}

Then the property customProp can be passed in cli as:

gradle -PcustomProp=myProp

ReferencesPermalink

• Spring - Creating a Multi Module Project