Creating Gradle Plugins - Oredev

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) {

apply plugin: 'checkstyle' 
apply plugin: 'findbugs' 
apply plugin: 'pmd' 
 
task checkstyle(type: Checkstyle) { 
description 'Checks if the code is somewhat acceptable' 
 
configFile file('./qa-check/checkstyle.xml') 
source 'src' 
 
ignoreFailures = false 
} 
 
task findbugs(type: FindBugs) { 
description 'Run findbugs' 
 
classes = files("$project.buildDir/intermediates/classes") 
source 'src' 
 
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' 
 
ruleSetFiles = files("./qa-check/pmd-ruleset.xml") 
ruleSets = [] 
 
source 'src' 
 
reports { 
xml.enabled = false 
html.enabled = true 
} 
 
ignoreFailures = true 
}
apply plugin: 'info.adavis.qualitychecks'

OVERVIEW
▸Gradle Task
▸Plugin Skeleton
▸Dependencies
▸Plugin Classes
▸Publishing
@BRWNGRLDEV

GRADLE BUILD
@BRWNGRLDEV
PROJECT
TASK TASK TASK
BUILD

GRADLE BUILD LIFECYCLE
@BRWNGRLDEV
TASK
TASK TASK
TASK TASK

EXAMPLE TASK
@BRWNGRLDEV
I want to ask you for your name.
1. Say Hello
2. Ask for your name

DEFINING A TASK
@BRWNGRLDEV
task sayHello {
doLast {
println “Hello.”
}
}

DEFINING A TASK
@BRWNGRLDEV
task askYourName {
dependsOn “sayHello”
doLast {
println “What is your name?”
}
}
task sayHello {
doLast {
println “Hello.”
}
}

PLUGIN
@BRWNGRLDEV
PROJECT
TASK TASK TASK
BUILD
TASK TASK
TASK
PLUGIN

CREATING PLUGINS
▸build.gradle ﬁle
▸buildSrc directory
▸separate project

PLUGIN - BUILD.GRADLE FILE
@BRWNGRLDEV

PLUGIN SKELETON
How Gradle ﬁnds the Plugin Implementation
@BRWNGRLDEV

DEPENDENCIES
apply plugin: ‘groovy'
dependencies {
compile gradleApi()
compile localGroovy()
}
@BRWNGRLDEV

DEPENDENCIES
dependencies {
…
testCompile 'junit:junit:4.12' 
testCompile ('org.spockframework:spock-core:1.0-groovy-2.4') { 
exclude module: 'groovy-all' 
}
}
@BRWNGRLDEV

PLUGIN.GROOVY
class CustomPlugin implements Plugin<Project> {
}
@BRWNGRLDEV

PLUGIN.GROOVY
class CustomPlugin implements Plugin<Project> {
@Override
void apply(Project project) {
}
}
@BRWNGRLDEV

QUALITYCHECKSPLUGIN.GROOVY
@BRWNGRLDEV

APPLY METHOD
@BRWNGRLDEV
void apply(Project project) { 
this.project = project 
 
}

APPLY METHOD
@BRWNGRLDEV
 
project.extensions.create('qualityChecks', QualityChecksExtension) 
 
}

APPLY METHOD
@BRWNGRLDEV
 
 
createConﬁgFilesIfNeeded() 
createConﬁgFileTasks() 
createQualityChecksTasks() 
}

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' 
 
}

PROJECT EXTENSION
Back in the application’s build.gradle file…
@BRWNGRLDEV
qualityChecks { 
pmdConfigFile = ‘checks/pmd.xml’
checkstyleConfigFile = ‘checks/checkstyle.xml’ 
}

CREATING TASKS
Give it a name and a type
@BRWNGRLDEV

CREATING TASKS
@BRWNGRLDEV
Build on existing task
Extend the DefaultTask

BUILD ON EXISTING TASK
@BRWNGRLDEV

EXTEND DEFAULT TASK
@BRWNGRLDEV

CUSTOMTASK.GROOVY
class CustomTask extends DefaultTask {
CustomTask() {
group: ‘veriﬁcation’
}
}
@BRWNGRLDEV

CUSTOMTASK.GROOVY
CustomTask() {
group: ‘veriﬁcation’
onlyIf {
// skip under certain conditions
}
}
@BRWNGRLDEV

CUSTOMTASK.GROOVY
@TaskAction
def defaultAction() {
description: ‘What my task does’
}
@BRWNGRLDEV

CUSTOMTASK.GROOVY
@BRWNGRLDEV
@TaskAction
def defaultAction() {
description: ‘What my task does’
<do your cool stuff here>
}

GRADLE TASK DOCUMENTATION
@BRWNGRLDEV

SO FAR…
▸Gradle Tasks
▸Plugin Skeleton
▸Dependencies
▸Plugin Classes
@BRWNGRLDEV

PUBLISHING
buildscript {
…
dependencies {
classpath "com.gradle.publish:plugin-publish-plugin:0.9.4"
}
}
apply plugin: 'com.gradle.plugin-publish'
@BRWNGRLDEV

PUBLISHING
version = "0.1.3"
group = "info.adavis"
@BRWNGRLDEV

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

PUBLISHING
pluginBundle {
…
plugins {
qualityChecksPlugin {
id = 'info.adavis.qualitychecks'
displayName = 'Quality Checks Plugin'
}
}
@BRWNGRLDEV

WE’RE DONE…
WRONG!
@BRWNGRLDEV

WE’RE DONE…
TESTS
@BRWNGRLDEV

TESTING - WITH JUNIT
@Before 
void setUp()
{ 
project = ProjectBuilder.builder().build() 
task = project.tasks.create('writeConﬁgFile', WriteConﬁgFileTask) 
}
@BRWNGRLDEV

@Test
void shouldBeAbleToCreateTask()
{
assertTrue(task instanceof WriteConﬁgFileTask)
}
@BRWNGRLDEV

@Test
void pluginShouldBeApplied()
{
project.apply(plugin: QualityChecksPlugin)
assertNotNull(project.tasks.ﬁndByName(‘mytask’))
}
@BRWNGRLDEV

TESTING - WITH SPOCK
def createCheckstyleTask() { 
given: "we have a project" 
def project = ProjectBuilder.builder().build()
 
}

 
and: "we apply the extension" 
 
and: "we supply an existing checkstyle config file" 
project.qualityChecks.checkstyleConfigFile = File.createTempFile('temp', '.xml').path 
}

 
when: "we create a checkstyle task" 
def checkstyleTask = project.tasks.create('checkstyle', CheckstyleTask) 
 
 
}

 
then: "it should not replace our previous ﬁle" 
checkstyleTask.conﬁgFile.name.startsWith('temp') 
}

@BRWNGRLDEV

TESTING - SPOCK-REPORT
dependencies {
…
testCompile( 'com.athaydes:spock-reports:1.2.12' ) { 
transitive = false
}
}
@BRWNGRLDEV

TESTING - SPOCK-REPORT
@BRWNGRLDEV

SUMMARY
▸Gradle Build Basics
▸Creating Task
▸Beneﬁts of Plugins
▸Testing techniques
▸Easy to publish
@BRWNGRLDEV

THANKS!
@brwngrldev
+AnnyceDavis
www.adavis.info
@BRWNGRLDEV

Creating Gradle Plugins - Oredev

More Related Content

What's hot (20)

Similar to Creating Gradle Plugins - Oredev (20)

More from Annyce Davis (17)

Recently uploaded (20)

Creating Gradle Plugins - Oredev