Jenkins-CI.html


<!DOCTYPE HTML>
<html lang="" >
    <head>
        <meta charset="UTF-8">
        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
        <title>Jenkins CI · GitBook</title>
        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
        <meta name="description" content="">
        <meta name="generator" content="GitBook 3.2.3">
        
        
    <link rel="stylesheet" href="gitbook/style.css">

    
                <link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-git-author/style.css">
                
            
    <meta name="HandheldFriendly" content="true"/>
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
    <meta name="apple-mobile-web-app-capable" content="yes">
    <meta name="apple-mobile-web-app-status-bar-style" content="black">
    <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
    <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">

    
    <link rel="next" href="Build-Environment-Setup.html" />
    
    
    <link rel="prev" href="CI-CD-Enviroment.html" />
    

    </head>
    <body>
        
<div class="book">
    <div class="book-summary">
        
            
<div id="book-search-input" role="search">
    <input type="text" placeholder="Type to search" />
</div>

            
                <nav role="navigation">
                

<ul class="summary">
    
    
        <li class="header">ATTX Project</li>
        
        
        <li class="chapter " data-level="1.1" data-path="./">
            
                <a href="./">
            
                    
                    ATTX Project
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.2" >
            
                <span>
            
                    
                    Applications and Use Cases
            
                </span>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.2.1" data-path="Use-case-Infrastructures-and-publications.html">
            
                <a href="Use-case-Infrastructures-and-publications.html">
            
                    
                    UC1 - Infrastructure and Publications
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.2.2" data-path="Use-case-Jyvaskyla.html">
            
                <a href="Use-case-Jyvaskyla.html">
            
                    
                    UC2 - Parallel Publication Dashboard
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.2.3" data-path="Use-case-Metax.html">
            
                <a href="Use-case-Metax.html">
            
                    
                    UC3 - Metax
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.2.4" data-path="Use-case-Mildred.html">
            
                <a href="Use-case-Mildred.html">
            
                    
                    UC4 - Mildred
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.3" data-path="ATTX-Architecture-Overview.html">
            
                <a href="ATTX-Architecture-Overview.html">
            
                    
                    ATTX Architecture Overview
            
                </a>
            

        </li>
    

        <li class="header">Getting Started</li>
        
        
        <li class="chapter " data-level="2.1" data-path="ATTX-Broker-Deployment.html">
            
                <a href="ATTX-Broker-Deployment.html">
            
                    
                    ATTX Broker Deployment
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="2.1.1" >
            
                <span>
            
                    
                    Run on Single Machine PC/Mac/VM
            
                </span>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="2.1.1.1" data-path="Building-Docker-application-stacks-in-Swarm-Mode.html">
            
                <a href="Building-Docker-application-stacks-in-Swarm-Mode.html">
            
                    
                    Building Swarm Mode on a PC/Mac
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="2.1.1.2" data-path="Running-the-ATTX-containerised-application-stack-in-your-own-PC-or-Mac.html">
            
                <a href="Running-the-ATTX-containerised-application-stack-in-your-own-PC-or-Mac.html">
            
                    
                    Running the ATTX Stack on a PC/Mac
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="2.1.2" >
            
                <span>
            
                    
                    Run on Distributed/Cloud
            
                </span>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="2.1.2.1" data-path="Provisioning-ATTX-Components-on-CSC-Open-Stack-cPouta.html">
            
                <a href="Provisioning-ATTX-Components-on-CSC-Open-Stack-cPouta.html">
            
                    
                    Provisioning ATTX Components on CSC Open Stack (cPouta)
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="2.1.2.2" data-path="Deploying-ATTX-Components-on-Docker-Swarm.html">
            
                <a href="Deploying-ATTX-Components-on-Docker-Swarm.html">
            
                    
                    Deploying ATTX Components on Docker Swarm
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="2.1.2.3" data-path="Shared-NFS-Swarm-Cloud.html">
            
                <a href="Shared-NFS-Swarm-Cloud.html">
            
                    
                    Setting-up a shared NFS filesystem in Docker Swarm running in CSC cPouta
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="2.1.2.4" data-path="Applying-Rolling-Updates-to-services-in-Docker-Swarm.html">
            
                <a href="Applying-Rolling-Updates-to-services-in-Docker-Swarm.html">
            
                    
                    Applying Rolling Updates to Services in Docker Swarm
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="2.1.3" data-path="Deploying-ATTX-SB-on-Kontena.html">
            
                <a href="Deploying-ATTX-SB-on-Kontena.html">
            
                    
                    Deploying ATTX Broker on Kontena
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    

        <li class="header">Core Components</li>
        
        
        <li class="chapter " data-level="3.1" data-path="ATTX-Component-Workflow.html">
            
                <a href="ATTX-Component-Workflow.html">
            
                    
                    Workflow Component
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="3.1.1" data-path="ETL-Artifacts.html">
            
                <a href="ETL-Artifacts.html">
            
                    
                    ETL Artifacts
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="3.1.2" data-path="Unified-Views-plugins.html">
            
                <a href="Unified-Views-plugins.html">
            
                    
                    UnifiedViews Plugins
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="3.1.3" data-path="Service-UVProvenance.html">
            
                <a href="Service-UVProvenance.html">
            
                    
                    UVProvovenance Service
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="3.2" data-path="ATTX-Component-Graph.html">
            
                <a href="ATTX-Component-Graph.html">
            
                    
                    Graph Component
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="3.2.1" data-path="Service-Graph-Manager.html">
            
                <a href="Service-Graph-Manager.html">
            
                    
                    Graph Manager Service
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="3.2.1.1" data-path="Examples-Graph-Manager-Service.html">
            
                <a href="Examples-Graph-Manager-Service.html">
            
                    
                    Graph Manager Message Examples
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="3.2.2" data-path="Graph-Store.html">
            
                <a href="Graph-Store.html">
            
                    
                    Graph Store
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="3.2.2.1" data-path="ATTX-Data-Model.html">
            
                <a href="ATTX-Data-Model.html">
            
                    
                    Ontology/Data model
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="3.2.3" data-path="Linking-Strategies.html">
            
                <a href="Linking-Strategies.html">
            
                    
                    Linking Strategies
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="3.3" data-path="ATTX-Component-Distribution.html">
            
                <a href="ATTX-Component-Distribution.html">
            
                    
                    Distribution Component
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="3.3.1" data-path="ElasticSearch-with-Siren.html">
            
                <a href="ElasticSearch-with-Siren.html">
            
                    
                    ElasticSearch 1.3 with Siren
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="3.3.2" data-path="ElasticSearch-5.html">
            
                <a href="ElasticSearch-5.html">
            
                    
                    ElasticSearch 5.x
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="3.3.3" data-path="Dissemination-Workflow.html">
            
                <a href="Dissemination-Workflow.html">
            
                    
                    How Dissemination worflows work
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="3.4" data-path="ATTX-Component-ServiceDiscovery.html">
            
                <a href="ATTX-Component-ServiceDiscovery.html">
            
                    
                    Service Discovery
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="3.4.1" data-path="Consul-ServiceDiscovery-Implementation.html">
            
                <a href="Consul-ServiceDiscovery-Implementation.html">
            
                    
                    Consul Service Discovery Implementation
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="3.4.2" data-path="Consul-for-Service-Discovery-on-Docker-Swarm.html">
            
                <a href="Consul-for-Service-Discovery-on-Docker-Swarm.html">
            
                    
                    Consul for Service Discovery on Docker Swarm
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="3.5" data-path="ATTX-Component-MessageBroker.html">
            
                <a href="ATTX-Component-MessageBroker.html">
            
                    
                    Message Broker
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="3.5.1" data-path="MessageBroker-ActiveMQ.html">
            
                <a href="MessageBroker-ActiveMQ.html">
            
                    
                    ActiveMQ Message Broker
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="3.5.2" data-path="MessageBroker-RabbitMQ.html">
            
                <a href="MessageBroker-RabbitMQ.html">
            
                    
                    RabbitMQ Message Broker
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    

        <li class="header">Broker Services</li>
        
        
        <li class="chapter " data-level="4.1" data-path="Service-Provenance.html">
            
                <a href="Service-Provenance.html">
            
                    
                    Provenance Service
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="4.1.1" data-path="Examples-Provenance-Service.html">
            
                <a href="Examples-Provenance-Service.html">
            
                    
                    Provenance Messages Examples
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="4.2" data-path="Service-RML.html">
            
                <a href="Service-RML.html">
            
                    
                    RML Service
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="4.2.1" data-path="Examples-RML-Service.html">
            
                <a href="Examples-RML-Service.html">
            
                    
                    RML Messages Examples
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="4.3" data-path="Service-Indexing.html">
            
                <a href="Service-Indexing.html">
            
                    
                    Indexing Service
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="4.3.1" data-path="Examples-Indexing-Service.html">
            
                <a href="Examples-Indexing-Service.html">
            
                    
                    Indexing Messages Examples
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="4.4" data-path="Service-Graph-Framing.html">
            
                <a href="Service-Graph-Framing.html">
            
                    
                    Graph Framing Service
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="4.4.1" data-path="Examples-Graph-Framing-Service.html">
            
                <a href="Examples-Graph-Framing-Service.html">
            
                    
                    Graph Framing Messages Examples
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="4.5" data-path="Service-Validation.html">
            
                <a href="Service-Validation.html">
            
                    
                    Validation Service
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="4.5.1" data-path="Examples-Validation-Service.html">
            
                <a href="Examples-Validation-Service.html">
            
                    
                    Validation Examples
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="4.6" data-path="Service-Ontology.html">
            
                <a href="Service-Ontology.html">
            
                    
                    Ontology Service
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="4.6.1" data-path="Examples-Ontology-Service.html">
            
                <a href="Examples-Ontology-Service.html">
            
                    
                    Ontology Examples
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    

        <li class="header">User Guide</li>
        
        
        <li class="chapter " data-level="5.1" data-path="User-Guide-Administrator.html">
            
                <a href="User-Guide-Administrator.html">
            
                    
                    Data Administrator's User guide
            
                </a>
            

        </li>
    

        <li class="header">Development Guidelines</li>
        
        
        <li class="chapter " data-level="6.1" data-path="ATTX-Development-Environment.html">
            
                <a href="ATTX-Development-Environment.html">
            
                    
                    ATTX Development Environment
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="6.2" data-path="Feature-roadmap.html">
            
                <a href="Feature-roadmap.html">
            
                    
                    Feature Roadmap
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="6.3" data-path="Release-Plan.html">
            
                <a href="Release-Plan.html">
            
                    
                    Release Plan
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="6.4" data-path="CI-CD-Enviroment.html">
            
                <a href="CI-CD-Enviroment.html">
            
                    
                    CI/CD Enviroment
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter active" data-level="6.4.1" data-path="Jenkins-CI.html">
            
                <a href="Jenkins-CI.html">
            
                    
                    Jenkins CI
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="6.4.2" data-path="Build-Environment-Setup.html">
            
                <a href="Build-Environment-Setup.html">
            
                    
                    Build Environment Setup
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="6.4.3" data-path="Containerized-testing.html">
            
                <a href="Containerized-testing.html">
            
                    
                    Containerized Testing
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    

        <li class="header">Reports & Contributions</li>
        
        
        <li class="chapter " data-level="7.1" >
            
                <span>
            
                    
                    Reports
            
                </span>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="7.1.1" data-path="CSC-cPouta-Cloud-Services-Report.html">
            
                <a href="CSC-cPouta-Cloud-Services-Report.html">
            
                    
                    CSC cPouta Cloud Services Report
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.1.2" data-path="Building-with-Gradle.html">
            
                <a href="Building-with-Gradle.html">
            
                    
                    Building with (Py)Gradle
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.1.3" data-path="Messaging-Brokers-Solutions.html">
            
                <a href="Messaging-Brokers-Solutions.html">
            
                    
                    Messaging Brokers Solutions Overview
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.1.4" data-path="Service-Discovery-Solutions.html">
            
                <a href="Service-Discovery-Solutions.html">
            
                    
                    Service Discovery Solutions Overview
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.1.5" data-path="Workflow-Management-Tools.html">
            
                <a href="Workflow-Management-Tools.html">
            
                    
                    Workflow Management Tools Overview
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.1.6" data-path="Solutions-API-Gateway.html">
            
                <a href="Solutions-API-Gateway.html">
            
                    
                    API Gateway Solutions Overview
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="7.2" >
            
                <span>
            
                    
                    Presentations
            
                </span>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="7.2.1" data-path="Presentation-ELAG-2017.html">
            
                <a href="Presentation-ELAG-2017.html">
            
                    
                    ELAG2017
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.2.2" data-path="Presentation-OSFair-2017.html">
            
                <a href="Presentation-OSFair-2017.html">
            
                    
                    OSFair2017
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.2.3" data-path="Presentation-SWIB-2017.html">
            
                <a href="Presentation-SWIB-2017.html">
            
                    
                    SWIB2017
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.2.4" data-path="Presentation-ISWC-2017.html">
            
                <a href="Presentation-ISWC-2017.html">
            
                    
                    ISWC2017
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="7.3" data-path="Open-Contributions.html">
            
                <a href="Open-Contributions.html">
            
                    
                    Open Source Contributions
            
                </a>
            

        </li>
    

        <li class="divider"></li>
        
        
        <li class="chapter " data-level="8.1" >
            
                <a target="_blank" href="https://www.helsinki.fi/en/projects/attx-2016">
            
                    
                    ATTX website
            
                </a>
            

        </li>
    

    <li class="divider"></li>

    <li>
        <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
            Published with GitBook
        </a>
    </li>
