refactor: avoid mocking system.getenv

Signed-off-by: Ruben Romero Montes <rromerom@redhat.com>

Author: ruromero

src/main/java/com/redhat/exhort/image/ImageUtils.java

@@ -16,7 +16,6 @@
 package com.redhat.exhort.image;
 
 import static com.redhat.exhort.image.Platform.EMPTY_PLATFORM;
-import static com.redhat.exhort.impl.ExhortApi.getStringValueEnvironment;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JsonNode;
@@ -25,10 +24,10 @@
 import com.fasterxml.jackson.databind.node.TextNode;
 import com.github.packageurl.MalformedPackageURLException;
 import com.redhat.exhort.tools.Operations;
+import com.redhat.exhort.utils.Environment;
 import java.io.File;
 import java.io.IOException;
 import java.util.AbstractMap;
-import java.util.ArrayList;
 import java.util.Collections;
 import java.util.EnumSet;
 import java.util.List;
@@ -91,7 +90,7 @@ public class ImageUtils {
           new AbstractMap.SimpleEntry<>("aarch64", "v8"));
 
   static String updatePATHEnv(String execPath) {
-    String path = System.getenv("PATH");
+    String path = Environment.get("PATH");
     if (path != null) {
       return String.format("PATH=%s%s%s", path, File.pathSeparator, execPath);
     } else {
@@ -129,8 +128,8 @@ static Operations.ProcessExecOutput execSyft(ImageRef imageRef) {
     var docker = Operations.getCustomPathOrElse("docker");
     var podman = Operations.getCustomPathOrElse("podman");
 
-    var syftConfigPath = getStringValueEnvironment(EXHORT_SYFT_CONFIG_PATH, "");
-    var imageSource = getStringValueEnvironment(EXHORT_SYFT_IMAGE_SOURCE, "");
+    var syftConfigPath = Environment.get(EXHORT_SYFT_CONFIG_PATH, "");
+    var imageSource = Environment.get(EXHORT_SYFT_IMAGE_SOURCE, "");
     SyftImageSource.getImageSource(imageSource);
 
     var dockerPath =
@@ -195,29 +194,23 @@ static List<String> getSyftEnvs(String dockerPath, String podmanPath) {
     } else if (!podmanPath.isEmpty()) {
       path = podmanPath;
     }
-    var envPath = path != null ? updatePATHEnv(path) : null;
-
-    List<String> envs = new ArrayList<>(1);
-    if (envPath != null) {
-      envs.add(envPath);
-    }
-    return envs;
+    return path != null ? List.of(updatePATHEnv(path)) : Collections.emptyList();
   }
 
   public static Platform getImagePlatform() {
-    var platform = getStringValueEnvironment(EXHORT_IMAGE_PLATFORM, "");
+    var platform = Environment.get(EXHORT_IMAGE_PLATFORM, "");
     if (!platform.isEmpty()) {
       return new Platform(platform);
     }
 
-    var imageSource = getStringValueEnvironment(EXHORT_SYFT_IMAGE_SOURCE, "");
+    var imageSource = Environment.get(EXHORT_SYFT_IMAGE_SOURCE, "");
     SyftImageSource source = SyftImageSource.getImageSource(imageSource);
 
-    var os = getStringValueEnvironment(EXHORT_IMAGE_OS, "");
+    var os = Environment.get(EXHORT_IMAGE_OS, "");
     if (os.isEmpty()) {
       os = source.getOs();
     }
-    var arch = getStringValueEnvironment(EXHORT_IMAGE_ARCH, "");
+    var arch = Environment.get(EXHORT_IMAGE_ARCH, "");
     if (arch.isEmpty()) {
       arch = source.getArch();
     }
@@ -226,7 +219,7 @@ public static Platform getImagePlatform() {
         return new Platform(os, arch, null);
       }
 
-      var variant = getStringValueEnvironment(EXHORT_IMAGE_VARIANT, "");
+      var variant = Environment.get(EXHORT_IMAGE_VARIANT, "");
       if (variant.isEmpty()) {
         variant = source.getVariant();
       }
@@ -425,8 +418,8 @@ static Map<Platform, String> getSingleImageDigest(ImageRef imageRef)
   static Operations.ProcessExecOutput execSkopeoInspect(ImageRef imageRef, boolean raw) {
     var skopeo = Operations.getCustomPathOrElse("skopeo");
 
-    var configPath = getStringValueEnvironment(EXHORT_SKOPEO_CONFIG_PATH, "");
-    var daemonHost = getStringValueEnvironment(EXHORT_IMAGE_SERVICE_ENDPOINT, "");
+    var configPath = Environment.get(EXHORT_SKOPEO_CONFIG_PATH, "");
+    var daemonHost = Environment.get(EXHORT_IMAGE_SERVICE_ENDPOINT, "");
 
     String[] cmd;
     if (daemonHost.isEmpty()) {

src/main/java/com/redhat/exhort/impl/ExhortApi.java

@@ -28,6 +28,7 @@
 import com.redhat.exhort.image.ImageUtils;
 import com.redhat.exhort.logging.LoggersFactory;
 import com.redhat.exhort.tools.Ecosystem;
+import com.redhat.exhort.utils.Environment;
 import jakarta.mail.MessagingException;
 import jakarta.mail.internet.MimeMultipart;
 import jakarta.mail.util.ByteArrayDataSource;
@@ -61,6 +62,12 @@
 /** Concrete implementation of the Exhort {@link Api} Service. */
 public final class ExhortApi implements Api {
 
+  private static final String DEV_EXHORT_BACKEND_URL = "DEV_EXHORT_BACKEND_URL";
+
+  private static final String EXHORT_DEV_MODE = "EXHORT_DEV_MODE";
+
+  private static final String HTTP_VERSION_EXHORT_CLIENT = "HTTP_VERSION_EXHORT_CLIENT";
+
   private static final Logger LOG = LoggersFactory.getLogger(ExhortApi.class.getName());
 
   public static final String DEFAULT_ENDPOINT = "https://rhda.rhcloud.com";
@@ -126,8 +133,8 @@ public ExhortApi() {
    * @return i.e. HttpClient.Version.HTTP_1.1
    */
   static HttpClient.Version getHttpVersion() {
-    return (System.getenv("HTTP_VERSION_EXHORT_CLIENT") != null
-            && System.getenv("HTTP_VERSION_EXHORT_CLIENT").contains("2"))
+    var version = Environment.get(HTTP_VERSION_EXHORT_CLIENT);
+    return (version != null && version.contains("2"))
         ? HttpClient.Version.HTTP_2
         : HttpClient.Version.HTTP_1_1;
   }
@@ -141,27 +148,27 @@ static HttpClient.Version getHttpVersion() {
     this.client = client;
     this.mapper = new ObjectMapper().disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
     // Take default from config.properties in case client didn't override DEV MODE
-    if (System.getProperty("EXHORT_DEV_MODE") == null) {
+    if (Environment.get(EXHORT_DEV_MODE) == null) {
       try {
         InputStream exhortConfig =
             this.getClass().getClassLoader().getResourceAsStream("config.properties");
         if (exhortConfig == null) {
           LOG.info(
               "config.properties not found on the class path, fallback to default DEV MODE ="
                   + " false");
-          System.setProperty("EXHORT_DEV_MODE", "false");
+          System.setProperty(EXHORT_DEV_MODE, "false");
         } else {
           Properties properties = new Properties();
           properties.load(exhortConfig);
-          System.setProperty("EXHORT_DEV_MODE", (String) properties.get("EXHORT_DEV_MODE"));
+          System.setProperty(EXHORT_DEV_MODE, (String) properties.get(EXHORT_DEV_MODE));
         }
       } catch (IOException e) {
         LOG.info(
             String.format(
                 "Error loading config.properties , fallback to set default property DEV MODE ="
                     + " false, Error message = %s",
                 e.getMessage()));
-        System.setProperty("EXHORT_DEV_MODE", "false");
+        System.setProperty(EXHORT_DEV_MODE, "false");
       }
     }
 
@@ -198,8 +205,8 @@ private static String getClientRequestId() {
 
   public String getExhortUrl() {
     String endpoint;
-    if (getBooleanValueEnvironment("EXHORT_DEV_MODE", "false")) {
-      endpoint = getStringValueEnvironment("DEV_EXHORT_BACKEND_URL", DEFAULT_ENDPOINT_DEV);
+    if (Environment.getBoolean(EXHORT_DEV_MODE, false)) {
+      endpoint = Environment.get(DEV_EXHORT_BACKEND_URL, DEFAULT_ENDPOINT_DEV);
 
     } else {
       endpoint = DEFAULT_ENDPOINT;
@@ -209,29 +216,15 @@ public String getExhortUrl() {
           String.format(
               "EXHORT_DEV_MODE=%s,DEV_EXHORT_BACKEND_URL=%s, Chosen Backend URL=%s ,"
                   + " DEFAULT_ENDPOINT_DEV=%s , DEFAULT_ENDPOINT=%s",
-              getBooleanValueEnvironment("EXHORT_DEV_MODE", "false"),
-              getStringValueEnvironment("DEV_EXHORT_BACKEND_URL", DEFAULT_ENDPOINT_DEV),
+              Environment.getBoolean(EXHORT_DEV_MODE, false),
+              Environment.get(DEV_EXHORT_BACKEND_URL, DEFAULT_ENDPOINT_DEV),
               endpoint,
               DEFAULT_ENDPOINT_DEV,
               DEFAULT_ENDPOINT));
     }
     return endpoint;
   }
 
-  public static boolean getBooleanValueEnvironment(String key, String defaultValue) {
-    String result =
-        Objects.requireNonNullElse(
-            System.getenv(key), Objects.requireNonNullElse(System.getProperty(key), defaultValue));
-    return Boolean.parseBoolean(result.trim().toLowerCase());
-  }
-
-  public static String getStringValueEnvironment(String key, String defaultValue) {
-    String result =
-        Objects.requireNonNullElse(
-            System.getenv(key), Objects.requireNonNullElse(System.getProperty(key), defaultValue));
-    return result;
-  }
-
   @Override
   public CompletableFuture<MixedReport> stackAnalysisMixed(final String manifestFile)
       throws IOException {
@@ -390,7 +383,7 @@ private static void logExhortRequestId(HttpResponse<?> response) {
   }
 
   public static boolean debugLoggingIsNeeded() {
-    return Boolean.parseBoolean(getStringValueEnvironment("EXHORT_DEBUG", "false"));
+    return Environment.getBoolean("EXHORT_DEBUG", false);
   }
 
   @Override
@@ -639,20 +632,20 @@ private HttpRequest buildRequest(
     Stream.of(ExhortApi.TokenProvider.values())
         .forEach(
             p -> {
-              var envToken = System.getenv(p.getVarName());
+              var envToken = Environment.get(p.getVarName());
               if (Objects.nonNull(envToken)) {
                 request.setHeader(p.getHeaderName(), envToken);
               } else {
-                var propToken = System.getProperty(p.getVarName());
+                var propToken = Environment.get(p.getVarName());
                 if (Objects.nonNull(propToken)) {
                   request.setHeader(p.getHeaderName(), propToken);
                 }
               }
-              var envUser = System.getenv(p.getUserHeaderName());
+              var envUser = Environment.get(p.getUserHeaderName());
               if (Objects.nonNull(envUser)) {
                 request.setHeader(p.getUserHeaderName(), envUser);
               } else {
-                var propUser = System.getProperty(p.getUserVarName());
+                var propUser = Environment.get(p.getUserVarName());
                 if (Objects.nonNull(propUser)) {
                   request.setHeader(p.getUserHeaderName(), propUser);
                 }
@@ -685,11 +678,6 @@ private String calculateHeaderValue(String headerName) {
   }
 
   private String calculateHeaderValueActual(String headerName) {
-    String result = null;
-    result = System.getenv(headerName);
-    if (result == null) {
-      result = System.getProperty(headerName);
-    }
-    return result;
+    return Environment.get(headerName);
   }
 }

src/main/java/com/redhat/exhort/providers/GoModulesProvider.java

@@ -16,7 +16,6 @@
 package com.redhat.exhort.providers;
 
 import static com.redhat.exhort.impl.ExhortApi.debugLoggingIsNeeded;
-import static com.redhat.exhort.impl.ExhortApi.getBooleanValueEnvironment;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JsonMappingException;
@@ -29,6 +28,7 @@
 import com.redhat.exhort.sbom.SbomFactory;
 import com.redhat.exhort.tools.Ecosystem.Type;
 import com.redhat.exhort.tools.Operations;
+import com.redhat.exhort.utils.Environment;
 import com.redhat.exhort.vcs.GitVersionControlSystemImpl;
 import com.redhat.exhort.vcs.TagInfo;
 import com.redhat.exhort.vcs.VersionControlSystem;
@@ -129,7 +129,7 @@ Sbom getDependenciesSbom(Path manifestPath, boolean buildTree) throws IOExceptio
     Sbom sbom;
     List<PackageURL> ignoredDeps = getIgnoredDeps(manifestPath);
     boolean matchManifestVersions =
-        getBooleanValueEnvironment(Provider.PROP_MATCH_MANIFEST_VERSIONS, "false");
+        Environment.getBoolean(Provider.PROP_MATCH_MANIFEST_VERSIONS, false);
     if (matchManifestVersions) {
       String[] goModGraphLines = goModulesResult.split(System.lineSeparator());
       performManifestVersionsCheck(goModGraphLines, manifestPath);
@@ -281,8 +281,7 @@ private Sbom buildSbomFromGraph(
         startingIndex += deps.size();
       }
     }
-    boolean goMvsLogicEnabled =
-        getBooleanValueEnvironment(PROP_EXHORT_GO_MVS_LOGIC_ENABLED, "false");
+    boolean goMvsLogicEnabled = Environment.getBoolean(PROP_EXHORT_GO_MVS_LOGIC_ENABLED, false);
     if (goMvsLogicEnabled) {
       edges = getFinalPackagesVersionsForModule(edges, manifestPath);
     }

src/main/java/com/redhat/exhort/providers/JavaMavenProvider.java

@@ -21,12 +21,12 @@
 import com.github.packageurl.PackageURL;
 import com.redhat.exhort.Api;
 import com.redhat.exhort.Provider;
-import com.redhat.exhort.impl.ExhortApi;
 import com.redhat.exhort.logging.LoggersFactory;
 import com.redhat.exhort.sbom.Sbom;
 import com.redhat.exhort.sbom.SbomFactory;
 import com.redhat.exhort.tools.Ecosystem.Type;
 import com.redhat.exhort.tools.Operations;
+import com.redhat.exhort.utils.Environment;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
@@ -50,6 +50,7 @@
  */
 public final class JavaMavenProvider extends BaseJavaProvider {
 
+  private static final String PROP_JAVA_HOME = "JAVA_HOME";
   private Logger log = LoggersFactory.getLogger(this.getClass().getName());
 
   public JavaMavenProvider(Path manifest) {
@@ -303,9 +304,9 @@ private List<DependencyAggregator> getDependencies(final Path manifestPath) thro
   }
 
   Map<String, String> getMvnExecEnvs() {
-    var javaHome = ExhortApi.getStringValueEnvironment("JAVA_HOME", "");
+    var javaHome = Environment.get(PROP_JAVA_HOME);
     if (javaHome != null && !javaHome.isBlank()) {
-      return Collections.singletonMap("JAVA_HOME", javaHome);
+      return Collections.singletonMap(PROP_JAVA_HOME, javaHome);
     }
     return null;
   }

src/main/java/com/redhat/exhort/providers/JavaScriptNpmProvider.java

@@ -30,6 +30,7 @@
 import com.redhat.exhort.tools.Ecosystem;
 import com.redhat.exhort.tools.Ecosystem.Type;
 import com.redhat.exhort.tools.Operations;
+import com.redhat.exhort.utils.Environment;
 import java.io.File;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
@@ -48,6 +49,7 @@
  */
 public final class JavaScriptNpmProvider extends Provider {
 
+  private static final String PROP_PATH = "PATH";
   private System.Logger log = System.getLogger(this.getClass().getName());
 
   public JavaScriptNpmProvider(Path manifest) {
@@ -219,13 +221,13 @@ private List<String> getIgnoredDeps(Path manifestPath) throws IOException {
   }
 
   Map<String, String> getNpmExecEnv() {
-    String nodeHome = System.getProperty("NODE_HOME");
+    String nodeHome = Environment.get("NODE_HOME");
     if (nodeHome != null && !nodeHome.isBlank()) {
-      String path = System.getenv("PATH");
+      String path = Environment.get(PROP_PATH);
       if (path != null) {
-        return Collections.singletonMap("PATH", path + File.pathSeparator + nodeHome);
+        return Collections.singletonMap(PROP_PATH, path + File.pathSeparator + nodeHome);
       } else {
-        return Collections.singletonMap("PATH", nodeHome);
+        return Collections.singletonMap(PROP_PATH, nodeHome);
       }
     }
     return null;