The Gradle Interface: Gradle Build Metadata
As I’ve shown in previous posts such as “Identifying Gradle Conventions” and “Evolving Gradle Build from Ant Build: Importing Ant Build File“, significant information about a Gradle build can be gleaned by accessing Gradle’s APIs via Groovy. In this post, I look demonstrate accessing basic Gradle build details via the Gradle interface.
The org.gradle.api.invocation.Gradle interface is accessible in the Gradle build file via simply “gradle” [which implicitly corresponds to getGradle() in Groovy parlance]. The next Gradle build script listing shows a subset of the metadata information available via the Gradle
interface.
build-gradle-interface.gradle
// build-gradle-interface.gradle apply plugin: 'java' println "Class: ${this.getClass().canonicalName}" println "Gradle: ${gradle.getClass().canonicalName}" println "Ant: ${ant.getClass().canonicalName}" println "Root Project: ${rootProject.getClass().canonicalName}" println "\n=== Gradle ===" println "\tgradleVersion = ${gradle.gradleVersion}" println "\tgradleHomeDir = ${gradle.gradleHomeDir}" println "\tgradleUserHomeDir = ${gradle.gradleUserHomeDir}" println "\n=== Gradle.startParameter ===" def startParameter = gradle.startParameter println "\tcurrentDir = ${startParameter.currentDir}" println "\tprojectDir = ${startParameter.projectDir}" println "\tgradleUserHomeDir = ${startParameter.gradleUserHomeDir}" println "\tbuildFile = ${startParameter.buildFile}" println "\tprojectProperties = ${startParameter.projectProperties}" println "\tsystemPropertiesArgs = ${startParameter.systemPropertiesArgs}" println "\ttaskNames = ${startParameter.taskNames}"
When I run the Gradle build above and specify that the “jar” task (a task provided by the Java plugin) should be run, the output appears as follows:
The above build listing and associated screen snapshot indicate that the Gradle
interface provides metadata such as version of Gradle, the Gradle installation’s home directory, and the Gradle user’s directory. The Gradle
interface also provides access to an instance of StartParameter that provides further build start-up metadata details such as project directory, current directory, the name of the build file, project properties, system properties, and names of tasks that were specified for execution.
There is significantly more information that can be gleaned about a Gradle build from the Gradle
interface and this post only shows a subset of that information.