Hello World from OSS Silicon Valley

_ Prerequisite

• Java Runtime Edition
• Cent OS (You can refer HowToUse/CentOS/6.5)
• Subversion (You can refer HowToUse/Subversion/1.6)
• Maven (You can refer HowToUse/Maven/3.2)
• Maven Javadoc (You can refer HowToUse/Maven/3.2/javadoc)

_ Install&Setup

_ Install Jenkins

Step.1

Import public key.

# wget -O /etc/yum.repos.d/jenkins.repo http://pkg.jenkins-ci.org/redhat/jenkins.repo
# rpm --import http://pkg.jenkins-ci.org/redhat/jenkins-ci.org.key

Step.2

Install Jenkins

# yum install jenkins

_ Launch Jenkins

Step.1

Login from GUI with root.

Step.2

Select System -> Administration -> Firewall

Step.3

Select "Other Ports" and click "Add" button and set 8080 port.

Step.4

Click "Apply" button on the "Firewall Configuration" window.

Step.5

Execute the following command and access http://<host name>:8080/.

# /etc/rc.d/init.d/jenkins start

_ HowToUse

_ Prepare maven project

Step.1

Prepare workspace in your pc.

# svn checkout <SVN repository path>

Step.2

Create Maven project.

$ cd <project directory>
$ mvn archetype:create \
 -DgroupId=<Group ID> \
 -DartifactId=<Artifact ID>

Step.3

Edit POM.xml so that maven create Javadoc.

# vi pom.xml

 <build>
   <plugins>
     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-javadoc-plugin</artifactId>
       <configuration>
         <author>true</author>
         <source>1.7</source>
         <show>protected</show>
         <encoding>UTF-8</encoding>
         <charset>UTF-8</charset>
         <docencoding>UTF-8</docencoding>
       </configuration>
     </plugin>
   </plugins>
 </build>

Or you can get sample files from the Github - OSSSV

Step.4

Check in files into the repository Jenkins will monitor.

# svn add .
# svn commit -m "Import new files"

_ Mail Server Configuration

Step.1

Click "Manage Jenkins".

Step.2

Click "Configure System".

Step.3

Setup mail notification configuration.

Step.4

Click "Advances..." button. Setup the configuration.

_ Install JDK for Jenkins

Step.1

Click "Manage Jenkins" link.

Step.2

Click "Configure System" link.

Step.3

Click "Add JDK" button.

Step.4

Step.5

Click "Please enter your username/password" link.

Step.6

Enter Oracle account and click "OK" button.

_ Install Maven for Jenkins

Step.1

Click "Add Maven" button and set Name.

Step.2

Click "Save" button.

_ Create Items for Build

Step.1

Click "New Item" link.

Step.2

Set "Item name", check "Freestyle project" and click "OK" button.

Now, you have new directory named "sample" in JENKINS_HOME, namely, /var/lib/jenkins. Resources which are necessary for build will be stored in workspace.

Step.3

Click Subversion for "Source Code Management" and set "Repository URL".

Step.4

Click "enter credential" link.

Step.5

You can choose build trigger according to your situation.

• "Build after other projects are built"
• "Build periodically"
• "Poll SCM"

Here, I choose "Poll SCM". Check "Poll SCM". If you want to check every 5min, set as follows. The order of parameters are same as cron.

min hour day month wday

H/5 * * * *

Step.6

Select "Invoke top-level Maven targets" from "Add build step".

Step.7

Set the following.

Step.8

Click "Advanced ..." link and set as following.

Step.9

Click "Save" button. Now, you can see New Item in the main window.

_ Run Build

Step.1

Click newly created "sample" link.

Step.2

Click "Build Job" link and you can see the status of job is changed.

Step.3

For your first job, Jenkins will download and install maven and related libraries, so it takes time. After the build job finished, you can check test result.

You can see the detail information from terminal log, Jenkins -> sample -> #<job number> -> "Console Output Windows".

_ E-mail notification setting

Step.1

It is useful to notify error by notification mail. Select target Item and click "Configure" link. Then choose "E-mail Notification" from "Add post-build action" and set "Recipients".

After saving, you will recieve notification mail when you encounter error in build.

_ JUnit Testing

Step.1

Jenkins can display JUnit test report. Select target Item and click "Configure" link. Then choose "Publish JUnit Test Result" from "Add post-build action".

Step.2

Add "test" to maven goal.

After saving, you can see test result in Jenkins window.

_ Javadoc creation

Step.1

Jenkins also can show Javadoc from its window. Select target Item and click "Configure" link. Then choose "Publish Javadoc" from "Add post-build action".

Step.2

Add "javadoc:javadoc" to maven goal.

After saving, you can see javadoc link in your build result page.

_ Deploy objects

Step.1

Click "New Item" link.

Step.2

Set "Item name", check "Freestyle project" and click "OK" button.

Step.3

Select "Build after other projects are built".

Step.4

Click "Execute shell" from "Add build step" to deploy the created files. Here, I use dummy program, "deploy_files.sh" for deployment.

Step.5

Set e-mail notification same as "sample".

_ Setup User Security

Step.1

Click "Mange Jenkins" link and "Setup Security".

Step.2

Click "Enable security" and "Jenkins'own user database".

Step.3

Sign up the user.

Step.4

If you set readonly for "anonymous", guest user cannot execute "build" any more.

_ Author

S.Yatsuzuka