chore: Cleanup Hashicorp Vault package structure (#4082)

Cleanup Hashicorp Vault package structure
eclipse-edc · Apr 3, 2024 · 0b83737 · 0b83737
1 parent 772d9cb
commit 0b83737
Show file tree

Hide file tree

Showing 19 changed files with 52 additions and 98 deletions.
diff --git a/...n/vault/vault-hashicorp/src/main/java/org/eclipse/edc/vault/hashicorp/HashicorpVault.java b/...n/vault/vault-hashicorp/src/main/java/org/eclipse/edc/vault/hashicorp/HashicorpVault.java
@@ -18,6 +18,7 @@
 import org.eclipse.edc.spi.monitor.Monitor;
 import org.eclipse.edc.spi.result.Result;
 import org.eclipse.edc.spi.security.Vault;
+import org.eclipse.edc.vault.hashicorp.client.HashicorpVaultClient;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -43,8 +44,8 @@ public HashicorpVault(@NotNull HashicorpVaultClient hashicorpVaultClient, @NotNu
         if (result.failed()) {
             monitor.debug("Failed to resolve secret '%s': %s".formatted(key, result.getFailureMessages()));
             return null;
-        } 
-        
+        }
+
         return result.getContent();
     }
 

diff --git a/...ault-hashicorp/src/main/java/org/eclipse/edc/vault/hashicorp/HashicorpVaultExtension.java b/...ault-hashicorp/src/main/java/org/eclipse/edc/vault/hashicorp/HashicorpVaultExtension.java
@@ -26,6 +26,9 @@
 import org.eclipse.edc.spi.system.ExecutorInstrumentation;
 import org.eclipse.edc.spi.system.ServiceExtension;
 import org.eclipse.edc.spi.system.ServiceExtensionContext;
+import org.eclipse.edc.vault.hashicorp.client.HashicorpVaultClient;
+import org.eclipse.edc.vault.hashicorp.client.HashicorpVaultSettings;
+import org.eclipse.edc.vault.hashicorp.client.HashicorpVaultTokenRenewTask;
 
 import static com.fasterxml.jackson.databind.DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES;
 
