Created jenkins manager. (#219)

* Add JenkinsManager to setup jenkins job for test

Author: Anders Breid

src/integrationtests/java/util/JenkinsManager.java

@@ -0,0 +1,213 @@
+package util;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.UnsupportedEncodingException;
+import java.net.URISyntaxException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+
+import javax.xml.bind.DatatypeConverter;
+
+import org.apache.http.client.ClientProtocolException;
+import org.json.JSONObject;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+
+import com.ericsson.ei.utils.HttpRequest;
+import com.ericsson.ei.utils.HttpRequest.HttpMethod;
+
+public class JenkinsManager {
+
+    private static final String JENKINS_JOB_TEMPLATE_FILE_PATH = String.join(File.separator, "src", "integrationtests",
+            "resources", "jenkinsJobTemplate.xml");
+    private static final String DEFAULT_JOB_TOKEN = "test";
+    private static final String DEFAULT_SCRIPT = "echo "Test"";
+    private static final String DEFAULT_JOB_NAME = "test_job";
+
+    private String host;
+    private int port;
+    private String encoding;
+    private String crumb;
+
+    /**
+     * Constructor, takes jenkins host, port, username and password.
+     * @param host
+     * @param port
+     * @param username
+     * @param password   **  Jenkins password or API-token
+     * @throws UnsupportedEncodingException
+     * @throws URISyntaxException
+     */
+    public JenkinsManager(String host, int port, String username, String password)
+            throws UnsupportedEncodingException, URISyntaxException {
+        String authString = String.join(":", username, password);
+
+        this.host = host;
+        this.port = port;
+        this.encoding = DatatypeConverter.printBase64Binary(authString.getBytes("utf-8"));
+        this.crumb = getCrumb();
+    }
+
+    /**
+     * Takes a token and script and returns XML data for jenkins with job_token and
+     * script added.
+     *
+     * @param job_token
+     * @param script
+     * @return
+     * @throws IOException
+     */
+    public String getXmlJobData(String job_token, String script) throws IOException {
+        String jobData = getStringFromFile(JENKINS_JOB_TEMPLATE_FILE_PATH);
+
+        if (job_token == null) {
+            job_token = DEFAULT_JOB_TOKEN;
+        }
+        if (script == null) {
+            script = DEFAULT_SCRIPT;
+        }
+
+        jobData = injectScriptAndTokenIntoXmlString(jobData, job_token, script);
+        return jobData;
+    }
+
+    /**
+     * Creates a jenkins job with a given name using the XML data as input for
+     * job configuration
+     *
+     * @param jobName
+     * @param jobXmlData
+     * @return
+     * @throws URISyntaxException
+     * @throws ClientProtocolException
+     * @throws IOException
+     */
+    public boolean createJob(String jobName, String jobXmlData) throws URISyntaxException {
+        HttpRequest httpRequest = new HttpRequest(HttpMethod.POST);
+        boolean success = false;
+
+        if (jobName == null) {
+            jobName = DEFAULT_JOB_NAME;
+        }
+
+        httpRequest.setHost(host).setPort(port).addHeader("Authorization", "Basic " + encoding)
+                .addHeader("Content-type", MediaType.APPLICATION_XML_VALUE).addHeader("Jenkins-Crumb", crumb)
+                .addParam("name", jobName).setBody(jobXmlData).setEndpoint("/createItem");
+
+        ResponseEntity<String> response = httpRequest.performRequest();
+        success = response.getStatusCode() == HttpStatus.OK;
+
+        return success;
+    }
+
+    /**
+     * This function recieves a jenkins job name and are used to trigger the job
+     *
+     * @throws URISyntaxException
+     */
+    public boolean triggerJob(String jobName, String job_token) throws URISyntaxException {
+        HttpRequest httpRequest = new HttpRequest(HttpMethod.GET);
+        boolean success = false;
+
+        if (jobName == null) {
+            jobName = DEFAULT_JOB_NAME;
+        }
+        if (job_token == null) {
+            job_token = DEFAULT_JOB_TOKEN;
+        }
+
+        String endpoint = "/job/" + jobName + "/build";
+
+        httpRequest.setHost(host).setPort(port).addHeader("Authorization", "Basic " + encoding)
+                .addHeader("Content-type", MediaType.APPLICATION_JSON_VALUE).addParam("token", job_token)
+                .setEndpoint(endpoint);
+
+        ResponseEntity<String> response = httpRequest.performRequest();
+        success = response.getStatusCode() == HttpStatus.CREATED;
+        return success;
+    }
+
+    /**
+     * This function recieves a jenkins job name and returns whether the job has
+     * been triggered at least once
+     *
+     * @param jobName
+     * @return
+     * @throws URISyntaxException
+     */
+    public boolean jobHasBeenTriggered(String jobName) throws URISyntaxException {
+        boolean isTriggered = false;
+        HttpRequest httpRequest = new HttpRequest(HttpMethod.GET);
+        if (jobName == null) {
+            jobName = DEFAULT_JOB_NAME;
+        }
+
+        String endpoint = "/job/" + jobName + "/1/api/json";
+
+        httpRequest.setHost(host).setPort(port).addHeader("Authorization", "Basic " + encoding)
+                .addHeader("Content-type", MediaType.APPLICATION_JSON_VALUE)
+                .setEndpoint(endpoint);
+
+        ResponseEntity<String> response = httpRequest.performRequest();
+        isTriggered = response.getStatusCode() == HttpStatus.OK;
+        return isTriggered;
+    }
+
+    /**
+     *
+     * This function recieves a jenkins job name and deletes that job from the
+     * jenkins system
+     *
+     * @param jobName
+     * @return
+     * @throws URISyntaxException
+     */
+    public boolean deleteJob(String jobName) throws URISyntaxException {
+        boolean isDeleted = false;
+        HttpRequest httpRequest = new HttpRequest(HttpMethod.POST);
+        if (jobName == null) {
+            jobName = DEFAULT_JOB_NAME;
+        }
+
+        String endpoint = "/job/" + jobName + "/doDelete";
+
+        httpRequest.setHost(host).setPort(port).addHeader("Authorization", "Basic " + encoding)
+                .addHeader("Content-type", MediaType.APPLICATION_JSON_VALUE).addHeader("Jenkins-Crumb", crumb)
+                .setEndpoint(endpoint);
+
+        ResponseEntity<String> response = httpRequest.performRequest();
+        isDeleted = response.getStatusCode() == HttpStatus.FOUND;
+        return isDeleted;
+    }
+
+    private String getCrumb() throws URISyntaxException {
+        String crumb = "";
+        HttpRequest httpRequest = new HttpRequest(HttpMethod.GET);
+
+        httpRequest.setHost(host).setPort(port).addHeader("Authorization", "Basic " + encoding)
+                .addHeader("Content-type", MediaType.APPLICATION_JSON_VALUE).setEndpoint("/crumbIssuer/api/json");
+
+        ResponseEntity<String> response = httpRequest.performRequest();
+        boolean success = response.getStatusCode() == HttpStatus.OK;
+
+        if (success) {
+            JSONObject jsonObj = new JSONObject(response.getBody());
+            crumb = jsonObj.getString("crumb");
+        }
+        return crumb;
+    }
+
+    private static String getStringFromFile(String filepath) throws IOException {
+        return new String(Files.readAllBytes(Paths.get(filepath)), StandardCharsets.UTF_8);
+    }
+
+    private String injectScriptAndTokenIntoXmlString(String xmlString, String token, String script) {
+        xmlString = xmlString.replaceAll("\\$\\{shell\\.script\\}", script);
+        xmlString = xmlString.replaceAll("\\$\\{auth\\.token\\}", token);
+        return xmlString;
+    }
+
+}

src/integrationtests/resources/jenkinsJobTemplate.xml

@@ -0,0 +1,21 @@
+<?xml version='1.1' encoding='UTF-8'?>
+<project>
+  <description></description>
+  <keepDependencies>false</keepDependencies>
+  <properties/>
+  <scm class="hudson.scm.NullSCM"/>
+  <canRoam>true</canRoam>
+  <disabled>false</disabled>
+  <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
+  <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+  <authToken>${auth.token}</authToken>
+  <triggers/>
+  <concurrentBuild>false</concurrentBuild>
+  <builders>
+    <hudson.tasks.Shell>
+      <command>${shell.script}</command>
+    </hudson.tasks.Shell>
+  </builders>
+  <publishers/>
+  <buildWrappers/>
+</project>