SONAR-6835 Do not dump env variables multiple times

diff --git a/sonar-batch/src/main/java/org/sonar/batch/report/AnalysisContextReportPublisher.java b/sonar-batch/src/main/java/org/sonar/batch/report/AnalysisContextReportPublisher.java
index e7ba57a7c0fab9eaa52cd155a8133f721dbcef9f..172a64a837ba5226f74e93913326220ae716018e 100644 (file)
--- a/sonar-batch/src/main/java/org/sonar/batch/report/AnalysisContextReportPublisher.java
+++ b/sonar-batch/src/main/java/org/sonar/batch/report/AnalysisContextReportPublisher.java
@@ -30,6 +30,7 @@ import org.sonar.api.batch.AnalysisMode;
 import org.sonar.api.batch.BatchSide;
 import org.sonar.api.batch.bootstrap.ProjectDefinition;
 import org.sonar.api.config.Settings;
+import org.sonar.api.utils.System2;
 import org.sonar.batch.bootstrap.BatchPluginRepository;
 import org.sonar.batch.protocol.output.BatchReportWriter;
 import org.sonar.core.platform.PluginInfo;
@@ -37,15 +38,18 @@ import org.sonar.core.platform.PluginInfo;
 @BatchSide
 public class AnalysisContextReportPublisher {
 
+  private static final String ENV_PROP_PREFIX = "env.";
   private static final String SONAR_PROP_PREFIX = "sonar.";
   private final BatchPluginRepository pluginRepo;
   private final AnalysisMode mode;
+  private final System2 system;
 
   private BatchReportWriter writer;
 
-  public AnalysisContextReportPublisher(AnalysisMode mode, BatchPluginRepository pluginRepo) {
+  public AnalysisContextReportPublisher(AnalysisMode mode, BatchPluginRepository pluginRepo, System2 system) {
     this.mode = mode;
     this.pluginRepo = pluginRepo;
+    this.system = system;
   }
 
   public void init(BatchReportWriter writer) {
@@ -72,7 +76,7 @@ public class AnalysisContextReportPublisher {
 
   private void writeSystemProps(BufferedWriter fileWriter) throws IOException {
     fileWriter.write("System properties:\n");
-    for (Map.Entry<Object, Object> env : System.getProperties().entrySet()) {
+    for (Map.Entry<Object, Object> env : system.properties().entrySet()) {
       if (env.getKey().toString().startsWith(SONAR_PROP_PREFIX)) {
         continue;
       }
@@ -80,9 +84,9 @@ public class AnalysisContextReportPublisher {
     }
   }
 
-  private static void writeEnvVariables(BufferedWriter fileWriter) throws IOException {
+  private void writeEnvVariables(BufferedWriter fileWriter) throws IOException {
     fileWriter.append("Environment variables:\n");
-    for (Map.Entry<String, String> env : System.getenv().entrySet()) {
+    for (Map.Entry<String, String> env : system.envVariables().entrySet()) {
       fileWriter.append(String.format("  - %s=%s", env.getKey(), env.getValue())).append('\n');
     }
   }
@@ -95,7 +99,7 @@ public class AnalysisContextReportPublisher {
     try (BufferedWriter fileWriter = Files.newBufferedWriter(analysisLog.toPath(), StandardCharsets.UTF_8, StandardOpenOption.WRITE, StandardOpenOption.APPEND)) {
       fileWriter.append(String.format("Settings for module: %s", moduleDefinition.getKey())).append('\n');
       for (Map.Entry<String, String> prop : settings.getProperties().entrySet()) {
-        if (System.getProperties().containsKey(prop.getKey()) && !prop.getKey().startsWith(SONAR_PROP_PREFIX)) {
+        if (alreadyLoggedAsSystemProp(prop) || alreadyLoggedAsEnv(prop)) {
           continue;
         }
         fileWriter.append(String.format("  - %s=%s", prop.getKey(), sensitive(prop.getKey()) ? "******" : prop.getValue())).append('\n');
@@ -105,6 +109,14 @@ public class AnalysisContextReportPublisher {
     }
   }
 
+  private boolean alreadyLoggedAsSystemProp(Map.Entry<String, String> prop) {
+    return system.properties().containsKey(prop.getKey()) && !prop.getKey().startsWith(SONAR_PROP_PREFIX);
+  }
+
+  private boolean alreadyLoggedAsEnv(Map.Entry<String, String> prop) {
+    return prop.getKey().startsWith(ENV_PROP_PREFIX) && system.envVariables().containsKey(prop.getKey().substring(ENV_PROP_PREFIX.length()));
+  }
+
   private static boolean sensitive(String key) {
     return key.contains(".password") || key.contains(".secured");
   }

diff --git a/sonar-batch/src/test/java/org/sonar/batch/report/AnalysisContextReportPublisherTest.java b/sonar-batch/src/test/java/org/sonar/batch/report/AnalysisContextReportPublisherTest.java
index f890b6ab7250fb89caa984640c5f1de28d1de9c7..f3e8076995954deae84a3a39077d332de07c1418 100644 (file)
--- a/sonar-batch/src/test/java/org/sonar/batch/report/AnalysisContextReportPublisherTest.java
+++ b/sonar-batch/src/test/java/org/sonar/batch/report/AnalysisContextReportPublisherTest.java
@@ -20,6 +20,9 @@
 package org.sonar.batch.report;
 
 import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Properties;
 import org.apache.commons.io.FileUtils;
 import org.junit.Before;
 import org.junit.Rule;
@@ -28,6 +31,7 @@ import org.junit.rules.TemporaryFolder;
 import org.sonar.api.batch.AnalysisMode;
 import org.sonar.api.batch.bootstrap.ProjectDefinition;
 import org.sonar.api.config.Settings;
+import org.sonar.api.utils.System2;
 import org.sonar.batch.bootstrap.BatchPluginRepository;
 import org.sonar.batch.protocol.output.BatchReportWriter;
 import org.sonar.core.platform.PluginInfo;
@@ -39,16 +43,24 @@ import static org.mockito.Mockito.when;
 
 public class AnalysisContextReportPublisherTest {
 
+  private static final String BIZ = "BIZ";
+  private static final String FOO = "FOO";
+  private static final String SONAR_SKIP = "sonar.skip";
+  private static final String COM_FOO = "com.foo";
+
   @Rule
   public TemporaryFolder temp = new TemporaryFolder();
 
   private BatchPluginRepository pluginRepo = mock(BatchPluginRepository.class);
   private AnalysisContextReportPublisher publisher;
   private AnalysisMode analysisMode = mock(AnalysisMode.class);
+  private System2 system2;
 
   @Before
   public void prepare() throws Exception {
-    publisher = new AnalysisContextReportPublisher(analysisMode, pluginRepo);
+    system2 = mock(System2.class);
+    when(system2.properties()).thenReturn(new Properties());
+    publisher = new AnalysisContextReportPublisher(analysisMode, pluginRepo, system2);
   }
 
   @Test
@@ -76,23 +88,52 @@ public class AnalysisContextReportPublisherTest {
   @Test
   public void shouldNotDumpSQPropsInSystemProps() throws Exception {
     BatchReportWriter writer = new BatchReportWriter(temp.newFolder());
-    System.setProperty("com.foo", "bar");
-    System.setProperty("sonar.skip", "true");
+    Properties props = new Properties();
+    props.setProperty(COM_FOO, "bar");
+    props.setProperty(SONAR_SKIP, "true");
+    when(system2.properties()).thenReturn(props);
+    publisher.init(writer);
+
+    String content = FileUtils.readFileToString(writer.getFileStructure().analysisLog());
+    assertThat(content).containsOnlyOnce(COM_FOO);
+    assertThat(content).doesNotContain(SONAR_SKIP);
+
+    Settings settings = new Settings();
+    settings.setProperty(COM_FOO, "bar");
+    settings.setProperty(SONAR_SKIP, "true");
+
+    publisher.dumpSettings(ProjectDefinition.create().setProperty("sonar.projectKey", "foo"), settings);
+
+    content = FileUtils.readFileToString(writer.getFileStructure().analysisLog());
+    assertThat(content).containsOnlyOnce(COM_FOO);
+    assertThat(content).containsOnlyOnce(SONAR_SKIP);
+  }
+
+  @Test
+  public void shouldNotDumpEnvTwice() throws Exception {
+    BatchReportWriter writer = new BatchReportWriter(temp.newFolder());
+
+    Map<String, String> env = new HashMap<>();
+    env.put(FOO, "BAR");
+    env.put(BIZ, "BAZ");
+    when(system2.envVariables()).thenReturn(env);
     publisher.init(writer);
 
     String content = FileUtils.readFileToString(writer.getFileStructure().analysisLog());
-    assertThat(content).containsOnlyOnce("com.foo");
-    assertThat(content).doesNotContain("sonar.skip");
+    assertThat(content).containsOnlyOnce(FOO);
+    assertThat(content).containsOnlyOnce(BIZ);
 
     Settings settings = new Settings();
-    settings.setProperty("com.foo", "bar");
-    settings.setProperty("sonar.skip", "true");
+    settings.setProperty("env." + FOO, "BAR");
+    settings.setProperty("env.another", "world");
 
     publisher.dumpSettings(ProjectDefinition.create().setProperty("sonar.projectKey", "foo"), settings);
 
     content = FileUtils.readFileToString(writer.getFileStructure().analysisLog());
-    assertThat(content).containsOnlyOnce("com.foo");
-    assertThat(content).containsOnlyOnce("sonar.skip");
+    assertThat(content).containsOnlyOnce("env.another");
+    assertThat(content).containsOnlyOnce(FOO);
+    assertThat(content).containsOnlyOnce(BIZ);
+    assertThat(content).doesNotContain("env." + FOO);
   }
 
   @Test