chore: remove exhort_dev_mode and default endpoints and use value from environment variables or arguments

Author: soul2zimate

CONTRIBUTING.md

@@ -37,13 +37,13 @@
 
 ### Good to know
 
-* You can override the default backend url by setting the `TRUSTIFY_DA_DEV_MODE` environment variable/system property to true:
-  * In case environment variable/System Property `TRUSTIFY_DA_DEV_MODE=true` - You can Override the default trustify-dependency-analytics backend by setting  
-    `DEV_TRUSTIFY_DA_BACKEND_URL` env variable/system property to the desired trustify-dependency-analytics backend instance address ( useful for tests).
-  * In case `DEV_TRUSTIFY_DA_BACKEND_URL` is not set via environment variable/system property, then the default DEV trustify-dependency-analytics backend is picked.
-  * In case `TRUSTIFY_DA_DEV_MODE=false` or not set at all levels, then default backend url ( trustify-dependency-analytics prod) is picked, regardless of the value of `DEV_TRUSTIFY_DA_BACKEND_URL`.
-  * Environment variables takes precedence over System properties - for example, if System property `TRUSTIFY_DA_DEV_MODE=true`
-    but environment variable `TRUSTIFY_DA_DEV_MODE=false` , then default trustify-dependency-analytics prod will be used anyway.
+* Backend URL Configuration:
+  * The client can be configured to use custom backend URLs through:
+    * Command line argument: `--backend-url https://custom.backend.url`
+    * Environment variable: `TRUSTIFY_DA_BACKEND_URL=https://custom.backend.url`
+  * Priority order: Command line argument > Environment variable > Default production endpoint
+  * Default production endpoint: `https://rhda.rhcloud.com`
+  * For development scenarios, you may use: `https://exhort.stage.devshift.net`
 
 ### OpenAPI Specifications
 

README.md