@@ -110,6 +113,7 @@ public void initialize(ServiceExtensionContext context) {
         monitor = context.getMonitor().withPrefix(NAME);
         settings = getSettings(context);
         tokenRenewalTask = new HashicorpVaultTokenRenewTask(
+                NAME,
                 executorInstrumentation,
                 hashicorpVaultClient(),
                 settings.renewBuffer(),

diff --git a/...s/common/vault/vault-hashicorp/src/main/java/org/eclipse/edc/vault/hashicorp/PemUtil.java b/...s/common/vault/vault-hashicorp/src/main/java/org/eclipse/edc/vault/hashicorp/PemUtil.java
diff --git a/...vault/hashicorp/HashicorpVaultClient.java → ...ashicorp/client/HashicorpVaultClient.java b/...vault/hashicorp/HashicorpVaultClient.java → ...ashicorp/client/HashicorpVaultClient.java
@@ -13,7 +13,7 @@
  *
  */
 
-package org.eclipse.edc.vault.hashicorp;
+package org.eclipse.edc.vault.hashicorp.client;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
@@ -31,6 +31,7 @@
 import org.eclipse.edc.vault.hashicorp.model.CreateEntryRequestPayload;
 import org.eclipse.edc.vault.hashicorp.model.CreateEntryResponsePayload;
 import org.eclipse.edc.vault.hashicorp.model.GetEntryResponsePayload;
+import org.eclipse.edc.vault.hashicorp.util.PathUtil;
 import org.jetbrains.annotations.NotNull;
 
 import java.io.IOException;
@@ -70,10 +71,10 @@ public class HashicorpVaultClient {
     private final HttpUrl healthCheckUrl;
     private final Monitor monitor;
 
-    HashicorpVaultClient(@NotNull EdcHttpClient httpClient,
-                         @NotNull ObjectMapper objectMapper,
-                         @NotNull Monitor monitor,
-                         @NotNull HashicorpVaultSettings settings) {
+    public HashicorpVaultClient(@NotNull EdcHttpClient httpClient,
+                                @NotNull ObjectMapper objectMapper,
+                                @NotNull Monitor monitor,
+                                @NotNull HashicorpVaultSettings settings) {
         this.httpClient = httpClient;
         this.objectMapper = objectMapper;
         this.monitor = monitor;

diff --git a/.../HashicorpVaultClientFallbackFactory.java → .../HashicorpVaultClientFallbackFactory.java b/.../HashicorpVaultClientFallbackFactory.java → .../HashicorpVaultClientFallbackFactory.java
@@ -12,7 +12,7 @@
  *
  */
 
-package org.eclipse.edc.vault.hashicorp;
+package org.eclipse.edc.vault.hashicorp.client;
 
 import dev.failsafe.Fallback;
 import okhttp3.Request;
@@ -28,7 +28,7 @@
  */
 public class HashicorpVaultClientFallbackFactory implements FallbackFactory {
 
-    private static final int[] NON_RETRYABLE_STATUS_CODES = {200, 204, 400, 403, 404, 405};
+    private static final int[] NON_RETRYABLE_STATUS_CODES = { 200, 204, 400, 403, 404, 405 };
 
     @Override
     public Fallback<Response> create(Request request) {

diff --git a/...ult/hashicorp/HashicorpVaultSettings.java → ...hicorp/client/HashicorpVaultSettings.java b/...ult/hashicorp/HashicorpVaultSettings.java → ...hicorp/client/HashicorpVaultSettings.java
@@ -12,14 +12,14 @@
  *
  */
 
-package org.eclipse.edc.vault.hashicorp;
+package org.eclipse.edc.vault.hashicorp.client;
 
 import okhttp3.HttpUrl;
 
 import static java.util.Objects.requireNonNull;
 
 /**
- * Value container for {@link HashicorpVaultExtension} settings.
+ * Settings for the {@link HashicorpVaultClient}.
  */
 public class HashicorpVaultSettings {
 
@@ -33,7 +33,8 @@ public class HashicorpVaultSettings {
     private long renewBuffer;
     private String secretPath;
 
-    private HashicorpVaultSettings() {}
+    private HashicorpVaultSettings() {
+    }
 
     public HttpUrl url() {
         return url;

diff --git a/...shicorp/HashicorpVaultTokenRenewTask.java → .../client/HashicorpVaultTokenRenewTask.java b/...shicorp/HashicorpVaultTokenRenewTask.java → .../client/HashicorpVaultTokenRenewTask.java
@@ -12,7 +12,7 @@
  *
  */
 
-package org.eclipse.edc.vault.hashicorp;
+package org.eclipse.edc.vault.hashicorp.client;
 
 import org.eclipse.edc.spi.monitor.Monitor;
 import org.eclipse.edc.spi.system.ExecutorInstrumentation;
@@ -34,11 +34,12 @@ public class HashicorpVaultTokenRenewTask {
     private static final String INITIAL_TOKEN_RENEW_ERR_MSG_FORMAT = "Initial token renewal failed with reason: %s";
     private static final String SCHEDULED_TOKEN_RENEWAL_ERR_MSG_FORMAT = "Scheduled token renewal failed: %s";
 
-    @NotNull
+    private final String name;
+
     private final ExecutorInstrumentation executorInstrumentation;
-    @NotNull
+
     private final HashicorpVaultClient client;
-    @NotNull
+
     private final Monitor monitor;
     private final long renewBuffer;
     private ScheduledExecutorService scheduledExecutorService;
@@ -51,14 +52,16 @@ public class HashicorpVaultTokenRenewTask {
      * before the token expires and failed renewals can be retried in time.
      *
      * @param executorInstrumentation executor instrumentation used to initialize a {@link ScheduledExecutorService}
-     * @param client the HashicorpVaultClient
-     * @param renewBuffer the renewal buffer time in seconds
-     * @param monitor the monitor
+     * @param client                  the HashicorpVaultClient
+     * @param renewBuffer             the renewal buffer time in seconds
+     * @param monitor                 the monitor
      */
-    public HashicorpVaultTokenRenewTask(@NotNull ExecutorInstrumentation executorInstrumentation,
+    public HashicorpVaultTokenRenewTask(@NotNull String name,
+                                        @NotNull ExecutorInstrumentation executorInstrumentation,
                                         @NotNull HashicorpVaultClient client,
                                         long renewBuffer,
                                         @NotNull Monitor monitor) {
+        this.name = name;
         this.executorInstrumentation = executorInstrumentation;
         this.client = client;
         this.renewBuffer = renewBuffer;
@@ -71,7 +74,7 @@ public HashicorpVaultTokenRenewTask(@NotNull ExecutorInstrumentation executorIns
      */
     public void start() {
         if (!isRunning()) {
-            scheduledExecutorService = executorInstrumentation.instrument(Executors.newSingleThreadScheduledExecutor(), HashicorpVaultExtension.NAME);
+            scheduledExecutorService = executorInstrumentation.instrument(Executors.newSingleThreadScheduledExecutor(), name);
             scheduledExecutorService.execute(this::initialize);
             isRunning.set(true);
         }

diff --git a/.../hashicorp/HashicorpVaultHealthCheck.java → ...orp/health/HashicorpVaultHealthCheck.java b/.../hashicorp/HashicorpVaultHealthCheck.java → ...orp/health/HashicorpVaultHealthCheck.java
@@ -13,13 +13,14 @@
  *
  */
 
-package org.eclipse.edc.vault.hashicorp;
+package org.eclipse.edc.vault.hashicorp.health;
 
 import org.eclipse.edc.spi.monitor.Monitor;
 import org.eclipse.edc.spi.system.health.HealthCheckResult;
 import org.eclipse.edc.spi.system.health.LivenessProvider;
 import org.eclipse.edc.spi.system.health.ReadinessProvider;
 import org.eclipse.edc.spi.system.health.StartupStatusProvider;
+import org.eclipse.edc.vault.hashicorp.client.HashicorpVaultClient;
 
 /**
  * Implements the healthcheck of the Hashicorp Vault.

diff --git a/...hicorp/HashicorpVaultHealthExtension.java → ...health/HashicorpVaultHealthExtension.java b/...hicorp/HashicorpVaultHealthExtension.java → ...health/HashicorpVaultHealthExtension.java
@@ -13,14 +13,15 @@
  *
  */
 
-package org.eclipse.edc.vault.hashicorp;
+package org.eclipse.edc.vault.hashicorp.health;
 
 import org.eclipse.edc.runtime.metamodel.annotation.Extension;
 import org.eclipse.edc.runtime.metamodel.annotation.Inject;
 import org.eclipse.edc.runtime.metamodel.annotation.Requires;
 import org.eclipse.edc.spi.system.ServiceExtension;
 import org.eclipse.edc.spi.system.ServiceExtensionContext;
 import org.eclipse.edc.spi.system.health.HealthCheckService;
+import org.eclipse.edc.vault.hashicorp.client.HashicorpVaultClient;
 
 import static org.eclipse.edc.vault.hashicorp.HashicorpVaultExtension.VAULT_HEALTH_CHECK_ENABLED;
 import static org.eclipse.edc.vault.hashicorp.HashicorpVaultExtension.VAULT_HEALTH_CHECK_ENABLED_DEFAULT;
@@ -51,7 +52,7 @@ public void initialize(ServiceExtensionContext context) {
             healthCheckService.addLivenessProvider(healthCheck);
             healthCheckService.addReadinessProvider(healthCheck);
             healthCheckService.addStartupStatusProvider(healthCheck);
-            monitor.info("Vault health check initialization complete");
+            monitor.debug("Vault health check initialization complete");
         } else {
             monitor.info("Vault health check disabled");
         }

diff --git a/...eclipse/edc/vault/hashicorp/PathUtil.java → ...se/edc/vault/hashicorp/util/PathUtil.java b/...eclipse/edc/vault/hashicorp/PathUtil.java → ...se/edc/vault/hashicorp/util/PathUtil.java
@@ -12,7 +12,7 @@
  *
  */
 
-package org.eclipse.edc.vault.hashicorp;
+package org.eclipse.edc.vault.hashicorp.util;
 
 public class PathUtil {
 

diff --git a/...ashicorp/src/main/resources/META-INF/services/org.eclipse.edc.spi.system.ServiceExtension b/...ashicorp/src/main/resources/META-INF/services/org.eclipse.edc.spi.system.ServiceExtension
@@ -11,4 +11,4 @@
 #       Mercedes-Benz Tech Innovation GmbH - Initial ServiceExtension file
 #
 org.eclipse.edc.vault.hashicorp.HashicorpVaultExtension
-org.eclipse.edc.vault.hashicorp.HashicorpVaultHealthExtension
+org.eclipse.edc.vault.hashicorp.health.HashicorpVaultHealthExtension
diff --git a/...ult/vault-hashicorp/src/test/java/org/eclipse/edc/vault/hashicorp/HashicorpVaultTest.java b/...ult/vault-hashicorp/src/test/java/org/eclipse/edc/vault/hashicorp/HashicorpVaultTest.java
@@ -16,6 +16,7 @@
 
 import org.eclipse.edc.spi.monitor.Monitor;
 import org.eclipse.edc.spi.result.Result;
+import org.eclipse.edc.vault.hashicorp.client.HashicorpVaultClient;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 

diff --git a/...hicorpVaultClientFallbackFactoryTest.java → ...hicorpVaultClientFallbackFactoryTest.java b/...hicorpVaultClientFallbackFactoryTest.java → ...hicorpVaultClientFallbackFactoryTest.java
@@ -12,7 +12,7 @@
  *
  */
 
-package org.eclipse.edc.vault.hashicorp;
+package org.eclipse.edc.vault.hashicorp.client;
 
 import okhttp3.Request;
 import org.eclipse.edc.http.spi.FallbackFactories;
@@ -22,7 +22,7 @@
 
 class HashicorpVaultClientFallbackFactoryTest {
 
-    private static final int[] NON_RETRYABLE_STATUS_CODES = {200, 204, 400, 403, 404, 405};
+    private static final int[] NON_RETRYABLE_STATUS_CODES = { 200, 204, 400, 403, 404, 405 };
 
     @Test
     void create_shouldInitializeWithCorrectStatusCodes() {

diff --git a/.../HashicorpVaultClientIntegrationTest.java → .../HashicorpVaultClientIntegrationTest.java b/.../HashicorpVaultClientIntegrationTest.java → .../HashicorpVaultClientIntegrationTest.java
@@ -12,7 +12,7 @@
  *
  */
 
-package org.eclipse.edc.vault.hashicorp;
+package org.eclipse.edc.vault.hashicorp.client;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import jakarta.json.Json;

diff --git a/...t/hashicorp/HashicorpVaultClientTest.java → ...corp/client/HashicorpVaultClientTest.java b/...t/hashicorp/HashicorpVaultClientTest.java → ...corp/client/HashicorpVaultClientTest.java
@@ -13,7 +13,7 @@
  *
  */
 
-package org.eclipse.edc.vault.hashicorp;
+package org.eclipse.edc.vault.hashicorp.client;
 
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;

diff --git a/...hashicorp/HashicorpVaultSettingsTest.java → ...rp/client/HashicorpVaultSettingsTest.java b/...hashicorp/HashicorpVaultSettingsTest.java → ...rp/client/HashicorpVaultSettingsTest.java
@@ -12,7 +12,7 @@
  *
  */
 
-package org.eclipse.edc.vault.hashicorp;
+package org.eclipse.edc.vault.hashicorp.client;
 
 import okhttp3.HttpUrl;
 import org.junit.jupiter.api.Test;
@@ -87,7 +87,7 @@ void createSettings_withVaultTokenNull_shouldThrowException() {
         var throwable = assertThrows(Exception.class, () -> createSettings(
                 URL,
                 null,
-                HEALTH_CHECK_PATH, 
+                HEALTH_CHECK_PATH,
                 VAULT_TOKEN_TTL_DEFAULT,
                 VAULT_TOKEN_RENEW_BUFFER_DEFAULT));
         assertThat(throwable.getMessage()).isEqualTo("Vault token must not be null");
@@ -105,12 +105,12 @@ void createSettings_withVaultTokenTtlLessThan5_shouldThrowException() {
     }
 
     @ParameterizedTest
-    @ValueSource(longs = {VAULT_TOKEN_TTL_DEFAULT, VAULT_TOKEN_TTL_DEFAULT + 1})
+    @ValueSource(longs = { VAULT_TOKEN_TTL_DEFAULT, VAULT_TOKEN_TTL_DEFAULT + 1 })
     void createSettings_withVaultTokenRenewBufferEqualOrGreaterThanTtl_shouldThrowException(long value) {
         var throwable = assertThrows(Exception.class, () -> createSettings(
                 URL,
                 TOKEN,
-                HEALTH_CHECK_PATH, 
+                HEALTH_CHECK_PATH,
                 VAULT_TOKEN_TTL_DEFAULT,
                 value));
         assertThat(throwable.getMessage()).isEqualTo("Vault token renew buffer value must be less than ttl value");

diff --git a/...orp/HashicorpVaultTokenRenewTaskTest.java → ...ent/HashicorpVaultTokenRenewTaskTest.java b/...orp/HashicorpVaultTokenRenewTaskTest.java → ...ent/HashicorpVaultTokenRenewTaskTest.java
@@ -12,7 +12,7 @@
  *
  */
 
-package org.eclipse.edc.vault.hashicorp;
+package org.eclipse.edc.vault.hashicorp.client;
 
 import org.eclipse.edc.spi.monitor.Monitor;
 import org.eclipse.edc.spi.result.Result;
@@ -38,6 +38,7 @@ class HashicorpVaultTokenRenewTaskTest {
     private final Monitor monitor = mock();
     private final HashicorpVaultClient client = mock();
     private final HashicorpVaultTokenRenewTask tokenRenewTask = new HashicorpVaultTokenRenewTask(
+            "Hashicorp Vault",
             ExecutorInstrumentation.noop(),
             client,
             RENEW_BUFFER,

diff --git a/...hicorp/HashicorpVaultHealthCheckTest.java → ...health/HashicorpVaultHealthCheckTest.java b/...hicorp/HashicorpVaultHealthCheckTest.java → ...health/HashicorpVaultHealthCheckTest.java
@@ -13,10 +13,11 @@
  *
  */
 
-package org.eclipse.edc.vault.hashicorp;
+package org.eclipse.edc.vault.hashicorp.health;
 
 import org.eclipse.edc.spi.monitor.Monitor;
 import org.eclipse.edc.spi.result.Result;
+import org.eclipse.edc.vault.hashicorp.client.HashicorpVaultClient;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;