✨ Fixed #JENKINS-27013. add support for managing credentials

Author: Wei Li

jenkins-client-it-docker/src/test/java/com/offbytwo/jenkins/integration/NoExecutorStartedManageCredentialsIT.java

@@ -0,0 +1,57 @@
+package com.offbytwo.jenkins.integration;
+
+import com.offbytwo.jenkins.model.credentials.Credential;
+import com.offbytwo.jenkins.model.credentials.UsernamePasswordCredential;
+import org.apache.commons.lang.RandomStringUtils;
+import org.testng.annotations.Test;
+
+import java.io.IOException;
+import java.util.Map;
+
+import static org.testng.Assert.*;
+
+/**
+ * Created by weili on 31/05/2017.
+ */
+@Test(groups = { Groups.NO_EXECUTOR_GROUP} )
+public class NoExecutorStartedManageCredentialsIT extends AbstractJenkinsIntegrationCase {
+
+    @Test
+    public void credentialCRUDL() throws IOException {
+        String credentialId = "credentialIntegrationTest-" + RandomStringUtils.randomAlphanumeric(24);
+        String testUsername = "testusername";
+        String testPassword = "testpassword";
+        UsernamePasswordCredential testCredential = new UsernamePasswordCredential();
+        testCredential.setId(credentialId);
+        testCredential.setUsername(testUsername);
+        testCredential.setPassword(testPassword);
+        //create the credential
+        jenkinsServer.createCredential(testCredential, false);
+
+        //check if has been created by listing
+        Map<String, Credential> credentials = jenkinsServer.listCredentials();
+        Credential found = credentials.get(credentialId);
+        assertNotNull(found);
+        assertTrue(found instanceof UsernamePasswordCredential);
+
+        //compare fields
+        assertEquals(credentialId, found.getId());
+        assertEquals(testUsername, ((UsernamePasswordCredential)found).getUsername());
+        assertNotNull(found.getDisplayName());
+
+        //update the credential
+        String updateUsername = "updatedTestusername";
+        testCredential.setUsername(updateUsername);
+        jenkinsServer.updateCredential(credentialId, testCredential, false);
+
+        //verify it is updated
+        credentials = jenkinsServer.listCredentials();
+        found = credentials.get(credentialId);
+        assertEquals(updateUsername, ((UsernamePasswordCredential)found).getUsername());
+
+        //delete the credential
+        jenkinsServer.deleteCredential(credentialId, false);
+        credentials = jenkinsServer.listCredentials();
+        assertFalse(credentials.containsKey(credentialId));
+    }
+}

jenkins-client/src/main/java/com/offbytwo/jenkins/JenkinsServer.java

@@ -8,11 +8,20 @@
 
 import java.io.IOException;
 import java.net.URI;
+import java.rmi.server.ExportException;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 
 import javax.xml.bind.JAXBException;
 
+import com.google.common.collect.Collections2;
+import com.google.common.collect.Lists;
+import com.offbytwo.jenkins.model.*;
+import com.offbytwo.jenkins.model.credentials.Credential;
+import com.offbytwo.jenkins.model.credentials.CredentialManager;
+import org.apache.commons.collections.CollectionUtils;
+import org.apache.commons.collections.Predicate;
 import org.apache.http.HttpStatus;
 import org.apache.http.client.HttpResponseException;
 import org.apache.http.entity.ContentType;
@@ -27,21 +36,6 @@
 import com.offbytwo.jenkins.client.JenkinsHttpClient;
 import com.offbytwo.jenkins.client.util.EncodingUtils;
 import com.offbytwo.jenkins.helper.JenkinsVersion;
