Jenkins Scripted Pipeline - Create Jenkins Pipeline for Automating Builds, Code quality checks, Deployments to Tomcat - How to build, deploy WARs using Jenkins Pipeline - Build pipelines integrate with github, Sonarqube, Slack, JaCoCo, Nexus, Tomcat
What are Pipelines in Jenkins?
Pre-requisites:
- Pipelines are better than freestyle jobs, you can write a lot of complex tasks using pipelines when compared to Freestyle jobs.
- You can see how long each stage takes time to execute so you have more control compared to freestyle.
- Pipeline is groovy based script that have set of plug-ins integrated for automating the builds, deployment and test execution.
- Pipeline defines your entire build process, which typically includes stages for building an application, testing it and then delivering it. - You can use snippet generator to generate pipeline code for the stages you don't know how to write groovy code.
- Pipelines are two types - Scripted pipeline and Declarative pipeline. Click here to know the difference between them.
Pre-requisites:
Install plug-ins
1. Install Deploy to container, Slack, Jacoco, Nexus Artifact Uploader and SonarQube plug-ins (if already installed, you can skip it)
Steps to Create Scripted Pipeline in Jenkins
1. Login to Jenkins
2. Create a New item
3. Give name as MyfirstPipelineJob and choose pipeline
4. Click ok. Pipeline is created now
5. Under build triggers, click on poll SCM, schedule as
H/02 * * * *
6. Go to Pipeline definition section, click on Pipeline syntax link. under sample step drop down, choose checkout: Checkout from version control. enter bitbucket or GitHub Repository URL, and enter right credentials. Click here to learn to use PAT if you are using GitHub. scroll down, click on Generate Pipeline script. Copy the code.
7. Now copy the below pipeline code highlighted section into Pipeline section in the pipeline. Please copy stage by stage
8. Change Maven3, SonarQube variables and also Slack channel name as highlighted above in red as per your settings.
9. For Nexus Upload stage, You need to change the Nexus URL and credentials ID for Nexus (which you can grab from Credentials tab after login)
10. For Dev Deploy stage, you can copy credentials ID used for connecting to Tomcat.
1. Install Deploy to container, Slack, Jacoco, Nexus Artifact Uploader and SonarQube plug-ins (if already installed, you can skip it)
Steps to Create Scripted Pipeline in Jenkins
1. Login to Jenkins
2. Create a New item
3. Give name as MyfirstPipelineJob and choose pipeline
4. Click ok. Pipeline is created now
5. Under build triggers, click on poll SCM, schedule as
H/02 * * * *
6. Go to Pipeline definition section, click on Pipeline syntax link. under sample step drop down, choose checkout: Checkout from version control. enter bitbucket or GitHub Repository URL, and enter right credentials. Click here to learn to use PAT if you are using GitHub. scroll down, click on Generate Pipeline script. Copy the code.
7. Now copy the below pipeline code highlighted section into Pipeline section in the pipeline. Please copy stage by stage
8. Change Maven3, SonarQube variables and also Slack channel name as highlighted above in red as per your settings.
9. For Nexus Upload stage, You need to change the Nexus URL and credentials ID for Nexus (which you can grab from Credentials tab after login)
10. For Dev Deploy stage, you can copy credentials ID used for connecting to Tomcat.
Pipeline Code:
node {
def mvnHome = tool 'Maven3'
stage ("checkout") {
copy code here which you generated from step #6
}
stage ('build') {
sh "${mvnHome}/bin/mvn clean install -f MyWebApp/pom.xml"
}
stage ('Code Quality scan') {
withSonarQubeEnv('SonarQube') {
sh "${mvnHome}/bin/mvn -f MyWebApp/pom.xml sonar:sonar"
}
}
stage ('Code coverage') {
jacoco()
}
stage ('Nexus upload') {
nexusArtifactUploader(
nexusVersion: 'nexus3',
protocol: 'http',
nexusUrl: 'nexus_url:8081',
groupId: 'myGroupId',
version: '1.0-SNAPSHOT',
repository: 'maven-snapshots',
credentialsId: '2c293828-9509-49b4-a6e7-77f3ceae7b39',
artifacts: [
[artifactId: 'MyWebApp',
classifier: '',
file: 'MyWebApp/target/MyWebApp.war',
type: 'war']
]
)
}
stage ('DEV Deploy') {
echo "deploying to DEV Env "
deploy adapters: [tomcat9(credentialsId: '4c55fae1-a02d-4b82-ba34-d262176eeb46', path: '', url: 'http://your_tomcat_url:8080')], contextPath: null, war: '**/*.war'
}
stage ('Slack notification') {
slackSend(channel:'channel-name', message: "Job is successful, here is the info - Job '${env.JOB_NAME} [${env.BUILD_NUMBER}]' (${env.BUILD_URL})")
}
stage ('DEV Approve') {
echo "Taking approval from DEV Manager for QA Deployment"
timeout(time: 7, unit: 'DAYS') {
input message: 'Do you approve QA Deployment?', submitter: 'admin'
}
}
stage ('QA Deploy') {
echo "deploying into QA Env "
deploy adapters: [tomcat9(credentialsId: '4c55fae1-a02d-4b82-ba34-d262176eeb46', path: '', url: 'http://your_tomcat_url:8080')], contextPath: null, war: '**/*.war'
}
node {
def mvnHome = tool 'Maven3'
stage ("checkout") {
copy code here which you generated from step #6
}
stage ('build') {
sh "${mvnHome}/bin/mvn clean install -f MyWebApp/pom.xml"
}
stage ('Code Quality scan') {
withSonarQubeEnv('SonarQube') {
sh "${mvnHome}/bin/mvn -f MyWebApp/pom.xml sonar:sonar"
}
}
stage ('Code coverage') {
jacoco()
}
stage ('Nexus upload') {
nexusArtifactUploader(
nexusVersion: 'nexus3',
protocol: 'http',
nexusUrl: 'nexus_url:8081',
groupId: 'myGroupId',
version: '1.0-SNAPSHOT',
repository: 'maven-snapshots',
credentialsId: '2c293828-9509-49b4-a6e7-77f3ceae7b39',
artifacts: [
[artifactId: 'MyWebApp',
classifier: '',
file: 'MyWebApp/target/MyWebApp.war',
type: 'war']
]
)
}
stage ('DEV Deploy') {
echo "deploying to DEV Env "
deploy adapters: [tomcat9(credentialsId: '4c55fae1-a02d-4b82-ba34-d262176eeb46', path: '', url: 'http://your_tomcat_url:8080')], contextPath: null, war: '**/*.war'
}
stage ('Slack notification') {
slackSend(channel:'channel-name', message: "Job is successful, here is the info - Job '${env.JOB_NAME} [${env.BUILD_NUMBER}]' (${env.BUILD_URL})")
}
stage ('DEV Approve') {
echo "Taking approval from DEV Manager for QA Deployment"
timeout(time: 7, unit: 'DAYS') {
input message: 'Do you approve QA Deployment?', submitter: 'admin'
}
}
stage ('QA Deploy') {
echo "deploying into QA Env "
deploy adapters: [tomcat9(credentialsId: '4c55fae1-a02d-4b82-ba34-d262176eeb46', path: '', url: 'http://your_tomcat_url:8080')], contextPath: null, war: '**/*.war'
}
stage ('QA notify') {
slackSend(channel:'channel-name', message: "QA Deployment was successful, here is the info - Job '${env.JOB_NAME} [${env.BUILD_NUMBER}]' (${env.BUILD_URL})")
}
stage ('QA Approve') {
echo "Taking approval from QA manager"
timeout(time: 7, unit: 'DAYS') {
input message: 'Do you want to proceed to PROD Deploy?', submitter: 'admin,manager_userid'
}
slackSend(channel:'channel-name', message: "QA Deployment was successful, here is the info - Job '${env.JOB_NAME} [${env.BUILD_NUMBER}]' (${env.BUILD_URL})")
}
stage ('QA Approve') {
echo "Taking approval from QA manager"
timeout(time: 7, unit: 'DAYS') {
input message: 'Do you want to proceed to PROD Deploy?', submitter: 'admin,manager_userid'
}
}
stage ('PROD Deploy') {
echo "deploying into PROD Env "
deploy adapters: [tomcat9(credentialsId: '4c55fae1-a02d-4b82-ba34-d262176eeb46', path: '', url: 'http://your_tomcat_url:8080')], contextPath: null, war: '**/*.war'
}
}
11. Click Apply, Save
echo "deploying into PROD Env "
deploy adapters: [tomcat9(credentialsId: '4c55fae1-a02d-4b82-ba34-d262176eeb46', path: '', url: 'http://your_tomcat_url:8080')], contextPath: null, war: '**/*.war'
}
}
11. Click Apply, Save
12. Now click on Build. It should execute all the stages and show pipeline view like this.
' x='0' y='0' height='100%25' width='100%25' xlink%3Ahref='data%3Aimage/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAYAAAAJCAIAAACe+MrKAAAAi0lEQVQI1wXBSxaCMAwF0Jc0gFSd6FE24MwduP/VOFBRPm1JE++l2/0BUDVT1Rj7nLLklLtdl9fVge+4uVUWkeNhz4EBAGAmNrNpXlQrEQ3XCxOxu7t70wgRAU4hSA6DS5xKYaFXaROLdPUZ0W9llBBO7fm9fJiZJIS2aapZSklV2QFV1aoAftNs5n9M0kxXIXxHrwAAAABJRU5ErkJggg=='%3E%3C/image%3E%3C/svg%3E)
' x='0' y='0' height='100%25' width='100%25' xlink%3Ahref='data%3Aimage/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAFCAIAAADzBuo/AAAAkUlEQVQI1wXBOw7CMAwA0MR21DQtiKrqwsTAyMrOCTgNZ+GGLEjQQlXSfBzznt7tz5WOzAImB2dh8YTIzITEKQPW1jYb5+rJf6/3W3s6AGiEIhLe86SH44WWT8rltT7boZNfJlA5Jx8iM6OSzugCxixxVoVSDCEmpaUUERGq+h78CFoRGqUJbUXNVlUOx4ek9Q/fuEg6CJHddQAAAABJRU5ErkJggg=='%3E%3C/image%3E%3C/svg%3E)
' x='0' y='0' height='100%25' width='100%25' xlink%3Ahref='data%3Aimage/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAECAIAAAAxsZngAAAAn0lEQVQI1xXL0Q6CIBQAUK4XBDRNzNLafGutttb/f0xb662trAejRAiq836gVErrJ2cxF7yeV8umEZw/7t35dAzkDwhMi4xEiMNg/MdbZ0djWEzTVN6vlzxLGIRMikTwXJXv98uMFili2662m7V3tp6pKPgJp8QaDET3T8GYd04WVa81RgCH/e63FwlKCsGOGACRAkQiSZHLR3dzgRjrvrZ0P0INzjDmAAAAAElFTkSuQmCC'%3E%3C/image%3E%3C/svg%3E)
' x='0' y='0' height='100%25' width='100%25' xlink%3Ahref='data%3Aimage/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAECAIAAAAxsZngAAAAnklEQVQI1wXBWQ6CMBAA0GmnIGWJK4mNMV5A4v3PovHL+INLsVGgnQ6+J47NKTJzJE80Q9xult3PB6IqL7rP93y9mN1eAhtjsNawyqBUUbFvDkbTuK2SVBBOYbCPn3sxcz3XED2mSvSjH3xAmKztbo/23j7bty2K/OWcj8wQE4lZlkiFUgoRiOv1GvPqS0pg2o/BM5AS1aIstXbOCoA/UJ1Sp4W/LZwAAAAASUVORK5CYII='%3E%3C/image%3E%3C/svg%3E)
' x='0' y='0' height='100%25' width='100%25' xlink%3Ahref='data%3Aimage/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAsAAAAFCAIAAAAcxIEBAAAAV0lEQVQImV2NUQrAMAhDvf9Zu+6jRak2bmGFsi2IIjxeRFUBjOGt9eubCbiFRAQf7lIOQjuZuTgx9wDmhKqldXen8m2Sdeio9WQjiXjyJ+ikZg2Vu4K5Aaqkogt1Hw0wAAAAAElFTkSuQmCC'%3E%3C/image%3E%3C/svg%3E)
