Jenkins for Java: tools and plugin configuration

Free Information Technology Software and Development Magazine Subscriptions and Document Downloads

Jenkins CI should generate web based auto-docs. Use Javadoc to generate HTML documents from source code and its comments. This is a native plugin which comes with Jenkins thus no installation is required. Configuration is required.

This example shows the basic Unix/Linux start script used to launch Jenkins. All configuration options in this example are set with environment variables and command line arguments:

• Install "Javadoc":
  • Javadoc comes with the Java SDK. See the YoLinux Java JDK Installation Tutorial

• Install Javadoc plugin:
  • Native plugin. Comes with Jenkins.

• Configure Jenkins System:
  In the section "Global Properties" + "Environment Variables", add to your PATH:
  • name: JAVA_HOME
  • value: /opt/java/latest
  • name: PATH
  • value: $JAVA_HOME/bin:$PATH
  Then select "Save" at bottom of page.

• Jenkins Project Configuration:
  • Select your build job from the Jenkins home page.
  • Select "Configure" (top left hand side of page)
  • At the bottom of page under "Post-build Actions" select the "Publish Javadoc" option.
  • Set Javadoc directory: build/javadoc

    

  • Select the "Save" button to save this configuration.

• Configure Build:
  • Shell Script:

    export PATH=$PATH:/opt/java/latest/bin
    javadoc -d build/javadoc -sourcepath ProjectX/trunk/JavaApp/src
            

  • Ant: Add target "javadoc"
    (add to build.xml)
    File: build.xml
    view sourceprint?

    01

    ...

    02

    ...

    03	<property name="src.dir" value="./src"/>

    04	<property name="javadoc.dir" value="${build.dir}/javadoc"/>

    05

    06	<target name="javadoc" description="Documentation generation" >

    07	<mkdir dir="${javadoc.dir}"/>

    08	<javadoc access="public"

    09	destdir="${javadoc.dir}"

    10	author="true"

    11	version="true"

    12	use="true"

    13	windowtitle="ABC Corp JavaApp">

    14	<fileset dir="${src.dir}"

    15	defaultexcludes="yes">

    16	<include name="**/*.java" />

    17	<exclude name="test/**/*.java" />

    18	</fileset>

    19	</javadoc>

    20

    </target>

    21

    22

    ...

    23

    ...

• Build Display:
  
  Select "Javadoc" link to view documentation.

Javadoc plugin location: /var/lib/jenkins/plugins/javadoc.hpi

FindBugs is used to find bad coding practices or potentially unintended behavior in Java code.
This is a list of FindBugs bug descriptions that will be searched.

• Install FindBugs:
  • Home page: http://sourceforge.net/projects/findbugs/
  • Download: findbugs-3.0.0.tar.gz
  • Install:

    cd /opt
    tar xzf findbugs-3.0.0.tar.gz
            

    User environments can add the following to their ~/.bashrc

    if [ -d /opt/findbugs-3.0.0/ ]
    then
      export FINDBUGS_HOME=/opt/findbugs-3.0.0
      PATH=$FINDBUGS_HOME/bin:$PATH
    fi
            

    FindBugs can run as a GUI tool (java -jar $FINDBUGS_HOME/lib/findbugs.jar) or from the command line as shown by our Ant script: build.xml

• Install Jenkins FindBugs Plugin:
  • Select from the Jenkins (start page) + "Manage Jenkins" + "Manage Plugins". Now select the "Available" tab and select the FindBugs Plugin.
  • Select the "Install and Restart Jenkins" button.
  • FindBugs Plugin Info

• Ant build:

  To add support for the Ant FindBugs XML tags, add the findbugs-ant.jar file to the Apache Ant library:
  ln -s /opt/findbugs-3.0.0/lib/findbugs-ant.jar /opt/apache-ant-1.8.2/lib/findbugs-ant.jar

  Add the following to your Ant build.xml file:

  view sourceprint?

  01	<taskdef name="findbugs" classname="edu.umd.cs.findbugs.anttask.FindBugsTask"/>

  02

  03

  ...

  04

  ...

  05

  06	<property name="findbugs.home" value="/opt/findbugs-3.0.0"/>

  07	<property name="build.dir" value="./build" />

  08	<property name="src.dir" value="./src" />

  09

  10

  ...

  11

  ...

  12

  13	<target name="findbugs" depends="jar">

  14	<findbugs home="${findbugs.home}" output="xml" outputFile="findbugs.xml" effort="max">

  15	<auxClasspath path="/opt/java/lib/junit-4.9b2.jar" />

  16	<sourcePath path="${src.dir}" />

  17	<class location="${base.dir}/${app.jar}" />

  18	</findbugs>

  19

  </target>

  Note:
  • The "taskdef" tag defines support for the Ant tag "findbugs".
  • The "sourcePath" is the source code to be examined. Jar file dependencies are also listed.

• Jenkins Configuration:

  

  Enter the FindBugs "outputFile" which the plug-in will read to display results.

• Results:

  

  Select the "FindBugs Trend" chart to view the details:

  

