Add test to PropertyDumpPlugin

Author: alban-auzeill

property-dump-plugin/pom.xml

@@ -33,9 +33,25 @@
       <version>1.7.30</version>
       <scope>provided</scope>
     </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter</artifactId>
+      <version>5.11.4</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.assertj</groupId>
+      <artifactId>assertj-core</artifactId>
+      <version>3.26.3</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.sonarsource.sonarqube</groupId>
+      <artifactId>sonar-plugin-api-impl</artifactId>
+      <version>25.3.0.104237</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
-
-
   <build>
     <plugins>
       <plugin>

property-dump-plugin/src/main/java/org/sonar/dump/PropertyDumpPlugin.java

@@ -24,7 +24,9 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.Arrays;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import java.util.Properties;
 import org.slf4j.Logger;
@@ -39,6 +41,18 @@ public class PropertyDumpPlugin implements Plugin, Sensor {
 
   private static final Logger LOG = LoggerFactory.getLogger(PropertyDumpPlugin.class);
 
+  // Visible for testing
+  final Map<String, String> environmentVariables;
+
+  // Visible for testing
+  final Properties systemProperties;
+
+  public PropertyDumpPlugin() {
+    environmentVariables = new HashMap<>(System.getenv());
+    systemProperties = new Properties();
+    systemProperties.putAll(System.getProperties());
+  }
+
   @Override
   public void define(Context context) {
     context.addExtension(this);
@@ -57,8 +71,8 @@ public void execute(SensorContext sensorContext) {
       var props = new Properties();
       Configuration config = sensorContext.config();
       getPropertyKeys("DUMP_SENSOR_PROPERTIES").forEach(key -> props.setProperty(key, nonNull(config.get(key))));
-      getPropertyKeys("DUMP_ENV_PROPERTIES").forEach(key -> props.setProperty(key, nonNull(System.getenv(key))));
-      getPropertyKeys("DUMP_SYSTEM_PROPERTIES").forEach(key -> props.setProperty(key, nonNull(System.getProperty(key, ""))));
+      getPropertyKeys("DUMP_ENV_PROPERTIES").forEach(key -> props.setProperty(key, nonNull(environmentVariables.get(key))));
+      getPropertyKeys("DUMP_SYSTEM_PROPERTIES").forEach(key -> props.setProperty(key, nonNull(systemProperties.getProperty(key, ""))));
       props.stringPropertyNames().forEach(key -> LOG.info("{}={}", key, props.getProperty(key)));
       try (OutputStream out = Files.newOutputStream(filePath)) {
         props.store(out, null);
@@ -78,8 +92,8 @@ private static String nonNull(Object value) {
     return "";
   }
 
-  private static List<String> getPropertyKeys(String envName) {
-    String list = System.getenv(envName);
+  private List<String> getPropertyKeys(String envName) {
+    String list = environmentVariables.get(envName);
     if (list == null) {
       return List.of();
     }

property-dump-plugin/src/test/java/org/sonar/dump/PropertyDumpPluginTest.java

@@ -0,0 +1,77 @@
+/*
+ * property-dump-plugin
+ * Copyright (C) 2009-2025 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.dump;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.List;
+import java.util.stream.Collectors;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+import org.sonar.api.batch.sensor.internal.SensorContextTester;
+
+import static java.nio.charset.StandardCharsets.UTF_8;
+import static org.assertj.core.api.Assertions.assertThat;
+
+class PropertyDumpPluginTest {
+
+  @Test
+  void test_plugin_execute(@TempDir Path workDir) throws IOException {
+    SensorContextTester sensorContext = SensorContextTester.create(Path.of("src", "test", "java"));
+    sensorContext.fileSystem().setWorkDir(workDir);
+    PropertyDumpPlugin plugin = new PropertyDumpPlugin();
+
+    // sensor properties
+    sensorContext.settings().setProperty("sonar.my-settings-prop", "my-value");
+
+    // environment variables
+    plugin.environmentVariables.put("MY_ENV1", "42");
+    plugin.environmentVariables.put("MY_ENV2", "666");
+
+    // system properties
+    plugin.systemProperties.setProperty("sonar.my-prop1", "Foo");
+    plugin.systemProperties.setProperty("sonar.my-prop2", "Bar");
+
+    // define which elements to dump
+    plugin.environmentVariables.put("DUMP_SENSOR_PROPERTIES", "sonar.my-settings-prop,sonar.unknown-settings-prop");
+    plugin.environmentVariables.put("DUMP_ENV_PROPERTIES", "MY_ENV1,MY_ENV2,UNKNOWN_ENV");
+    plugin.environmentVariables.put("DUMP_SYSTEM_PROPERTIES", "sonar.my-prop1,sonar.my-prop2,sonar.unknown-prop");
+
+    plugin.execute(sensorContext);
+
+    List<String> lines = Files.readAllLines(workDir.resolve("dumpSensor.system.properties"), UTF_8);
+    String result = lines.stream()
+      .filter(line -> !line.startsWith("#"))
+      .sorted()
+      .collect(Collectors.joining("\n"));
+
+    assertThat(result).isEqualTo("""
+      MY_ENV1=42
+      MY_ENV2=666
+      UNKNOWN_ENV=
+      sonar.my-prop1=Foo
+      sonar.my-prop2=Bar
+      sonar.my-settings-prop=my-value
+      sonar.unknown-prop=
+      sonar.unknown-settings-prop=""");
+  }
+
+}