Skip to content
This repository has been archived by the owner on Jun 19, 2024. It is now read-only.

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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;
Expand Down Expand Up @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
@@ -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);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand All @@ -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();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
import io.fabric8.maven.enricher.api.MavenEnricherContext;

import java.util.Collections;
import java.util.HashMap;
import java.util.List;

/**
Expand Down Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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<>()));
});

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really not sure why we need to duplicate that piece of code in every enricher. For me that looks like a smell.

Whats about a post processing step outside of all enricher, which just overrides the environment variables added by the enricher chain ?

final List<HasMetadata> kubernetesItems = new ArrayList<>();
processArtifactSetResources(this.kubernetesDependencyArtifacts, items -> {
kubernetesItems.addAll(Arrays.asList(items.toArray(new HasMetadata[items.size()])));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down
Loading