-import com.offbytwo.jenkins.model.Build;
-import com.offbytwo.jenkins.model.Computer;
-import com.offbytwo.jenkins.model.ComputerSet;
-import com.offbytwo.jenkins.model.FolderJob;
-import com.offbytwo.jenkins.model.Job;
-import com.offbytwo.jenkins.model.JobConfiguration;
-import com.offbytwo.jenkins.model.JobWithDetails;
-import com.offbytwo.jenkins.model.LabelWithDetails;
-import com.offbytwo.jenkins.model.MainView;
-import com.offbytwo.jenkins.model.MavenJobWithDetails;
-import com.offbytwo.jenkins.model.PluginManager;
-import com.offbytwo.jenkins.model.Queue;
-import com.offbytwo.jenkins.model.QueueItem;
-import com.offbytwo.jenkins.model.QueueReference;
-import com.offbytwo.jenkins.model.View;
 
 /**
  * The main starting point for interacting with a Jenkins server.
@@ -51,6 +45,8 @@ public class JenkinsServer {
 
     private final JenkinsHttpClient client;
 
+    private CredentialManager credentialManager;
+
     /**
      * Create a new Jenkins server reference given only the server address
      *
@@ -917,4 +913,83 @@ private String toViewBaseUrl(FolderJob folder, String name) {
         return toBaseUrl(folder) + "view/" + EncodingUtils.encode(name);
     }
 
+    /**
+     * List the credentials from the Jenkins server.
+     * @return a hash map of the credentials. The key is the id of each credential.
+     * @throws IOException
+     */
+    public Map<String, Credential> listCredentials() throws IOException {
+        return this.getCredentialManager().listCredentials();
+    }
+
+    /**
+     * Create the given credential
+     * @param credential a credential instance
+     * @param crumbFlag
+     * @throws IOException
+     */
+    public void createCredential(Credential credential, boolean crumbFlag) throws IOException {
+        this.getCredentialManager().createCredential(credential, crumbFlag);
+    }
+
+    /**
+     * Update an existing credential
+     * @param credentialId the id of the credential
+     * @param credential the updated credential instance
+     * @param crumbFlag
+     * @throws IOException
+     */
+    public void updateCredential(String credentialId, Credential credential, boolean crumbFlag) throws IOException {
+        this.getCredentialManager().updateCredential(credentialId, credential, crumbFlag);
+    }
+
+    /**
+     * Delete an existing credential
+     * @param credentialId the id of the credential to delete
+     * @param crumbFlag
+     * @throws IOException
+     */
+    public void deleteCredential(String credentialId, boolean crumbFlag) throws IOException {
+        this.getCredentialManager().deleteCredential(credentialId, crumbFlag);
+    }
+
+    /**
+     * Return the credentialManager instance. Will initialise it if it's never used before.
+     * @return the credentialManager instance
+     * @throws IOException
+     */
+    private CredentialManager getCredentialManager() throws IOException {
+        if (this.credentialManager == null) {
+            Plugin credentialPlugin = findPluginWithName("credentials");
+            if (credentialPlugin == null) {
+                throw new ExportException("credential plugin is not installed");
+            }
+            String version = credentialPlugin.getVersion();
+            this.credentialManager = new CredentialManager(version, this.client);
+        }
+        return this.credentialManager;
+    }
+
+    /**
+     * Find a plugin that matches the given short name
+     * @param pluginShortName the short name of the plugin to find
+     * @return the pluin object that is found. Can be null if no match found.
+     * @throws IOException
+     */
+    private Plugin findPluginWithName(final String pluginShortName) throws IOException {
+        List<Plugin> plugins = this.getPluginManager().getPlugins();
+        Object foundPlugin = CollectionUtils.find(plugins, new Predicate() {
+            @Override
+            public boolean evaluate(Object o) {
+                Plugin p = (Plugin) o;
+                if (p.getShortName().equalsIgnoreCase(pluginShortName)) {
+                    return true;
+                } else {
+                    return false;
+                }
+            }
+        });
+
+        return foundPlugin == null ? null : (Plugin) foundPlugin;
+    }
 }

jenkins-client/src/main/java/com/offbytwo/jenkins/client/JenkinsHttpClient.java

@@ -312,6 +312,59 @@ public void post_form(String path, Map<String, String> data, boolean crumbFlag)
         }
     }
 
