chore: remove SNYK and OSS_INDEX refs

Author: soul2zimate

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

@@ -60,7 +60,6 @@
 import java.util.function.Supplier;
 import java.util.logging.Logger;
 import java.util.stream.Collectors;
-import java.util.stream.Stream;
 
 /** Concrete implementation of the Exhort {@link Api} Service. */
 public final class ExhortApi implements Api {
@@ -88,38 +87,6 @@ public String getEndpoint() {
     return endpoint;
   }
 
-  /** Enum for identifying token environment variables and their corresponding request headers. */
-  private enum TokenProvider {
-    SNYK,
-    OSS_INDEX;
-
-    /**
-     * Get the expected environment variable name.
-     *
-     * @return i.e. TRUSTIFY_DA_SNYK_TOKEN
-     */
-    String getVarName() {
-      return String.format("TRUSTIFY_DA_%s_TOKEN", this);
-    }
-
-    String getUserVarName() {
-      return String.format("TRUSTIFY_DA_%s_USER", this);
-    }
-
-    /**
-     * Get the expected request header name.
-     *
-     * @return i.e. ex-snyk-token
-     */
-    String getHeaderName() {
-      return String.format("ex-%s-token", this.toString().replace("_", "-").toLowerCase());
-    }
-
-    String getUserHeaderName() {
-      return String.format("ex-%s-user", this.toString().replace("_", "-").toLowerCase());
-    }
-  }
-
   private final HttpClient client;
   private final ObjectMapper mapper;
 
@@ -648,29 +615,6 @@ private HttpRequest buildRequest(
             .setHeader("Content-Type", content.type)
             .POST(HttpRequest.BodyPublishers.ofString(new String(content.buffer)));
 
-    // include tokens from environment variables of java properties as request headers
-    Stream.of(ExhortApi.TokenProvider.values())
-        .forEach(
-            p -> {
-              var envToken = Environment.get(p.getVarName());
-              if (Objects.nonNull(envToken)) {
-                request.setHeader(p.getHeaderName(), envToken);
-              } else {
-                var propToken = Environment.get(p.getVarName());
-                if (Objects.nonNull(propToken)) {
-                  request.setHeader(p.getHeaderName(), propToken);
-                }
-              }
-              var envUser = Environment.get(p.getUserHeaderName());
-              if (Objects.nonNull(envUser)) {
-                request.setHeader(p.getUserHeaderName(), envUser);
-              } else {
-                var propUser = Environment.get(p.getUserVarName());
-                if (Objects.nonNull(propUser)) {
-                  request.setHeader(p.getUserHeaderName(), propUser);
-                }
-              }
-            });
     // set trust-da-token
     // Environment variable/property name = TRUST_DA_TOKEN
     String trustDaToken = calculateHeaderValue(TRUST_DA_TOKEN_HEADER);

src/main/resources/exhort/openapi.yaml

@@ -20,20 +20,13 @@ paths:
       summary:  Takes a client-resolved dependency graph to perform a full stack analysis from all the available Vulnerability sources
       security:
         - TrustDaTokenAuth: []
-        - SnykTokenAuth: []
-        - OssIndexUserAuth: []
-          OssIndexTokenAuth: []
       parameters:
         - name: providers
           in: query
           description: List of vulnerability providers to get the report from
           required: false
           schema:
-            enum:
-              - snyk
-              - oss-index
             type: string
-          example: snyk
       requestBody:
         required: true
         description: Dependency graph in SBOM format
@@ -75,20 +68,13 @@ paths:
       summary: Takes an array of client-resolved dependency graphs to perform a full stack analysis from all the available Vulnerability sources
       security:
         - TrustDaTokenAuth: [ ]
-        - SnykTokenAuth: [ ]
-        - OssIndexUserAuth: [ ]
-          OssIndexTokenAuth: [ ]
       parameters:
         - name: providers
           in: query
           description: List of vulnerability providers to get the report from
           required: false
           schema:
-            enum:
-              - snyk
-              - oss-index
             type: string
-          example: snyk
       requestBody:
         required: true
         description: An array of dependency graphs in SBOM format
@@ -138,9 +124,6 @@ paths:
       summary: Validates a vulnerability provider token
       security:
         - TrustDaTokenAuth: []
-        - SnykTokenAuth: []
-        - OssIndexUserAuth: []
-          OssIndexTokenAuth: []
       responses:
         '200':
           description: Successful token validation
@@ -184,18 +167,6 @@ components:
       type: apiKey
       in: header
       name: trust-da-token
-    SnykTokenAuth:
-      type: apiKey
-      in: header
-      name: ex-snyk-token
-    OssIndexUserAuth:
-      type: apiKey
-      in: header
-      name: ex-oss-index-name
-    OssIndexTokenAuth:
-      type: apiKey
-      in: header
-      name: ex-oss-index-token
   schemas:
     AnalysisReport:
       type: object

src/test/java/com/redhat/exhort/impl/Exhort_Api_Test.java

@@ -66,7 +66,6 @@
 import java.util.function.Function;
 import java.util.function.Supplier;
 import java.util.stream.Collectors;
-import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.junitpioneer.jupiter.ClearSystemProperty;
@@ -80,7 +79,6 @@
 import org.mockito.junit.jupiter.MockitoExtension;
 
 @ExtendWith(MockitoExtension.class)
-@ClearSystemProperty(key = "TRUSTIFY_DA_SNYK_TOKEN")
 @ClearSystemProperty(key = "TRUSTIFY_DA_DEV_MODE")
 @ClearSystemProperty(key = "TRUSTIFY_DA_PROXY_URL")
 @ClearSystemProperty(key = "DEV_TRUSTIFY_DA_BACKEND_URL")
@@ -95,13 +93,7 @@ class TRUSTIFY_DA_Api_Test extends ExhortTest {
 
   @InjectMocks ExhortApi exhortApiSut;
 
-  @AfterEach
-  void cleanup() {
-    System.clearProperty("TRUSTIFY_DA_SNYK_TOKEN");
-  }
-
   @Test
-  @SetSystemProperty(key = "TRUSTIFY_DA_SNYK_TOKEN", value = "snyk-token-from-env-var")
   @SetSystemProperty(key = "TRUST_DA_TOKEN", value = "trust-da-token-from-env-var")
   @SetSystemProperty(key = "TRUST_DA_SOURCE", value = "trust-da-source-from-env-var")
   void stackAnalysisHtml_with_pom_xml_should_return_html_report_from_the_backend()
@@ -122,9 +114,6 @@ void stackAnalysisHtml_with_pom_xml_should_return_html_report_from_the_backend()
         r ->
             r.headers().firstValue("Content-Type").get().equals("fake-content-type")
                 && r.headers().firstValue("Accept").get().equals("text/html")
-                &&
-                // snyk token is set using the environment variable (annotation)
-                r.headers().firstValue("ex-snyk-token").get().equals("snyk-token-from-env-var")
                 && r.headers()
                     .firstValue("trust-da-token")
                     .get()
@@ -168,7 +157,6 @@ void stackAnalysisHtml_with_pom_xml_should_return_html_report_from_the_backend()
   }
 
   @Test
-  @SetSystemProperty(key = "TRUSTIFY_DA_SNYK_TOKEN", value = "snyk-token")
   @SetSystemProperty(key = "TRUST_DA_TOKEN", value = "trust-da-token")
   @SetSystemProperty(key = "TRUST_DA_SOURCE", value = "trust-da-source")
   void stackAnalysis_with_pom_xml_should_return_json_object_from_the_backend()
@@ -189,7 +177,6 @@ void stackAnalysis_with_pom_xml_should_return_json_object_from_the_backend()
         r ->
             r.headers().firstValue("Content-Type").get().equals("fake-content-type")
                 && r.headers().firstValue("Accept").get().equals("application/json")
-                && r.headers().firstValue("ex-snyk-token").get().equals("snyk-token")
                 && r.headers().firstValue("trust-da-token").get().equals("trust-da-token")
                 && r.headers().firstValue("trust-da-source").get().equals("trust-da-source")
                 && r.headers().firstValue("trust-da-operation-type").get().equals("Stack Analysis")
@@ -244,7 +231,6 @@ void componentAnalysis_with_pom_xml_should_return_json_object_from_the_backend()
         .willReturn(new Provider.Content("fake-body-content".getBytes(), "fake-content-type"));
 
     // we expect this to picked up because no env var to take precedence
-    System.setProperty("TRUSTIFY_DA_SNYK_TOKEN", "snyk-token-from-property");
     System.setProperty("TRUST_DA_TOKEN", "trust-da-token-from-property");
     System.setProperty("TRUST_DA_SOURCE", "trust-da-source-from-property");
 
@@ -253,10 +239,6 @@ void componentAnalysis_with_pom_xml_should_return_json_object_from_the_backend()
         r ->
             r.headers().firstValue("Content-Type").get().equals("fake-content-type")
                 && r.headers().firstValue("Accept").get().equals("application/json")
-                &&
-                // snyk token is set using properties which is picked up because no env var
-                // specified
-                r.headers().firstValue("ex-snyk-token").get().equals("snyk-token-from-property")
                 && r.headers()
                     .firstValue("trust-da-token")
                     .get()
@@ -388,17 +370,12 @@ void componentAnalysis_with_pom_xml_as_path_should_return_json_object_from_the_b
         .willReturn(new Provider.Content("fake-body-content".getBytes(), "fake-content-type"));
 
     // we expect this to picked up because no env var to take precedence
-    System.setProperty("TRUSTIFY_DA_SNYK_TOKEN", "snyk-token-from-property");
 
     // create an argument matcher to make sure we mock the response for the right request
     ArgumentMatcher<HttpRequest> matchesRequest =
         r ->
             r.headers().firstValue("Content-Type").get().equals("fake-content-type")
                 && r.headers().firstValue("Accept").get().equals("application/json")
-                &&
-                // snyk token is set using properties which is picked up because no env var
-                // specified
-                r.headers().firstValue("ex-snyk-token").get().equals("snyk-token-from-property")
                 && r.method().equals("POST");
 
     // load dummy json and set as the expected analysis
@@ -472,7 +449,6 @@ void check_TRUSTIFY_DA_Url_When_Nothing_Set_Then_Default_TRUSTIFY_DA_URL_Selecte
   }
 
   @Test
-  @SetSystemProperty(key = "TRUSTIFY_DA_SNYK_TOKEN", value = "snyk-token-from-env-var")
   @SetSystemProperty(key = "TRUST_DA_TOKEN", value = "trust-da-token-from-env-var")
   @SetSystemProperty(key = "TRUST_DA_SOURCE", value = "trust-da-source-from-env-var")
   @SetSystemProperty(key = SKIP_VALIDATION_KEY, value = "true")
@@ -536,7 +512,6 @@ void test_image_analysis()
                       .firstValue("Accept")
                       .get()
                       .equals(Api.MediaType.APPLICATION_JSON.toString())
-                  && r.headers().firstValue("ex-snyk-token").get().equals("snyk-token-from-env-var")
                   && r.headers()
                       .firstValue("trust-da-token")
                       .get()
@@ -581,7 +556,6 @@ void test_image_analysis()
   }
 
   @Test
