Getting Started With Jenkins And Drupal

12,464 views

Published on

Jenkins is a really powerful tool for automating things like code analysis, testing and even deployment. Getting started with Jenkins, especially with Drupal, is a challenge and can be quite difficult for a beginner to the system. In this session I'll show you how to install Jenkins, how to configure things like authentication and then how to do some interesting things with the tool. I'll show some real life examples of things that can be done with the tool on your Drupal sites to do things like run cron jobs, syntax check the code or even automatically copying code to your web servers.

Published in: Technology

Getting Started With Jenkins And Drupal

  1. 1. Getting Started With Jenkins and Drupal Phil Norton DrupalCampNW 2013 #!
  2. 2. Me • Phil Norton (@philipnorton42) • #! code (www.hashbangcode.com) • Technical Lead at Access • Help run NWDUG • DrupalCampNW2013 co-organizer • Help out at PHPNW #!
  3. 3. Jenkins • Build and automation server • Java application • Used to be called Hudson • Built for continuous integration • Helps you run repetitive tasks • http://jenkins-ci.org/ #!
  4. 4. #!
  5. 5. Jenkins Drupal Examples • Inspect your code • Run cron • Build documentation • Test drush make files • Test Drupal install profiles • Run tests • Deploy sites #!
  6. 6. Installing Jenkins • Different for most platforms • Go to jenkins-ci.org • Click on your platform on right hand side • Follow instructions #!
  7. 7. 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 #!
  8. 8. localhost:8080 #!
  9. 9. Authentication • Jenkins doesn’t have authentication when first installed • Probably a good idea to enable it! • Many different models from local user credentials to domain authentication #!
  10. 10. Creating A User In Jenkins • Simplest security model for beginners • Manage Jenkins > Configure Security > Enable Security • Manage Jenkins > Manage Users > Create User #!
  11. 11. ooopss… • Quite easy to lock yourself out • Open the file config.xml remove the element <useSecurity> to remove security #!
  12. 12. Anatomy Of Jenkins • Jenkins can 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/ #!
  13. 13. Your First Jenkins Project Jenkins Project #!
  14. 14. Drupal Cron • Start off using Jenkins with something simple • Running a Drupal cron through Jenkins is easy #!
  15. 15. Drupal Cron • Create a ‘free-style software project’ #!
  16. 16. #!
  17. 17. Drupal Cron Build Trigger • Select ‘build periodically’ • Crontab syntax applies • Can also use @hourly to run the job every hour #!
  18. 18. Drupal Cron Build Step • Create an Execute shell build task • Use 'wget' to call the cron page remotely #!
  19. 19. Notifications • Useful to know if a job fails • Email notifications are available • Sends detailed notifications on failed jobs #!
  20. 20. Jenkins Job List #!
  21. 21. Jenkins Plugins #!
  22. 22. Jenkins Plugins • Jenkins can be extended with plugins • Install them via the plugin manager • Manage Jenkins > Manage Plugins #!
  23. 23. Drupal Code Analysis In Jenkins #!
  24. 24. Drupal Code Analysis • Syntax checking • Check for coding standards violations • Analyse for duplication of code • Check for potential problems in source code #!
  25. 25. STAHP! #!
  26. 26. Some Rules For Using 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 #!
  27. 27. Standardise Standard repo structure docroot/ scripts/ make/ Standard Drupal 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/ #!
  28. 28. Git • Use source control to 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 #!
  29. 29. Git • Use source control to 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. 30. Add your git ssh URL to Jenkins Jenkins will give you a warning if it can’t see the repo #!
  31. 31. Syntax Checking #!
  32. 32. PHP Lint • Syntax check any PHP file with php -l myfile.php • Can only do one file at a time • How can we check an entire project? #!
  33. 33. • Build tool • Controlled with XML files • Written in PHP • Available through PEAR • Integrates with Jenkins • Certified awesome! #!
  34. 34. Phing And PHP Lint • 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 #!
  35. 35. <?xml version="1.0"?> <project name="phpsyntaxcheck" default="syntaxcheck_php"> <target name="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> #!
  36. 36. Running Phing Syntax Check Syntax Check • 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 #!
  37. 37. Add Phing Build Step To Jenkins • Use the Jenkins Phing Plugin to invoke the syntaxcheck_php Phing target #!
  38. 38. What Next? #!
  39. 39. Drupal Coding Standards https://drupal.org/coding-standards #!
  40. 40. Checkstyle • Jenkins Plugin • Reports on coding standards results • Accepts a checkstyle.xml file produces lots of graphs and code reports #!
  41. 41. PHP CodeSniffer • Inspect code for Drupal coding standards • Produces checkstyle.xml files for Checkstyle • Looks for best practice in your code #!
  42. 42. Install PHP CodeSniffer • Install the 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 #!
  43. 43. phpcs docroot/sites/all/modules/custom #!
  44. 44. phpcs --standard=Drupal docroot/sites/all/modules/custom #!
  45. 45. phpcs --standard=Drupal --extensions=php,module,inc,install,test,profil e,theme docroot/sites/all/modules/custom #!
  46. 46. phpcs --report=checkstyle --standard=Drupal --extensions=php,module,inc,install,test,profil e,theme docroot/sites/all/modules/custom #!
  47. 47. phpcs --report-file=reports/checkstyle.xml --report=checkstyle --standard=Drupal --extensions=php,module,inc,install,test,profil e,theme docroot/sites/all/modules/custom #!
  48. 48. The Missing Element? • Git stores the code • phpcs produces the reports • Jenkins and processes reports • What fits all these elements together? #!
  49. 49. Phing! (did I mention it was awesome?) #!
  50. 50. phpcs Phing Module • Tell Phing 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 #!
  51. 51. <?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> #!
  52. 52. <?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> #!
  53. 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. 54. Add PHP CodeSniffer To Jenkins • Use the Phing plugin to invoke Phing target #!
  55. 55. Publish PHP CodeSniffer Output • Create a Post Build action • Reports directory contains PHPCS report • Checkstyle plugin creates graphs from this file #!
  56. 56. #!
  57. 57. #!
  58. 58. #!
  59. 59. Try It Yourself • PHP Mess Detect Phing output into PMD Analysis Results graphs in Jenkins • PHP Copy Paste Detect Phing output into Duplicate Code Analysis results graphs in Jenkins #!
  60. 60. Do More! • Use Phing to run an action • Use Jenkins to automate it — or — • Use Phing to generate reports • Use Jenkins plugins to convert reports into graphs #!
  61. 61. joind.in/10137 #!
  62. 62. Me • Phil Norton (@philipnorton42) • #! code (www.hashbangcode.com) • Technical Lead at Access • Help run NWDUG • DrupalCampNW2013 co-organizer • Help out at PHPNW #!

×