Writing your Third Plugin

1. Getting to Your Third Plugin Justin Ryan jryan@netﬂix.com @quidryan

2. Disclaimer Jenkins has evolved There will be zombies [http://www.squidoo.com/zombies-hq] [http://www.evike.com/product_info.php?products_id=27951]

5. Disclaimer Jenkins has evolved There will be zombies Survival Tip: Use your instincts [http://www.squidoo.com/zombies-hq] [http://www.evike.com/product_info.php?products_id=27951]

6. Why do we write plugins? “An extendable open source continuous integration server” [http://www.ufunk.net/en/photos/dead-of-the-class-lavantapres-des-zombies/]

7. Don’t write a plugin! Boilerplate Maintenance Overhead [http://www.ufunk.net/en/photos/dead-of-the-class-lavantapres-des-zombies/]

8. Avoiding writing of plugins Groovy Plugin Groovy Postbuild Plugin Job DSL Plugin [http://www.wired.co.uk/magazine/archive/2012/02/play/on-your-marks]

9. Groovy Plugin Access to complete system Sample: Disable failing jobs Scan for known errors Enforce plugin defaults [http://www.spencersonline.com/product/n-zombie-brains-poster/]

10. Groovy Plugin def buildable = Jenkins.instance.projects .findAll { !it.getBuilds().isEmpty() && it.buildable } def bad = "Illegal attempt to republish existing" buildable.each { job -> lastBuild = job.getLastBuild() log = lastBuild.getLog(100) logLength = log.size() int lineNum = 0 for (; lineNum < logLength && !errorFound; lineNum++) { if (log[lineNum].contains(bad)) { print "Error in ${job.name} “ println “build ${lastBuild.number} on line ${lineNum}" errorFound = true; } } }

11. Display Object def display(obj) { if (obj == null) { println "Null" return } println obj.class.name println " Properties:" obj.metaClass.properties.each { p -> if (p.getter) { println " ${p.name}:${p.type}:${p.getProperty(obj)}" } } println " Methods:" obj.class.getDeclaredMethods().each { m -> println " ${m.toString()}" } } Jenkins.instance.items.each { display(it) }

12. Groovy Postbuild Plugin Add Badges Add Summary Set Status Provides Context Searching [http://www.stickergiant.com/zombies-button_hpsb4036.html] [http://www.cafepress.com/+keep_calm_and_kill_zombies_35_button,669439132] [http://www.polyvore.com/zombies_buttons_pins_badges_cafepress/thing?id=17892027]

13. Groovy Postbuild Plugin pattern = ~/.*src/main/java/(.*).java:[^ ]* (.*) def map = [:] manager.build.logFile.eachLine { line -> matcher = pattern.matcher(line) if(matcher.matches()) { ownClass = matcher.group(1).replaceAll("/", ".") map[ownClass] = matcher.group(2) } } summary = manager.createSummary("warning.gif") summary.appendText("Classes using Sun proprietary API:<ul>", false) map.each { summary.appendText("<li><b>$it.key</b> - $it.value</li>", false) } summary.appendText("</ul>", false)

14. Groovy Postbuild Plugin https://wiki.jenkins-ci.org/display/JENKINS/Groovy+Postbuild+Plugin

15. Groovy Postbuild Plugin if("true".equals(manager.build.buildVariables.get("storeToDB"))) { manager.addBadge("db_in.gif", "Stored to DB") } https://wiki.jenkins-ci.org/display/JENKINS/Groovy+Postbuild+Plugin

16. Job DSL Plugin Programmatic Editable Templates [http://www.zombiedaily.com/2008/08/zombie-zoot-suit.html?m=1]

17. Job DSL Plugin import groovy.json.JsonSlurper def project = 'Netflix/asgard' def url = “https://api.github.com/repos/${project}/branches” def api = new URL(url) def branches = new JsonSlurper().parse(api.newReader()) branches.each { def branchName = it.name job { name "${project}-${branchName}".replaceAll('/','-') scm { git("git://github.com/${project}.git", branchName) } steps { maven('clean build') } } } https://github.com/jenkinsci/job-dsl-plugin/wiki

18. Getting Started Plugin Tutorial Stephen Connolly’s 7 Part Tutorial hello-world Plugin [http://www.myspace.com/theraychul/photos/736009]

19. Mental Model Categorize technologies Dig deeper into each Able to ask questions [http://www.zombiesatemyblog.com/post/1277325743]

20. Describable Everything with a UI JDKs Build Step Actual Instance [http://sylverblaque.wordpress.com/2011/10/24/zombie-love-song/]

21. Describable

22. Descriptor Needed for each Describable Hold Global Conﬁg Creates Describable [http://www.sandovalnation.webs.com/]

23. Extension Points “Hooks into system” @ExtensionPoint indicates implementation Most Common: BuildWrapper Trigger BuildStep Publisher [http://s268.photobucket.com/albums/jj23/cooljay1622/?action=view&current=ZombieArms.png&newest=1]

24. Extension Points “Hooks into system” @ExtensionPoint indicates implementation Most Common: BuildWrapper Trigger BuildStep Publisher

25. What is a HPI? Just a .jar META-INF/MANIFEST.MF WEB-INF classes META-INF lib Isolated Classloader [http://zombieapocalypseacademy.org/zombie-wallpapers/]

26. What is a Plugin? HPI Published to Jenkins Maven Documented in Jenkins Wiki [http://ismashphone.com/2011/08/plug-in-zone-out-die-english-tabloid-warns-of-ipod-zombies.html]

27. Plugin Model Plugin HPI/JPI Extension Extension Extension Descriptor Describable Describable Describable

28. UI Model Browser Stapler GET POST Ajax Jelly Describable Descriptor

29. Stapler Technically a URL mapping system Responsible for Loading UI Form submissions View “Structured Form Submission” Wiki [http://www.bitrebels.com/geek/zombie-skull-pencil-holder-for-the-horriﬁc-ofﬁce-worker/]

30. Descriptor Lifecycle Startup Descriptor() Global Config Descriptor.configure Job Config Descriptor.newInstance

31. Descriptor Lifecycle Startup Descriptor() Call load() on constructor Global Config Descriptor.configure Job Config Descriptor.newInstance

32. Descriptor Lifecycle Startup Descriptor() Call load() on constructor Global Descriptor.configure req.getParam Config Job Config Descriptor.newInstance

33. Descriptor Lifecycle Startup Descriptor() Call load() on constructor Global Descriptor.configure req.getParam Config Job Descriptor.newInstance req.getParam Config

34. Descriptor Lifecycle Startup Descriptor() Call load() on constructor Global Descriptor.configure req.getParam Config Job Descriptor.newInstance req.getParam Config @DataBoundConstructor

35. Describable Lifecycle Conﬁguration -> AJAX doCheckFoo doFillFooItems doAutocompleteFoo Saving -> Descriptor Loading -> XStream readResolve() for migrations [http://www.mrpoesmorgue.com/boneyard/robzombie.html]

36. Stapler Example @Override public boolean configure(StaplerRequest req, JSONObject formData) throws FormException { globalExcludedRevprop = fixEmptyAndTrim( req.getParameter("svn.global_excluded_revprop")); String workspaceFormatStr = req.getParameter("svn.workspaceFormat"); workspaceFormat = Integer.parseInt(workspaceFormatStr); validateRemoteUpToVar = formData.containsKey("validateRemoteUpToVar"); // Save configuration save(); return super.configure(req, formData); }

37. Break What have I not talked about? [http://www.seattlepi.com/local/slideshow/Zombie-Walk-in-Fremont-45631.php]

38. Jelly JSP-like Placed in a package with name of Describable [http://www.crawlofthedead.com/article/the_zombie_brain_jelly_mould/]

39. Jelly JSP-like Placed in a package with name of Describable Annoying to write in groovy [http://www.crawlofthedead.com/article/the_zombie_brain_jelly_mould/]

40. Jelly Eclipse will not like the JSP-like package name Placed in a package with name of Describable Annoying to write in groovy [http://www.crawlofthedead.com/article/the_zombie_brain_jelly_mould/]

41. Jelly Sample <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form"> <f:section title=”$%{My Plugin Setup}” <f:entry title="${%Server URL}" name=”server”> <f:textbox/> </f:entry> <f:advanced> <f:entry title="${%Workspace name}" field=”workspaceName”> <f:textbox/> </f:entry> </f:advanced> </f:section> </j:jelly> [http://commons.apache.org/jelly/] [http://jenkins-ci.org/maven-site/hudson-core/jelly-taglib-ref.html#form]

42. Jelly Files Locations Plugin Manager Listing src/main/resources/index.jelly Global Config src/main/resources/${package}/${describable}/global.jelly Job Config src/main/resources/${package}/${describable}/config.jelly src/main/resources/${package}/${describable}/help-$ {field}.html Viewing Job src/main/resources/${package}/${action}/summary.jelly

43. Plugin Ecosystem Recommendations: Associated File Plugin hello-world Plugin TEPCO Plugin Avoid for copying: Static Analysis Plugins Job Property Plugin [http://gregtodiffer.com/home/2011/4/21/a-bangkok-zombie-apocalypse.html]

44. Installations Per Plugin

45. Median

46. Jenkins Singleton Top-level access to Jenkins data model Made up of ItemGroup ﬁlled with Item [http://zombiecombatcommand.com/]

47. Jenkins Singleton Top-level access to Ignore Jenkins data model Hudson.getInstance() Made up of ItemGroup ﬁlled with Item [http://zombiecombatcommand.com/]

48. Jenkins Singleton Top-level access to Jenkins data model Made up of ItemGroup ﬁlled with Item

49. Jenkins Singleton Ignore StaplerRequest Top-level access to Jenkins data model Methods Made up of ItemGroup ﬁlled with Item

50. Jenkins Singleton Ignore StaplerRequest Top-level access to Jenkins data model Methods Made up of ItemGroup ﬁlled with Item Ignore doCli/ doCreateView

51. Jenkins Singleton Ignore StaplerRequest Top-level access to Jenkins data model Beware Methods synchronized Made up of ItemGroup ﬁlled with Item methods Ignore doCli/ doCreateView

52. Jenkins Singleton Ignore StaplerRequest Top-level access to Jenkins data model Beware Methods synchronized Made up of ItemGroup ﬁlled with Item methods Ignore doCli/ rebuildDependencyGraph doCreateView when changing Upstream/ Downstream

53. Jenkins Singleton getItem is useful if Ignore you know access to StaplerRequest Top-level the name Jenkins data model Beware Methods synchronized Made up of ItemGroup ﬁlled with Item methods Ignore doCli/ rebuildDependencyGraph doCreateView when changing Upstream/ Downstream

54. Jenkins Singleton getItem is useful if Ignore you know access to StaplerRequest Top-level the name Jenkins data model Beware Methods synchronized Made up of ItemGroup ﬁlled with Item methods Ignore doCli/ rebuildDependencyGraph doCreateView when changing Upstream/ Downstream Never call onRename/ OnDeleted

55. Jenkins Singleton getItem is useful if Ignore you know access to StaplerRequest Top-level the name Jenkins data model Beware Methods synchronized Made up of ItemGroup ﬁlled with Item methods Ignore doCli/ rebuildDependencyGraph doCreateView when changing Upstream/ Downstream Never call getPlugin to get onRename/ other plugins OnDeleted

56. Jenkins Model Jenkins Project/ Project/ Job Project/ Job Job Build Build Build Action Action Action

57. Actions Badly Named Metadata tacked on Persisted when attached to Build [http://tnation.t-nation.com/free_online_forum/music_movies_girls_life/zombie_apocalypse_choose_your_weapon]

58. Actions Badly Named Metadata tacked on Persisted when attached to Build Keep Actions on Build [http://tnation.t-nation.com/free_online_forum/music_movies_girls_life/zombie_apocalypse_choose_your_weapon]

59. FilePath Very likely that a “ﬁle” is remote AbstractBuild.getWorkspace() FileCallable [http://www.cisionwire.com/livingsocial-uk/i/the-horde,c148133]

60. FilePath // make 'file' a fresh empty directory. file.act(new FileCallable<Void>() { // if 'file' is on a different node, this FileCallable will // be transfered to that node and executed there. public Void invoke(File f,VirtualChannel channel) { // f and file represents the same thing f.deleteContents(); f.mkdirs(); } });

61. Build Tool Maven Gradle [http://zombieupdate2k12.tumblr.com/post/24677485908]

62. Thank You To Our Sponsors

63. Justin Ryan jryan@netflix.com @quidryan Netflix is hiring! techblog.netflix.com netflix.github.com [http://calitreview.com/7933]

Writing your Third Plugin

Writing your Third Plugin

Recommended

More Related Content

What's hot

What's hot(20)

Viewers also liked

Viewers also liked(8)

Similar to Writing your Third Plugin

Similar to Writing your Third Plugin(20)

Recently uploaded

Recently uploaded(20)

Writing your Third Plugin

Editor's Notes