-  @SetSystemProperty(key = "TRUSTIFY_DA_SNYK_TOKEN", value = "snyk-token-from-env-var")
   @SetSystemProperty(key = "TRUST_DA_TOKEN", value = "trust-da-token-from-env-var")
   @SetSystemProperty(key = "TRUST_DA_SOURCE", value = "trust-da-source-from-env-var")
   @SetSystemProperty(key = SKIP_VALIDATION_KEY, value = "true")
@@ -644,7 +618,6 @@ void imageAnalysisHtml() throws IOException, ExecutionException, InterruptedExce
                       .firstValue("Accept")
                       .get()
                       .equals(Api.MediaType.TEXT_HTML.toString())
-                  && r.headers().firstValue("ex-snyk-token").get().equals("snyk-token-from-env-var")
                   && r.headers()
                       .firstValue("trust-da-token")
                       .get()
@@ -668,7 +641,6 @@ void imageAnalysisHtml() throws IOException, ExecutionException, InterruptedExce
   }
 
   @Test
-  @SetSystemProperty(key = "TRUSTIFY_DA_SNYK_TOKEN", value = "snyk-token-from-env-var")
   @SetSystemProperty(key = "TRUST_DA_TOKEN", value = "trust-da-token-from-env-var")
   @SetSystemProperty(key = "TRUST_DA_SOURCE", value = "trust-da-source-from-env-var")
   void test_perform_batch_analysis()
@@ -691,7 +663,6 @@ void test_perform_batch_analysis()
                       .firstValue("Accept")
                       .get()
                       .equals(Api.MediaType.APPLICATION_JSON.toString())
-                  && r.headers().firstValue("ex-snyk-token").get().equals("snyk-token-from-env-var")
                   && r.headers()
                       .firstValue("trust-da-token")
                       .get()