chore(java): Adds afterTest cleanup method to clean DDB items created in test run

Author: sharmabikram

Examples/runtimes/java/DynamoDbEncryption/src/main/java/software/amazon/cryptography/examples/ExampleUtils.java

@@ -5,20 +5,20 @@
 import java.util.concurrent.ThreadLocalRandom;
 
 /**
- * Shared utilities for examples. The TEST_PREFIX provides a unique suffix
+ * Shared utilities for examples. The TEST_SUFFIX provides a unique suffix
  * per JVM process so that parallel CI matrix jobs (different Java versions / OS)
  * do not overwrite each other's items in the shared DynamoDB test table.
  *
  * Each example uses a hardcoded partition key like "rawEcdhKeyringItem".
  * In CI, multiple JVMs run in parallel against the same table. Without
  * isolation, one JVM can overwrite another's item, causing decrypt failures.
- * By appending a random prefix, each JVM writes to its own partition key
+ * By appending a random suffix, each JVM writes to its own partition key
  * (e.g., "rawEcdhKeyringItem-482913") while keeping cross-example reads
  * working within the same JVM.
  */
 public class ExampleUtils {
 
-  private static final String TEST_PREFIX = String.valueOf(
+  private static final String TEST_SUFFIX = String.valueOf(
     ThreadLocalRandom.current().nextInt(100000, 999999)
   );
 
@@ -27,6 +27,6 @@ public class ExampleUtils {
    * Example: "rawEcdhKeyringItem" becomes "rawEcdhKeyringItem-482913"
    */
   public static String uniquePk(String base) {
-    return base + "-" + TEST_PREFIX;
+    return base + "-" + TEST_SUFFIX;
   }
 }

Examples/runtimes/java/DynamoDbEncryption/src/test/java/software/amazon/cryptography/examples/TestUtils.java

@@ -42,6 +42,20 @@ public class TestUtils {
   public static final String TEST_DDB_TABLE_NAME =
     "DynamoDbEncryptionInterceptorTestTable";
 
+  /**
+   * Deletes a test item using the standard table schema (partition_key S, sort_key N).
+   * Use this for items written by examples that use ExampleUtils.uniquePk().
+   */
+  public static void cleanUpExampleItem(final String partitionKeyBase) {
+    cleanUpDDBItem(
+      TEST_DDB_TABLE_NAME,
+      "partition_key",
+      "sort_key",
+      ExampleUtils.uniquePk(partitionKeyBase),
+      "0"
+    );
+  }
+
   /**
    * Deletes an item from a DynamoDB table.
    *

Examples/runtimes/java/DynamoDbEncryption/src/test/java/software/amazon/cryptography/examples/clientsupplier/TestClientSupplierExample.java

@@ -2,6 +2,7 @@
 
 import java.util.Collections;
 import java.util.List;
+import org.testng.annotations.AfterTest;
 import org.testng.annotations.Test;
 import software.amazon.awssdk.regions.Region;
 import software.amazon.cryptography.examples.TestUtils;
@@ -35,4 +36,10 @@ public void TestClientSupplierExample() {
       regions
     );
   }
+
+  @AfterTest
+  public void cleanup() {
+    TestUtils.cleanUpExampleItem("clientSupplierItem");
+    TestUtils.cleanUpExampleItem("awsKmsMrkMultiKeyringItem");
+  }
 }

Examples/runtimes/java/DynamoDbEncryption/src/test/java/software/amazon/cryptography/examples/enhanced/TestEnhancedPutGetExample.java

@@ -1,5 +1,6 @@
 package software.amazon.cryptography.examples.enhanced;
 
+import org.testng.annotations.AfterTest;
 import org.testng.annotations.Test;
 import software.amazon.cryptography.examples.TestUtils;
 
@@ -28,4 +29,11 @@ public void TestTableSchemaBuilderPutGet() {
       TestUtils.TEST_DDB_TABLE_NAME
     );
   }
+
+  @AfterTest
+  public void cleanup() {
+    TestUtils.cleanUpExampleItem("EnhancedPutGetExample");
+    TestUtils.cleanUpExampleItem("LombokPutGetExample");
+    TestUtils.cleanUpExampleItem("TableSchemaBuilderPutGetExample");
+  }
 }

Examples/runtimes/java/DynamoDbEncryption/src/test/java/software/amazon/cryptography/examples/enhanced/TestSingleTableExample.java

@@ -1,5 +1,6 @@
 package software.amazon.cryptography.examples.enhanced;
 
+import org.testng.annotations.AfterTest;
 import org.testng.annotations.Test;
 import software.amazon.cryptography.examples.TestUtils;
 
@@ -12,4 +13,11 @@ public void TestEnhancedSingleTable() {
       TestUtils.TEST_DDB_TABLE_NAME
     );
   }
+
+  @AfterTest
+  public void cleanup() {
+    TestUtils.cleanUpExampleItem("EnhancedPutGetExample1");
+    TestUtils.cleanUpExampleItem("EnhancedPutGetExample2");
+    TestUtils.cleanUpExampleItem("EnhancedPutGetExample3");
+  }
 }

Examples/runtimes/java/DynamoDbEncryption/src/test/java/software/amazon/cryptography/examples/keyring/TestKmsEcdhKeyringExample.java

@@ -5,6 +5,7 @@
 import static software.amazon.cryptography.examples.keyring.KmsEcdhKeyringExample.shouldGetNewPublicKeys;
 import static software.amazon.cryptography.examples.keyring.KmsEcdhKeyringExample.writePublicKeyPemForEccKey;
 
+import org.testng.annotations.AfterTest;
 import org.testng.annotations.Test;
 import software.amazon.cryptography.examples.TestUtils;
 
@@ -46,4 +47,9 @@ public void TestKmsEcdhKeyringExampleDiscovery() {
       TestUtils.TEST_KMS_ECDH_KEY_ID_P256_RECIPIENT
     );
   }
+
+  @AfterTest
+  public void cleanup() {
+    TestUtils.cleanUpExampleItem("awsKmsEcdhKeyringItem");
+  }
 }

Examples/runtimes/java/DynamoDbEncryption/src/test/java/software/amazon/cryptography/examples/keyring/TestKmsRsaKeyringExample.java

@@ -3,6 +3,7 @@
 import static software.amazon.cryptography.examples.keyring.KmsRsaKeyringExample.shouldGetNewPublicKey;
 import static software.amazon.cryptography.examples.keyring.KmsRsaKeyringExample.writePublicKeyPemForRsaKey;
 
+import org.testng.annotations.AfterTest;
 import org.testng.annotations.Test;
 import software.amazon.cryptography.examples.TestUtils;
 
@@ -22,4 +23,9 @@ public void TestKmsRsaKeyringExample() {
       TestUtils.TEST_KMS_RSA_KEY_ID
     );
   }
+
+  @AfterTest
+  public void cleanup() {
+    TestUtils.cleanUpExampleItem("awsKmsRsaKeyringItem");
+  }
 }

Examples/runtimes/java/DynamoDbEncryption/src/test/java/software/amazon/cryptography/examples/keyring/TestMrkDiscoveryMultiKeyringExample.java

@@ -2,6 +2,7 @@
 
 import java.util.Collections;
 import java.util.List;
+import org.testng.annotations.AfterTest;
 import org.testng.annotations.Test;
 import software.amazon.cryptography.examples.TestUtils;
 
@@ -21,4 +22,9 @@ public void TestMrkDiscoveryMultiKeyringExample() {
       regions
     );
   }
+
+  @AfterTest
+  public void cleanup() {
+    TestUtils.cleanUpExampleItem("awsKmsMrkDiscoveryMultiKeyringItem");
+  }
 }

Examples/runtimes/java/DynamoDbEncryption/src/test/java/software/amazon/cryptography/examples/keyring/TestMrkMultiKeyringExample.java

@@ -1,5 +1,6 @@
 package software.amazon.cryptography.examples.keyring;
 
+import org.testng.annotations.AfterTest;
 import org.testng.annotations.Test;
 import software.amazon.cryptography.examples.TestUtils;
 
@@ -14,4 +15,9 @@ public void TestMrkMultiKeyringExample() {
       TestUtils.TEST_MRK_REPLICA_KEY_ID_US_EAST_1
     );
   }
+
+  @AfterTest
+  public void cleanup() {
+    TestUtils.cleanUpExampleItem("awsKmsMrkMultiKeyringItem");
+  }
 }

Examples/runtimes/java/DynamoDbEncryption/src/test/java/software/amazon/cryptography/examples/keyring/TestMultiKeyringExample.java

@@ -1,6 +1,7 @@
 package software.amazon.cryptography.examples.keyring;
 
 import java.nio.ByteBuffer;
+import org.testng.annotations.AfterTest;
 import org.testng.annotations.Test;
 import software.amazon.cryptography.examples.TestUtils;
 
@@ -17,4 +18,9 @@ public void TestMultiKeyringExample() {
       aesKeyBytes
     );
   }
+
+  @AfterTest
+  public void cleanup() {
+    TestUtils.cleanUpExampleItem("multiKeyringItem");
+  }
 }