Merge pull request #215 from jglick/SCMSource.id

Predictable `Snippetizer` output for `LibraryStep`

Author: jglick

pom.xml

@@ -79,6 +79,12 @@
                 <scope>import</scope>
                 <type>pom</type>
             </dependency>
+            <!-- TODO until in BOM -->
+            <dependency>
+                <groupId>org.jenkins-ci.plugins</groupId>
+                <artifactId>structs</artifactId>
+                <version>362.va_b_695ef4fdf9</version>
+            </dependency>
         </dependencies>
     </dependencyManagement>
     <dependencies>

src/main/java/org/jenkinsci/plugins/workflow/libs/SCMSourceRetriever.java

@@ -39,7 +39,7 @@
 import java.io.StringWriter;
 import java.util.ArrayList;
 import java.util.Collection;
-import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import jenkins.scm.api.SCMRevision;
@@ -121,13 +121,13 @@ public Collection<SCMSourceDescriptor> getSCMDescriptors() {
             return descriptors;
         }
 
+        // TODO can be deleted after https://github.com/jenkinsci/scm-api-plugin/pull/357
         @Override public UninstantiatedDescribable customUninstantiate(UninstantiatedDescribable ud) {
             Object scm = ud.getArguments().get("scm");
-            if (scm instanceof UninstantiatedDescribable) {
-                UninstantiatedDescribable scmUd = (UninstantiatedDescribable) scm;
-                Map<String, Object> scmArguments = new HashMap<>(scmUd.getArguments());
+            if (scm instanceof UninstantiatedDescribable scmUd) {
+                Map<String, Object> scmArguments = new LinkedHashMap<>(scmUd.getArguments());
                 scmArguments.remove("id");
-                Map<String, Object> retrieverArguments = new HashMap<>(ud.getArguments());
+                Map<String, Object> retrieverArguments = new LinkedHashMap<>(ud.getArguments());
                 retrieverArguments.put("scm", scmUd.withArguments(scmArguments));
                 return ud.withArguments(retrieverArguments);
             }

src/test/java/org/jenkinsci/plugins/workflow/libs/LibraryStepTest.java

@@ -78,8 +78,8 @@ public class LibraryStepTest {
         s.setRetriever(new SCMSourceRetriever(scmSource));
         s.setChangelog(true);
         r.assertEqualDataBoundBeans(s, stepTester.configRoundTrip(s));
-        // TODO uninstantiate works but SnippetizerTester.assertRoundTrip fails due to differing SCMSource.id values
-        assertEquals("library identifier: 'foo@master', retriever: modernSCM(gitSource(traits: [gitBranchDiscovery()], credentialsId: '', remote: 'https://nowhere.net/'))", Snippetizer.object2Groovy(s));
+        // TODO uninstantiate works but SnippetizerTester.assertRoundTrip fails due to differing SCMSource.id values pending https://github.com/jenkinsci/scm-api-plugin/pull/357
+        assertEquals("library identifier: 'foo@master', retriever: modernSCM(gitSource(credentialsId: '', remote: 'https://nowhere.net/', traits: [gitBranchDiscovery()]))", Snippetizer.object2Groovy(s));
         s.setRetriever(new SCMRetriever(new GitSCM(Collections.singletonList(new UserRemoteConfig("https://nowhere.net/", null, null, null)),
             Collections.singletonList(new BranchSpec("${library.foo.version}")),
             null, null, Collections.<GitSCMExtension>emptyList())));