@@ -142,9 +142,12 @@ import java.util.concurrent.CompletableFuture;
 
 public class TrustifyExample {
     public static void main(String... args) throws Exception {
-        // instantiate the Trustify DA Java Client implementation
+        // instantiate the Trustify DA Java Client implementation (uses default backend URL)
         var exhortApi = new ExhortApi();
 
+        // alternatively, specify custom backend URL
+        var customExhortApi = new ExhortApi("https://custom.backend.url");
+
         // get a byte array future holding a html Stack Analysis report
         CompletableFuture<byte[]> htmlStackReport = exhortApi.stackAnalysisHtml("/path/to/pom.xml");
 
@@ -155,7 +158,7 @@ public class TrustifyExample {
         // - (json) deserialized Stack Analysis report
         // - (html) html Stack Analysis report
         CompletableFuture<MixedReport> mixedStackReport = exhortApi.stackAnalysisMixed("/path/to/pom.xml");
-        
+
         // get a AnalysisReport future holding a deserialized Component Analysis report
         var manifestContent = Files.readAllBytes(Path.of("/path/to/pom.xml"));
         CompletableFuture<AnalysisReport> componentReport = exhortApi.componentAnalysis("/path/to/pom.xml", manifestContent);
@@ -590,25 +593,36 @@ java -jar target/trustify-da-java-client-cli.jar <COMMAND> <FILE_PATH> [OPTIONS]
 
 **Stack Analysis**
 ```shell
-java -jar trustify-da-java-client-cli.jar stack <file_path> [--summary|--html]
+java -jar trustify-da-java-client-cli.jar stack <file_path> [--summary|--html] [--backend-url <url>]
 ```
 Perform stack analysis on the specified manifest file.
 
 Options:
 - `--summary` - Output summary in JSON format
 - `--html` - Output full report in HTML format
+- `--backend-url <url>` - Custom backend URL for Trustify Dependency Analytics service
 - (default) - Output full report in JSON format
 
 **Component Analysis**
 ```shell
-java -jar trustify-da-java-client-cli.jar component <file_path> [--summary]
+java -jar trustify-da-java-client-cli.jar component <file_path> [--summary] [--backend-url <url>]
 ```
 Perform component analysis on the specified manifest file.
 
 Options:
 - `--summary` - Output summary in JSON format
+- `--backend-url <url>` - Custom backend URL for Trustify Dependency Analytics service
 - (default) - Output full report in JSON format
 
+#### Backend Configuration
+
+The client can be configured to use custom backend URLs through:
+
+- **Command line argument**: `--backend-url https://custom.backend.url`
+- **Environment variable**: `TRUSTIFY_DA_BACKEND_URL=https://custom.backend.url`
+
+Priority order: Command line argument > Environment variable > Default production endpoint (`https://rhda.rhcloud.com`)
+
 #### Examples
 
 ```shell
@@ -621,12 +635,21 @@ java -jar trustify-da-java-client-cli.jar stack /path/to/package.json --summary
 # Stack analysis with HTML output
 java -jar trustify-da-java-client-cli.jar stack /path/to/build.gradle --html
 
+# Stack analysis with custom backend URL
+java -jar trustify-da-java-client-cli.jar stack /path/to/pom.xml --backend-url https://custom.backend.url
+
 # Component analysis with JSON output (default)
 java -jar trustify-da-java-client-cli.jar component /path/to/requirements.txt
 
 # Component analysis with summary
 java -jar trustify-da-java-client-cli.jar component /path/to/go.mod --summary
 
+# Component analysis with custom backend URL
+java -jar trustify-da-java-client-cli.jar component /path/to/requirements.txt --backend-url https://custom.backend.url
+
+# Using environment variable for backend URL
+TRUSTIFY_DA_BACKEND_URL=https://custom.backend.url java -jar trustify-da-java-client-cli.jar stack /path/to/pom.xml
+
 # Show help
 java -jar trustify-da-java-client-cli.jar --help
 ```

src/main/java/io/github/guacsec/trustifyda/cli/App.java

@@ -81,15 +81,27 @@ private static CliArgs parseArgs(String[] args) {
     }
 
     Command command = parseCommand(args[0]);
-
     Path path = validateFile(args[1]);
-
     OutputFormat outputFormat = OutputFormat.JSON;
-    if (args.length == 3) {
-      outputFormat = parseOutputFormat(command, args[2]);
+    String backendUrl = null;
+
+    for (int i = 2; i < args.length; i++) {
+      String arg = args[i];
+      if (arg.startsWith("--backend-url=")) {
+        backendUrl = arg.substring("--backend-url=".length());
+        if (backendUrl.isEmpty()) {
+          throw new IllegalArgumentException("--backend-url requires a value");
+        }
+      } else if ("--backend-url".equals(arg) && i + 1 < args.length) {
+        backendUrl = args[++i];
+      } else if ("--backend-url".equals(arg)) {
+        throw new IllegalArgumentException("--backend-url requires a URL argument");
+      } else {
+        outputFormat = parseOutputFormat(command, arg);
+      }
     }
 
-    return new CliArgs(command, path, outputFormat);
+    return new CliArgs(command, path, outputFormat, backendUrl);
   }
 
   private static Command parseCommand(String commandStr) {
@@ -133,18 +145,19 @@ private static Path validateFile(String filePath) {
   private static CompletableFuture<String> executeCommand(CliArgs args) throws IOException {
     switch (args.command) {
       case STACK:
-        return executeStackAnalysis(args.filePath.toAbsolutePath().toString(), args.outputFormat);
+        return executeStackAnalysis(
+            args.filePath.toAbsolutePath().toString(), args.outputFormat, args.backendUrl);
       case COMPONENT:
         return executeComponentAnalysis(
-            args.filePath.toAbsolutePath().toString(), args.outputFormat);
+            args.filePath.toAbsolutePath().toString(), args.outputFormat, args.backendUrl);
       default:
         throw new AssertionError();
     }
   }
 
   private static CompletableFuture<String> executeStackAnalysis(
-      String filePath, OutputFormat outputFormat) throws IOException {
-    Api api = new ExhortApi();
+      String filePath, OutputFormat outputFormat, String backendUrl) throws IOException {
+    Api api = (backendUrl != null) ? new ExhortApi(backendUrl) : new ExhortApi();
     switch (outputFormat) {
       case JSON:
         return api.stackAnalysis(filePath).thenApply(App::toJsonString);
@@ -160,8 +173,8 @@ private static CompletableFuture<String> executeStackAnalysis(
   }
 
   private static CompletableFuture<String> executeComponentAnalysis(
-      String filePath, OutputFormat outputFormat) throws IOException {
-    Api api = new ExhortApi();
+      String filePath, OutputFormat outputFormat, String backendUrl) throws IOException {
+    Api api = (backendUrl != null) ? new ExhortApi(backendUrl) : new ExhortApi();
     CompletableFuture<AnalysisReport> analysis = api.componentAnalysis(filePath);
     if (outputFormat.equals(OutputFormat.SUMMARY)) {
       var summary = analysis.thenApply(App::extractSummary);

src/main/java/io/github/guacsec/trustifyda/cli/CliArgs.java

@@ -22,10 +22,12 @@ public class CliArgs {
   public final Command command;
   public final Path filePath;
   public final OutputFormat outputFormat;
+  public final String backendUrl;
 
-  public CliArgs(Command command, Path filePath, OutputFormat outputFormat) {
+  public CliArgs(Command command, Path filePath, OutputFormat outputFormat, String backendUrl) {
     this.command = command;
     this.filePath = filePath;
     this.outputFormat = outputFormat;
+    this.backendUrl = backendUrl;
   }
 }

src/main/java/io/github/guacsec/trustifyda/impl/ExhortApi.java

@@ -34,7 +34,6 @@
 import jakarta.mail.internet.MimeMultipart;
 import jakarta.mail.util.ByteArrayDataSource;
 import java.io.IOException;
-import java.io.InputStream;
 import java.net.InetSocketAddress;
 import java.net.ProxySelector;
 import java.net.URI;
@@ -51,7 +50,6 @@
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
-import java.util.Properties;
 import java.util.Set;
 import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
@@ -64,18 +62,14 @@
 /** Concrete implementation of the Exhort {@link Api} Service. */
 public final class ExhortApi implements Api {
 
-  private static final String DEV_TRUSTIFY_DA_BACKEND_URL = "DEV_TRUSTIFY_DA_BACKEND_URL";
-
-  private static final String TRUSTIFY_DA_DEV_MODE = "TRUSTIFY_DA_DEV_MODE";
-
   private static final String HTTP_VERSION_TRUSTIFY_DA_CLIENT = "HTTP_VERSION_TRUSTIFY_DA_CLIENT";
 
   private static final String TRUSTIFY_DA_PROXY_URL = "TRUSTIFY_DA_PROXY_URL";
 
   private static final Logger LOG = LoggersFactory.getLogger(ExhortApi.class.getName());
 
-  public static final String DEFAULT_ENDPOINT = "https://rhda.rhcloud.com";
-  public static final String DEFAULT_ENDPOINT_DEV = "https://exhort.stage.devshift.net";
+  private static final String TRUSTIFY_DA_BACKEND_URL = "TRUSTIFY_DA_BACKEND_URL";
+  private static final String DEFAULT_PROD_ENDPOINT = "https://rhda.rhcloud.com";
   public static final String TRUST_DA_TOKEN_HEADER = "trust-da-token";
   public static final String TRUST_DA_SOURCE_HEADER = "trust-da-source";
   public static final String TRUST_DA_OPERATION_TYPE_HEADER = "trust-da-operation-type";
@@ -97,7 +91,11 @@ public String getEndpoint() {
   private LocalDateTime endTime;
 
   public ExhortApi() {
-    this(createHttpClient());
+    this(createHttpClient(), null);
+  }
+
+  public ExhortApi(String backendUrl) {
+    this(createHttpClient(), backendUrl);
   }
 
   /**
@@ -113,40 +111,11 @@ static HttpClient.Version getHttpVersion() {
         : HttpClient.Version.HTTP_1_1;
   }
 
-  ExhortApi(final HttpClient client) {
-    //    // temp system property - as long as prod exhort url not implemented the multi-source v4
-    // endpoint, this
-    // property needs to be true
-    //    System.setProperty("TRUSTIFY_DA_DEV_MODE","true");
+  ExhortApi(final HttpClient client, final String backendUrl) {
     commonHookBeginning(true);
     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 (Environment.get(TRUSTIFY_DA_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(TRUSTIFY_DA_DEV_MODE, "false");
-        } else {
-          Properties properties = new Properties();
-          properties.load(exhortConfig);
-          System.setProperty(TRUSTIFY_DA_DEV_MODE, (String) properties.get(TRUSTIFY_DA_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(TRUSTIFY_DA_DEV_MODE, "false");
-      }
-    }
-
-    this.endpoint = getExhortUrl();
+    this.endpoint = getExhortUrl(backendUrl);
   }
 
   public static HttpClient createHttpClient() {
@@ -192,24 +161,35 @@ private static String getClientRequestId() {
     return RequestManager.getInstance().getTraceIdOfRequest();
   }
 
-  public String getExhortUrl() {
+  private String getExhortUrl(String backendUrl) {
     String endpoint;
-    if (Environment.getBoolean(TRUSTIFY_DA_DEV_MODE, false)) {
-      endpoint = Environment.get(DEV_TRUSTIFY_DA_BACKEND_URL, DEFAULT_ENDPOINT_DEV);
 
+    if (backendUrl != null && !backendUrl.trim().isEmpty()) {
+      endpoint = backendUrl.trim();
     } else {
-      endpoint = DEFAULT_ENDPOINT;
+      endpoint = Environment.get(TRUSTIFY_DA_BACKEND_URL, DEFAULT_PROD_ENDPOINT);
     }
+
     if (debugLoggingIsNeeded()) {
+      String source;
+      String sourceDetail;
+
+      if (backendUrl != null && !backendUrl.trim().isEmpty()) {
+        source = "CLI parameter";
+        sourceDetail = String.format("--backend-url=%s", backendUrl.trim());
+      } else if (Environment.get(TRUSTIFY_DA_BACKEND_URL) != null) {
+        source = "environment variable";
+        sourceDetail =
+            String.format("TRUSTIFY_DA_BACKEND_URL=%s", Environment.get(TRUSTIFY_DA_BACKEND_URL));
+      } else {
+        source = "default configuration";
+        sourceDetail = String.format("DEFAULT_PROD_ENDPOINT=%s", DEFAULT_PROD_ENDPOINT);
+      }
+
       LOG.info(
           String.format(
-              "TRUSTIFY_DA_DEV_MODE=%s,DEV_TRUSTIFY_DA_BACKEND_URL=%s, Chosen Backend URL=%s ,"
-                  + " DEFAULT_ENDPOINT_DEV=%s , DEFAULT_ENDPOINT=%s",
-              Environment.getBoolean(TRUSTIFY_DA_DEV_MODE, false),
-              Environment.get(DEV_TRUSTIFY_DA_BACKEND_URL, DEFAULT_ENDPOINT_DEV),
-              endpoint,
-              DEFAULT_ENDPOINT_DEV,
-              DEFAULT_ENDPOINT));
+              "Backend URL configured - Source: %s, Value: %s, Final endpoint: %s",
+              source, sourceDetail, endpoint));
     }
     return endpoint;
   }

src/main/resources/cli_help.txt

@@ -4,24 +4,32 @@ USAGE:
   java -jar trustify-da-java-client-cli.jar <COMMAND> <FILE_PATH> [OPTIONS]
 
 COMMANDS:
-  stack <file_path> [--summary|--html]
+  stack <file_path> [--summary|--html] [--backend-url <url>]
     Perform stack analysis on the specified manifest file
     Options:
       --summary    Output summary in JSON format
       --html       Output full report in HTML format
       (default)    Output full report in JSON format
 
-  component <file_path> [--summary]
+  component <file_path> [--summary] [--backend-url <url>]
     Perform component analysis on the specified manifest file
     Options:
       --summary    Output summary in JSON format
       (default)    Output full report in JSON format
 
 OPTIONS:
-  -h, --help     Show this help message
+  -h, --help                 Show this help message
+  --backend-url <url>        Specify custom backend URL
+                           Can also be set via TRUSTIFY_DA_BACKEND_URL environment variable
+                           Defaults to: https://rhda.rhcloud.com
+
+ENVIRONMENT VARIABLES:
+  TRUSTIFY_DA_BACKEND_URL    Backend URL for the Trustify Dependency Analytics service
 
 EXAMPLES:
   java -jar trustify-da-java-client-cli.jar stack /path/to/pom.xml
   java -jar trustify-da-java-client-cli.jar stack /path/to/package.json --summary
   java -jar trustify-da-java-client-cli.jar stack /path/to/build.gradle --html
   java -jar trustify-da-java-client-cli.jar component /path/to/requirements.txt
+  java -jar trustify-da-java-client-cli.jar stack /path/to/pom.xml --backend-url https://custom.backend.url
+  TRUSTIFY_DA_BACKEND_URL=https://custom.backend.url java -jar trustify-da-java-client-cli.jar stack /path/to/pom.xml