Resolve environment variables before descriptor lookup in HeteroDescribableConfigurator (#2805)

Author: somiljain2006

plugin/src/main/java/io/jenkins/plugins/casc/impl/configurators/HeteroDescribableConfigurator.java

@@ -82,7 +82,7 @@ public List<Configurator<T>> getConfigurators(ConfigurationContext context) {
     @NonNull
     @Override
     public T configure(CNode config, ConfigurationContext context) {
-        return preConfigure(config)
+        return preConfigure(config, context)
                 .apply((shortName, subConfig) -> lookupDescriptor(shortName, config)
                         .map(descriptor -> forceLookupConfigurator(context, descriptor))
                         .map(configurator -> doConfigure(context, configurator, subConfig.getOrNull())))
@@ -277,10 +277,10 @@ private HashMap<String, Descriptor<T>> handleDuplicateSymbols(
         }
     }
 
-    private Tuple2<String, Option<CNode>> preConfigure(CNode config) {
+    private Tuple2<String, Option<CNode>> preConfigure(CNode config, ConfigurationContext context) {
         switch (config.getType()) {
             case SCALAR:
-                return configureScalar(config);
+                return configureScalar(config, context);
             case MAPPING:
                 return configureMapping(config);
             default:
@@ -292,9 +292,10 @@ private Tuple2<String, Option<CNode>> configureUnexpected(CNode config) {
         throw new IllegalArgumentException("Unexpected configuration type " + config);
     }
 
-    private Tuple2<String, Option<CNode>> configureScalar(CNode config) {
+    private Tuple2<String, Option<CNode>> configureScalar(CNode config, ConfigurationContext context) {
         Scalar scalar = unchecked(config::asScalar).apply();
-        return Tuple.of(scalar.getValue(), Option.none());
+        String resolvedValue = context.getSecretSourceResolver().resolve(scalar.getValue());
+        return Tuple.of(resolvedValue, Option.none());
     }
 
     private Tuple2<String, Option<CNode>> configureMapping(CNode config) {

plugin/src/test/java/io/jenkins/plugins/casc/impl/configurators/HeteroDescribableConfiguratorTest.java

@@ -0,0 +1,58 @@
+package io.jenkins.plugins.casc.impl.configurators;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.containsString;
+import static org.junit.Assert.assertThrows;
+import static org.junit.Assert.assertTrue;
+
+import hudson.markup.RawHtmlMarkupFormatter;
+import io.jenkins.plugins.casc.ConfigurationAsCode;
+import io.jenkins.plugins.casc.UnknownAttributesException;
+import java.util.Objects;
+import jenkins.model.Jenkins;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.contrib.java.lang.system.EnvironmentVariables;
+import org.jvnet.hudson.test.JenkinsRule;
+
+public class HeteroDescribableConfiguratorTest {
+
+    @Rule
+    public JenkinsRule j = new JenkinsRule();
+
+    @Rule
+    public EnvironmentVariables environment = new EnvironmentVariables();
+
+    @Test
+    public void testScalarVariableInterpolation() {
+        environment.set("ENV_FORMATTER", "rawHtml");
+
+        String yamlResource = Objects.requireNonNull(
+                        getClass().getResource("HeteroDescribableConfiguratorTest_scalarInterpolation.yml"))
+                .toExternalForm();
+        ConfigurationAsCode.get().configure(yamlResource);
+
+        assertTrue(
+                "Markup formatter should be resolved to RawHtmlMarkupFormatter",
+                Jenkins.get().getMarkupFormatter() instanceof RawHtmlMarkupFormatter);
+    }
+
+    @Test
+    public void testInvalidResolvedVariableThrowsException() {
+        environment.set("ENV_FORMATTER", "some-invalid-formatter-name");
+
+        String yamlResource = Objects.requireNonNull(
+                        getClass().getResource("HeteroDescribableConfiguratorTest_scalarInterpolation.yml"))
+                .toExternalForm();
+
+        UnknownAttributesException thrown =
+                assertThrows(UnknownAttributesException.class, () -> ConfigurationAsCode.get()
+                        .configure(yamlResource));
+
+        assertThat(
+                "Exception should mention the failure to find an implementation",
+                thrown.getMessage(),
+                containsString(
+                        "No hudson.markup.MarkupFormatter implementation found for some-invalid-formatter-name"));
+    }
+}

plugin/src/test/resources/io/jenkins/plugins/casc/impl/configurators/HeteroDescribableConfiguratorTest_scalarInterpolation.yml

@@ -0,0 +1,2 @@
+jenkins:
+  markupFormatter: ${ENV_FORMATTER}