Ensure ConfiguratorException can be reported (#2730)

Author: apuig

plugin/src/main/java/io/jenkins/plugins/casc/ConfiguratorException.java

@@ -25,6 +25,7 @@
 import io.jenkins.plugins.casc.model.CNode;
 import java.util.Collections;
 import java.util.List;
+import jenkins.model.Jenkins;
 
 /**
  * Exception type for {@link Configurator} issues.
@@ -100,7 +101,10 @@ public String getErrorMessage() {
     @Override
     public String getMessage() {
         if (configurator != null) {
-            return String.format("%s: %s", configurator.getName(), super.getMessage());
+            return String.format(
+                    "%s: %s",
+                    Jenkins.getInstanceOrNull() == null ? configurator.getClass() : configurator.getName(),
+                    super.getMessage());
         }
         return super.getMessage();
     }

test-harness/src/test/java/io/jenkins/plugins/casc/impl/configurators/DataBoundConfiguratorTest.java

@@ -28,12 +28,15 @@
 import io.jenkins.plugins.casc.model.Mapping;
 import io.jenkins.plugins.casc.model.Scalar;
 import io.jenkins.plugins.casc.model.Sequence;
+import java.io.PrintWriter;
+import java.io.StringWriter;
 import java.util.HashSet;
 import java.util.Set;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import javax.annotation.ParametersAreNonnullByDefault;
 import javax.annotation.PostConstruct;
+import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.jvnet.hudson.test.Issue;
@@ -53,6 +56,9 @@ class DataBoundConfiguratorTest {
 
     private final LogRecorder logging = new LogRecorder();
 
+    /** captured exception to be printed after Jenkins is shut down */
+    private static Throwable savedConfiguratorException;
+
     @BeforeEach
     void tearUp(JenkinsRule j) {
         this.j = j;
@@ -164,6 +170,8 @@ void packageParametersAreNonnullByDefault() {
                         .configure(config, new ConfigurationContext(registry)));
 
         assertThat(exception.getMessage(), is(expectedMessage));
+
+        savedConfiguratorException = exception;
     }
 
     @Test
@@ -249,6 +257,19 @@ void shouldThrowConfiguratorException() {
                                 + " Constructor: public io.jenkins.plugins.casc.impl.configurators.DataBoundConfiguratorTest$Foo(java.lang.String,boolean,int).\n"
                                 + " Arguments: [java.lang.String, java.lang.Boolean, java.lang.Integer].\n"
                                 + " Expected Parameters: foo java.lang.String, bar boolean, qix int"));
+
+        savedConfiguratorException = e;
+    }
+
+    @AfterAll
+    static void checkConfiguratorExceptionCanBeReportedWithoutJenkins() {
+        if (savedConfiguratorException != null) {
+            StringWriter sw = new StringWriter();
+            try (PrintWriter pw = new PrintWriter(sw)) {
+                savedConfiguratorException.printStackTrace(pw);
+            }
+            savedConfiguratorException = null;
+        }
     }
 
     @Test