feat(#937): Overrides environment variables when defined in resources

enricher/api/src/main/java/io/fabric8/maven/enricher/api/BaseEnricher.java

@@ -15,6 +15,11 @@
  */
 package io.fabric8.maven.enricher.api;
 
+import io.fabric8.kubernetes.api.builder.TypedVisitor;
+import io.fabric8.kubernetes.api.model.ConfigMapBuilder;
+import io.fabric8.kubernetes.api.model.ContainerBuilder;
+import io.fabric8.kubernetes.api.model.EnvVar;
+import io.fabric8.kubernetes.api.model.EnvVarBuilder;
 import io.fabric8.kubernetes.api.model.KubernetesListBuilder;
 import io.fabric8.maven.core.config.PlatformMode;
 import io.fabric8.maven.core.model.Configuration;
@@ -24,6 +29,8 @@
 import io.fabric8.maven.docker.util.Logger;
 
 import java.util.Collections;
+import java.util.Iterator;
+import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -105,6 +112,56 @@ protected EnricherContext getContext() {
         return enricherContext;
     }
 
+    protected void overrideEnvironmentVariables(KubernetesListBuilder builder, final Map<String, String> resourceEnv) {
+        builder.accept(new TypedVisitor<ContainerBuilder>() {
+            @Override
+            public void visit(ContainerBuilder containerBuilder) {
+                List<EnvVar> envVars = containerBuilder.buildEnv();
+
+                if (envVars == null) {
+                    envVars = new LinkedList<>();
+                    containerBuilder.withEnv(envVars);
+                }
+
+                if (resourceEnv != null) {
+                    for (Map.Entry<String, String> resourceEnvEntry : resourceEnv.entrySet()) {
+                        EnvVar newEnvVar =
+                            new EnvVarBuilder()
+                                .withName(resourceEnvEntry.getKey())
+                                .withValue(resourceEnvEntry.getValue())
+                                .build();
+                        if (hasEnvWithName(envVars, resourceEnvEntry.getKey())) {
+                            final String oldValue = removeEnvWithName(envVars, resourceEnvEntry.getKey());
+                            log.warn(
+                                "Environment variable %s is overridden: Setting the value %s, which replaces %s",
+                                newEnvVar.getName(), newEnvVar.getValue(), oldValue);
+                        }
+                        envVars.add(newEnvVar);
+                    }
+                    containerBuilder.withEnv(envVars);
+                }
+            }
+        });
+
+    }
+
+    private String removeEnvWithName(List<EnvVar> envVars, String name) {
+        final Iterator<EnvVar> iterator = envVars.iterator();
+        while(iterator.hasNext()) {
+            final EnvVar envVar = iterator.next();
+            if (envVar.getName().equals(name)) {
+                iterator.remove();
+                return envVar.getValue();
+            }
+        }
+
+        return "";
+    }
+
+    private boolean hasEnvWithName(List<EnvVar> envVars, String name) {
+        return envVars.stream().anyMatch(e -> e.getName().equals(name));
+    }
+
     /**
      * Returns true if we are in OpenShift S2I binary building mode
      */

enricher/api/src/test/java/io/fabric8/maven/enricher/api/BaseEnricherTest.java

@@ -0,0 +1,151 @@
+/**
+ * Copyright 2018 Red Hat, Inc.
+ *
+ * Red Hat licenses this file to you under the Apache License, version
+ * 2.0 (the "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ * implied.  See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+package io.fabric8.maven.enricher.api;
+
+import io.fabric8.kubernetes.api.builder.TypedVisitor;
+import io.fabric8.kubernetes.api.model.Container;
+import io.fabric8.kubernetes.api.model.ContainerBuilder;
+import io.fabric8.kubernetes.api.model.ContainerPortBuilder;
+import io.fabric8.kubernetes.api.model.EnvVar;
+import io.fabric8.kubernetes.api.model.EnvVarBuilder;
+import io.fabric8.kubernetes.api.model.KubernetesListBuilder;
+import java.util.HashMap;
+import java.util.List;
+import mockit.Mocked;
+import mockit.integration.junit4.JMockit;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@RunWith(JMockit.class)
+public class BaseEnricherTest {
+
+    @Mocked
+    private EnricherContext enricherContext;
+
+    @Test
+    public void setEnvironmentVariablesFromResources() {
+
+        // Given
+        final DummyBaseEnricher dummyBaseEnricher = new DummyBaseEnricher(enricherContext, "dummy");
+
+        // When
+        final KubernetesListBuilder kubernetesListBuilder = createKubernetesList();
+        final HashMap<String, String> resourceEnv = new HashMap<>();
+        resourceEnv.put("A", "B");
+
+        dummyBaseEnricher.overrideEnvironmentVariables(kubernetesListBuilder, resourceEnv);
+
+        // Then
+        kubernetesListBuilder.accept(new TypedVisitor<ContainerBuilder>() {
+            @Override
+            public void visit(ContainerBuilder element) {
+                final List<EnvVar> envVars = element.buildEnv();
+
+                assertThat(envVars)
+                    .containsExactly(createEnvVar("A", "B"));
+            }
+        });
+    }
+
+    @Test
+    public void addResourceEnvironmentVariablesToContainerEnvironmentVariables() {
+
+        // Given
+        final DummyBaseEnricher dummyBaseEnricher = new DummyBaseEnricher(enricherContext, "dummy");
+
+        // When
+        final KubernetesListBuilder kubernetesListBuilder = createKubernetesList(createEnvVar("C", "D"));
+        final HashMap<String, String> resourceEnv = new HashMap<>();
+        resourceEnv.put("A", "B");
+
+
+        dummyBaseEnricher.overrideEnvironmentVariables(kubernetesListBuilder, resourceEnv);
+
+        // Then
+        kubernetesListBuilder.accept(new TypedVisitor<ContainerBuilder>() {
+            @Override
+            public void visit(ContainerBuilder element) {
+                final List<EnvVar> envVars = element.buildEnv();
+
+                assertThat(envVars)
+                    .containsExactlyInAnyOrder(createEnvVar("A", "B"), createEnvVar("C", "D"));
+            }
+        });
+
+    }
+
+    @Test
+    public void overrideResourceEnvironmentVariablesToContainerEnvironmentVariables() {
+
+        // Given
+        final DummyBaseEnricher dummyBaseEnricher = new DummyBaseEnricher(enricherContext, "dummy");
+
+        // When
+        final KubernetesListBuilder kubernetesListBuilder = createKubernetesList(createEnvVar("A", "B"));
+        final HashMap<String, String> resourceEnv = new HashMap<>();
+        resourceEnv.put("A", "C");
+
+        dummyBaseEnricher.overrideEnvironmentVariables(kubernetesListBuilder, resourceEnv);
+
+        // Then
+        kubernetesListBuilder.accept(new TypedVisitor<ContainerBuilder>() {
+            @Override
+            public void visit(ContainerBuilder element) {
+                final List<EnvVar> envVars = element.buildEnv();
+
+                assertThat(envVars)
+                    .containsExactlyInAnyOrder(createEnvVar("A", "C"));
+            }
+        });
+
+    }
+
+
+    private KubernetesListBuilder createKubernetesList(EnvVar... envVars) {
+        final Container container = new ContainerBuilder()
+            .withName("test-port-enricher")
+            .withImage("test-image")
+            .withEnv(envVars)
+            .withPorts(new ContainerPortBuilder().withContainerPort(80).withProtocol("TCP").build())
+            .build();
+        return new KubernetesListBuilder()
+            .addNewReplicaSetItem()
+            .withNewSpec()
+            .withNewTemplate()
+            .withNewSpec()
+            .withContainers(container)
+            .endSpec()
+            .endTemplate()
+            .endSpec()
+            .endReplicaSetItem();
+    }
+
+    private EnvVar createEnvVar(String key, String value) {
+        return
+            new EnvVarBuilder()
+                .withName(key)
+                .withValue(value)
+                .build();
+    }
+
+    class DummyBaseEnricher extends BaseEnricher {
+        public DummyBaseEnricher(EnricherContext enricherContext, String name) {
+            super(enricherContext, name);
+        }
+    }
+}

enricher/fabric8/src/main/java/io/fabric8/maven/enricher/fabric8/AbstractHealthCheckEnricher.java

@@ -20,8 +20,10 @@
 import io.fabric8.kubernetes.api.model.ContainerBuilder;
 import io.fabric8.kubernetes.api.model.KubernetesListBuilder;
 import io.fabric8.kubernetes.api.model.Probe;
+import io.fabric8.maven.core.config.ResourceConfig;
 import io.fabric8.maven.enricher.api.BaseEnricher;
 import io.fabric8.maven.enricher.api.MavenEnricherContext;
+import java.util.HashMap;
 
 /**
  * Enriches containers with health check probes.
@@ -35,6 +37,11 @@ public AbstractHealthCheckEnricher(MavenEnricherContext buildContext, String nam
     @Override
     public void addMissingResources(KubernetesListBuilder builder) {
 
+        getConfiguration().getResource().ifPresent(resourceConfig -> {
+            overrideEnvironmentVariables(builder, resourceConfig.getEnv()
+                .orElse(new HashMap<>()));
+        });
+
         builder.accept(new TypedVisitor<ContainerBuilder>() {
             @Override
             public void visit(ContainerBuilder container) {

enricher/standard/src/main/java/io/fabric8/maven/enricher/standard/ConfigMapEnricher.java

@@ -18,6 +18,7 @@
 import io.fabric8.kubernetes.api.builder.TypedVisitor;
 import io.fabric8.kubernetes.api.model.ConfigMapBuilder;
 import io.fabric8.kubernetes.api.model.KubernetesListBuilder;
+import io.fabric8.maven.core.config.ResourceConfig;
 import io.fabric8.maven.enricher.api.BaseEnricher;
 import io.fabric8.maven.enricher.api.MavenEnricherContext;
 import java.io.IOException;
@@ -38,6 +39,12 @@ public ConfigMapEnricher(MavenEnricherContext enricherContext) {
 
     @Override
     public void addMissingResources(KubernetesListBuilder builder) {
+
+        getConfiguration().getResource().ifPresent(resourceConfig -> {
+            overrideEnvironmentVariables(builder, resourceConfig.getEnv()
+                .orElse(new HashMap<>()));
+        });
+
         addAnnotations(builder);
     }
 

enricher/standard/src/main/java/io/fabric8/maven/enricher/standard/DebugEnricher.java

@@ -28,13 +28,15 @@
 import io.fabric8.kubernetes.api.model.apps.DeploymentSpec;
 import io.fabric8.kubernetes.api.model.apps.ReplicaSet;
 import io.fabric8.kubernetes.api.model.apps.ReplicaSetSpec;
+import io.fabric8.maven.core.config.ResourceConfig;
 import io.fabric8.maven.core.util.kubernetes.KubernetesHelper;
 import io.fabric8.maven.core.util.kubernetes.KubernetesResourceUtil;
 import io.fabric8.maven.enricher.api.BaseEnricher;
 import io.fabric8.maven.enricher.api.MavenEnricherContext;
 import io.fabric8.openshift.api.model.DeploymentConfig;
 import io.fabric8.openshift.api.model.DeploymentConfigSpec;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
 import org.apache.commons.lang3.StringUtils;
 
@@ -55,6 +57,12 @@ public DebugEnricher(MavenEnricherContext buildContext) {
 
     @Override
     public void addMissingResources(KubernetesListBuilder builder) {
+
+        getConfiguration().getResource().ifPresent(resourceConfig -> {
+            overrideEnvironmentVariables(builder, resourceConfig.getEnv()
+                .orElse(new HashMap<>()));
+        });
+
         if (debugEnabled()) {
             int count = 0;
             List<HasMetadata> items = builder.getItems();

enricher/standard/src/main/java/io/fabric8/maven/enricher/standard/DefaultControllerEnricher.java

@@ -41,6 +41,7 @@
 import io.fabric8.maven.enricher.api.MavenEnricherContext;
 
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
 
 /**
@@ -96,6 +97,12 @@ public DefaultControllerEnricher(MavenEnricherContext buildContext) {
 
     @Override
     public void addMissingResources(KubernetesListBuilder builder) {
+
+        getConfiguration().getResource().ifPresent(resourceConfig -> {
+                overrideEnvironmentVariables(builder, resourceConfig.getEnv()
+                    .orElse(new HashMap<>()));
+        });
+
         final String name = getConfig(Config.name, MavenUtil.createDefaultResourceName(getContext().getGav().getSanitizedArtifactId()));
         final ResourceConfig config = new ResourceConfig.Builder()
                     .controllerName(name)

enricher/standard/src/main/java/io/fabric8/maven/enricher/standard/DefaultServiceEnricher.java

@@ -26,6 +26,7 @@
 import io.fabric8.kubernetes.api.model.ServicePort;
 import io.fabric8.kubernetes.api.model.ServicePortBuilder;
 import io.fabric8.kubernetes.api.model.ServiceSpec;
+import io.fabric8.maven.core.config.ResourceConfig;
 import io.fabric8.maven.core.util.Configs;
 import io.fabric8.maven.core.util.MavenUtil;
 import io.fabric8.maven.core.util.kubernetes.KubernetesHelper;
@@ -97,6 +98,12 @@ public DefaultServiceEnricher(MavenEnricherContext buildContext) {
 
     @Override
     public void addMissingResources(KubernetesListBuilder builder) {
+
+        getConfiguration().getResource().ifPresent(resourceConfig -> {
+            overrideEnvironmentVariables(builder, resourceConfig.getEnv()
+                .orElse(new HashMap<>()));
+        });
+
         final Service defaultService = getDefaultService();
 
         if (hasServices(builder)) {

enricher/standard/src/main/java/io/fabric8/maven/enricher/standard/DependencyEnricher.java

@@ -15,6 +15,7 @@
  */
 package io.fabric8.maven.enricher.standard;
 
+import io.fabric8.maven.core.config.ResourceConfig;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
@@ -119,6 +120,12 @@ private void addArtifactsWithYaml(Set<URL> artifactSet, String dependencyYaml) {
 
     @Override
     public void adapt(final KubernetesListBuilder builder) {
+
+        getConfiguration().getResource().ifPresent(resourceConfig -> {
+            overrideEnvironmentVariables(builder, resourceConfig.getEnv()
+                .orElse(new HashMap<>()));
+        });
+
         final List<HasMetadata> kubernetesItems = new ArrayList<>();
         processArtifactSetResources(this.kubernetesDependencyArtifacts, items -> {
             kubernetesItems.addAll(Arrays.asList(items.toArray(new HasMetadata[items.size()])));

enricher/standard/src/main/java/io/fabric8/maven/enricher/standard/ImageEnricher.java

@@ -16,6 +16,7 @@
 package io.fabric8.maven.enricher.standard;
 
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
@@ -86,6 +87,12 @@ private enum Config implements Configs.Key {
 
     @Override
     public void addMissingResources(KubernetesListBuilder builder) {
+
+        getConfiguration().getResource().ifPresent(resourceConfig -> {
+            overrideEnvironmentVariables(builder, resourceConfig.getEnv()
+                .orElse(new HashMap<>()));
+        });
+
         if (!hasImageConfiguration()) {
             log.verbose("No images resolved. Skipping ...");
             return;