Configuration as Code support

Unit tests and Symbols

Author: rsandell

src/main/java/org/jenkinsci/plugins/docker/commons/credentials/DockerServerCredentials.java

@@ -28,6 +28,7 @@
 import hudson.Extension;
 import hudson.Util;
 import hudson.util.Secret;
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 import javax.annotation.CheckForNull;
@@ -111,7 +112,7 @@ public String getServerCaCertificate() {
         return serverCaCertificate;
     }
 
-    @Extension
+    @Extension @Symbol({"x509ClientCert", "dockerServer"})
     public static class DescriptorImpl extends BaseStandardCredentialsDescriptor {
         @Override
         public String getDisplayName() {

src/main/java/org/jenkinsci/plugins/docker/commons/tools/DockerTool.java

@@ -43,6 +43,7 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import jenkins.model.Jenkins;
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 /**
@@ -114,7 +115,8 @@ public DockerTool forNode(Node node, TaskListener log) throws IOException, Inter
         }
     }
 
-    @Extension public static class DescriptorImpl extends ToolDescriptor<DockerTool> {
+    @Extension @Symbol("dockerTool")
+    public static class DescriptorImpl extends ToolDescriptor<DockerTool> {
 
         @Override public String getDisplayName() {
             return "Docker";

src/main/java/org/jenkinsci/plugins/docker/commons/tools/DockerToolInstaller.java

@@ -44,6 +44,7 @@
 import java.util.regex.Pattern;
 import javax.annotation.Nonnull;
 import jenkins.security.MasterToSlaveCallable;
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 /**
@@ -165,7 +166,7 @@ private static VersionNumber parseVersion(String version) {
         throw new IllegalArgumentException("Failed to parse version " + version);
     }
 
-    @Extension
+    @Extension @Symbol("fromDocker")
     public static class DescriptorImpl extends ToolInstallerDescriptor<DockerToolInstaller> {
 
         @Override

src/test/java/org/jenkinsci/plugins/docker/commons/CasCTest.java

@@ -0,0 +1,103 @@
+package org.jenkinsci.plugins.docker.commons;
+
+import com.cloudbees.plugins.credentials.CredentialsMatchers;
+import com.cloudbees.plugins.credentials.CredentialsProvider;
+import com.cloudbees.plugins.credentials.common.IdCredentials;
+import hudson.security.ACL;
+import hudson.tools.InstallSourceProperty;
+import hudson.tools.ToolProperty;
+import hudson.tools.ToolPropertyDescriptor;
+import hudson.util.DescribableList;
+import hudson.util.Secret;
+import io.jenkins.plugins.casc.misc.RoundTripAbstractTest;
+import org.jenkinsci.plugins.docker.commons.credentials.DockerServerCredentials;
+import org.jenkinsci.plugins.docker.commons.credentials.DockerServerDomainRequirement;
+import org.jenkinsci.plugins.docker.commons.tools.DockerTool;
+import org.jenkinsci.plugins.docker.commons.tools.DockerToolInstaller;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+import org.jvnet.hudson.test.RestartableJenkinsRule;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.beans.HasPropertyWithValue.hasProperty;
+import static org.hamcrest.collection.ArrayMatching.arrayContaining;
+import static org.hamcrest.collection.IsArrayWithSize.arrayWithSize;
+import static org.hamcrest.collection.IsIterableContainingInOrder.contains;
+import static org.hamcrest.core.AllOf.allOf;
+import static org.hamcrest.core.IsEqual.equalTo;
+import static org.hamcrest.core.IsInstanceOf.instanceOf;
+import static org.hamcrest.core.IsNull.nullValue;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+@RunWith(Parameterized.class)
+public class CasCTest extends RoundTripAbstractTest {
+
+    final String resource;
+
+    public CasCTest(final String resource) {
+        this.resource = resource;
+    }
+
+    @Parameterized.Parameters(name = "{0}")
+    public static Object[][] params() {
+        return new Object[][]{{"casc_bare.yaml"}, {"casc_symbols.yaml"}};
+    }
+
+    @Override
+    protected void assertConfiguredAsExpected(final RestartableJenkinsRule j, final String s) {
+
+        //The credentials
+        final IdCredentials cred = CredentialsMatchers.firstOrNull(CredentialsProvider.lookupCredentials(IdCredentials.class, j.j.jenkins,
+                ACL.SYSTEM, new DockerServerDomainRequirement()), CredentialsMatchers.withId("dockerx509"));
+        assertNotNull(cred);
+        assertThat(cred, instanceOf(DockerServerCredentials.class));
+        DockerServerCredentials dCreds = (DockerServerCredentials) cred;
+        assertEquals("THE CLIENT", dCreds.getClientCertificate());
+        assertEquals("THE SERVER", dCreds.getServerCaCertificate());
+        assertEquals("Be wewy wewy cuwiet", Secret.toString(dCreds.getClientKeySecret()));
+        assertEquals("Docker X.509", dCreds.getDescription());
+
+
+        //The ToolInstaller
+        final DockerTool[] installations = j.j.jenkins.getDescriptorByType(DockerTool.DescriptorImpl.class).getInstallations();
+        assertNotNull(installations);
+        assertThat(installations, arrayWithSize(2));
+        assertThat(installations, arrayContaining(
+                allOf(
+                        hasProperty("name", equalTo("docker-latest")),
+                        hasProperty("home", nullValue())
+                ),
+                allOf(
+                        hasProperty("name", equalTo("docker-native")),
+                        hasProperty("home", equalTo("/etc/docket/docker"))
+                )
+        ));
+        final DescribableList<ToolProperty<?>, ToolPropertyDescriptor> properties = installations[0].getProperties();
+        assertThat(properties, contains(instanceOf(InstallSourceProperty.class)));
+        final InstallSourceProperty property = (InstallSourceProperty) properties.get(0);
+        assertThat(property.installers, contains(
+                allOf(
+                        instanceOf(DockerToolInstaller.class),
+                        hasProperty("version", equalTo("latest"))
+                )
+        ));
+
+        /*
+        * DockerRegistryEndpoint is not directly used in this plugin in any global config sense,
+        * So it is better tested in the plugins that uses it for example docker workflow plugin:
+        * https://github.com/jenkinsci/docker-workflow-plugin/blob/2ba1ac97b75a3f188e243333b31ef06d55b9221a/src/main/java/org/jenkinsci/plugins/docker/workflow/declarative/GlobalConfig.java
+        */
+
+    }
+
+    @Override
+    protected String configResource() {
+        return resource;
+    }
+
+    @Override
+    protected String stringInLogExpected() {
+        return DockerServerCredentials.class.getName();
+    }
+}