</ul>


                </nav>
            
        
    </div>

    <div class="book-body">
        
            <div class="body-inner">
                
                    
<div class="book-header" role="navigation">
    

    <!-- Title -->
    <h1>
        <i class="fa fa-circle-o-notch fa-spin"></i>
        <a href="." >Jenkins CI</a>
    </h1>
</div>


                    <div class="page-wrapper" tabindex="-1" role="main">
                        <div class="page-inner">
                            
<div id="book-search-results">
    <div class="search-noresults">
    
                                <section class="normal markdown-section">
                                
                                <div class="git-author-container git-author-top"><div class="modified">Current page last modified at: 11-Jan-2018 11:11:37</div></div><h1 id="jenkins-ci">Jenkins CI</h1>
<p>The role of Jenkins in the ATTX development infrastructure:</p>
<ul>
<li>Jenkins triggers, orchestrates, executes and monitors running of Gradle tasks using pipelines;</li>
<li>Gradle tasks are used to implement all the required actions related to pipelines (e.g. <code>:buildDockerImage</code>, running integration tests, deploying artifacts).</li>
</ul>
<p>So instead of using Jenkins plugin to call Docker and create images, we should create a Gradle task that uses Docker and call that task from a Jenkins pipeline.</p>
<p>Orchestration is handled using Jenkins pipelines that all should share some of the common stages listed below.</p>
<p><img src="images/cicd_jenkins-gradle-tools.svg" alt="Figure 1. Jenkins CI/CD Overview"></p>
<p>Figure 1. Roles of Jenkins, Gradle and tools (i.e. Docker, java etc.)</p>
<h3 id="table-of-contents">Table of Contents</h3>
<!-- TOC START min:1 max:3 link:true update:false -->
<ul>
<li><a href="#stages">Stages</a><ul>
<li><a href="#checkout">Checkout</a></li>
<li><a href="#compilepackagetest">Compile/Package/Test</a></li>
<li><a href="#deploy-artifacts">Deploy artifacts</a></li>
<li><a href="#publish-reports">Publish reports</a></li>
<li><a href="#build-image">Build image</a></li>
<li><a href="#failure">Failure</a></li>
</ul>
</li>
<li><a href="#plugins">Plugins</a></li>
<li><a href="#additions-to-the-jenkins-image">Additions to the Jenkins image</a></li>
</ul>
<!-- TOC END -->
<p>There are two types of flows:</p>
<ol>
<li><code>/feature-* branch</code> to <code>/dev</code> branch</li>
<li><code>/dev</code> branch to <code>/master</code> branch</li>
</ol>
<p>Either one can be solved with Gradle plugins or Github hooks</p>
<p>The image below describes the build and deploy workflow from a <code>/feature-name</code> branch to <code>/dev</code> branch.</p>
<p><img src="images/dev_workflow.svg" alt="Figure 2. build_workflow"></p>
<p>Figure 2. Dev releases branch build workflow</p>
<p>The image below describes the build and deploy workflow from a <code>/dev</code> branch to <code>/master</code> branch.</p>
<p><img src="images/master_workflow.svg" alt="build_workflow_master"></p>
<p>Figure 3. Master branch releases build workflow</p>
<h2 id="stages">Stages</h2>
<p>Example configuration:</p>
<pre><code class="lang-groovy">pipeline {
    agent any
    stages {
        stage(<span class="hljs-string">&apos;Checkout&apos;</span>) { <span class="hljs-comment">// for display purposes</span>
            steps {
                <span class="hljs-comment">// Get some code from a GitHub repository</span>
                git <span class="hljs-string">branch:</span> <span class="hljs-string">&apos;dev&apos;</span>, <span class="hljs-string">url:</span> <span class="hljs-string">&apos;https://github.com/ATTX-project/platform-deployment.git&apos;</span>
            }
        }
        stage(<span class="hljs-string">&apos;Compile/Package/Test&apos;</span>) {
            steps {
                echo sh (<span class="hljs-string">script:</span> <span class="hljs-string">&quot;${GRADLE_HOME}/bin/gradle --console=plain -b ${workspace}/build.gradle -PregistryURL=attx-dev:5000 -PartifactRepoURL=http://archiva:8080 -Penv=dev -PtestEnv=CI :pd-feature-tests:clean :pd-feature-tests:runContainerTests&quot;</span>, <span class="hljs-string">returnStdout:</span> <span class="hljs-literal">true</span>)
            }
            post {
                always {
                    echo <span class="hljs-string">&apos;publishing reports&apos;</span>
                    publishHTML <span class="hljs-string">target:</span> [
<span class="hljs-symbol">                        allowMissing:</span> <span class="hljs-literal">false</span>,
<span class="hljs-symbol">                        alwaysLinkToLastBuild:</span> <span class="hljs-literal">false</span>,
<span class="hljs-symbol">                        keepAll:</span> <span class="hljs-literal">false</span>,
<span class="hljs-symbol">                        reportDir:</span> <span class="hljs-string">&apos;pd-feature-tests/build/reports/tests/integTest&apos;</span>,
<span class="hljs-symbol">                        reportFiles:</span> <span class="hljs-string">&apos;index.html&apos;</span>,
<span class="hljs-symbol">                        reportName:</span> <span class="hljs-string">&apos;pd-feature-tests-reports&apos;</span>
                        ]                    
                }
                failure {
                    echo sh (<span class="hljs-string">script:</span> <span class="hljs-string">&quot;${GRADLE_HOME}/bin/gradle --console=plain -b ${workspace}/build.gradle -PregistryURL=attx-dev:5000 -PartifactRepoURL=http://archiva:8080 -Penv=dev -PtestEnv=CI :pd-feature-tests:clean :pd-feature-tests:removeImages&quot;</span>, <span class="hljs-string">returnStdout:</span> <span class="hljs-literal">true</span>)
                }
            }
        }
    }

}
</code></pre>
<p>In the following we will be breaking down the configuration steps and expected output.</p>
<h3 id="checkout">Checkout</h3>
<p>Getting the code from Github, repository.</p>
<p>Example:</p>
<p><code>git branch: &apos;dev&apos;, url: &apos;https://github.com/ATTX-project/distribution-component.git&apos;</code></p>
<h3 id="compilepackagetest">Compile/Package/Test</h3>
<p>Example:</p>
<pre><code class="lang-shell">echo sh (script: &quot;${GRADLE_HOME}/bin/gradle --console=plain -b ${workspace}/build.gradle -PregistryURL=attx-dev:5000 -PartifactRepoURL=http://archiva:8080 -Penv=dev -PtestEnv=CI :pd-feature-tests:clean :pd-feature-tests:runContainerTests&quot;, returnStdout: true)
</code></pre>
<p>We need both &quot;echo&quot; and <code>returnStdout: true</code> to get the output of the Gradle execution to Jenkins logs.</p>
<h3 id="deploy-artifacts">Deploy artifacts</h3>
<p>Copies output artifacts to somewhere where they can be used by other pipelines.</p>
<p>Example:</p>
<pre><code>archiveArtifacts artifacts: &apos;dc-elasticsearch-siren/attx-api-plugin/build/libs/*.jar&apos;, onlyIfSuccessful: true
</code></pre><h3 id="publish-reports">Publish reports</h3>
<p>Copies output of HTML reports to somewhere where Jenkins can access them. It is important for the results to be displayed even if there was a failure in the build process in order to achieve such functionality we use the syntax provided by Jenkins: <a href="https://jenkins.io/doc/book/pipeline/syntax/#post" target="_blank">https://jenkins.io/doc/book/pipeline/syntax/#post</a></p>
<p>Example: publishing test reports</p>
<pre><code class="lang-groovy">{
    publishHTML <span class="hljs-string">target:</span> [
<span class="hljs-symbol">        allowMissing:</span> <span class="hljs-literal">false</span>,
<span class="hljs-symbol">        alwaysLinkToLastBuild:</span> <span class="hljs-literal">false</span>,
<span class="hljs-symbol">        keepAll:</span> <span class="hljs-literal">false</span>,
<span class="hljs-symbol">        reportDir:</span> <span class="hljs-string">&apos;pd-feature-tests/build/reports/tests/integTest&apos;</span>,
<span class="hljs-symbol">        reportFiles:</span> <span class="hljs-string">&apos;index.html&apos;</span>,
<span class="hljs-symbol">        reportName:</span> <span class="hljs-string">&apos;pd-feature-tests-reports&apos;</span>
        ]                    
}
</code></pre>
<h3 id="build-image">Build image</h3>
<p>Artifacts are accessed from Jenkins. Normally artifacts are restricted to authenticated clients, but this can be changed by first setting property <code>hudson.security.ArtifactsPermission = true</code> (<a href="https://issues.jenkins-ci.org/browse/JENKINS-1871" target="_blank">https://issues.jenkins-ci.org/browse/JENKINS-1871</a> and <a href="https://wiki.jenkins-ci.org/display/JENKINS/Features+controlled+by+system+properties" target="_blank">https://wiki.jenkins-ci.org/display/JENKINS/Features+controlled+by+system+properties</a>) and then giving everyone access to the artifacts in the Jenkins security matrix.</p>
<p>Other option is to set &quot;Allow anonymous read access&quot; in the security settings.</p>
<h3 id="failure">Failure</h3>
<p>Some of the pipelines required a failure step, more precisely the integration test related tasks, as the tasks created and run containers. In case of failure of correctly executing the Compile/Package/Test task, the containers are not removed and the task is stopped mid execution, thus such a &quot;post execution&quot; task is required.</p>
<h2 id="plugins">Plugins</h2>
<p>Listing existing plugins can be done via <a href="https://stackoverflow.com/a/35292719" target="_blank">https://stackoverflow.com/a/35292719</a></p>
<h2 id="additions-to-the-jenkins-image">Additions to the Jenkins image</h2>
<p>Jenkins container must be linked to the pivy repository container:</p>
<pre><code class="lang-shell">docker run -d --restart=always --link pivy_repo:pivyrepo  -v /var/run/docker.sock:/var/run/docker.sock -v $(which docker):/usr/bin/docker -p 49001:8080 -v /data/jenkins:/var/jenkins_home -t attxproject/attx-jenkins
</code></pre>
<p>The following packages needs to added in order to make use of the libXML in any of the Python projects:</p>
<ul>
<li><code>apt-get install libxml2-dev libxslt1-dev python-dev</code></li>
<li><code>apt-get install build-essential</code></li>
<li><code>apt-get install zlib1g-dev</code></li>
</ul>
<p>In order to build Maven/Java projects, we need it to be installed:</p>
<ul>
<li><code>apt-get install -y maven</code></li>
</ul>
<p>In order to build Node.js projects, we need it to be installed:</p>
<ul>
<li><code>apt-get install -y nodejs</code></li>
</ul>

                                
                                </section>
                            
    </div>
    <div class="search-results">
        <div class="has-results">
            
            <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
            <ul class="search-results-list"></ul>
            
        </div>
        <div class="no-results">
            
            <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
            
        </div>
    </div>
</div>

                        </div>
                    </div>
                
            </div>

            
                <a href="CI-CD-Enviroment.html" class="navigation navigation-prev " aria-label="Previous page: CI/CD Enviroment">
                    <i class="fa fa-angle-left"></i>
                </a>
                
                
                <a href="Build-Environment-Setup.html" class="navigation navigation-next " aria-label="Next page: Build Environment Setup">
                    <i class="fa fa-angle-right"></i>
                </a>
                
            
    </div>

    <script>
        var gitbook = gitbook || [];
        gitbook.push(function() {
            gitbook.page.hasChanged({"page":{"title":"Jenkins CI","level":"6.4.1","depth":2,"next":{"title":"Build Environment Setup","level":"6.4.2","depth":2,"path":"Build-Environment-Setup.md","ref":"Build-Environment-Setup.md","articles":[]},"previous":{"title":"CI/CD Enviroment","level":"6.4","depth":1,"path":"CI-CD-Enviroment.md","ref":"CI-CD-Enviroment.md","articles":[{"title":"Jenkins CI","level":"6.4.1","depth":2,"path":"Jenkins-CI.md","ref":"Jenkins-CI.md","articles":[]},{"title":"Build Environment Setup","level":"6.4.2","depth":2,"path":"Build-Environment-Setup.md","ref":"Build-Environment-Setup.md","articles":[]},{"title":"Containerized Testing","level":"6.4.3","depth":2,"path":"Containerized-testing.md","ref":"Containerized-testing.md","articles":[]}]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":["highlight","fontsettings","search","git-author","gitversion","copy-code-button"],"pluginsConfig":{"gitversion":{},"git-author":{"position":"top","modifyTpl":"Current page last modified at: {timeStamp}","createTpl":false,"timeStampFormat":"DD-MMM-YYYY HH:mm:ss"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"family":"sans","size":2,"theme":"white"},"fontSettings":{"size":1},"highlight":{},"copy-code-button":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"Jenkins-CI.md","mtime":"2018-07-10T08:39:38.252Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-07-12T07:02:52.974Z"},"basePath":".","book":{"language":""}});
        });
    </script>
</div>

        
    <script src="gitbook/gitbook.js"></script>
    <script src="gitbook/theme.js"></script>
    
        
        <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-search/search.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-copy-code-button/toggle.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
        
    
    </body>
</html>