chore: rename Exhort to Trustify DA

Author: soul2zimate

.github/workflows/pr.yml

@@ -49,8 +49,8 @@ jobs:
         echo "python-bin-location=$(echo $pythonLocation)/bin" >> $GITHUB_OUTPUT
     - name: Verify the project and create coverage report
       env:
-        EXHORT_PYTHON3_PATH: "${{steps.python-location.outputs.python-bin-location}}/python3"
-        EXHORT_PIP3_PATH: "${{steps.python-location.outputs.python-bin-location}}/pip3"
+        TRUSTIFY_DA_PYTHON3_PATH: "${{steps.python-location.outputs.python-bin-location}}/python3"
+        TRUSTIFY_DA_PIP3_PATH: "${{steps.python-location.outputs.python-bin-location}}/pip3"
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: |
         mvn verify -Pits,cov -B -ff

CONTRIBUTING.md

@@ -37,17 +37,17 @@
 
 ### Good to know
 
-* You can override the default backend url by setting the `EXHORT_DEV_MODE` environment variable/system property to true:
-  * In case environment variable/System Property `EXHORT_DEV_MODE=true` - You can Override the default exhort backend by setting  
-    `DEV_EXHORT_BACKEND_URL` env variable/system property to the desired exhort backend instance address ( useful for tests).
-  * In case `DEV_EXHORT_BACKEND_URL` is not set via environment variable/system property, then the default DEV exhort backend is picked.
-  * In case `EXHORT_DEV_MODE=false` or not set at all levels, then default backend url ( exhort prod) is picked, regardless of the value of `DEV_EXHORT_BACKEND_URL`.
-  * Environment variables takes precedence over System properties - for example, if System property `EXHORT_DEV_MODE=true`
-    but environment variable `EXHORT_DEV_MODE=false` , then default exhort prod will be used anyway.
+* 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.
 
 ### OpenAPI Specifications
 