src/test/resources/org/jenkinsci/plugins/docker/commons/casc_bare.yaml

@@ -0,0 +1,22 @@
+credentials:
+  system:
+    domainCredentials:
+      - credentials:
+          - dockerServer:
+              clientCertificate: "THE CLIENT"
+              clientKeySecret: "Be wewy wewy cuwiet"
+              description: "Docker X.509"
+              id: "dockerx509"
+              scope: GLOBAL
+              serverCaCertificate: "THE SERVER"
+tool:
+  dockerTool:
+    installations:
+      - name: "docker-latest"
+        properties:
+          - installSource:
+              installers:
+                - docker:
+                    version: "latest"
+      - home: "/etc/docket/docker"
+        name: "docker-native"

src/test/resources/org/jenkinsci/plugins/docker/commons/casc_symbols.yaml

@@ -0,0 +1,22 @@
+credentials:
+  system:
+    domainCredentials:
+      - credentials:
+          - x509ClientCert:
+              clientCertificate: "THE CLIENT"
+              clientKeySecret: "Be wewy wewy cuwiet"
+              description: "Docker X.509"
+              id: "dockerx509"
+              scope: GLOBAL
+              serverCaCertificate: "THE SERVER"
+tool:
+  dockerTool:
+    installations:
+      - name: "docker-latest"
+        properties:
+          - installSource:
+              installers:
+                - fromDocker:
+                    version: "latest"
+      - home: "/etc/docket/docker"
+        name: "docker-native"