This plugin reports the number of Java compiler warnings and errors over time. This plugin can be used to generate a plot. No extra software is required as it just reports extra information about your Java build.

• Install Jenkins Warnings Plugin:
  • Select from the Jenkins (start page) + "Manage Jenkins" + "Manage Plugins". Now select the "Available" tab and select the Compiler Warnings Plugin.
  • Select the "Install and Restart Jenkins" button.
  • Warnings Plugin Info (scans Java and C++ console logs for warnings)

• Jenkins Configuration:

  

  Select "Add" (Scan console log), then specify your compiler (in this case javac)

• Results:

  

  Plot of the number of compiler warnings (in this case none)

When compiling with Apache Ant, warnings are supressed by default. It is required that one use the following Java compiler flag (-Xlint:all) to generate Java warnings which can be plotted by the Jenkins Warnings Plugin. This can be added using the following XML in your build file.

Apache Ant Build File: build.xml (snippet)

When compiling with Maven, warnings are supressed by default. It is required that one use the compiler plugin for Maven to generate Java warnings which can be plotted by the Jenkins Warnings Plugin. This can be added using the following XML in your POM file.

Maven Build File: pom.xml (snippet)

OR

use the following which keeps the POM Netbeans friendly. The compiler argument directive is not Netbeans friendly and can be injected to the pom.xml file as a Jenkins property which is not viewed by Netbeans when building from the POM file.

Jenkins project configuration:

Note that the Jenkins "Property "compilerArgument" matches the name used as the variable set in the POM.

Maven Build File: pom.xml (snippet)

This POM file is Netbeans friendly because the variable "${compilerArgument}" does not get substituted for "Xlint:all" which suspends Netbeans scrolling during the build process. It will however be used during the Jenkins build.

JUnit is supported natively by Jenkins so there is no extra plug-in installation, just configuration.

• JUnit Installation:
  • See the YoLinux JUnit Tutorial for download and installation instructions as well as coding with JUnit.

• Ant build: File: build.xml (snippets)
  view sourceprint?

  01	<?xml version="1.0" encoding="UTF-8"?>

  02

  03	<project name="projx" default="all" basedir=".">

  04	<description>Builds, tests, and runs projx</description>

  05	<property name="build.dir" value="./"/>

  06	<property name="src.dir" location="${build.dir}/src"/>

  07	<property name="test.dir" location="${build.dir}/test/src"/>

  08	<property name="test.htmlreports.dir" location="${build.dir}/test/htmlreports"/>

  09

  10	<property name="test.data.dir" location="${build.dir}/test/data"/>

  11	<property name="junit.class.name" value="com.megacorp.projx.JUnit.AllTests"/>

  12

  13

  ...

  14

  ...

  15

  16	<path id="classpath.junittest">

  17

  18	<path refid="classpath.base" />

  19	<pathelement location="/opt/java/lib/junit-4.9b2.jar" />

  20	<pathelement location="${test.dir}" />

  21

  </path>

  22

  23

  ...

  24

  ...

  25

  26	<target name="test" depends="compile-test">

  27	<mkdir dir="${test.data.dir}"/>

  28	<mkdir dir="${test.htmlreports.dir}"/>

  29

  30	<junit fork="no" haltonfailure="no" showoutput="yes" printsummary="true">

  31	<test name="${junit.class.name}" todir="${test.data.dir}"/>

  32	<formatter type="brief" usefile="false"/>

  33	<formatter type="xml"/>

  34	<classpath refid="classpath.base" />

  35	<classpath refid="classpath.src" />

  36

  37	<classpath refid="classpath.junittest" />

  38

  </junit>

  39	<junitreport todir="${test.htmlreports.dir}">

  40	<fileset dir="${test.data.dir}">

  41	<include name="TEST-*.xml"/>

  42	</fileset>

  43

  44	<report format="frames" todir="${test.htmlreports.dir}"/>

  45	</junitreport>

  46

  </target>

  47

  48	<target name="all" depends="compile-test" />

  49

  50	</project>

• Jenkins Configuration:

  

  Configuration must match the "todir" directory of the JUnit test output.

• JUnit Results:

  

  JUnit chart of sucessful tests. Increase is due to the addition of new tests.

  

  Click on the JUnit chart to view details

  

  JUnit HTML Results Report: ./test/htmlreports/index.html

For a full tutorial on the use of Maven with JUnit, see the Yolinux JUnit tutorial

Configure Jenkins to point to the JUnit test results:

Use the Jenkins Maven plug-in rather than executing Maven as a shell command. The Maven plug-in is Maven aware and will post-process JUnit results for use with Jenkins. Select your Jenkins project and "Configure":

Configure Build Project JUnit reporting:

Test results will be put into the following directory structure:

• Install "JaCoCo":
  • JaCoCo Home Page
  • Download jacoco-0.7.2.201409121644.zip
  • Install:

    mkdir /opt/JaCoCo
    cd /opt/JaCoCo
    unzip path-to-file/jacoco-0.7.2.201409121644.zip
            