-We use the Java generated library for the [Exhort OpenAPI spec][1] for deserialization of the Backend's
+We use the Java generated library for the [Trustify Dependency Analytics API Specification][1] for deserialization of the Backend's
 API responses.<br/>
 
 When the [Backend's spec file][1] is modified, a new
@@ -97,10 +97,10 @@ $ mvn clean verify -Pits,dev
 ```
 
 Integration tests are executed against a mocked _Backend_ server.<br/>
-If you need to run against the actual _Backend_ server, use the _EXHORT_ITS_USE_REAL_API_ environment variable:
+If you need to run against the actual _Backend_ server, use the _TRUSTIFY_DA_ITS_USE_REAL_API_ environment variable:
 
 ```shell
-EXHORT_ITS_USE_REAL_API=true mvn clean verify -Pits
+TRUSTIFY_DA_ITS_USE_REAL_API=true mvn clean verify -Pits
 ```
 
 > TIP: When working on a new integration test project, it's helpful opening the IDE directly in the test project folder.
@@ -114,7 +114,7 @@ contribution. See the [DCO](DCO) file for details.
 
 <!-- Real links -->
 [0]: https://www.conventionalcommits.org/en/v1.0.0/
-[1]: https://github.com/guacsec/trustify-da-api-spec/blob/main/api/v4/openapi.yaml
+[1]: https://github.com/guacsec/trustify-da-api-spec/blob/main/api/v5/openapi.yaml
 
 <!-- Badge links -->
 [10]: https://badgen.net/badge/Java%20Version/11/5382a1

README.md

@@ -40,14 +40,14 @@
 
 public class ImageUtils {
 
-  static final String EXHORT_SYFT_CONFIG_PATH = "EXHORT_SYFT_CONFIG_PATH";
-  static final String EXHORT_SYFT_IMAGE_SOURCE = "EXHORT_SYFT_IMAGE_SOURCE";
-  static final String EXHORT_IMAGE_PLATFORM = "EXHORT_IMAGE_PLATFORM";
-  static final String EXHORT_IMAGE_OS = "EXHORT_IMAGE_OS";
-  static final String EXHORT_IMAGE_ARCH = "EXHORT_IMAGE_ARCH";
-  static final String EXHORT_IMAGE_VARIANT = "EXHORT_IMAGE_VARIANT";
-  static final String EXHORT_SKOPEO_CONFIG_PATH = "EXHORT_SKOPEO_CONFIG_PATH";
-  static final String EXHORT_IMAGE_SERVICE_ENDPOINT = "EXHORT_IMAGE_SERVICE_ENDPOINT";
+  static final String TRUSTIFY_DA_SYFT_CONFIG_PATH = "TRUSTIFY_DA_SYFT_CONFIG_PATH";
+  static final String TRUSTIFY_DA_SYFT_IMAGE_SOURCE = "TRUSTIFY_DA_SYFT_IMAGE_SOURCE";
+  static final String TRUSTIFY_DA_IMAGE_PLATFORM = "TRUSTIFY_DA_IMAGE_PLATFORM";
+  static final String TRUSTIFY_DA_IMAGE_OS = "TRUSTIFY_DA_IMAGE_OS";
+  static final String TRUSTIFY_DA_IMAGE_ARCH = "TRUSTIFY_DA_IMAGE_ARCH";
+  static final String TRUSTIFY_DA_IMAGE_VARIANT = "TRUSTIFY_DA_IMAGE_VARIANT";
+  static final String TRUSTIFY_DA_SKOPEO_CONFIG_PATH = "TRUSTIFY_DA_SKOPEO_CONFIG_PATH";
+  static final String TRUSTIFY_DA_IMAGE_SERVICE_ENDPOINT = "TRUSTIFY_DA_IMAGE_SERVICE_ENDPOINT";
   private static final String MEDIA_TYPE_DOCKER2_MANIFEST =
       "application/vnd.docker.distribution.manifest.v2+json";
   private static final String MEDIA_TYPE_DOCKER2_MANIFEST_LIST =
@@ -135,8 +135,8 @@ static Operations.ProcessExecOutput execSyft(ImageRef imageRef) {
     var docker = Operations.getCustomPathOrElse(DOCKER);
     var podman = Operations.getCustomPathOrElse(PODMAN);
 
-    var syftConfigPath = Environment.get(EXHORT_SYFT_CONFIG_PATH, "");
-    var imageSource = Environment.get(EXHORT_SYFT_IMAGE_SOURCE, "");
+    var syftConfigPath = Environment.get(TRUSTIFY_DA_SYFT_CONFIG_PATH, "");
+    var imageSource = Environment.get(TRUSTIFY_DA_SYFT_IMAGE_SOURCE, "");
     SyftImageSource.getImageSource(imageSource);
 
     var dockerPath =
@@ -205,19 +205,19 @@ static List<String> getSyftEnvs(String dockerPath, String podmanPath) {
   }
 
   public static Platform getImagePlatform() {
-    var platform = Environment.get(EXHORT_IMAGE_PLATFORM, "");
+    var platform = Environment.get(TRUSTIFY_DA_IMAGE_PLATFORM, "");
     if (!platform.isEmpty()) {
       return new Platform(platform);
     }
 
-    var imageSource = Environment.get(EXHORT_SYFT_IMAGE_SOURCE, "");
+    var imageSource = Environment.get(TRUSTIFY_DA_SYFT_IMAGE_SOURCE, "");
     SyftImageSource source = SyftImageSource.getImageSource(imageSource);
 
-    var os = Environment.get(EXHORT_IMAGE_OS, "");
+    var os = Environment.get(TRUSTIFY_DA_IMAGE_OS, "");
     if (os.isEmpty()) {
       os = source.getOs();
     }
-    var arch = Environment.get(EXHORT_IMAGE_ARCH, "");
+    var arch = Environment.get(TRUSTIFY_DA_IMAGE_ARCH, "");
     if (arch.isEmpty()) {
       arch = source.getArch();
     }
@@ -226,7 +226,7 @@ public static Platform getImagePlatform() {
         return new Platform(os, arch, null);
       }
 
-      var variant = Environment.get(EXHORT_IMAGE_VARIANT, "");
+      var variant = Environment.get(TRUSTIFY_DA_IMAGE_VARIANT, "");
       if (variant.isEmpty()) {
         variant = source.getVariant();
       }
@@ -425,8 +425,8 @@ static Map<Platform, String> getSingleImageDigest(ImageRef imageRef)
   static Operations.ProcessExecOutput execSkopeoInspect(ImageRef imageRef, boolean raw) {
     var skopeo = Operations.getExecutable(SKOPEO, ARG_VERSION);
 
-    var configPath = Environment.get(EXHORT_SKOPEO_CONFIG_PATH, "");
-    var daemonHost = Environment.get(EXHORT_IMAGE_SERVICE_ENDPOINT, "");
+    var configPath = Environment.get(TRUSTIFY_DA_SKOPEO_CONFIG_PATH, "");
+    var daemonHost = Environment.get(TRUSTIFY_DA_IMAGE_SERVICE_ENDPOINT, "");
 
     String[] cmd;
     if (daemonHost.isEmpty()) {

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

@@ -65,13 +65,13 @@
 /** 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 DEV_TRUSTIFY_DA_BACKEND_URL = "DEV_TRUSTIFY_DA_BACKEND_URL";
 
-  private static final String EXHORT_DEV_MODE = "EXHORT_DEV_MODE";
+  private static final String TRUSTIFY_DA_DEV_MODE = "TRUSTIFY_DA_DEV_MODE";
 
-  private static final String HTTP_VERSION_EXHORT_CLIENT = "HTTP_VERSION_EXHORT_CLIENT";
+  private static final String HTTP_VERSION_TRUSTIFY_DA_CLIENT = "HTTP_VERSION_TRUSTIFY_DA_CLIENT";
 
-  private static final String EXHORT_PROXY_URL = "EXHORT_PROXY_URL";
+  private static final String TRUSTIFY_DA_PROXY_URL = "TRUSTIFY_DA_PROXY_URL";
 
   private static final Logger LOG = LoggersFactory.getLogger(ExhortApi.class.getName());
 
@@ -80,7 +80,7 @@ public final class ExhortApi implements Api {
   public static final String RHDA_TOKEN_HEADER = "rhda-token";
   public static final String RHDA_SOURCE_HEADER = "rhda-source";
   public static final String RHDA_OPERATION_TYPE_HEADER = "rhda-operation-type";
-  public static final String EXHORT_REQUEST_ID_HEADER_NAME = "ex-request-id";
+  public static final String TRUSTIFY_DA_REQUEST_ID_HEADER_NAME = "ex-request-id";
 
   private final String endpoint;
 
@@ -96,14 +96,14 @@ private enum TokenProvider {
     /**
      * Get the expected environment variable name.
      *
-     * @return i.e. EXHORT_SNYK_TOKEN
+     * @return i.e. TRUSTIFY_DA_SNYK_TOKEN
      */
     String getVarName() {
-      return String.format("EXHORT_%s_TOKEN", this);
+      return String.format("TRUSTIFY_DA_%s_TOKEN", this);
     }
 
     String getUserVarName() {
-      return String.format("EXHORT_%s_USER", this);
+      return String.format("TRUSTIFY_DA_%s_USER", this);
     }
 
     /**
@@ -138,7 +138,7 @@ public ExhortApi() {
    * @return i.e. HttpClient.Version.HTTP_1.1
    */
   static HttpClient.Version getHttpVersion() {
-    var version = Environment.get(HTTP_VERSION_EXHORT_CLIENT);
+    var version = Environment.get(HTTP_VERSION_TRUSTIFY_DA_CLIENT);
     return (version != null && version.contains("2"))
         ? HttpClient.Version.HTTP_2
         : HttpClient.Version.HTTP_1_1;
@@ -148,32 +148,32 @@ static HttpClient.Version getHttpVersion() {
     //    // temp system property - as long as prod exhort url not implemented the multi-source v4
     // endpoint, this
     // property needs to be true
-    //    System.setProperty("EXHORT_DEV_MODE","true");
+    //    System.setProperty("TRUSTIFY_DA_DEV_MODE","true");
     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(EXHORT_DEV_MODE) == null) {
+    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(EXHORT_DEV_MODE, "false");
+          System.setProperty(TRUSTIFY_DA_DEV_MODE, "false");
         } else {
           Properties properties = new Properties();
           properties.load(exhortConfig);
-          System.setProperty(EXHORT_DEV_MODE, (String) properties.get(EXHORT_DEV_MODE));
+          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(EXHORT_DEV_MODE, "false");
+        System.setProperty(TRUSTIFY_DA_DEV_MODE, "false");
       }
     }
 
@@ -182,14 +182,14 @@ static HttpClient.Version getHttpVersion() {
 
   public static HttpClient createHttpClient() {
     HttpClient.Builder builder = HttpClient.newBuilder().version(getHttpVersion());
-    String proxyUrl = Environment.get(EXHORT_PROXY_URL);
+    String proxyUrl = Environment.get(TRUSTIFY_DA_PROXY_URL);
     if (proxyUrl != null && !proxyUrl.isBlank()) {
       try {
         URI proxyUri = URI.create(proxyUrl);
         builder.proxy(
             ProxySelector.of(new InetSocketAddress(proxyUri.getHost(), proxyUri.getPort())));
       } catch (IllegalArgumentException e) {
-        LOG.warning("Invalid EXHORT_PROXY_URL: " + proxyUrl + ", using direct connection");
+        LOG.warning("Invalid TRUSTIFY_DA_PROXY_URL: " + proxyUrl + ", using direct connection");
       }
     }
     return builder.build();
@@ -225,19 +225,19 @@ private static String getClientRequestId() {
 
   public String getExhortUrl() {
     String endpoint;
-    if (Environment.getBoolean(EXHORT_DEV_MODE, false)) {
-      endpoint = Environment.get(DEV_EXHORT_BACKEND_URL, DEFAULT_ENDPOINT_DEV);
+    if (Environment.getBoolean(TRUSTIFY_DA_DEV_MODE, false)) {
+      endpoint = Environment.get(DEV_TRUSTIFY_DA_BACKEND_URL, DEFAULT_ENDPOINT_DEV);
 
     } else {
       endpoint = DEFAULT_ENDPOINT;
     }
     if (debugLoggingIsNeeded()) {
       LOG.info(
           String.format(
-              "EXHORT_DEV_MODE=%s,DEV_EXHORT_BACKEND_URL=%s, Chosen Backend URL=%s ,"
+              "TRUSTIFY_DA_DEV_MODE=%s,DEV_TRUSTIFY_DA_BACKEND_URL=%s, Chosen Backend URL=%s ,"
                   + " DEFAULT_ENDPOINT_DEV=%s , DEFAULT_ENDPOINT=%s",
-              Environment.getBoolean(EXHORT_DEV_MODE, false),
-              Environment.get(DEV_EXHORT_BACKEND_URL, DEFAULT_ENDPOINT_DEV),
+              Environment.getBoolean(TRUSTIFY_DA_DEV_MODE, false),
+              Environment.get(DEV_TRUSTIFY_DA_BACKEND_URL, DEFAULT_ENDPOINT_DEV),
               endpoint,
               DEFAULT_ENDPOINT_DEV,
               DEFAULT_ENDPOINT));
@@ -392,7 +392,7 @@ private AnalysisReport getAnalysisReportFromResponse(
 
   private static void logExhortRequestId(HttpResponse<?> response) {
     Optional<String> headerExRequestId =
-        response.headers().allValues(EXHORT_REQUEST_ID_HEADER_NAME).stream().findFirst();
+        response.headers().allValues(TRUSTIFY_DA_REQUEST_ID_HEADER_NAME).stream().findFirst();
     headerExRequestId.ifPresent(
         value ->
             LOG.info(
@@ -403,7 +403,7 @@ private static void logExhortRequestId(HttpResponse<?> response) {
   }
 
   public static boolean debugLoggingIsNeeded() {
-    return Environment.getBoolean("EXHORT_DEBUG", false);
+    return Environment.getBoolean("TRUSTIFY_DA_DEBUG", false);
   }
 
   @Override

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

@@ -51,7 +51,8 @@
  */
 public final class GoModulesProvider extends Provider {
 
-  public static final String PROP_EXHORT_GO_MVS_LOGIC_ENABLED = "EXHORT_GO_MVS_LOGIC_ENABLED";
+  public static final String PROP_TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED =
+      "TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED";
   private static final Logger log = LoggersFactory.getLogger(GoModulesProvider.class.getName());
   public static final String DEFAULT_MAIN_VERSION = "v0.0.0";
   private final String goExecutable;
@@ -277,7 +278,7 @@ private Sbom buildSbomFromGraph(
         startingIndex += deps.size();
       }
     }
-    boolean goMvsLogicEnabled = Environment.getBoolean(PROP_EXHORT_GO_MVS_LOGIC_ENABLED, true);
+    boolean goMvsLogicEnabled = Environment.getBoolean(PROP_TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED, true);
     if (goMvsLogicEnabled) {
       edges = getFinalPackagesVersionsForModule(edges, manifestPath);
     }

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

@@ -222,7 +222,7 @@ private String extractPackageName(String line) {
 
   private Path getDependencies(Path manifestPath) throws IOException {
     // create a temp file for storing the dependency tree in
-    var tempFile = Files.createTempFile("exhort_graph_", null);
+    var tempFile = Files.createTempFile("TRUSTIFY_DA_graph_", null);
     // the command will create the dependency tree in the temp file
     String gradleCommand = gradleExecutable + " dependencies";
 

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

@@ -72,7 +72,7 @@ public Content provideStack() throws IOException {
     // execute the clean command
     Operations.runProcess(manifest.getParent(), mvnCleanCmd.toArray(String[]::new), mvnEnvs);
     // create a temp file for storing the dependency tree in
-    var tmpFile = Files.createTempFile("exhort_dot_graph_", null);
+    var tmpFile = Files.createTempFile("TRUSTIFY_DA_dot_graph_", null);
     // the tree command will build the project and create the dependency tree in the temp file
     var mvnTreeCmd =
         buildMvnCommandArgs(
@@ -128,7 +128,7 @@ public Content provideComponent() throws IOException {
   }
 
   private Content generateSbomFromEffectivePom() throws IOException {
-    var tmpEffPom = Files.createTempFile("exhort_eff_pom_", ".xml");
+    var tmpEffPom = Files.createTempFile("TRUSTIFY_DA_eff_pom_", ".xml");
     var mvnEffPomCmd =
         buildMvnCommandArgs(
             "clean",

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

@@ -211,14 +211,16 @@ private PackageURL toPurl(String name, String version) {
   private PythonControllerBase getPythonController() {
     String pythonPipBinaries;
     boolean useVirtualPythonEnv;
-    if (!Environment.get(PythonControllerBase.PROP_EXHORT_PIP_SHOW, "").trim().isEmpty()
-        && !Environment.get(PythonControllerBase.PROP_EXHORT_PIP_FREEZE, "").trim().isEmpty()) {
+    if (!Environment.get(PythonControllerBase.PROP_TRUSTIFY_DA_PIP_SHOW, "").trim().isEmpty()
+        && !Environment.get(PythonControllerBase.PROP_TRUSTIFY_DA_PIP_FREEZE, "")
+            .trim()
+            .isEmpty()) {
       pythonPipBinaries = "python;;pip";
       useVirtualPythonEnv = false;
     } else {
       pythonPipBinaries = getExecutable("python", "--version");
       useVirtualPythonEnv =
-          Environment.getBoolean(PythonControllerBase.PROP_EXHORT_PYTHON_VIRTUAL_ENV, false);
+          Environment.getBoolean(PythonControllerBase.PROP_TRUSTIFY_DA_PYTHON_VIRTUAL_ENV, false);
     }
 
     String[] parts = pythonPipBinaries.split(";;");

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

@@ -45,7 +45,7 @@
 
 public class CycloneDXSbom implements Sbom {
 
-  private static final String EXHORT_IGNORE_METHOD = "EXHORT_IGNORE_METHOD";
+  private static final String TRUSTIFY_DA_IGNORE_METHOD = "TRUSTIFY_DA_IGNORE_METHOD";
   private final Logger log = LoggersFactory.getLogger(this.getClass().getName());
   private static final Version VERSION = Version.VERSION_14;
   private String exhortIgnoreMethod;
@@ -120,7 +120,7 @@ public <T> Sbom filterIgnoredDeps(Collection<T> ignoredDeps) {
   }
 
   private String getExhortIgnoreMethod() {
-    var val = Environment.get(EXHORT_IGNORE_METHOD);
+    var val = Environment.get(TRUSTIFY_DA_IGNORE_METHOD);
     return val != null ? val.trim().toLowerCase() : null;
   }