+    /**
+     * Perform a POST request using form url encoding.
+     *
+     * This method was added for the purposes of creating credentials, but may be
+     * useful for other API calls as well.
+     *
+     * Unlike post and post_xml, the path is *not* modified by adding
+     * "/api/json". Additionally, the params in data are provided as both
+     * request parameters including a json parameter, *and* in the
+     * JSON-formatted StringEntity, because this is what the folder creation
+     * call required. It is unclear if any other jenkins APIs operate in this
+     * fashion.
+     *
+     * @param path path to request, can be relative or absolute
+     * @param data data to post
+     * @param crumbFlag true / false.
+     * @throws IOException in case of an error.
+     */
+    public void post_form_json(String path, Map<String, Object> data, boolean crumbFlag) throws IOException {
+        HttpPost request;
+        if (data != null) {
+            // https://gist.github.com/stuart-warren/7786892 was slightly
+            // helpful here
+            List<String> queryParams = Lists.newArrayList();
+
+            queryParams.add("json=" + EncodingUtils.encodeParam(JSONObject.fromObject(data).toString()));
+            String value = mapper.writeValueAsString(data);
+            StringEntity stringEntity = new StringEntity(value, ContentType.APPLICATION_FORM_URLENCODED);
+            request = new HttpPost(noapi(path) + StringUtils.join(queryParams, "&"));
+            request.setEntity(stringEntity);
+        } else {
+            request = new HttpPost(noapi(path));
+        }
+
+        if (crumbFlag == true) {
+            Crumb crumb = get("/crumbIssuer", Crumb.class);
+            if (crumb != null) {
+                request.addHeader(new BasicHeader(crumb.getCrumbRequestField(), crumb.getCrumb()));
+            }
+        }
+
+        HttpResponse response = client.execute(request, localContext);
+        getJenkinsVersionFromHeader(response);
+
+        try {
+            httpResponseValidator.validateResponse(response);
+        } finally {
+            EntityUtils.consume(response.getEntity());
+            releaseConnection(request);
+        }
+    }
+
+
     /**
      * Perform a POST request of XML (instead of using json mapper) and return a
      * string rendering of the response entity.

jenkins-client/src/main/java/com/offbytwo/jenkins/model/credentials/Credential.java

@@ -0,0 +1,102 @@
+package com.offbytwo.jenkins.model.credentials;
+
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.offbytwo.jenkins.model.BaseModel;
+
+import java.util.Map;
+
+@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "typeName")
+@JsonSubTypes({@JsonSubTypes.Type(value = UsernamePasswordCredential.class, name = "Username with password")})
+/**
+ * Base class for credentials. Should not be instantiated directly.
+ */
+public abstract class Credential extends BaseModel {
+
+    protected static final String SCOPE_GLOBAL = "GLOBAL";
+    private static final String BASE_URL = "/credentials/store/system/domain/_/";
+
+    private String id = "";
+    private String scope = SCOPE_GLOBAL;
+    private String description = "";
+    private String fullName = "";
+    private String displayName = "";
+
+    private String typeName = "";
+
+    protected String $class;
+
+    public String getScope() {
+        return scope;
+    }
+
+    /**
+     * Set the scope of the credential. It is "GLOBAL" by default. Should not be changed.
+     * @param scope
+     */
+    public void setScope(String scope) {
+        this.scope = scope;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public void setDescription(String description) {
+        this.description = description;
+    }
+
+    public String getId() {
+        return this.id;
+    }
+
+    /**
+     * Set the id of the credential. When creating a new credential, if this is not provided, a random id will be generated by Jenkins.
+     * Required for update and delete operations
+     * @param id the id of the credential.
+     */
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    public String getFullName() {
+        return fullName;
+    }
+
+    /**
+     * Should not be used. The value is set by Jenkins.
+     * @param fullName
+     */
+    public void setFullName(String fullName) {
+        this.fullName = fullName;
+    }
+
+    public String getTypeName() {
+        return typeName;
+    }
+
+    /**
+     * Should not be used. The value is set by Jenkins.
+     * @param typeName
+     */
+    public void setTypeName(String typeName) {
+        this.typeName = typeName;
+    }
+
+    public String getDisplayName() {
+        return this.displayName;
+    }
+
+    /**
+     * Should not be used. The value is set by Jenkins
+     * @param displayName
+     */
+    public void setDisplayName(String displayName) {
+        this.displayName = displayName;
+    }
+
+    public abstract Map<String, Object> dataForCreate();
+
+    public abstract Map<String, String> dataForUpdate();
+}