Setup Jenkin Runner for Gatling-imap and Documentation

Author: quantranhong1999

README.adoc

@@ -135,3 +135,27 @@ $ JAVA_OPTS="-DnumberOfMailInInbox=15 -DpercentageOfMailToExpunge=30 -DmaxDurati
 ----
 
 In the case of expunge scenario the maxDuration parameter is in minutes
+
+=== Building with a local jenkins runner
+
+You can use a custom local jenkins runner with the `Jenkinsfile` at the root of this project to build the project.
+This will automatically do for you:
+
+* checkout and compile the latest code of Gatling-imap project
+* launch Gatling integration tests
+
+To launch it you need to have docker installed. From the root of this project, you can build the Jenkins runner locally yourself:
+
+----
+docker build -t local-jenkins-runner dockerfiles/jenkins-runner
+----
+
+And then you need to launch it with the Jenkinsfile:
+
+----
+docker run --rm -v /var/run/docker.sock:/var/run/docker.sock -v ${PWD}/dockerfiles/jenkins-runner/Jenkinsfile:/workspace/Jenkinsfile
+--network=host local-jenkins-runner
+----
+
+If you don't want the build to redownload everytime all the sbt dependencies (it can be heavy) you can mount
+your local sbt repository as a volume by adding `-v $HOME/.ivy2/cache:/root/.ivy2/cache` to the above command.

dockerfiles/jenkins-runner/Dockerfile

@@ -0,0 +1,17 @@
+FROM jenkins/jenkinsfile-runner:adoptopenjdk-11-hotspot
+
+# Install git, docker, sdkman
+RUN apt-get update && \
+  apt-get install -y wget git unzip zip apt-transport-https ca-certificates curl gnupg2 software-properties-common && \
+  curl -fsSL https://download.docker.com/linux/$(. /etc/os-release; echo "$ID")/gpg > /tmp/dkey; apt-key add /tmp/dkey && \
+  add-apt-repository \
+    "deb [arch=amd64] https://download.docker.com/linux/$(. /etc/os-release; echo "$ID") \
+    $(lsb_release -cs) \
+    stable" && \
+  apt-get update && \
+  apt-get -y install docker-ce &&  \
+  rm -rf /var/lib/apt/lists/* &&  \
+  rm /bin/sh && ln -s /bin/bash /bin/sh && curl -s "https://get.sdkman.io" | bash
+
+# Install sbt
+RUN source "$HOME/.sdkman/bin/sdkman-init.sh" && sdk install sbt

dockerfiles/jenkins-runner/Jenkinsfile

@@ -0,0 +1,20 @@
+pipeline {
+    agent any
+    stages {
+        stage('Git checkout') {
+            steps {
+                git 'https://github.com/linagora/gatling-imap'
+            }
+        }
+        stage('Compile') {
+            steps {
+                sh '$HOME/.sdkman/candidates/sbt/current/bin/sbt clean compile'
+            }
+        }
+        stage('Test') {
+            steps {
+                sh '$HOME/.sdkman/candidates/sbt/current/bin/sbt GatlingIt/test'
+            }
+        }
+    }
+}