Merge pull request #1170 from DependencyTrack/fix-e2e-tests

Author: nscuro

e2e/pom.xml

@@ -35,9 +35,18 @@
 
     <dependencies>
         <dependency>
-            <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-rest-client-jackson</artifactId>
+            <groupId>io.github.openfeign</groupId>
+            <artifactId>feign-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.github.openfeign</groupId>
+            <artifactId>feign-jackson</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.github.openfeign</groupId>
+            <artifactId>feign-jaxrs3</artifactId>
+        </dependency>
+
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-junit5</artifactId>

e2e/src/main/java/org/dependencytrack/apiserver/ApiServerClientHeaderFactory.java renamed to e2e/src/main/java/org/dependencytrack/apiserver/ApiServerAuthInterceptor.java

@@ -18,38 +18,34 @@
  */
 package org.dependencytrack.apiserver;
 
-import jakarta.ws.rs.core.MultivaluedHashMap;
-import jakarta.ws.rs.core.MultivaluedMap;
-import org.eclipse.microprofile.rest.client.ext.ClientHeadersFactory;
+import feign.RequestInterceptor;
+import feign.RequestTemplate;
 
-public class ApiServerClientHeaderFactory implements ClientHeadersFactory {
+public class ApiServerAuthInterceptor implements RequestInterceptor {
 
     private static String bearerToken;
     private static String apiKey;
 
     @Override
-    public MultivaluedMap<String, String> update(final MultivaluedMap<String, String> incomingHeaders,
-                                                 final MultivaluedMap<String, String> clientOutgoingHeaders) {
-        final var headers = new MultivaluedHashMap<String, String>();
+    public void apply(final RequestTemplate requestTemplate) {
         if (apiKey != null) {
-            headers.putSingle("X-Api-Key", apiKey);
+            requestTemplate.header("X-Api-Key", apiKey);
         } else if (bearerToken != null) {
-            headers.putSingle("Authorization", "Bearer " + bearerToken);
+            requestTemplate.header("Authorization", "Bearer " + bearerToken);
         }
-        return headers;
     }
 
     public static void setBearerToken(final String bearerToken) {
-        ApiServerClientHeaderFactory.bearerToken = bearerToken;
+        ApiServerAuthInterceptor.bearerToken = bearerToken;
     }
 
     public static void setApiKey(final String apiKey) {
-        ApiServerClientHeaderFactory.apiKey = apiKey;
+        ApiServerAuthInterceptor.apiKey = apiKey;
     }
 
     public static void reset() {
-        ApiServerClientHeaderFactory.bearerToken = null;
-        ApiServerClientHeaderFactory.apiKey = null;
+        ApiServerAuthInterceptor.bearerToken = null;
+        ApiServerAuthInterceptor.apiKey = null;
     }
 
 }

e2e/src/main/java/org/dependencytrack/apiserver/ApiServerClient.java

@@ -44,13 +44,11 @@
 import org.dependencytrack.apiserver.model.VulnerabilityPolicy;
 import org.dependencytrack.apiserver.model.WorkflowState;
 import org.dependencytrack.apiserver.model.WorkflowTokenResponse;
-import org.eclipse.microprofile.rest.client.annotation.RegisterClientHeaders;
 
 import java.util.List;
 import java.util.UUID;
 
 @Path("/api/v1")
-@RegisterClientHeaders(ApiServerClientHeaderFactory.class)
 public interface ApiServerClient {
 
     @POST

e2e/src/main/java/org/dependencytrack/apiserver/CompositeDecoder.java

@@ -0,0 +1,52 @@
+/*
+ * This file is part of Dependency-Track.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright (c) OWASP Foundation. All Rights Reserved.
+ */
+package org.dependencytrack.apiserver;
+
+import feign.FeignException;
+import feign.Response;
+import feign.codec.Decoder;
+import feign.jackson.JacksonDecoder;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.lang.reflect.Type;
+import java.nio.charset.StandardCharsets;
+import java.util.Collections;
+import java.util.stream.Collectors;
+
+public class CompositeDecoder implements Decoder {
+
+    private final Decoder jsonDecoder = new JacksonDecoder();
+
+    @Override
+    public Object decode(final Response response, final Type type) throws IOException, FeignException {
+        final String contentType = response.headers().getOrDefault("Content-Type", Collections.emptyList()).stream()
+                .findFirst()
+                .orElse(null);
+
+        if ("application/json".equals(contentType)) {
+            return jsonDecoder.decode(response, type);
+        }
+
+        try (final var reader = new BufferedReader(response.body().asReader(StandardCharsets.UTF_8))) {
+            return reader.lines().collect(Collectors.joining());
+        }
+    }
+
+}

e2e/src/main/java/org/dependencytrack/apiserver/CompositeEncoder.java

@@ -0,0 +1,52 @@
+/*
+ * This file is part of Dependency-Track.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright (c) OWASP Foundation. All Rights Reserved.
+ */
+package org.dependencytrack.apiserver;
+
+import feign.RequestTemplate;
+import feign.codec.EncodeException;
+import feign.codec.Encoder;
+import feign.jackson.JacksonEncoder;
+
+import java.lang.reflect.Type;
+import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+public class CompositeEncoder implements Encoder {
+
+    private final Encoder jsonEncoder = new JacksonEncoder();
+
+    @Override
+    @SuppressWarnings("unchecked")
+    public void encode(final Object object, final Type bodyType, final RequestTemplate template) throws EncodeException {
+        if (bodyType == Encoder.MAP_STRING_WILDCARD) {
+            final Map<String, ?> body = (Map<String, ?>) object;
+            template.body(body.entrySet().stream()
+                    .map(entry -> "%s=%s".formatted(
+                            URLEncoder.encode(entry.getKey(), StandardCharsets.UTF_8),
+                            URLEncoder.encode(String.valueOf(entry.getValue()), StandardCharsets.UTF_8)
+                    ))
+                    .collect(Collectors.joining("&")));
+        } else {
+            jsonEncoder.encode(object, bodyType, template);
+        }
+    }
+
+}

e2e/src/test/java/org/dependencytrack/e2e/AbstractE2ET.java

@@ -18,9 +18,12 @@
  */
 package org.dependencytrack.e2e;
 
-import io.quarkus.rest.client.reactive.QuarkusRestClientBuilder;
+import feign.Feign;
+import feign.jaxrs3.JAXRS3Contract;
+import org.dependencytrack.apiserver.ApiServerAuthInterceptor;
 import org.dependencytrack.apiserver.ApiServerClient;
-import org.dependencytrack.apiserver.ApiServerClientHeaderFactory;
+import org.dependencytrack.apiserver.CompositeDecoder;
+import org.dependencytrack.apiserver.CompositeEncoder;
 import org.dependencytrack.apiserver.model.CreateTeamRequest;
 import org.dependencytrack.apiserver.model.Team;
 import org.junit.jupiter.api.AfterEach;
@@ -36,7 +39,6 @@
 import org.testcontainers.images.PullPolicy;
 import org.testcontainers.utility.DockerImageName;
 
-import java.net.URI;
 import java.util.Optional;
 import java.util.Set;
 
@@ -198,16 +200,19 @@ protected void customizeVulnAnalyzerContainer(final GenericContainer<?> containe
     }
 
     private ApiServerClient initializeApiServerClient() {
-        final ApiServerClient client = QuarkusRestClientBuilder.newBuilder()
-                .baseUri(URI.create("http://localhost:%d".formatted(apiServerContainer.getFirstMappedPort())))
-                .build(ApiServerClient.class);
+        final ApiServerClient client = Feign.builder()
+                .contract(new JAXRS3Contract())
+                .decoder(new CompositeDecoder())
+                .encoder(new CompositeEncoder())
+                .requestInterceptor(new ApiServerAuthInterceptor())
+                .target(ApiServerClient.class, "http://localhost:%d".formatted(apiServerContainer.getFirstMappedPort()));
 
         logger.info("Changing API server admin password");
         client.forcePasswordChange("admin", "admin", "admin123", "admin123");
 
         logger.info("Authenticating as admin");
         final String bearerToken = client.login("admin", "admin123");
-        ApiServerClientHeaderFactory.setBearerToken(bearerToken);
+        ApiServerAuthInterceptor.setBearerToken(bearerToken);
 
         logger.info("Creating e2e team");
         final Team team = client.createTeam(new CreateTeamRequest("e2e"));
@@ -228,14 +233,14 @@ private ApiServerClient initializeApiServerClient() {
         }
 
         logger.info("Authenticating as e2e team");
-        ApiServerClientHeaderFactory.setApiKey(team.apiKeys().get(0).key());
+        ApiServerAuthInterceptor.setApiKey(team.apiKeys().get(0).key());
 
         return client;
     }
 
     @AfterEach
     void afterEach() {
-        ApiServerClientHeaderFactory.reset();
+        ApiServerAuthInterceptor.reset();
 
         Optional.ofNullable(vulnAnalyzerContainer).ifPresent(GenericContainer::stop);
         Optional.ofNullable(repoMetaAnalyzerContainer).ifPresent(GenericContainer::stop);

pom.xml

@@ -80,6 +80,7 @@
     <lib.micrometer-jvm-extras.version>0.2.2</lib.micrometer-jvm-extras.version>
     <lib.minio.version>8.5.9</lib.minio.version>
     <lib.mockserver-netty.version>5.15.0</lib.mockserver-netty.version>
+    <lib.open-feign.version>13.2.1</lib.open-feign.version>
     <lib.org-json.version>20240303</lib.org-json.version>
     <lib.pebble.version>3.2.2</lib.pebble.version>
     <lib.resilience4j.version>2.2.0</lib.resilience4j.version>
@@ -319,6 +320,22 @@
         <version>${lib.mockserver-netty.version}</version>
       </dependency>
 
+      <dependency>
+        <groupId>io.github.openfeign</groupId>
+        <artifactId>feign-core</artifactId>
+        <version>${lib.open-feign.version}</version>
+      </dependency>
+      <dependency>
+        <groupId>io.github.openfeign</groupId>
+        <artifactId>feign-jackson</artifactId>
+        <version>${lib.open-feign.version}</version>
+      </dependency>
+      <dependency>
+        <groupId>io.github.openfeign</groupId>
+        <artifactId>feign-jaxrs3</artifactId>
+        <version>${lib.open-feign.version}</version>
+      </dependency>
+
       <dependency>
         <groupId>org.assertj</groupId>
         <artifactId>assertj-core</artifactId>