[FIXED JENKINS-43337] Get FQN for ambiguous parameter classes

jenkinsci · Apr 4, 2017 · fcf14af · fcf14af
1 parent 28b1a0c
commit fcf14af
Show file tree

Hide file tree

Showing 6 changed files with 229 additions and 1 deletion.
diff --git a/plugin/src/main/java/org/jenkinsci/plugins/structs/describable/DescribableParameter.java b/plugin/src/main/java/org/jenkinsci/plugins/structs/describable/DescribableParameter.java
@@ -192,7 +192,17 @@ private Object uncoerce(Object o, Type type) {
                 // Check to see if this can be treated as a data-bound struct.
                 UninstantiatedDescribable nested = DescribableModel.uninstantiate2_(o);
                 if (type != o.getClass()) {
-                    nested.setKlass(o.getClass().getSimpleName());
+                    int simpleNameCount = 0;
+                    for (Class<?> c : findSubtypes(getErasedType())) {
+                        if (c.getSimpleName().equals(o.getClass().getSimpleName())) {
+                            simpleNameCount++;
+                        }
+                    }
+                    if (simpleNameCount > 1) {
+                        nested.setKlass(o.getClass().getName());
+                    } else {
+                        nested.setKlass(o.getClass().getSimpleName());
+                    }
                 }
                 nested.setSymbol(symbolOf(o));
                 return nested;

diff --git a/plugin/src/test/java/org/jenkinsci/plugins/structs/describable/AmbiguousContainer.java b/plugin/src/test/java/org/jenkinsci/plugins/structs/describable/AmbiguousContainer.java
@@ -0,0 +1,50 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2017, CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package org.jenkinsci.plugins.structs.describable;
+
+import hudson.Extension;
+import hudson.model.AbstractDescribableImpl;
+import hudson.model.Describable;
+import hudson.model.Descriptor;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+public class AmbiguousContainer extends AbstractDescribableImpl<AmbiguousContainer> {
+    public final Describable<?> ambiguous;
+    public final Describable<?> unambiguous;
+
+    @DataBoundConstructor
+    public AmbiguousContainer(Describable<?> ambiguous, Describable<?> unambiguous) {
+        this.ambiguous = ambiguous;
+        this.unambiguous = unambiguous;
+    }
+
+    @Extension
+    public static class DescriptorImpl extends Descriptor<AmbiguousContainer> {
+        @Override
+        public String getDisplayName() {
+            return "ambiguous container";
+        }
+    }
+}
diff --git a/plugin/src/test/java/org/jenkinsci/plugins/structs/describable/DescribableModelTest.java b/plugin/src/test/java/org/jenkinsci/plugins/structs/describable/DescribableModelTest.java
@@ -725,6 +725,29 @@ public ToBeRemoved() {
         }
     }
 
+    @Issue("JENKINS-43337")
+    @Test
+    public void ambiguousSimpleName() throws Exception {
+        AmbiguousContainer container = new AmbiguousContainer(new FirstAmbiguous.CommonName("first"),
+                new UnambiguousClassName("second"));
+
+        UninstantiatedDescribable ud = DescribableModel.uninstantiate2_(container);
+
+        Object o = ud.toMap().get("ambiguous");
+        assertTrue(o instanceof Map);
+        Map<String,Object> m = (Map<String,Object>)o;
+
+        // Make sure the ambiguous class is fully qualified.
+        assertEquals(FirstAmbiguous.CommonName.class.getName(), m.get("$class"));
+
+        Object o2 = ud.toMap().get("unambiguous");
+        assertTrue(o2 instanceof Map);
+        Map<String,Object> m2 = (Map<String,Object>)o2;
+
+        // Make sure the unambiguous class just uses the simple name.
+        assertEquals(UnambiguousClassName.class.getSimpleName(), m2.get("$class"));
+    }
+
     private static Map<String,Object> map(Object... keysAndValues) {
         if (keysAndValues.length % 2 != 0) {
             throw new IllegalArgumentException();

diff --git a/plugin/src/test/java/org/jenkinsci/plugins/structs/describable/FirstAmbiguous.java b/plugin/src/test/java/org/jenkinsci/plugins/structs/describable/FirstAmbiguous.java
@@ -0,0 +1,49 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2017, CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package org.jenkinsci.plugins.structs.describable;
+
+import hudson.Extension;
+import hudson.model.AbstractDescribableImpl;
+import hudson.model.Descriptor;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+public class FirstAmbiguous {
+    public static class CommonName extends AbstractDescribableImpl<CommonName> {
+        public final String one;
+
+        @DataBoundConstructor
+        public CommonName(String one) {
+            this.one = one;
+        }
+
+        @Extension
+        public static class DescriptorImpl extends Descriptor<CommonName> {
+            @Override
+            public String getDisplayName() {
+                return "FirstAmbiguous$CommonName";
+            }
+        }
+    }
+}
diff --git a/plugin/src/test/java/org/jenkinsci/plugins/structs/describable/SecondAmbiguous.java b/plugin/src/test/java/org/jenkinsci/plugins/structs/describable/SecondAmbiguous.java
@@ -0,0 +1,49 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2017, CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package org.jenkinsci.plugins.structs.describable;
+
+import hudson.Extension;
+import hudson.model.AbstractDescribableImpl;
+import hudson.model.Descriptor;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+public class SecondAmbiguous {
+    public static class CommonName extends AbstractDescribableImpl<CommonName> {
+        public final String two;
+
+        @DataBoundConstructor
+        public CommonName(String two) {
+            this.two = two;
+        }
+
+        @Extension
+        public static class DescriptorImpl extends Descriptor<CommonName> {
+            @Override
+            public String getDisplayName() {
+                return "SecondAmbiguous$CommonName";
+            }
+        }
+    }
+}
diff --git a/plugin/src/test/java/org/jenkinsci/plugins/structs/describable/UnambiguousClassName.java b/plugin/src/test/java/org/jenkinsci/plugins/structs/describable/UnambiguousClassName.java
@@ -0,0 +1,47 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2017, CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package org.jenkinsci.plugins.structs.describable;
+
+import hudson.Extension;
+import hudson.model.AbstractDescribableImpl;
+import hudson.model.Descriptor;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+public class UnambiguousClassName extends AbstractDescribableImpl<UnambiguousClassName> {
+    public final String one;
+
+    @DataBoundConstructor
+    public UnambiguousClassName(String one) {
+            this.one = one;
+        }
+
+    @Extension
+    public static class DescriptorImpl extends Descriptor<UnambiguousClassName> {
+        @Override
+        public String getDisplayName() {
+                return "An unambiguous describable";
+            }
+    }
+}