apache/maven-mvnd
1
0
Fork 0
mirror of https://github.com/apache/maven-mvnd.git synced 2025-09-10 04:59:54 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Make sure the environment is properly updated, fixes #352

Browse Source
This commit is contained in:
Guillaume Nodet
2021-02-10 21:36:02 +01:00
parent a7c37b8c1c
commit c3d33a1a0b
6 changed files with 173 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
daemon/src/main/java/org/apache/maven/cli/DaemonMavenCli.java
View File

@@ -23,6 +23,7 @@ import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.PrintStream;
import java.lang.reflect.Field;
import java.nio.file.Files;
import java.util.ArrayList;
import java.util.Collections;
@@ -94,6 +95,7 @@ import org.codehaus.plexus.classworlds.realm.ClassRealm;
import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
import org.codehaus.plexus.util.StringUtils;
import org.eclipse.aether.transfer.TransferListener;
import org.fusesource.jansi.internal.CLibrary;
import org.mvndaemon.mvnd.cache.invalidating.InvalidatingExtensionRealmCache;
import org.mvndaemon.mvnd.cache.invalidating.InvalidatingPluginArtifactsCache;
import org.mvndaemon.mvnd.cache.invalidating.InvalidatingPluginRealmCache;
@@ -208,6 +210,7 @@ public class DaemonMavenCli {
Properties props = (Properties) System.getProperties().clone();
try {
initialize(cliRequest);
environment(cliRequest.workingDirectory, clientEnv);
cli(cliRequest);
properties(cliRequest);
help(cliRequest);
@@ -219,7 +222,6 @@ public class DaemonMavenCli {
populateRequest(cliRequest);
encryption(cliRequest);
repository(cliRequest);
environment(clientEnv);
return execute(cliRequest);
} catch (ExitException e) {
return e.exitCode;
@@ -650,17 +652,26 @@ public class DaemonMavenCli {
}
}
private void environment(Map<String, String> clientEnv) {
private void environment(String workingDir, Map<String, String> clientEnv) {
Map<String, String> requested = new TreeMap<>(clientEnv);
Map<String, String> actual = new TreeMap<>(System.getenv());
requested.put("PWD", workingDir);
List<String> diffs = Stream.concat(requested.keySet().stream(), actual.keySet().stream())
.sorted()
.distinct()
.filter(s -> !s.startsWith("JAVA_MAIN_CLASS_"))
.filter(key -> !Objects.equals(requested.get(key), actual.get(key)))
.collect(Collectors.toList());
if (!diffs.isEmpty()) {
slf4jLogger.warn("Environment mismatch !");
try {
for (String key : diffs) {
String vr = requested.get(key);
CLibrary.setenv(key, vr);
}
setEnv(clientEnv);
CLibrary.chdir(workingDir);
System.setProperty("user.dir", workingDir);
} catch (Exception e) {
slf4jLogger.warn("Environment mismatch ! Could not set the environment (" + e + ")");
slf4jLogger.warn("A few environment mismatches have been detected between the client and the daemon.");
diffs.forEach(key -> {
String vr = requested.get(key);
@@ -672,6 +683,37 @@ public class DaemonMavenCli {
}
}
@SuppressWarnings("unchecked")
protected static void setEnv(Map<String, String> newenv) throws Exception {
try {
Class<?> processEnvironmentClass = Class.forName("java.lang.ProcessEnvironment");
Field theEnvironmentField = processEnvironmentClass.getDeclaredField("theEnvironment");
theEnvironmentField.setAccessible(true);
Map<String, String> env = (Map<String, String>) theEnvironmentField.get(null);
env.clear();
env.putAll(newenv);
Field theCaseInsensitiveEnvironmentField = processEnvironmentClass
.getDeclaredField("theCaseInsensitiveEnvironment");
theCaseInsensitiveEnvironmentField.setAccessible(true);
Map<String, String> cienv = (Map<String, String>) theCaseInsensitiveEnvironmentField.get(null);
cienv.clear();
cienv.putAll(newenv);
} catch (NoSuchFieldException e) {
Class<?>[] classes = Collections.class.getDeclaredClasses();
Map<String, String> env = System.getenv();
for (Class<?> cl : classes) {
if ("java.util.Collections$UnmodifiableMap".equals(cl.getName())) {
Field field = cl.getDeclaredField("m");
field.setAccessible(true);
Object obj = field.get(env);
Map<String, String> map = (Map<String, String>) obj;
map.clear();
map.putAll(newenv);
}
}
}
}
private int execute(CliRequest cliRequest)
throws MavenExecutionRequestPopulationException {
commands(cliRequest);

69
integration-tests/src/test/java/org/mvndaemon/mvnd/it/EnvironmentTest.java Normal file
View File

@@ -0,0 +1,69 @@
/*
* Copyright 2021 the original author or authors.
*
* Licensed 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 org.mvndaemon.mvnd.it;
import java.io.IOException;
import java.nio.file.Path;
import java.util.Arrays;
import javax.inject.Inject;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.mvndaemon.mvnd.assertj.TestClientOutput;
import org.mvndaemon.mvnd.client.Client;
import org.mvndaemon.mvnd.junit.ClientFactory;
import org.mvndaemon.mvnd.junit.MvndTest;
import org.mvndaemon.mvnd.junit.TestParameters;
import org.mvndaemon.mvnd.junit.TestRegistry;
import static org.junit.jupiter.api.Assertions.assertTrue;
@MvndTest(projectDir = "src/test/projects/environment")
public class EnvironmentTest {
@Inject
TestRegistry registry;
@Inject
ClientFactory clientFactory;
@Inject
TestParameters parameters;
@Test
void cleanInstall() throws IOException, InterruptedException {
assertDaemonRegistrySize(0);
/* Install the dependencies */
for (String artifactDir : Arrays.asList("project/prj1", "project/prj2")) {
Path dir = parameters.getTestDir().resolve(artifactDir);
final Client cl = clientFactory.newClient(parameters.cd(dir));
final TestClientOutput output = new TestClientOutput();
cl.execute(output, "org.apache.maven.plugins:maven-help-plugin:3.2.0:evaluate",
"-Dexpression=user.dir", "-e").assertSuccess();
assertDaemonRegistrySize(1);
String pathStr = dir.toAbsolutePath().toString();
assertTrue(output.getMessages().stream()
.anyMatch(m -> m.toString().contains(pathStr)), "Output should contain " + pathStr);
}
assertDaemonRegistrySize(1);
}
private void assertDaemonRegistrySize(int size) {
Assertions.assertThat(registry.getAll().size())
.as("Daemon registry size should be " + size)
.isEqualTo(size);
}
}

3
integration-tests/src/test/projects/environment/.mvn/maven.config Normal file
View File

@@ -0,0 +1,3 @@
-Dmaven.wagon.httpconnectionManager.ttlSeconds=120
-Dmaven.wagon.http.retryHandler.requestSentEnabled=true
-Dmaven.wagon.http.retryHandler.count=10

27
integration-tests/src/test/projects/environment/prj1/pom.xml Normal file
View File

@@ -0,0 +1,27 @@
<!--
Copyright 2021 the original author or authors.
Licensed 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.
-->
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.mvndaemon.mvnd.test.environment</groupId>
<artifactId>environment-prj1</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>pom</packaging>
</project>

27
integration-tests/src/test/projects/environment/prj2/pom.xml Normal file
View File

@@ -0,0 +1,27 @@
<!--
Copyright 2021 the original author or authors.
Licensed 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.
-->
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.mvndaemon.mvnd.test.environment</groupId>
<artifactId>environment-prj2</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>pom</packaging>
</project>

2
pom.xml
View File

@@ -40,7 +40,7 @@
<graalvm.version>20.3.0</graalvm.version>
<groovy.version>3.0.7</groovy.version>
<jakarta.inject.version>1.0</jakarta.inject.version>
<jansi.version>2.1.1</jansi.version>
<jansi.version>2.3.1</jansi.version>
<jline.version>3.18.0</jline.version>
<junit.jupiter.version>5.6.0</junit.jupiter.version>
<logback.version>1.2.3</logback.version>