Jenkins Pipeline Dev Tools

SPb Jenkins Meetup #10 в Dell EMC Pipeline Dev Tools
February 27, 2018

© Copyright 2018 Dell Inc. 2 About us • Alexey
Nikitin – Elastic Cloud Storage

© Copyright 2018 Dell Inc. 3 About us • Alexey
Nikitin – Elastic Cloud Storage • Fedor Chemaskin – Elastic Cloud Storage

© Copyright 2018 Dell Inc. 5 Agenda • Static analysis
• IDE

• Scripted pipelines

• Scripted pipelines • Small shared library for our custom loader

• Scripted pipelines • Small shared library for our custom loader • Standards plugins. For our needs - Robot Framework and JUnit plugin

• Scripted pipelines • Small shared library for our custom loader • Standards plugins. For our needs - Robot Framework and JUnit plugin • CI/CD and Automation

Static analysis

• Detecting errors on early stage (before using Jenkins for launch)

• Detecting errors on early stage (before using Jenkins for launch) • Get recommendations on code formatting (with our code style)

• Detecting errors on early stage (before using Jenkins for launch) • Get recommendations on code formatting (with our code style) • Metrics

© Copyright 2018 Dell Inc. 16 Static analysis Way to
go Before:

© Copyright 2018 Dell Inc. 17 Static analysis Way to
go Before: After:

© Copyright 2018 Dell Inc. 18 Static analysis Tool selection
Tool

© Copyright 2018 Dell Inc. 19 Static analysis Tool selection
Tool Custom rules HTML report Managing error and warning categories for existing rules Custom rules HTML report Custom rules Jenkins

© Copyright 2018 Dell Inc. 20 Static analysis Codenarc –
Less Bugs Better Code

Less Bugs Better Code • Analyzes Groovy code for defects, bad practices, inconsistencies, style issues and more

Less Bugs Better Code • Analyzes Groovy code for defects, bad practices, inconsistencies, style issues and more • Set of Rules (predefined and/or custom) that are applied to each Groovy file* * - сan be configured

Report • Reports come in HTML, XML or text format

Integration

Integration • Codenarc CLI

Integration • Codenarc CLI • Plugins for:

Integration • Codenarc CLI • Plugins for: – Maven – Gradle – Grails – ... – Hudson

Jenkins Integration

Jenkins Integration • Hudson Violations Plugin is not maintained

Jenkins Integration • Hudson Violations Plugin is not maintained • Jenkins Warning plugin

Jenkins Integration • Hudson Violations Plugin is not maintained • Jenkins Warning plugin • JENKINS-45930 java.io.NotSerializableException: hudson.plugins.violations.types.codenarc.CodenarcParser at java.io.ObjectOutputStream.writeObject0(ObjectOutputStream.java:1183)

Jenkins Integration workaround

Jenkins Integration workaround Main job

Jenkins Integration workaround Main job CI for pipelines (including Codenarc run)

Jenkins Integration workaround Main job Freestyle job CI for pipelines (including Codenarc run) XML report

Jenkins Integration workaround Running on the master Warning plugin in “Post-build Actions“ sed -i "s/Package path=''/Package path='pipelines'/“ xmlReportName.xml Main job Freestyle job CI for pipelines (including Codenarc run) XML report

© Copyright 2018 Dell Inc. 41 Static analysis Our code
style

style • Based on Groovy Style with a few changes

style • Based on Groovy Style with a few changes • Strongly typed

style • Based on Groovy Style with a few changes • Strongly typed • «Pipelines DSL != Groovy» (с) Oleg Nenashev

style • Based on Groovy Style with a few changes • Strongly typed • «Pipelines DSL != Groovy» (с) Oleg Nenashev • Turn-off some Codenarc rules (e.g. Println, design patterns rules)

© Copyright 2018 Dell Inc. 48 Static analysis Jenkins REST
API for code validation • Like in “Pipeline” block or “Replay”

