[JENKINS-71343] EnvInjector plugin generates error when env variable already exists

[jenkins-infra-bot]

In the virtual machine OS environment, there is a variable with the name EXAMPLE_VARIALBE. The variable has a default value which is needed by local tools. In Jenkins jobs, I am using the EnvInject plugin to inject new environment variables but also to overwrite EXAMPLE_VARIALBE with a new value. This is standard action, however, after upgrading the Environment Injector plugin from 2.4.0 to the newest one, it started to generate an error:

ERROR: Not all environment variables could be successfully injected. Check for similarly-named environment variables.

Catching such behavior was introduced due to a ticket: https://issue-redirect.jenkins.io/issue/60559

25669f1

And for unknown reasons, the warning message was changed to error one, which in my opinion is completely incorrect and misleading:

1bd3095

First, the message should be clearer and inform the user of what is really happening. It could be a warning or just information, but not an error.

Second, the case from https://issue-redirect.jenkins.io/issue/60559 should also be caught separately, as the first message concerns a different case.

---

Originally reported by p_jaskowiec, imported from: EnvInjector plugin generates error when env variable already exists

• status: Open
• priority: Critical
• component(s): envinject-plugin
• resolution: Unresolved
• votes: 2
• watchers: 6
• imported: 20251223-165436

Raw content of original issue

In the virtual machine OS environment, there is a variable with the name EXAMPLE_VARIALBE. The variable has a default value which is needed by local tools. In Jenkins jobs, I am using the EnvInject plugin to inject new environment variables but also to overwrite EXAMPLE_VARIALBE with a new value. This is standard action, however, after upgrading the Environment Injector plugin from 2.4.0 to the newest one, it started to generate an error:

ERROR: Not all environment variables could be successfully injected. Check for similarly-named environment variables.

Catching such behavior was introduced due to a ticket: https://issues.jenkins.io/browse/JENKINS-60559

25669f1

And for unknown reasons, the warning message was changed to error one, which in my opinion is completely incorrect and misleading:

1bd3095

First, the message should be clearer and inform the user of what is really happening. It could be a warning or just information, but not an error.

Second, the case from https://issues.jenkins.io/browse/JENKINS-60559 should also be caught separately, as the first message concerns a different case.

[jenkins-infra-bot]

whoyoumommy:

• Original comment link
• Raw content of original comment:

  Could you change this misleading message, which is printed when you inject env that already exists in the given environment:
          misleading message (used by updated EnvInjector plugin when one of injected env that already exist):
          ERROR: Not all environment variables may have been successfully injected. Check environment variables with similar names.
  To:
          more appropriate message:
          WARNNING: The environment variable already exists and has been overwritten by the EnvInjector plug-in. <env_name>=<value_before_injection> overwritten to <env_name>=<value_after_injection>
  
  
  Or at least please bring back this as a warning and not an error, as EnvInect overwrites envs without an issue:
          WARNING: Not all environment variables may have been successfully injected. Check environment variables with similar names.
   
  

Could you change this misleading message, which is printed when you inject env that already exists in the given environment:
        misleading message (used by updated EnvInjector plugin when one of injected env that already exist):
        ERROR: Not all environment variables may have been successfully injected. Check environment variables with similar names.
To:
        more appropriate message:
        WARNNING: The environment variable already exists and has been overwritten by the EnvInjector plug-in. = overwritten to =

Or at least please bring back this as a warning and not an error, as EnvInect overwrites envs without an issue:
        WARNING: Not all environment variables may have been successfully injected. Check environment variables with similar names.
 

[jenkins-infra-bot]

rhpatrick:

• Original comment link
• Raw content of original comment:

  My build logs are now getting filled up with hundreds of these messages.  Since the build hasn't changed (only the version of Jenkins and/or the plugin), it would be nice to revert marking this as an error...
  

My build logs are now getting filled up with hundreds of these messages.  Since the build hasn't changed (only the version of Jenkins and/or the plugin), it would be nice to revert marking this as an error...

[jenkins-infra-bot]

jimsearle:

• Original comment link
• Raw content of original comment:

  Please revert this back to a warning. Better yet, instead of just counting the number of variables before != number of variables after + injected, just check that the injected variables end up in the environment with the proper value.
  

Please revert this back to a warning. Better yet, instead of just counting the number of variables before != number of variables after + injected, just check that the injected variables end up in the environment with the proper value.

[jenkins-infra-bot]

rhpatrick:

• Original comment link
• Raw content of original comment:

  Typical, no response for this issue...my Jenkins log is useless because my builds have thousands of these messages so it is almost impossible to see any actual errors.
  

Typical, no response for this issue...my Jenkins log is useless because my builds have thousands of these messages so it is almost impossible to see any actual errors.

[robertpatrick]

Are there any plans to give us a way to squelch these meaningless errors to prevent filling up the Jenkins logs with these messages?

[robertpatrick]

The problem I see is in this code: https://github.com/jenkinsci/envinject-plugin/blob/master/src/main/java/org/jenkinsci/plugins/envinject/EnvInjectEnvVarsContributor.java#L25-L33

Basically, any time that the environment variables overall, it is spitting out an error, which I think is wrong. What I would do is:

• reduce the severity level and/or give me a way to make this not pollute the Jenkins logs, and
• change the code to tolerate overlaps, maybe something like the following:

                Map<String, String> result = jobPropertyInfo.getPropertiesContentMap(env);
                if (result != null) {
                    HashSet<String> mergedSet = new HashSet<>(env.keySet());
                    mergedSet.addAll(result.keySet());
                    int expectedEnvSize = mergedSet.size();
                    env.putAll(result);
                    if (env.size() != expectedEnvSize) {
                        listener.error("Not all environment variables could be successfully injected. " +
                                "Check for similarly-named environment variables.");
                    }
                }

[dmatej]

I can confirm this problem - it works, but it just prints this log confusing me that it doesn't work. I tried to inject custom JAVA_HOME and PATH env variables based on a parameter JavaVersion which is just a number 17/21/25. It works, but spams the log with this error message.