Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MSHARED-969] Environment variable with null value #68

Merged
merged 1 commit into from
Apr 16, 2021
Merged

[MSHARED-969] Environment variable with null value #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,9 @@
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<reuseForks>false</reuseForks>
<environmentVariables>
<TEST_SHARED_ENV>TestValue</TEST_SHARED_ENV>
</environmentVariables>
</configuration>
</plugin>
</plugins>
Expand Down
11 changes: 6 additions & 5 deletions src/main/java/org/apache/maven/shared/utils/cli/Commandline.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,15 +241,16 @@ public void addSystemEnvironment()
public String[] getEnvironmentVariables()
{
addSystemEnvironment();
String[] environmentVars = new String[envVars.size()];
int i = 0;
List<String> environmentVars = new ArrayList<>();
for ( String name : envVars.keySet() )
slawekjaranowski marked this conversation as resolved.
Show resolved Hide resolved
{
String value = envVars.get( name );
environmentVars[i] = name + "=" + value;
i++;
if ( value != null )
{
environmentVars.add( name + "=" + value );
}
}
return environmentVars;
return environmentVars.toArray( new String[0] );
slawekjaranowski marked this conversation as resolved.
Show resolved Hide resolved
}

/**
Expand Down
39 changes: 39 additions & 0 deletions src/test/java/org/apache/maven/shared/utils/cli/CommandLineUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
* under the License.
*/

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.hasItemInArray;
import static org.hamcrest.Matchers.not;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
Expand Down Expand Up @@ -168,4 +171,40 @@ private void assertCmdLineArgs( final String[] expected, final String cmdLine )
assertEquals( expected.length, actual.length );
assertEquals( Arrays.asList( expected ), Arrays.asList( actual ) );
}

@Test
public void environmentVariableWithNullShouldNotBeSet() {

Commandline commandline = new Commandline();
commandline.addEnvironment("TEST_NULL_ENV", null);
Copy link

Choose a reason for hiding this comment

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

With reard to my previous comments I'd like to ask the OS experts what sense it make to store null in an environment variable?

Copy link
Member Author

Choose a reason for hiding this comment

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

As I wrote before Command Line object has local map of environment variable which are provided to Runtime.exec after translate this map to list of name=value. Translation is done in getEnvironmentVariables.

Please look at my last comment at jira and new test in last update.


String[] environmentVariables = commandline.getEnvironmentVariables();

assertNotNull( environmentVariables );
assertThat( environmentVariables, not( hasItemInArray( "TEST_NULL_ENV=null" ) ) );
}

@Test
public void environmentVariableFromSystemIsCopied() {

Commandline commandline = new Commandline();

String[] environmentVariables = commandline.getEnvironmentVariables();

assertNotNull(environmentVariables);
assertThat(environmentVariables, hasItemInArray( "TEST_SHARED_ENV=TestValue" ) );
}

@Test
public void environmentVariableFromSystemIsRemoved() {

Commandline commandline = new Commandline();
commandline.addEnvironment("TEST_SHARED_ENV", null);

String[] environmentVariables = commandline.getEnvironmentVariables();

assertNotNull(environmentVariables);
assertThat(environmentVariables, not ( hasItemInArray( "TEST_SHARED_ENV=TestValue" ) ) );
}

}