• Install JaCoCo plugin:
  • Select from the Jenkins (start page) + "Manage Jenkins" + "Manage Plugins". Now select the "Available" tab and select the JaCoCo Plugin.
  • Select the "Install and Restart Jenkins" button.
  • JaCoCo Plugin info

• Configure Build:
  • Ant configuration: build.xml
    view sourceprint?

    01

    ...

    02

    ...

    03	<property name="junit.class.name" value="AllTests"/>

    04	<property name="test.data.dir" location="${build.dir}/test/data"/>

    05	<property name="test.htmlreports.dir" location="${build.dir}/test/htmlreports"/>

    06

    07	<taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">

    08	<classpath path="/opt/JaCoCo/lib/jacocoant.jar"/>

    09	</taskdef>

    10

    ...

    11

    ...

    12	<target name="test" depends="compile-test">

    13	<mkdir dir="${test.data.dir}"/>

    14	<mkdir dir="${test.htmlreports.dir}"/>

    15	<jacoco:coverage destfile="jacoco.exec">

    16	<junit fork="true" forkmode="once" haltonfailure="no" showoutput="yes" printsummary="true">

    17	<test name="${junit.class.name}" todir="${test.data.dir}"/>

    18	<formatter type="brief" usefile="false"/>

    19	<formatter type="xml"/>

    20	<classpath refid="classpath" />

    21

    </junit>

    22	</jacoco:coverage>

    23	<junitreport todir="${test.htmlreports.dir}">

    24	<fileset dir="${test.data.dir}">

    25	<include name="TEST-*.xml"/>

    26	</fileset>

    27	<report format="frames" todir="${test.htmlreports.dir}"/>

    28	</junitreport>

    29

    </target>

    30

    31

    ...

    32

    ...

    Note that the "taskdef" defines the JaCoCo Ant tags and the Jar file to provide this functionality. Alternatively this Jar file could be added to the Ant lib/ directory.
    Wrap whatever you want to run, JUnit tests or just code execution with the following:

    <jacoco:coverage destfile="jacoco.exec">
    ...
    ...
    </jacoco:coverage>
            

    The binary output file jacoco.exec is used by the plugin. For Jacoco HTML reports accessed by the sidebar link plugin run the following:
    view sourceprint?

    01

    ...

    02

    ...

    03	<property name="jacoco.report.dir" location="${base.dir}/jacoco"/>

    04	<property name="build.dir" value="./build" />

    05	<property name="src.dir" value="./src" />

    06

    ...

    07

    ...

    08

    09	<target name="jacoco-report" depends="compile-test">

    10	<!-- Step 3: Create coverage report -->

    11	<jacoco:report>

    12	<!-- This task needs the collected execution data and ... -->

    13	<executiondata>

    14	<file file="jacoco.exec"/>

    15	</executiondata>

    16	<!-- the class files and optional source files ... -->

    17	<structure name="JaCoCo Report">

    18	<classfiles>

    19	<fileset dir="${build.dir}"/>

    20	</classfiles>

    21	<sourcefiles encoding="UTF-8">

    22	<fileset dir="${src.dir}"/>

    23	</sourcefiles>

    24	</structure>

    25	<!-- to produce reports in different formats. -->

    26	<html destdir="${jacoco.report.dir}"/>

    27	<csv destfile="${jacoco.report.dir}/report.csv"/>

    28	<xml destfile="${jacoco.report.dir}/report.xml"/>

    29	</jacoco:report>

    30

    </target>

    31

    ...

    32

    ...

    Jacoco report URL: http://localhost/jenkins/job/ExampleJavaApp/ws/jacoco/index.html

• Jenkins Plugin Configuration:
  Turn on report generation: For the Jenkins project, select "Configure" + "Add post-build action" (bottom of page) + "Record JaCoCo coverage report" + "Apply". The following entry form will be available:

  

  Direct JaCoCo to use use the binary output file (jacoco.exec), and Java source and compiled class files. Code coverage limits can be set to determine if the build is considered a pass or fail. Set to zero if code coverage will not be used to determine if the build is a pass or fail.
  Select the "Save" button to save this configuration.

• Build Display:

  

  Select graph plot to view details. If the build and test runs are successful, the "Overall Coverage Summary" of percentages will be posted.

  

Maven Build File: pom.xml (snippet)

Jenkins project post-build JaCoCo configuration:

Also see the Jenkins JaCoCo plugin home page

• Jenkins home page
• Apache Ant home page
  • Download: download
  • Apache Ant manual

	Continuous Integration: Improving Software Quality and Reducing Risk (Paperback) by Steve Matyas, Andrew Glover Addison-Wesley Professional
	Jenkins: The Definitive Guide (Paperback) by John Ferguson Smart O'Reilly Media (July 27, 2011) Java development focus.
	Better Software Magazine Free subscription for software professionals who care about quality. Each issue brings you relevant, timely information to help you build better software. Continuing to deliver in-depth articles on testing, tools, defect tracking, metrics, and management.	Free Subscription