Downloaded 138 times
Uploaded byPhilip Norton
Getting Started With Jenkins And Drupal
The document provides a comprehensive guide on integrating Jenkins with Drupal for continuous integration and automated tasks, including installation steps, user management, and project creation. It details specific tasks such as running Drupal cron jobs, performing code analysis with phing and php codesniffer, and managing security. Additionally, it discusses the use of plugins to enhance Jenkins capabilities and avoid common pitfalls when using Jenkins with Drupal.
Getting Started With Jenkins And Drupal
- 1. Getting Started With Jenkinsand Drupal Phil Norton DrupalCampNW 2013 #!
- 2. Me • Phil Norton (@philipnorton42) • #!code (www.hashbangcode.com) • Technical Lead at Access • Help run NWDUG • DrupalCampNW2013 co-organizer • Help out at PHPNW #!
- 3. Jenkins • Build and automationserver • Java application • Used to be called Hudson • Built for continuous integration • Helps you run repetitive tasks • http://jenkins-ci.org/ #!
- 4.
- 6. Jenkins Drupal Examples • Inspectyour code • Run cron • Build documentation • Test drush make files • Test Drupal install profiles • Run tests • Deploy sites #!
- 7. Installing Jenkins • Different formost platforms • Go to jenkins-ci.org • Click on your platform on right hand side • Follow instructions #!
- 8. Installing On Ubuntu wget-q -O - http://pkg.jenkinsci.org/debian/jenkins-ci.org.key | sudo apt-key add - Add “deb http://pkg.jenkins-ci.org/debian binary/“ to the file /etc/apt/sources.list sudo apt-get update sudo apt-get install jenkins #!
- 9.
- 10. Authentication • Jenkins doesn’t haveauthentication when first installed • Probably a good idea to enable it! • Many different models from local user credentials to domain authentication #!
- 11. Creating A UserIn Jenkins • Simplest security model for beginners • Manage Jenkins > Configure Security > Enable Security • Manage Jenkins > Manage Users > Create User #!
- 12. ooopss… • Quite easy tolock yourself out • Open the file config.xml remove the element <useSecurity> to remove security #!
- 13. Anatomy Of Jenkins • Jenkinscan be found at /var/lib/jenkins • May contain one or more of the following: .ssh config.xml jobs/ nodeMonitors.xml plugins/ secret.key secret.key.not-so-secret updates/ userContent/ users/ workspace/ #!
- 14. Your First Jenkins Project JenkinsProject #!
- 15. Drupal Cron • Start offusing Jenkins with something simple • Running a Drupal cron through Jenkins is easy #!
- 16. Drupal Cron • Create a‘free-style software project’ #!
- 17.
- 18. Drupal Cron BuildTrigger • Select ‘build periodically’ • Crontab syntax applies • Can also use @hourly to run the job every hour #!
- 19. Drupal Cron BuildStep • Create an Execute shell build task • Use 'wget' to call the cron page remotely #!
- 20. Notifications • Useful to knowif a job fails • Email notifications are available • Sends detailed notifications on failed jobs #!
- 21.
- 22.
- 23. Jenkins Plugins • Jenkins canbe extended with plugins • Install them via the plugin manager • Manage Jenkins > Manage Plugins #!
- 24. Drupal Code Analysis InJenkins #!
- 25. Drupal Code Analysis • Syntaxchecking • Check for coding standards violations • Analyse for duplication of code • Check for potential problems in source code #!
- 26.
- 27. Some Rules ForUsing Jenkins With Drupal • Use source control • Only analyse your own code as priority • Know what you are analysing • Understand the output • Standardise as much as you can #!
- 28. Standardise Standard repo structure docroot/ scripts/ make/ StandardDrupal setup sites/all/modules/contrib/ sites/all/modules/custom/ Standard custom module structure module.module includes/module.inc Standard theme structure template.php templates/ js/ css/ #!
- 29. Git • Use source controlto pull code into Jenkins • To use Git you need the Jenkins Git plugin • Best results are using SSH (you will also need some ssh keys) • Perhaps the most complex part of the job setup #!
- 30. Git • Use source controlto pull code into Jenkins • To use Git you need the Jenkins Git plugin • Best results are using SSH (you will also need some ssh keys) • Perhaps the most complex part of the job setup #!
- 31. Add your gitssh URL to Jenkins Jenkins will give you a warning if it can’t see the repo #!
- 32.
- 33. PHP Lint • Syntax checkany PHP file with php -l myfile.php • Can only do one file at a time • How can we check an entire project? #!
- 34. • Build tool • Controlled withXML files • Written in PHP • Available through PEAR • Integrates with Jenkins • Certified awesome! #!
- 36. Phing And PHPLint • Add a Phing build file to your source code • What we need to do is: 1. Tell Phing what files we want to scan 2. Use the phplint Phing task to scan files 3. Fail the build if any errors found #!
- 37. <?xml version="1.0"?> <project name="phpsyntaxcheck" default="syntaxcheck_php"> <targetname="syntaxcheck_php" description="Run PHP syntax checking on the project docroot."> <fileset dir="../docroot" id="phpfiles"> <include name="*.php" /> <include name="**/*.php" /> <include name="**/*.inc" /> <include name="**/*.module" /> <include name="**/*.install" /> <include name="**/*.profile" /> <include name="**/*.test" /> </fileset> <phplint haltonfailure="true"> <fileset refid="phpfiles" /> </phplint> </target> </project> #!
- 38. Running Phing Syntax Check SyntaxCheck • Add the Phing file to your source code as build.xml • You can run this build using the following: phing -f scripts/build.xml syntaxcheck_php #!
- 39. Add Phing BuildStep To Jenkins • Use the Jenkins Phing Plugin to invoke the syntaxcheck_php Phing target #!
- 40.
- 41.
- 42. Checkstyle • Jenkins Plugin • Reports oncoding standards results • Accepts a checkstyle.xml file produces lots of graphs and code reports #!
- 43. PHP CodeSniffer • Inspect codefor Drupal coding standards • Produces checkstyle.xml files for Checkstyle • Looks for best practice in your code #!
- 44. Install PHP CodeSniffer • Installthe PHP CodeSniffer package sudo pear install PHP_CodeSniffer • Download Coder and link the Drupal CodeSniffer standard drush dl coder sudo ln -sv /path/to/coder/coder_sniffer/Drupal $(pear config-get php_dir)/PHP/CodeSniffer/Standards/Drupal #!
- 45.
- 46.
- 47.
- 48. phpcs --report=checkstyle --standard=Drupal --extensions=php,module,inc,install,test,profil e,themedocroot/sites/all/modules/custom #!
- 49. phpcs --report-file=reports/checkstyle.xml --report=checkstyle --standard=Drupal --extensions=php,module,inc,install,test,profil e,themedocroot/sites/all/modules/custom #!
- 50. The Missing Element? • Gitstores the code • phpcs produces the reports • Jenkins and processes reports • What fits all these elements together? #!
- 51. Phing! (did I mentionit was awesome?) #!
- 52. phpcs Phing Module • TellPhing what files we want to scan • Use the phpcs Phing module to scan the files and what standard to use • Output the report in a checkstyle.xml file #!
- 53. <?xml version="1.0"?> <project name="phpcodesniffer"default="phpcs"> <target name="phpcs" depends="findcustomfiles"> <fileset dir="../docroot" id="drupalfiles"> <include name="sites/all/modules/custom/**/*.php" /> <include name="sites/all/modules/custom/**/*.inc" /> <include name="sites/all/modules/custom/**/*.module" /> <include name="sites/all/modules/custom/**/*.install" /> <include name="sites/all/themes/mytheme/*.php" /> <include name="sites/all/themes/mytheme/*.inc" /> </fileset> <phpcodesniffer standard="Drupal" format="checkstyle"> <fileset refid="drupalfiles" /> <formatter type="checkstyle" outfile="../reports/checkstyle.xml"/> </phpcodesniffer> </target> </project> #!
- 54. <?xml version="1.0"?> <project name="phpcodesniffer"default="phpcs"> <target name="phpcs" depends="findcustomfiles"> <fileset dir="../docroot" id="drupalfiles"> <include name="sites/all/modules/custom/**/*.php" /> <include name="sites/all/modules/custom/**/*.inc" /> <include name="sites/all/modules/custom/**/*.module" /> <include name="sites/all/modules/custom/**/*.install" /> <include name="sites/all/themes/mytheme/*.php" /> <include name="sites/all/themes/mytheme/*.inc" /> </fileset> <phpcodesniffer standard="Drupal" format="checkstyle"> <fileset refid="drupalfiles" /> <formatter type="checkstyle" outfile="../reports/checkstyle.xml"/> </phpcodesniffer> </target> </project> #!
- 55. <?xml version="1.0"?> <project name="phpcodesniffer"default="phpcs"> <target name="phpcs" depends="findcustomfiles"> <fileset dir="../docroot" id="drupalfiles"> <include name="sites/all/modules/custom/**/*.php" /> <include name="sites/all/modules/custom/**/*.inc" /> <include name="sites/all/modules/custom/**/*.module" /> <include name="sites/all/modules/custom/**/*.install" /> <include name="sites/all/themes/mytheme/*.php" /> <include name="sites/all/themes/mytheme/*.inc" /> </fileset> <phpcodesniffer standard="Drupal" format="checkstyle"> <fileset refid="drupalfiles" /> <formatter type="checkstyle" outfile="../reports/checkstyle.xml"/> </phpcodesniffer> </target> </project> #!
- 56. Add PHP CodeSnifferTo Jenkins • Use the Phing plugin to invoke Phing target #!
- 57. Publish PHP CodeSniffer Output • Createa Post Build action • Reports directory contains PHPCS report • Checkstyle plugin creates graphs from this file #!
- 58.
- 59.
- 60.
- 61. Try It Yourself • PHPMess Detect Phing output into PMD Analysis Results graphs in Jenkins • PHP Copy Paste Detect Phing output into Duplicate Code Analysis results graphs in Jenkins #!
- 62. Do More! • Use Phingto run an action • Use Jenkins to automate it — or — • Use Phing to generate reports • Use Jenkins plugins to convert reports into graphs #!
- 63.
- 64. Me • Phil Norton (@philipnorton42) • #!code (www.hashbangcode.com) • Technical Lead at Access • Help run NWDUG • DrupalCampNW2013 co-organizer • Help out at PHPNW #!