Light, fluffy, and always free - The AWS Local Emulator alternative
fix(secrets-manager): return partial result for missing secrets in batch (#1591)
Maciejbf53ff71d8a3
diff --git a/compatibility-tests/sdk-test-awscli/test/secretsmanager.bats b/compatibility-tests/sdk-test-awscli/test/secretsmanager.batsindex c4e1b27e25..07fce170b4 100644--- a/compatibility-tests/sdk-test-awscli/test/secretsmanager.bats+++ b/compatibility-tests/sdk-test-awscli/test/secretsmanager.bats@@ -224,3 +224,48 @@ teardown() {has_current=$(echo "$output" | jq --arg vid "$v1" '.VersionIdsToStages[$vid] | any(. == "AWSCURRENT")')[ "$has_current" = "true" ]}++# --- Batch Get Secret Value Tests ---++@test "Secrets Manager: batch-get-secret-value returns all found secrets" {+ S1="${SECRET_NAME}-batch-a"+ S2="${SECRET_NAME}-batch-b"++ aws_cmd secretsmanager create-secret \+ --name "$S1" \+ --secret-string '{"key":"val-a"}' >/dev/null+ aws_cmd secretsmanager create-secret \+ --name "$S2" \+ --secret-string '{"key":"val-b"}' >/dev/null++ run aws_cmd secretsmanager batch-get-secret-value \+ --secret-id-list "$S1" "$S2"+ assert_success++ count=$(echo "$output" | jq '.SecretValues | length')+ [ "$count" = "2" ]+ errors=$(echo "$output" | jq '.Errors | length')+ [ "$errors" = "0" ]++ aws_cmd secretsmanager delete-secret --secret-id "$S1" --force-delete-without-recovery >/dev/null 2>&1 || true+ aws_cmd secretsmanager delete-secret --secret-id "$S2" --force-delete-without-recovery >/dev/null 2>&1 || true+}++@test "Secrets Manager: batch-get-secret-value with one missing returns partial Errors list" {+ aws_cmd secretsmanager create-secret \+ --name "$SECRET_NAME" \+ --secret-string '{"key":"value"}' >/dev/null++ run aws_cmd secretsmanager batch-get-secret-value \+ --secret-id-list "$SECRET_NAME" "not-exists"+ assert_success++ values=$(echo "$output" | jq '.SecretValues | length')+ [ "$values" = "1" ]+ errors=$(echo "$output" | jq '.Errors | length')+ [ "$errors" = "1" ]+ error_code=$(echo "$output" | jq -r '.Errors[0].ErrorCode')+ [ "$error_code" = "ResourceNotFoundException" ]+ secret_id=$(echo "$output" | jq -r '.Errors[0].SecretId')+ [ "$secret_id" = "not-exists" ]+}diff --git a/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/SecretsManagerTest.java b/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/SecretsManagerTest.javaindex 5daab9a5ae..b608d2dd61 100644--- a/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/SecretsManagerTest.java+++ b/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/SecretsManagerTest.java@@ -1,6 +1,13 @@package com.floci.test;-import org.junit.jupiter.api.*;+import org.junit.jupiter.api.AfterAll;+import org.junit.jupiter.api.Assumptions;+import org.junit.jupiter.api.BeforeAll;+import org.junit.jupiter.api.DisplayName;+import org.junit.jupiter.api.MethodOrderer;+import org.junit.jupiter.api.Order;+import org.junit.jupiter.api.Test;+import org.junit.jupiter.api.TestMethodOrder;import software.amazon.awssdk.core.SdkBytes;import software.amazon.awssdk.services.lambda.LambdaClient;import software.amazon.awssdk.services.lambda.model.CreateFunctionRequest;@@ -8,6 +15,8 @@ import software.amazon.awssdk.services.lambda.model.DeleteFunctionRequest;import software.amazon.awssdk.services.lambda.model.FunctionCode;import software.amazon.awssdk.services.lambda.model.Runtime;import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient;+import software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueRequest;+import software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueResponse;import software.amazon.awssdk.services.secretsmanager.model.CreateSecretRequest;import software.amazon.awssdk.services.secretsmanager.model.CreateSecretResponse;import software.amazon.awssdk.services.secretsmanager.model.DeleteSecretRequest;@@ -26,19 +35,19 @@ import software.amazon.awssdk.services.secretsmanager.model.PutSecretValueResponimport software.amazon.awssdk.services.secretsmanager.model.RotateSecretRequest;import software.amazon.awssdk.services.secretsmanager.model.RotateSecretResponse;import software.amazon.awssdk.services.secretsmanager.model.RotationRulesType;-import software.amazon.awssdk.services.secretsmanager.model.SecretsManagerException;import software.amazon.awssdk.services.secretsmanager.model.SecretVersionsListEntry;+import software.amazon.awssdk.services.secretsmanager.model.SecretsManagerException;import software.amazon.awssdk.services.secretsmanager.model.TagResourceRequest;import software.amazon.awssdk.services.secretsmanager.model.UntagResourceRequest;import software.amazon.awssdk.services.secretsmanager.model.UpdateSecretRequest;-import software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueRequest;-import software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueResponse;import java.util.List;import java.util.Map;+import java.util.UUID;import java.util.stream.Collectors;-import static org.assertj.core.api.Assertions.*;+import static org.assertj.core.api.Assertions.assertThat;+import static org.assertj.core.api.Assertions.assertThatThrownBy;@DisplayName("Secrets Manager")@TestMethodOrder(MethodOrderer.OrderAnnotation.class)@@ -412,4 +421,42 @@ class SecretsManagerTest {} catch (Exception ignored) {}}}++ @Test+ @Order(20)+ @DisplayName("batchGetSecretValue returns partial Errors list for missing secrets without throwing")+ void batchGetSecretValuePartialErrors() {+ String exists = "batch-exists-" + UUID.randomUUID();+ String missing = "batch-missing-" + UUID.randomUUID();++ try {+ sm.createSecret(CreateSecretRequest.builder()+ .name(exists)+ .secretString("v1")+ .build());++ BatchGetSecretValueResponse response = sm.batchGetSecretValue(+ BatchGetSecretValueRequest.builder()+ .secretIdList(exists, missing)+ .build()+ );++ assertThat(response.secretValues()).hasSize(1);+ assertThat(response.secretValues().get(0).name()).isEqualTo(exists);++ assertThat(response.errors()).hasSize(1);+ assertThat(response.errors().get(0).secretId()).isEqualTo(missing);+ assertThat(response.errors().get(0).errorCode()).isEqualTo("ResourceNotFoundException");+ assertThat(response.errors().get(0).message())+ .isEqualTo("Secrets Manager can't find the specified secret.");+ } finally {+ try {+ sm.deleteSecret(DeleteSecretRequest.builder()+ .secretId(exists)+ .forceDeleteWithoutRecovery(true)+ .build());+ } catch (Exception ignored) {+ }+ }+ }}diff --git a/src/main/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerJsonHandler.java b/src/main/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerJsonHandler.javaindex fa088cc7bd..a2fb2c6b9b 100644--- a/src/main/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerJsonHandler.java+++ b/src/main/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerJsonHandler.java@@ -1,7 +1,6 @@package io.github.hectorvent.floci.services.secretsmanager;import io.github.hectorvent.floci.core.common.AwsErrorResponse;-import io.github.hectorvent.floci.core.common.AwsException;import io.github.hectorvent.floci.services.secretsmanager.model.Secret;import io.github.hectorvent.floci.services.secretsmanager.model.SecretVersion;import com.fasterxml.jackson.databind.JsonNode;@@ -72,18 +71,16 @@ public class SecretsManagerJsonHandler {}List<SecretsManagerService.BatchSecretValue> values;+ List<SecretsManagerService.BatchGetSecretValueError> errors = List.of();String nextToken = null;if (request.has("SecretIdList")) {List<String> secretIdList = new ArrayList<>();request.path("SecretIdList").forEach(id -> secretIdList.add(id.asText()));- try {- values = service.batchGetSecretValue(secretIdList, region);- } catch (AwsException e) {- return Response.status(e.getHttpStatus())- .entity(new AwsErrorResponse(e.jsonType(), e.getMessage()))- .build();- }+ SecretsManagerService.BatchGetSecretValueResult result =+ service.batchGetSecretValue(secretIdList, region);+ values = result.values();+ errors = result.errors();} else {// Validate paging inputs before the service scans and filters the whole store.int maxResults = request.has("MaxResults") ? request.path("MaxResults").asInt() : 20;@@ -145,10 +142,20 @@ public class SecretsManagerJsonHandler {secretValues.add(node);}response.set("SecretValues", secretValues);++ ArrayNode errorNodes = objectMapper.createArrayNode();+ for (SecretsManagerService.BatchGetSecretValueError error : errors) {+ ObjectNode node = objectMapper.createObjectNode();+ node.put("SecretId", error.secretId());+ node.put("ErrorCode", error.errorCode());+ node.put("Message", error.message());+ errorNodes.add(node);+ }+ response.set("Errors", errorNodes);+if (nextToken != null) {response.put("NextToken", nextToken);}- response.set("Errors", objectMapper.createArrayNode());return Response.ok(response).build();}diff --git a/src/main/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerService.java b/src/main/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerService.javaindex 04a3897001..c2e764d7e6 100644--- a/src/main/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerService.java+++ b/src/main/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerService.java@@ -18,6 +18,7 @@ import jakarta.enterprise.context.ApplicationScoped;import jakarta.inject.Inject;import org.jboss.logging.Logger;+import java.util.Collections;import java.util.concurrent.ExecutorService;import java.util.concurrent.Executors;@@ -614,39 +615,45 @@ public class SecretsManagerService {return result;}- public List<BatchSecretValue> batchGetSecretValue(List<String> secretIdList, String region) {- List<BatchSecretValue> result = new ArrayList<>();+ public BatchGetSecretValueResult batchGetSecretValue(List<String> secretIdList, String region) {+ List<BatchSecretValue> secretValues = new ArrayList<>();+ List<BatchGetSecretValueError> errors = new ArrayList<>();+if (secretIdList == null) {- return result;+ return BatchGetSecretValueResult.empty();}for (String secretId : secretIdList) {try {Secret secret = resolveSecret(secretId, region);if (secret.getDeletedDate() != null) {+ errors.add(new BatchGetSecretValueError(secretId, "InvalidRequestException",+ "You can't perform this operation on the secret because it was marked for deletion."));continue;}+SecretVersion version = findVersionByStage(secret, AWSCURRENT);- if (version != null) {- result.add(new BatchSecretValue(- secret.getArn(),- secret.getName(),- version.getSecretString(),- version.getSecretBinary(),- version.getVersionId(),- version.getVersionStages(),- version.getCreatedDate()- ));+ if (version == null) {+ errors.add(new BatchGetSecretValueError(secretId, "ResourceNotFoundException",+ "Secrets Manager can't find the specified secret value for staging label: " + AWSCURRENT));+ continue;}++ secretValues.add(new BatchSecretValue(+ secret.getArn(),+ secret.getName(),+ version.getSecretString(),+ version.getSecretBinary(),+ version.getVersionId(),+ version.getVersionStages(),+ version.getCreatedDate()+ ));} catch (AwsException e) {- // AWS documentation says: "Secrets Manager doesn't return an error if a secret in the SecretIdList doesn't exist."- // Wait, let me re-check that.- // Actually, "If any of the secrets in the SecretIdList don't exist, Secrets Manager returns an error."- // Let me verify this in the AWS docs.- throw e;+ errors.add(new BatchGetSecretValueError(secretId, e.getErrorCode(), e.getMessage()));}}- return result;++ return new BatchGetSecretValueResult(secretValues, errors);}public Secret updateSecretVersionStage(String secretId, String moveToVersionId, String removeFromVersionId, String versionStage, String region) {@@ -742,6 +749,22 @@ public class SecretsManagerService {) {}+ public record BatchGetSecretValueError(+ String secretId,+ String errorCode,+ String message+ ) {+ }++ public record BatchGetSecretValueResult(+ List<BatchSecretValue> values,+ List<BatchGetSecretValueError> errors+ ) {+ public static BatchGetSecretValueResult empty() {+ return new BatchGetSecretValueResult(Collections.emptyList(), Collections.emptyList());+ }+ }+private Secret resolveSecret(String secretId, String region) {if (secretId.startsWith("arn:")) {// 1. Exact full-ARN matchdiff --git a/src/test/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerJsonHandlerTest.java b/src/test/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerJsonHandlerTest.javaindex 87a13e006c..5aa709d44d 100644--- a/src/test/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerJsonHandlerTest.java+++ b/src/test/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerJsonHandlerTest.java@@ -389,6 +389,43 @@ class SecretsManagerJsonHandlerTest {assertThat(body.get("SecretList").get(0).get("Name").asText(), is("test-secret-a"));}+ @Test+ void batchGetSecretValuePartialMissingReturns200WithErrorsList() {+ String existingSecretName = "exists-secret";+ String missingSecretName = "does-not-exist";++ ObjectNode createReq = MAPPER.createObjectNode();+ createReq.put("Name", existingSecretName);+ createReq.put("SecretString", "val");+ handler.handle("CreateSecret", createReq, REGION);++ ObjectNode batchReq = MAPPER.createObjectNode();+ batchReq.putArray("SecretIdList").add(existingSecretName).add(missingSecretName);++ Response response = handler.handle("BatchGetSecretValue", batchReq, REGION);++ assertThat(response.getStatus(), is(200));+ ObjectNode body = (ObjectNode) response.getEntity();+ assertThat(body.get("SecretValues").size(), is(1));+ assertThat(body.get("SecretValues").get(0).get("Name").asText(), is(existingSecretName));+ assertThat(body.get("Errors").size(), is(1));+ assertThat(body.get("Errors").get(0).get("SecretId").asText(), is(missingSecretName));+ assertThat(body.get("Errors").get(0).get("ErrorCode").asText(), is("ResourceNotFoundException"));+ }++ @Test+ void batchGetSecretValueAllMissingReturns200WithEmptyValuesAndErrors() {+ ObjectNode batchReq = MAPPER.createObjectNode();+ batchReq.putArray("SecretIdList").add("no-such-secret-1").add("no-such-secret-2");++ Response response = handler.handle("BatchGetSecretValue", batchReq, REGION);++ assertThat(response.getStatus(), is(200));+ ObjectNode body = (ObjectNode) response.getEntity();+ assertThat(body.get("SecretValues").size(), is(0));+ assertThat(body.get("Errors").size(), is(2));+ }+@Testvoid rotateSecretParsesRotationRules() {ObjectNode createReq = MAPPER.createObjectNode();diff --git a/src/test/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerServiceTest.java b/src/test/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerServiceTest.javaindex 735f771a80..d10d5a4e64 100644--- a/src/test/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerServiceTest.java+++ b/src/test/java/io/github/hectorvent/floci/services/secretsmanager/SecretsManagerServiceTest.java@@ -333,32 +333,73 @@ class SecretsManagerServiceTest {service.createSecret("secret1", "value1", null, null, null, null, REGION);service.createSecret("secret2", "value2", null, null, null, null, REGION);- List<SecretsManagerService.BatchSecretValue> values = service.batchGetSecretValue(+ SecretsManagerService.BatchGetSecretValueResult result = service.batchGetSecretValue(List.of("secret1", "secret2"), REGION);+ List<SecretsManagerService.BatchSecretValue> values = result.values();assertEquals(2, values.size());assertTrue(values.stream().anyMatch(v -> "secret1".equals(v.name()) && "value1".equals(v.secretString())));assertTrue(values.stream().anyMatch(v -> "secret2".equals(v.name()) && "value2".equals(v.secretString())));++ assertEquals(0, result.errors().size());}@Test- void batchGetSecretValueSkipsDeleted() {+ void batchGetSecretValueReportsDeletedInErrors() {service.createSecret("secret1", "value1", null, null, null, null, REGION);service.createSecret("secret2", "value2", null, null, null, null, REGION);service.deleteSecret("secret1", 7, false, REGION);- List<SecretsManagerService.BatchSecretValue> values = service.batchGetSecretValue(+ SecretsManagerService.BatchGetSecretValueResult result = service.batchGetSecretValue(List.of("secret1", "secret2"), REGION);+ List<SecretsManagerService.BatchSecretValue> values = result.values();assertEquals(1, values.size());assertEquals("secret2", values.getFirst().name());++ List<SecretsManagerService.BatchGetSecretValueError> errors = result.errors();+ assertEquals(1, errors.size());+ assertEquals("secret1", errors.getFirst().secretId());+ assertEquals("InvalidRequestException", errors.getFirst().errorCode());+ assertEquals("You can't perform this operation on the secret because it was marked for deletion.",+ errors.getFirst().message());}@Test- void batchGetSecretValueThrowsIfNotFound() {+ void batchGetSecretValueReportsMissingCurrentVersionInErrors() {service.createSecret("secret1", "value1", null, null, null, null, REGION);- assertThrows(AwsException.class, () ->- service.batchGetSecretValue(List.of("secret1", "non-existent"), REGION));++ Secret secret = service.describeSecret("secret1", REGION);+ SecretVersion version = secret.getVersions().get(secret.getCurrentVersionId());+ version.setVersionStages(List.of());++ SecretsManagerService.BatchGetSecretValueResult result = service.batchGetSecretValue(+ List.of("secret1"), REGION);++ assertEquals(0, result.values().size());++ List<SecretsManagerService.BatchGetSecretValueError> errors = result.errors();+ assertEquals(1, errors.size());+ assertEquals("secret1", errors.getFirst().secretId());+ assertEquals("ResourceNotFoundException", errors.getFirst().errorCode());+ }++ @Test+ void batchGetSecretValueReportsMissingInErrors() {+ service.createSecret("secret1", "value1", null, null, null, null, REGION);++ SecretsManagerService.BatchGetSecretValueResult result = service.batchGetSecretValue(+ List.of("secret1", "non-existent"), REGION);++ List<SecretsManagerService.BatchSecretValue> values = result.values();+ assertEquals(1, values.size());+ assertEquals("secret1", values.getFirst().name());++ List<SecretsManagerService.BatchGetSecretValueError> errors = result.errors();+ assertEquals(1, errors.size());+ assertEquals("non-existent", errors.getFirst().secretId());+ assertEquals("ResourceNotFoundException", errors.getFirst().errorCode());+ assertEquals("Secrets Manager can't find the specified secret.", errors.getFirst().message());}@Test