Support withCredentials on GitLabApiToken(Impl) (#1754)

* support withCredentials -- initial implementation and tests

* support withCredentials -- move tests + final touches

* support withCredentials -- de-hardcore display name string

* support withCredentials -- use interface instead of implementation class

* support withCredentials -- groovy file from tabs to spaces

* revert test port back to 80

Co-authored-by: Kris Stern <[email protected]>

---------

Co-authored-by: Kris Stern <[email protected]>

Author: tiago-teixeira5

src/main/java/com/dabsquared/gitlabjenkins/connection/GitLabApiTokenBinding.java

@@ -0,0 +1,74 @@
+package com.dabsquared.gitlabjenkins.connection;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+import edu.umd.cs.findbugs.annotations.Nullable;
+import hudson.Extension;
+import hudson.FilePath;
+import hudson.Launcher;
+import hudson.model.Run;
+import hudson.model.TaskListener;
+import hudson.util.Secret;
+import java.io.IOException;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.Set;
+import org.jenkinsci.Symbol;
+import org.jenkinsci.plugins.credentialsbinding.BindingDescriptor;
+import org.jenkinsci.plugins.credentialsbinding.MultiBinding;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+public class GitLabApiTokenBinding extends MultiBinding<GitLabApiToken> {
+
+    private final String variable;
+
+    @DataBoundConstructor
+    public GitLabApiTokenBinding(String credentialsId, String variable) {
+        super(credentialsId);
+        this.variable = variable;
+    }
+
+    @Override
+    protected Class<GitLabApiToken> type() {
+        return GitLabApiToken.class;
+    }
+
+    @Override
+    public Set<String> variables() {
+        return Collections.singleton(variable);
+    }
+
+    @Override
+    public MultiEnvironment bind(
+            @NonNull Run<?, ?> build,
+            @Nullable FilePath workspace,
+            @Nullable Launcher launcher,
+            @NonNull TaskListener listener)
+            throws IOException, InterruptedException {
+        GitLabApiToken credentials = getCredentials(build);
+        Map<String, String> values = new LinkedHashMap<>();
+        values.put(variable, Secret.toString(credentials.getApiToken()));
+        return new MultiEnvironment(values);
+    }
+
+    @Symbol("gitlabApiToken")
+    @Extension
+    public static class DescriptorImpl extends BindingDescriptor<GitLabApiTokenImpl> {
+
+        @Override
+        protected Class<GitLabApiTokenImpl> type() {
+            return GitLabApiTokenImpl.class;
+        }
+
+        @NonNull
+        @Override
+        public String getDisplayName() {
+            return Messages.GitLabApiToken_name();
+        }
+
+        @Override
+        public boolean requiresWorkspace() {
+            return false;
+        }
+    }
+}

src/test/java/com/dabsquared/gitlabjenkins/connection/GitLabApiTokenBindingTest.java

@@ -0,0 +1,55 @@
+package com.dabsquared.gitlabjenkins.connection;
+
+import com.cloudbees.plugins.credentials.CredentialsProvider;
+import com.cloudbees.plugins.credentials.CredentialsScope;
+import com.cloudbees.plugins.credentials.CredentialsStore;
+import com.cloudbees.plugins.credentials.SystemCredentialsProvider;
+import com.cloudbees.plugins.credentials.domains.Domain;
+import hudson.model.Run;
+import hudson.util.Secret;
+import java.io.IOException;
+import java.util.List;
+import org.apache.commons.io.IOUtils;
+import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
+import org.jenkinsci.plugins.workflow.job.WorkflowJob;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+
+public class GitLabApiTokenBindingTest {
+
+    private static final String API_TOKEN = "secret";
+    private static final String API_TOKEN_ID = "apiTokenId";
+
+    @Rule
+    public JenkinsRule jenkins = new JenkinsRule();
+
+    @Before
+    public void setup() throws IOException {
+        for (CredentialsStore credentialsStore : CredentialsProvider.lookupStores(jenkins.jenkins)) {
+            if (credentialsStore instanceof SystemCredentialsProvider.StoreImpl) {
+                List<Domain> domains = credentialsStore.getDomains();
+                credentialsStore.addCredentials(
+                        domains.get(0),
+                        new GitLabApiTokenImpl(
+                                CredentialsScope.GLOBAL,
+                                API_TOKEN_ID,
+                                "GitLab API Token",
+                                Secret.fromString(API_TOKEN)));
+            }
+        }
+    }
+
+    @Test
+    public void withCredentials_success() throws Exception {
+        WorkflowJob project = jenkins.createProject(WorkflowJob.class);
+        String pipelineText =
+                IOUtils.toString(getClass().getResourceAsStream("pipeline/withCredentials-pipeline.groovy"));
+        project.setDefinition(new CpsFlowDefinition(pipelineText, false));
+        Run<?, ?> build = jenkins.buildAndAssertSuccess(project);
+        // assert false to know we run it in tests
+        jenkins.assertLogContains("Token1 is ecret", build);
+        jenkins.assertLogContains("Token2 is ecret", build);
+    }
+}

src/test/resources/com/dabsquared/gitlabjenkins/connection/pipeline/withCredentials-pipeline.groovy

@@ -0,0 +1,18 @@
+package com.dabsquared.gitlabjenkins.connection.pipeline
+
+node {
+    withCredentials([[
+        $class: 'com.dabsquared.gitlabjenkins.connection.GitLabApiTokenBinding',
+        credentialsId: "apiTokenId",
+        variable: "API_TOKEN1"
+    ]]) {
+        println "Token1 is ${API_TOKEN1.substring(1)}"
+    }
+
+    withCredentials([gitlabApiToken(
+        credentialsId: "apiTokenId",
+        variable: "API_TOKEN2"
+    )]) {
+        println "Token2 is ${API_TOKEN2.substring(1)}"
+    }
+}