HvA ASV :: Assignment 3 (v5)

This is an introductory exercise about Continuous Integration. You will work with the Jenkins tool, and will create jobs to compile, package and deploy applications in a staging environment.

Prerequisites

You must have a JDK 11+ installed in your computer.

Preparation

During this phase you will install the required software to do the exercise:

1. Maven installation

Maven will be used to manage a Java application (compilation, testing, deployment). Make sure that you have Maven installed on your local machine. If not:

• Download and extract Maven from the Maven website
• Optional if you want to run maven from your console: Add your maven_folder/bin to your PATH

2. Git installation

Git will be used as our repository. Make sure that you have git installed on your local machine. If not:

• Download and extract git from the Git WebSite
• Add your git_folder/bin to your PATH environment variable

3. Jenkins installation

Jenkins is a CI/CD (Continuos Integration/Continuous Deployment) tool. Make sure that you have Jenkins installed on your local machine. If not:

• Download Jenkins from the Jenkins WebSite. Select Generic Java Package (war) for this exercise.
• Start the Jenkins Server from the command line: java -jar jenkins.war --httpPort=9090
• The command will start a Jetty container. You can access Jenkins from http://localhost:9090. The log file will display the generated admin password. Copy this password to be used in the upcoming step.
• Follow the instructions to unlock Jenkins using the provided admin password.
• You don't need to install any plugin right now

4. Jenkins configuration

1. Open Jenkins startup page http://localhost:9090
2. Change the admin password. Go to the admin user menu (top-right of the screen) > Configure and change your password
3. Go to Manage Jenkins > Manage Plugins option
4. Install the GitHub plugin. This plugin integrates Jenkins with Github projects
5. Go to Manage Jenkins > Global Tool Configuration and configure the location of your JDK and Maven. Do not ask Jenkins to install automatically these software units, provide your own location.
   • In Mac computers, the JDK installation resides in /Library/Java/JavaVirtualMachines/jdk[version]/Contents/Home/

Exercise Part 1 of 3

In this part, you will build a "Hello World" Jenkins Job.

1. Open the Jenkins startup page at http://localhost:9090
2. Create a new job (new item option)
3. Specify a name and choose the freestyle project
4. Create a build step to execute a shell command (Unix/Linux/Mac) or batch command (Windows).
5. Add some simple command like echo "Hello World"
6. Go to the main page and schedule a build
7. See if your command executed properly in the console output

Exercise Part 2 of 3

In this part, you create your Maven-based Jenkins project. A sample JEE project on GitHub is provided.

1. Fork the sample project https://github.com/marciofk/hva-asv-assignment-3.git. Please do not use the original project, fork it and you will have your own copy to play during the exercise!
2. Open the Jenkins startup page http://localhost:9090
3. Create a new job (new item option)
4. Specify a name and choose the freestyle project
5. In Source Code management, inform your git repository URL (no credentials needed for this GitHub project), keep using the master branch.
6. In Build, select to invoke a top-level Maven target
   • Select your maven installation
   • Specify the goal clean package
7. Go to the main page and schedule a build
8. See if your command executed properly
   • Check the console output
   • Check if your target outcomes are presented in the job workspace

Now, configure the job to start automatically if the repository changes:

1. Go to the job configuration
2. In Build Triggers, use the Poll SCM strategy
   • Use the crontab syntax (check the syntax on Google)
3. Make any change in your project and push it to the repository
4. Check if the task started automatically

Exercise Part 3 of 3

In this step, you will deploy your application into a Tomcat Staging Server.

1. Download and install Tomcat 9

2. Start Tomcat using the startup.sh or startup.bat shell scripts located in the bin folder of the installation. In Unix/Linux/Mac computers you will need to grant execution permissions to the bin shell scripts.

3. Open the Jenkins startup page http://localhost:9090

4. Modify your existing job

   • Add a new build step, Execute Shell for Unix-based systems or Windows Batch command for Windows OS
   • In the command field, execute cp ${WORKSPACE}/target/*.war <your-tomcat-installation>/webapps, where WORKSPACE is the environment variable with the build folder, and should be replaced with the folder where your tomcat is installed in your local computer. Note that tomcat will automatically install any war file copied to this folder.

5. Go to the main page and schedule a build

6. Check if the build executed properly by viewing the console output.

7. Test if the application is running by visiting the page http://localhost:8080/hva-asv-assignment-3-1.0/

Optional

This project is using JaCoCo to generate the coverage report. The report is generated in the target folder, as could be seen in assignment 1. Your task is executing scripts to copy the HTML files to a web server.

Hints:

• For the sake of simplicity, you can publish the HTML in your tomcat running at port 8090 in the folder webapps/root. Static files are visible from the root folder of your tomcat installation.
• You will need a plugin to run "shell scripts"