Incorrect warning about overriding environment variable

[rgordill]

Description

Info

• Eclipse JKube version : 1.4.0
• Maven version (mvn -v) :

Maven home: /usr/share/maven
Java version: 11.0.12, vendor: Red Hat, Inc., runtime: /usr/lib/jvm/java-11-openjdk-11.0.12.0.7-0.fc34.x86_64
Default locale: en_US, platform encoding: UTF-8
OS name: "linux", version: "5.13.12-200.fc34.x86_64", arch: "amd64", family: "unix"

• Kubernetes / Red Hat OpenShift setup and version : k8s 1.21

• If it's a bug, how to reproduce : Just adding images with environment vars that can be overriden to resources. Ex.

<configuration>
	<images>
		<image>
			<name>quay.io/example/%a:%l</name>
			<build>
				<from>quay.io/jkube/jkube-java-binary-s2i:0.0.9</from>
				<assembly>
					<targetDir>/deployments</targetDir>
				</assembly>
			</build>
		</image>
	</images>
	<resources>
		<env>
			<!-- disable jolokia -->
			<AB_JOLOKIA_OFF>true</AB_JOLOKIA_OFF>
			<JAVA_OPTIONS>-Djgroups.dns.query=${project.artifactId}-ping</JAVA_OPTIONS>
			<JAVA_ARGS>--spring.profiles.active=${deployment.mode},${infinispan.mode} --spring.application.name=customer-service-cache --spring.cloud.kubernetes.config.name=customer-service-cache-config --spring.cloud.kuberentes.config.paths=/opt/jboss/etc --spring.cloud.kubernetes.config.enableApi=false</JAVA_ARGS>
		</env>
	</resources>
</configuration>

• Log:

[INFO] k8s: jkube-controller: Adding a default Deployment
[WARNING] k8s: jkube-image: Environment variable AB_JOLOKIA_OFF will not be overridden: trying to set the value true, but its actual value is true
[WARNING] k8s: jkube-image: Environment variable JAVA_ARGS will not be overridden: trying to set the value --spring.profiles.active=kubernetes,embedded --spring.application.name=customer-service-cache --spring.cloud.kubernetes.config.name=customer-service-cache-config --spring.cloud.kuberentes.config.paths=/opt/jboss/etc --spring.cloud.kubernetes.config.enableApi=false, but its actual value is --spring.profiles.active=kubernetes,embedded --spring.application.name=customer-service-cache --spring.cloud.kubernetes.config.name=customer-service-cache-config --spring.cloud.kuberentes.config.paths=/opt/jboss/etc --spring.cloud.kubernetes.config.enableApi=false
[WARNING] k8s: jkube-image: Environment variable JAVA_OPTIONS will not be overridden: trying to set the value -Djgroups.dns.query=customer-service-cache-ping, but its actual value is -Djgroups.dns.query=customer-service-cache-ping

• Sample Reproducer Project : https://github.com/rgordill/customer-service-cache

• Other references: It is also shown in this blog: https://www.wildfly.org/news/2021/02/01/Bootable-jar-jkube-clustering-openshift/

[rohanKanojia]

I think this warning is coming from here:
https://github.com/eclipse/jkube/blob/40b056179d70d28166b58ca01e15393e3fc73a22/jkube-kit/enricher/generic/src/main/java/org/eclipse/jkube/enricher/generic/ImageEnricher.java#L286-L290

We check whether we already have the environment variable with the provided name. If absent, we're adding it to containerEnvVars otherwise we're logging Environment variable will not be overridden message without checking whether old and new values are different or not. I think we should add a condition here to log only when provided value and old value are different. Something like this should work:

EnvVar oldEnvVar = containerEnvVars.stream()
  .filter(e -> e.getName().equals(newEnvVar.getName()))
  .findFirst().orElse(null);
if (oldEnvVar == null) {
    containerEnvVars.add(newEnvVar);
} else if (!newEnvVar.getValue().equals(oldEnvVar.getValue())) {
    log.warn(
      "Environment variable %s will not be overridden: trying to set the value %s, but its actual value is %s",
      newEnvVar.getName(), newEnvVar.getValue(), oldEnvVar.getValue());
}