Gradle Plugin, take the control of the build!

http://bit.ly/gradle-plugin-devoxx for speaker notes

Transcript

1. @YourTwitterHandle #YourSessionHashtag Plugin Gradle, prenez le contrôle du build !
2. Eyal LEZMY http://eyal.fr Cedric CHAMPEAU @CedricChampeau
3. SLIDES bit.ly/gradle-plugin-devoxx
4. DEFINITIONS 01
5. A dependency management engine A dependency based execution system A plugin system A set of plugins DEFINITIONS What is Gradle? by Luke Daley, Gradle core developer
6. Build scripts Your build.gradle file Script plugins The customization you start writing Binary plugins The code I want you to write DEFINITIONS Gradle Plugins Types
7. Is a piece of work for a build Compiling a class, generating javadoc, ... Can be manipulated doFirst, doLast Can inherit from another type Can depend on another task dependsOn, finalizedBy DEFINITIONS The Gradle Task
8. LET’S GET STARTED! 02
9. Your unit tests results, you have to version THE SUBJECT
10. THE JOB Copy and version this folder
11. task archiveTests (type: Copy) { from "$reportsDir/reports" into "$projectDir/reports/report-${currentTimeMillis()}" } tasks.test.finalizedBy archiveTests THE CODE End of build.gradle
12. task archiveTests (type: Copy) { from "$reportsDir/reports" into "$projectDir/reports/report-${currentTimeMillis()}" } tasks.test.finalizedBy archiveTests THE CODE We create the task End of build.gradle
13. task archiveTests (type: Copy) { from "$reportsDir/reports" into "$projectDir/reports/report-${currentTimeMillis()}" } tasks.test.finalizedBy archiveTests THE CODE It inherits from Copy task End of build.gradle
14. task archiveTests (type: Copy) { from "$reportsDir/reports" into "$projectDir/reports/report-${currentTimeMillis()}" } tasks.test.finalizedBy archiveTests THE CODE We define the copy parameters End of build.gradle
15. task archiveTests (type: Copy) { from "$reportsDir/reports" into "$projectDir/reports/report-${ currentTimeMillis()}" } tasks.test.finalizedBy archiveTests THE CODE We define the copy parameters This is the versioning End of build.gradle
16. task archiveTests (type: Copy) { from "$reportsDir/reports" into "$projectDir/reports/report-${currentTimeMillis()}" } tasks.test.finalizedBy archiveTests THE CODE We ask to run it after test task End of build.gradle
17. BUILD A PLUGIN 03 … for real
18. A PLUGIN? Use it on different projects Share it with others Keep your build script clean Keep your build script focused Cause’ it’s so easy! Why a plugin?
19. Is a Gradle project Basically, a Groovy project It contains A build.gradle A plugin class A descriptor One or several tasks An extension Examples Java, Groovy, Maven, Android plugin A PLUGIN? The Binary Plugin
20. THE ARCHITECTURE
21. THE ARCHITECTURE The plugin class
22. THE ARCHITECTURE The plugin class A task
23. THE ARCHITECTURE The plugin class A task The extension
24. THE ARCHITECTURE The plugin class A task The extension The descriptor
25. THE ARCHITECTURE The plugin class A task The extension The descriptor The build.gradle
26. class ArchiveTestsPlugin implements Plugin<Project> { void apply(Project project) { //TODO create the extension //TODO create the tasks //TODO link the tasks to the build chain } } THE CODE The Plugin class
27. class ArchiveTestsPlugin implements Plugin<Project> { void apply(Project project) { //TODO create the extension //TODO create the tasks //TODO link the tasks to the build chain } } THE CODE The Plugin class
28. class ArchiveTestsPlugin implements Plugin<Project> { void apply(Project project) { //TODO create the extension //TODO create the tasks //TODO link the tasks to the build chain } } THE CODE The Plugin class
29. class ArchiveTestsPlugin implements Plugin<Project> { void apply(Project project) { //TODO create the extension //TODO create the tasks //TODO link the tasks to the build chain } } THE CODE The Plugin class
30. class ArchiveTestsPlugin implements Plugin<Project> { void apply(Project project) { //create the extension project.extensions.create(“achivetest”,ArchiveTestPluginExtension, project) //create the tasks project.task(name:“achivetest”, type:ArchiveTask){} //link the tasks to the build chain Task task = project.tasks.getByName(project.archivetest.task) task.finalizedBy “achivetest” } } THE CODE The Plugin class
31. class ArchiveTask extends Copy { ArchiveTask(){ from project.archivetest.from into project.archivetest.into } @TaskAction def exec() { println "Reports copied into ${project.archivetest.into}" } } THE CODE The Task class
32. class ArchiveTask extends Copy { ArchiveTask(){ from project.archivetest.from into project.archivetest.into } @TaskAction def exec() { println "Reports copied into ${project.archivetest.into}" } } THE CODE The Task class
33. class ArchiveTask extends Copy { ArchiveTask(){ from project.archivetest.from into project.archivetest.into } @TaskAction def exec() { println "Reports copied into ${project.archivetest.into}" } } THE CODE We want a Copy task. Use DefaultTask to implement your own The Task class
34. class ArchiveTask extends Copy { ArchiveTask(){ from project.archivetest.from into project.archivetest.into } @TaskAction def exec() { println "Reports copied into ${project.archivetest.into}" } } THE CODE The Task class
35. class ArchiveTask extends Copy { ArchiveTask(){ from project.archivetest.from into project.archivetest.into } @TaskAction def exec() { println "Reports copied into ${project.archivetest.into}" } } THE CODE The Task class
36. class ArchiveTask extends Copy { ArchiveTask(){ from project.archivetest.from into project.archivetest.into } @TaskAction def exec() { println "Reports copied into ${project.archivetest.into}" } } THE CODE The Task class Here we use the extension’s content
37. archivetest { from "origin/folder" into "destination/folder" task "taskToLaunchCopy" } THE CODE The Extension: the syntax expected
38. archivetest { from "origin/folder" into "destination/folder" task "taskToLaunchCopy" } THE CODE The Extension: the syntax expected
39. THE CODE The Extension class class ArchiveTestPluginExtension { def from def into def task ArchiveTestPluginExtension(Project project) { from = project. reportsDir into = project.projectDir+"/reports/report-${currentTimeMillis()}" task = "test" } }
40. THE CODE The Extension class class ArchiveTestPluginExtension { def from def into def task ArchiveTestPluginExtension(Project project) { from = project. reportsDir into = project.projectDir+"/reports/report-${currentTimeMillis()}" task = "test" } } This is a simple POGO
41. THE CODE The Extension class class ArchiveTestPluginExtension { def from def into def task ArchiveTestPluginExtension(Project project) { from = project.reportsDir into = project.projectDir+"/reports/report-${currentTimeMillis()}" task = "test" } }
42. implementation-class= main.groovy.fr.eyal.ArchiveTestPlugin THE CODE The Descriptor: achivetest.properties
43. implementation-class=main.groovy.fr.eyal.ArchiveTestPlugin THE CODE The name of this file implies apply plugin: “archivetest” The Descriptor: achivetest.properties
44. apply plugin: 'groovy' dependencies { compile gradleApi() compile localGroovy() } ... THE CODE The build.gradle (1/2)
45. apply plugin: 'groovy' dependencies { compile gradleApi() compile localGroovy() } ... THE CODE The build.gradle (1/2) A plugin is a groovy project
46. apply plugin: 'groovy' dependencies { compile gradleApi() compile localGroovy() } ... THE CODE The build.gradle (1/2) Add a gradle API dependency corresponding to the gradle version used to compile the project
47. apply plugin: 'groovy' dependencies { compile gradleApi() compile localGroovy() } ... THE CODE The build.gradle (1/2) Add a groovy dependency corresponding to the gradle version used
48. ... apply plugin: 'maven-publish' group = 'fr.eyal' version = '0.1' publishing { publications { mavenJava(MavenPublication) { from components.java } } } THE CODE The build.gradle (2/2)
49. ... apply plugin: 'maven-publish' group = 'fr.eyal' version = '0.1' publishing { publications { mavenJava(MavenPublication) { from components.java } } } THE CODE The build.gradle (2/2)
50. ... apply plugin: 'maven-publish' group = 'fr.eyal' version = '0.1' publishing { publications { mavenJava(MavenPublication) { from components.java } } } THE CODE The build.gradle (2/2)
51. USE THE PLUGIN 04
52. USE THE PLUGIN Add the repository Add dependency Apply the plugin Configure the plugin if needed How to use our plugin?
53. buildscript { repositories { mavenLocal() } dependencies { classpath 'fr.eyal:archivetest:0.1' } } apply plugin: 'archivetest' archivetest { from "build/report" into "/tmp/archives" task “connectedAndroidTest” } THE CODE The user’s build.gradle
54. buildscript { repositories { mavenLocal() } dependencies { classpath 'fr.eyal:archivetest:0.1' } } apply plugin: 'archivetest' archivetest { from "build/report" into "/tmp/archives" task “connectedAndroidTest” } THE CODE The user’s build.gradle
55. buildscript { repositories { mavenLocal() } dependencies { classpath 'fr.eyal:archivetest:0.1' } } apply plugin: 'archivetest' archivetest { from "build/report" into "/tmp/archives" task “connectedAndroidTest” } THE CODE The user’s build.gradle The local repository folder
56. buildscript { repositories { mavenLocal() } dependencies { classpath ' fr.eyal:archivetest:0.1' } } apply plugin: 'archivetest' archivetest { from "build/report" into "/tmp/archives" task “connectedAndroidTest” } THE CODE The user’s build.gradle pom.group pom.artifactId pom.version
57. buildscript { repositories { mavenLocal() } dependencies { classpath 'fr.eyal:archivetest:0.1' } } apply plugin: ' archivetest' archivetest { from "build/report" into "/tmp/archives" task “connectedAndroidTest” } THE CODE The user’s build.gradle archivetest.properties
58. buildscript { repositories { mavenLocal() } dependencies { classpath 'fr.eyal:archivetest:0.1' } } apply plugin: 'archivetest' archivetest { from "build/report" into "/tmp/archives" task “connectedAndroidTest” } THE CODE The user’s build.gradle Our extension
59. RUN IT 05
60. archivetest { from "build/report" into "/tmp/archives" } RUN IT $ gradle test
61. archivetest { from "build/report" into "/tmp/archives" } RUN IT $ gradle test ... Reports copied into /home/user/project/reports/report-1422480068261 ... BUILD SUCCESSFUL
62. archivetest { from "build/report" into "/tmp/archives" } RUN IT $ gradle test ... Reports copied into /home/user/project/reports/report-1422480068261 ... BUILD SUCCESSFUL Yay!
63. RUN IT archivetest { from "build/report" into "/tmp/archives" task "hello" } task hello << { println "Sample task" }
64. RUN IT archivetest { from "build/report" into "/tmp/archives" task "hello" } task hello << { println "Sample task" } Copy after the hello task
65. RUN IT archivetest { from "build/report" into "/tmp/archives" task "hello" } task hello << { println "Sample task" } Copy after the hello task Create the hello task
66. $ gradle hello archivetest { from "build/report" into "/tmp/archives" task "hello" } task hello << { println "Sample task" } RUN IT
67. RUN IT $ gradle hello ... BUILD SUCCESSFUL archivetest { from "build/report" into "/tmp/archives" task "hello" } task hello << { println "Sample task" } No copy
68. RUN IT $ gradle hello ... BUILD SUCCESSFUL archivetest { from "build/report" into "/tmp/archives" task "hello" } task hello << { println "Sample task" } Oh no...
69. To figure out you have to
70. apply plugin: 'archivetest' archivetest { from "build/report" into "/tmp/archives" task "hello" } task hello << { println "Sample task" } DEBUG IT The user’s build.gradle
71. apply plugin: 'archivetest' archivetest { from "build/report" into "/tmp/archives" task "hello" } task hello << { println "Sample task" } DEBUG IT The user’s build.gradle Call apply() on ArchiveTestPlugin
72. apply plugin: 'archivetest' archivetest { from "build/report" into "/tmp/archives" task "hello" } task hello << { println "Sample task" } DEBUG IT The user’s build.gradle Call apply() on ArchiveTestPlugin - Create the extension - archivetest.task = "test" - Create the copy task - Finalize archivetest.task by achivetest task
73. apply plugin: 'archivetest' archivetest { from "build/report" into "/tmp/archives" task "hello" } task hello << { println "Sample task" } DEBUG IT The user’s build.gradle Modify the extension content - archivetest.task = "hello" Call apply() on ArchiveTestPlugin - Create the extension - archivetest.task = "test" - Create the copy task - Finalize archivetest.task by achivetest task
74. apply plugin: 'archivetest' archivetest { from "build/report" into "/tmp/archives" task "hello" } task hello << { println "Sample task" } DEBUG IT The user’s build.gradle Call apply() on ArchiveTestPlugin Create the hello task - Create the extension - archivetest.task = "test" - Create the copy task - Finalize archivetest.task by achivetest task Modify the extension content - archivetest.task = "hello"
75. THE TASK GRAPH
76. THE TASK GRAPH Created by Java/Groovy plugin test
77. THE TASK GRAPH Created by archivetest plugin test test archive test
78. THE TASK GRAPH ‘test’ finalized by ‘archivetest’ test test archive test
79. THE TASK GRAPH test test archive test test archive test Created by build.gradle hello
80. THE TASK GRAPH test archive test hello Launch hello
81. THE TASK GRAPH test archive test hello Launch hello
82. THE TASK GRAPH test archive test hello Launch hello
83. THE TASK GRAPH test archive test hello Launch hello No link to our copy task
84. class ArchiveTestsPlugin implements Plugin<Project> { void apply(Project project) { //create the extension project.extensions.create(“achivetest”,ArchiveTestPluginExtension, project) //create the tasks project.task(name:“achivetest”, type:ArchiveTask){} //link the tasks to the build chain Task task = project.tasks.getByName(project.archivetest.task) task.finalizedBy “achivetest” } } DEBUG IT The Plugin class
85. class ArchiveTestsPlugin implements Plugin<Project> { void apply(Project project) { //create the extension project.extensions.create(“achivetest”,ArchiveTestPluginExtension, project) //create the tasks project.task(name:“achivetest”, type:ArchiveTask){} //link the tasks to the build chain Task task = project.tasks.getByName(project.archivetest.task) task.finalizedBy “achivetest” } } DEBUG IT The Plugin class Executed too early
86. DEBUG IT Initialization Choose project(s) to build Configuration Execute build.gradle Build task graph Execution Execute tasks chain Gradle build lifecylcle
87. DEBUG IT Project evaluation beforeEvaluate afterEvaluate Task Graph whenTaskAdded whenReady beforeTask afterTask The lifecycle events
88. class ArchiveTestsPlugin implements Plugin<Project> { void apply(Project project) { ... //link the tasks to the build chain Task task = project.tasks.getByName(project.archivetest.task) task.finalizedBy “achivetest” } } DEBUG IT The Plugin class
89. class ArchiveTestsPlugin implements Plugin<Project> { void apply(Project project) { ... //link the tasks to the build chain project.afterEvaluate { Task task = project.tasks.getByName(project.archivetest.task) task.finalizedBy “achivetest” } } } DEBUG IT The Plugin class We add the task after the evaluation
90. THE TASK GRAPH test archive test hello
91. THE TASK GRAPH test archive test hello Yay!
92. TEST IT 06
93. Very simple As simple as Groovy is Groovy is your best friend A language very easy to mock Junit & co As anybody knows TEST IT Gradle project testing
94. ProjectBuilder To create a mock project Evaluate To execute your mocked build script A few specificities TEST IT
95. TEST IT
96. TEST IT Adding a test class
97. TEST IT Adding a test class Adding junit dependency
98. TEST IT Our buid.gradle ... repositories { jcenter() } dependencies { testCompile 'junit:junit:4.11' } ...
99. TEST IT Our buid.gradle ... repositories { jcenter() } dependencies { testCompile 'junit:junit:4.11' } ... Adding maven central repository
100. TEST IT Our buid.gradle ... repositories { jcenter() } dependencies { testCompile 'junit:junit:4.11' } ... Adding junit as testing dependency
101. Now, test the extension
102. TEST IT Your first test! class ArchiveTestPluginTest { @Test public void canAddArchiveTestExtension() { Project project = ProjectBuilder.builder().build() project.apply plugin: 'java' project.apply plugin: 'archivetest' assert project.archivetest instanceof ArchiveTestPluginExtension } }
103. TEST IT Your first test! class ArchiveTestPluginTest { @Test public void canAddArchiveTestExtension() { Project project = ProjectBuilder.builder().build() project.apply plugin: 'java' project.apply plugin: 'archivetest' assert project.archivetest instanceof ArchiveTestPluginExtension } } Mock a Gradle project
104. TEST IT Your first test! class ArchiveTestPluginTest { @Test public void canAddArchiveTestExtension() { Project project = ProjectBuilder.builder().build() project.apply plugin: 'java' project.apply plugin: 'archivetest' assert project.archivetest instanceof ArchiveTestPluginExtension } } Apply Java plugin To create ‘test’ task
105. TEST IT Your first test! class ArchiveTestPluginTest { @Test public void canAddArchiveTestExtension() { Project project = ProjectBuilder.builder().build() project.apply plugin: 'java' project.apply plugin: 'archivetest' assert project.archivetest instanceof ArchiveTestPluginExtension } } Apply our plugin
106. TEST IT Your first test! class ArchiveTestPluginTest { @Test public void canAddArchiveTestExtension() { Project project = ProjectBuilder.builder().build() project.apply plugin: 'java' project.apply plugin: 'archivetest' assert project.archivetest instanceof ArchiveTestPluginExtension } } Test our extension exists
107. Now, test the task
108. TEST IT Your second test! class ArchiveTestPluginTest { @Test public void canAddArchiveTask() { Project project = ProjectBuilder.builder().build() project.apply plugin: 'java' project.apply plugin: 'archivetest' assert project.tasks.archivetest instanceof ArchiveTask } } We initialize our project
109. TEST IT Your second test! class ArchiveTestPluginTest { @Test public void canAddArchiveTask() { Project project = ProjectBuilder.builder().build() project.apply plugin: 'java' project.apply plugin: 'archivetest' assert project.tasks.archivetest instanceof ArchiveTask } } We test the task
110. TEST IT Run your second test $ gradle test --stacktrace --debug
111. TEST IT Run your second test $ gradle test --stacktrace --debug ... test.groovy.fr.eyal.ArchiveTestPluginTest > canAddArchiveTask FAILED MissingPropertyException: Could not find property 'archivetest' on task set ... BUILD FAILED
112. TEST IT Run your second test $ gradle test --stacktrace --debug ... test.groovy.fr.eyal.ArchiveTestPluginTest > canAddArchiveTask FAILED MissingPropertyException: Could not find property 'archivetest' on task set ... BUILD FAILED Our task is not created
113. class ArchiveTestsPlugin implements Plugin<Project> { void apply(Project project) { ... project.afterEvaluate { //create the tasks project.task(name:“achivetest”, type:ArchiveTask){} //inject the task Task task = project.tasks.getByName(project.archivetest.task) task.finalizedBy “achivetest” } } } TEST IT The Plugin class Tasks are often created after project. evaluate()
114. So, evaluate.
115. TEST IT Your first test! class ArchiveTestPluginTest { @Test void canAddArchiveTask() { Project project = ProjectBuilder.builder().build() project.apply plugin: 'java' project.apply plugin: 'archivetest' project.evaluate() assert project.tasks.archivetest instanceof ArchiveTask } } We launch evaluate() on the project
116. TEST IT Run your second test $ gradle test --stacktrace --debug
117. TEST IT Run your second test $ gradle test --stacktrace --debug ... BUILD SUCCESSFUL
118. TEST IT Run your second test $ gradle test --stacktrace --debug ... BUILD SUCCESSFUL Yay!
119. TEST IT LUKE DALEY Gradleware Principal Engineer GRADLE FORUM You don't see this in the API docs for Project because it is an internal method and is therefore potentially subject to change in future releases. There will be a supported mechanism for doing this kind of thing in the near future. ” “
120. TEST IT LUKE DALEY Gradleware Principal Engineer GRADLE FORUM You don't see this in the API docs for Project because it is an internal method and is therefore potentially subject to change in future releases. There will be a supported mechanism for doing this kind of thing in the near future. June 2011 ” “
121. IMPROVE IT 07
122. Plugin Base Java vs. Plugin Java Defines what is a test task tasks.withType(Test) IMPROVE IT Convention over Configuration
123. Avoid running useless tasks UP-TO-DATE Declare Inputs @Input, @InputFile, @InputFiles, @InputDirectory Declare outputs @OutputFile, @OutputDirectory IMPROVE IT Incremental builds
124. More flexibility of annotations @InputFile String filePath @InputDirectory String directoryPath ... IMPROVE IT Coming soon
125. OnlyIf Conditional task execution IMPROVE IT Tweaking Execution Graph
126. ArchiveTask() { onlyIf { !parent.state.skipped } } IMPROVE IT
127. Gradle Plugin documentation https://gradle.org/documentation References
128. SLIDES http://bit.ly/gradle-plugin-devoxx Thank you!