Creating Gradle Plugins - GR8Conf US
•
3 likes•710 views
If you find yourself copying and pasting code from your build.gradle file every time you start a new project, then it's time you learn about Gradle Plugins. Come and learn what it takes to create a custom Gradle plugin for use in your Android/Java applications. We're going to go over the following: • Plugin Structure • Key Components • Testing • Publishing Walk away feeling empowered to create your own awesome plugins!
Recommended
Recommended
More Related Content
What's hot
What's hot (19)
Similar to Creating Gradle Plugins - GR8Conf US
Similar to Creating Gradle Plugins - GR8Conf US (20)
More from Annyce Davis
More from Annyce Davis (16)
Recently uploaded
Recently uploaded (20)
Creating Gradle Plugins - GR8Conf US
- 2. @BRWNGRLDEV
- 3. @BRWNGRLDEV
- 4. apply plugin: 'checkstyle' apply plugin: 'findbugs' apply plugin: 'pmd' task checkstyle(type: Checkstyle) { description 'Checks if the code is somewhat acceptable' group 'verification' configFile file('./qa-check/checkstyle.xml') source 'src' include '**/*.java' exclude '**/gen/**' classpath = files() ignoreFailures = false } task findbugs(type: FindBugs) {
- 5. apply plugin: 'checkstyle' apply plugin: 'findbugs' apply plugin: 'pmd' task checkstyle(type: Checkstyle) { description 'Checks if the code is somewhat acceptable' group 'verification' configFile file('./qa-check/checkstyle.xml') source 'src' include '**/*.java' exclude '**/gen/**' classpath = files() ignoreFailures = false } task findbugs(type: FindBugs) { description 'Run findbugs' group 'verification' classes = files("$project.buildDir/intermediates/classes") source 'src' classpath = files() effort 'max' excludeFilter file('./qa-check/findbugs-exclude.xml') reports { xml.enabled = true html.enabled = false } ignoreFailures = true } task pmd(type: Pmd) { description 'Run PMD' group 'verification' ruleSetFiles = files("./qa-check/pmd-ruleset.xml") ruleSets = [] source 'src' include '**/*.java' exclude '**/gen/**' reports { xml.enabled = false html.enabled = true } ignoreFailures = true } apply plugin: 'info.adavis.qualitychecks'
- 6. OVERVIEW ▸Plugin Skeleton ▸Dependencies ▸Plugin.groovy ▸CustomTask.groovy ▸Publishing @BRWNGRLDEV
- 10. PLUGIN SKELETON How Gradle finds the Plugin Implementation @BRWNGRLDEV
- 13. DEPENDENCIES apply plugin: ‘groovy' dependencies { compile gradleApi() compile localGroovy() } @BRWNGRLDEV
- 14. DEPENDENCIES dependencies { … testCompile 'junit:junit:4.12' testCompile ('org.spockframework:spock-core:1.0-groovy-2.4') { exclude module: 'groovy-all' } } @BRWNGRLDEV
- 17. GRADLE BUILD @BRWNGRLDEV PROJECT TASK TASK TASK BUILD
- 18. GRADLE BUILD @BRWNGRLDEV PROJECT TASK TASK TASK BUILD PROJECT TASK TASK TASK
- 19. PLUGIN.GROOVY class CustomPlugin implements Plugin<Project> { } @BRWNGRLDEV
- 20. PLUGIN.GROOVY class CustomPlugin implements Plugin<Project> { @Override void apply(Project project) { } } @BRWNGRLDEV
- 22. APPLY METHOD @BRWNGRLDEV void apply(Project project) { this.project = project }
- 23. APPLY METHOD @BRWNGRLDEV void apply(Project project) { this.project = project project.extensions.create('qualityChecks', QualityChecksExtension) }
- 24. APPLY METHOD @BRWNGRLDEV void apply(Project project) { this.project = project project.extensions.create('qualityChecks', QualityChecksExtension) createConfigFilesIfNeeded() createConfigFileTasks() createQualityChecksTasks() }
- 25. PROJECT EXTENSION @BRWNGRLDEV class QualityChecksExtension { String pmdConfigFile = 'quality-checks/pmd-ruleset.xml' String checkstyleConfigFile = 'quality-checks/checkstyle.xml' String findBugsExclusionFile = 'quality-checks/findbugs-exclude.xml' }
- 26. PROJECT EXTENSION @BRWNGRLDEV class QualityChecksExtension { String pmdConfigFile = 'quality-checks/pmd-ruleset.xml' String checkstyleConfigFile = 'quality-checks/checkstyle.xml' String findBugsExclusionFile = 'quality-checks/findbugs-exclude.xml' }
- 27. PROJECT EXTENSION Back in the application’s build.gradle file… @BRWNGRLDEV qualityChecks { pmdConfigFile = ‘checks/pmd.xml’ checkstyleConfigFile = ‘checks/checkstyle.xml’ }
- 28. PROJECT EXTENSION Back in the application’s build.gradle file… @BRWNGRLDEV qualityChecks { pmdConfigFile = ‘checks/pmd.xml’ checkstyleConfigFile = ‘checks/checkstyle.xml’ }
- 30. CREATING TASKS Give it a name and a type @BRWNGRLDEV
- 31. CREATING TASKS @BRWNGRLDEV ▸Build on existing task ▸Extend the DefaultTask
- 32. BUILD ON EXISTING TASK @BRWNGRLDEV
- 35. CUSTOMTASK.GROOVY class CustomTask extends DefaultTask { CustomTask() { group: ‘verification’ } } @BRWNGRLDEV
- 36. CUSTOMTASK.GROOVY class CustomTask extends DefaultTask { CustomTask() { group: ‘verification’ } } @BRWNGRLDEV
- 37. CUSTOMTASK.GROOVY CustomTask() { group: ‘verification’ onlyIf { // skip under certain conditions } } @BRWNGRLDEV
- 38. CUSTOMTASK.GROOVY @TaskAction def defaultAction() { description: ‘What my task does’ } @BRWNGRLDEV
- 39. CUSTOMTASK.GROOVY @BRWNGRLDEV @TaskAction def defaultAction() { description: ‘What my task does’ <do your cool stuff here> }
- 44. PUBLISHING buildscript { … dependencies { classpath "com.gradle.publish:plugin-publish-plugin:0.9.4" } } apply plugin: 'com.gradle.plugin-publish' @BRWNGRLDEV
- 45. PUBLISHING version = "0.1.3" group = "info.adavis" @BRWNGRLDEV
- 46. PUBLISHING pluginBundle { website = 'https://github.com/adavis/quality-checks' vcsUrl = 'https://github.com/adavis/quality-checks.git' description = 'Gradle Plugin for…’ tags = ['Checkstyle', 'FindBugs', 'PMD'] } @BRWNGRLDEV
- 47. PUBLISHING pluginBundle { … plugins { qualityChecksPlugin { id = 'info.adavis.qualitychecks' displayName = 'Quality Checks Plugin' } } @BRWNGRLDEV
- 48. @BRWNGRLDEV
- 49. @BRWNGRLDEV
- 52. TESTING - WITH JUNIT @Before void setUp() { projectDir = temporaryFolder.root projectDir.mkdirs() } @BRWNGRLDEV
- 53. TESTING - WITH JUNIT @Before void setUp() { projectDir = temporaryFolder.root projectDir.mkdirs() project = ProjectBuilder.builder().withProjectDir(projectDir).build() task = project.tasks.create('writeConfigFile', WriteConfigFileTask) } @BRWNGRLDEV
- 54. TESTING - WITH JUNIT @Test void shouldBeAbleToCreateTask() { assertTrue(task instanceof WriteConfigFileTask) } @BRWNGRLDEV
- 55. TESTING - WITH JUNIT @Test void pluginShouldBeApplied() { project.apply(plugin: QualityChecksPlugin) assertNotNull(project.tasks.findByName(‘mytask’)) } @BRWNGRLDEV
- 57. TESTING - WITH SPOCK def createCheckstyleTask() { given: "we have a project" def project = ProjectBuilder.builder().build() }
- 58. TESTING - WITH SPOCK def createCheckstyleTask() { and: "we apply the extension" project.extensions.create('qualityChecks', QualityChecksExtension) and: "we supply an existing checkstyle config file" project.qualityChecks.checkstyleConfigFile = File.createTempFile('temp', '.xml').path }
- 59. TESTING - WITH SPOCK def createCheckstyleTask() { when: "we create a checkstyle task" def checkstyleTask = project.tasks.create('checkstyle', CheckstyleTask) }
- 60. TESTING - WITH SPOCK def createCheckstyleTask() { then: "it should not replace our previous file" checkstyleTask.configFile.name.startsWith('temp') }
- 61. TESTING - WITH SPOCK @BRWNGRLDEV
- 63. TESTING - SPOCK-REPORT dependencies { … testCompile( 'com.athaydes:spock-reports:1.2.12' ) { transitive = false } } @BRWNGRLDEV
- 65. @BRWNGRLDEV
- 69. SUMMARY ▸Helps avoid copy/paste horror ▸Simple project structure ▸Extending DefaultTask ▸Testing techniques ▸Easy to publish @BRWNGRLDEV