Gradle Operations TODEPLETE: Difference between revisions
| Line 1: | Line 1: | ||
=DEPLETE TO= | =DEPLETE TO= | ||
{{Internal|Gradle Operations|Gradle Operations}} | {{Internal|Gradle Operations|Gradle Operations}} | ||
=Operations= | =Operations= | ||
Revision as of 01:40, 28 March 2021
DEPLETE TO
Operations
Debug a Gradle Script
This will allow setting breakpoints in the gradle scripts (build.gradle, etc.):
export JAVA_OPTS="-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005"
gradle ...
Also, important, make sure not to use the Gradle daemon when debugging the Gradle scripts.
Alternatively, Gradle setting org.gradle.debug can be used:
gradle -Dorg.gradle.debug=true --no-daemon build
Debug a Test Executed with Gradle
gradle test --debug-jvm
Gradle will suspend execution right before running tests and wait for debugger connection on port 5005.
TODO:
- For selecting specific tests for execution, see https://docs.gradle.org/current/userguide/java_testing.html#simple_name_pattern
- Reconcile with Testing_with_Gradle_Java_Plugin#Debugging_a_Gradle_Test
Start a Project
gradle init
Creates a project structure that includes:
- build.gradle
- settings.gradle
- a project-level gradle directory
- a project-level .gradle directory
- gradlew, gradlew.bat
Note that in some cases, the execution flag is not set on gradlew, so you may have to set it manually.
Gradle Project Initialization Script
This is a script that is a little bit more complex than gradle init. The script creates the project root directory, interactively queries project elements, such as the initial package name, etc. It then will will create the initial package and a simple Main class, will initialize build.gradle with the minimal configuration required to build a Java project and it will put in place the run wrapper.
List Sub-Projects
gradle projects
Inspect Dependencies, Generate Dependency Tree
The full graph of the project's dependencies can be rendered. The selection reason and origin for a dependency can also be displayed.
To display the dependency trees for all dependency configurations of the project, execute:
gradle -q dependencies
The result is called a dependency report. Any dependency that could not be resolved is marked with FAILED in red color. Dependencies with the same coordinates that can occur multiple times in the graph are omitted and indicated by an asterisk. Dependencies that had to undergo conflict resolution render the requested and selected version separated by a right arrow character. The dependency report provides the raw list of dependencies but does not explain why they have been selected or which dependency is responsible for pulling them into the graph. These explanations can though be generated, see Identify Why a Specific Dependency was Selected.
To display the dependency tree for just one dependency configuration:
gradle -q dependencies --configuration <configuration-name>
Identify Why a Specific Dependency was Selected
gradle -q dependencyInsight --dependency <dependency-name> [--configuration <configuration-name>]
Print the Runtime Classpath
task printClasspath {
doLast {
configurations.runtimeClasspath.each { print it; print ':' }
}
}
Then Gradle must be run with "-q" option to discard extraneous output:
gradle -q printClasspath
Run a Specific Test
gradle test --tests "com.example.MyTests.mySingleTest"
Do Not Use Gradle Daemon to Run the Build
gradle --no-daemon ...
Useful when debugging Gradle configuration scripts.
Pass Configuration on Command Line
Pass Configuration via Custom Environment Variables
Artifact Publishing Operations
Command-Line Interface
Tasks
build
gradle build
Build a sub-project:
gradle :<sub-project-name>:build
Build without Tests
Build without tests. Works with simple projects or multi-project builds.
gradle build -x test gradle build -x :some-project:test
projects
gradle projects
tasks
properties
Displays project properties, properties added by various plugins and their default values.
gradle properties