API for code validation

© Copyright 2018 Dell Inc. 54 IDE Requirements • Custom
Jenkins instructions (e.g. sh, node)

Jenkins instructions (e.g. sh, node) • Custom Pipeline libraries methods (e.g. myPerfectLib.buildEverything())

Jenkins instructions (e.g. sh, node) • Custom Pipeline libraries methods (e.g. myPerfectLib.buildEverything()) • Groovy syntax

Jenkins instructions (e.g. sh, node) • Custom Pipeline libraries methods (e.g. myPerfectLib.buildEverything()) • Groovy syntax • Jenkins classes support (e.g. hudson.model.Run)

Jenkins instructions (e.g. sh, node) • Custom Pipeline libraries methods (e.g. myPerfectLib.buildEverything()) • Groovy syntax • Jenkins classes support (e.g. hudson.model.Run) • Codenarc integration

© Copyright 2018 Dell Inc. 59 IDE GDSL • GDSL
(GroovyDSL) is a feature which enables IDE support for custom DSLs

© Copyright 2018 Dell Inc. 63 IDE IDEA Inspection •
IntelliJ IDEA performs code analysis by applying inspections to your code

IntelliJ IDEA performs code analysis by applying inspections to your code • The inspections detect not only compiling errors, but also different code inefficiencies:

IntelliJ IDEA performs code analysis by applying inspections to your code • The inspections detect not only compiling errors, but also different code inefficiencies: – unreachable code – unused code – unresolved method – spelling – …

IntelliJ IDEA performs code analysis by applying inspections to your code • The inspections detect not only compiling errors, but also different code inefficiencies: – unreachable code – unused code – unresolved method – spelling – … • Turn-off useless and disturbing inspections

what? • One more «rough» code check (e.g. imports, typos, syntax, …) • Jenkins dependencies

what? • One more «rough» code check (e.g. imports, typos, syntax, …) • Jenkins dependencies • Codenarc integration

developer • Groovy console in IDEA – little experiments • Jenkins Script console (carefully) – peek inside live Jenkins data structures

developer • Groovy console in IDEA – little experiments • Jenkins Script console (carefully) – peek inside live Jenkins data structures • Don’t forget about Snippet Generator

analysis tools: – uniform codestyle (better readability, maintainability, standard for team)

analysis tools: – uniform codestyle (better readability, maintainability, standard for team) – detecting errors

analysis tools: – uniform codestyle (better readability, maintainability, standard for team) – detecting errors – improve Groovy knowledge

analysis tools: – uniform codestyle (better readability, maintainability, standard for team) – detecting errors – improve Groovy knowledge • Use IDE:

analysis tools: – uniform codestyle (better readability, maintainability, standard for team) – detecting errors – improve Groovy knowledge • Use IDE: – autocomplete, hints, documentation and navigation for pipelines

analysis tools: – uniform codestyle (better readability, maintainability, standard for team) – detecting errors – improve Groovy knowledge • Use IDE: – autocomplete, hints, documentation and navigation for pipelines – easy access to Jenkins source code

analysis tools: – uniform codestyle (better readability, maintainability, standard for team) – detecting errors – improve Groovy knowledge • Use IDE: – autocomplete, hints, documentation and navigation for pipelines – easy access to Jenkins source code – everything in the one place (VCS, editor, task management, …)

© Copyright 2018 Dell Inc. 88 Links • Codenarc –
https://codenarc.org • Groovy style - http://groovy-lang.org/style-guide.html • GDSL - https://st-g.de/2016/08/jenkins-pipeline-autocompletion-in-intellij • GDSL and Gradle - https://intellij-support.jetbrains.com/hc/en- us/community/posts/115000140204-Setting-up-Groovy-completion-for-Jenkins-Pipelines- consumers

Jenkins Pipeline Dev Tools

Jenkins Pipeline Dev Tools

Other Decks in Programming

Featured

Transcript