CCM-13711: test data variations rebranched (#394)

* add test letter variation to script

* update wrapper script

* add error spec to set and rename batch folder location

* tests fixes

* fix tests and update script comments

* allow prod for single test letter upload

* Add missing dependencies

* lockfile

* lock

* lint

---------

Co-authored-by: namitha.prabhu <namitha.prabhu2@nhs.net>
Co-authored-by: Steve Buxton <steve.buxton@nhs.net>

Author: 3 people

package-lock.json

@@ -43,11 +43,12 @@ For creating multiple batches with different specification and group IDs, use th
   --status PENDING
 ```
 
-This script creates 3 batches with the following configurations:
+This script creates 4 batches with the following configurations:
 
 - Batch 1: `--specification-id integration-specification-english --group-id group-english`
 - Batch 2: `--specification-id integration-specification-braille --group-id group-accessible`
 - Batch 3: `--specification-id integration-specification-arabic --group-id group-international`
+- Batch 4: `--specification-id integration-specification-missing-pdf --group-id group-error`
 
 **Note:** The default configuration creates 2,505 letters total (835 letters × 3 batches) with an 18-month TTL.
 
@@ -57,5 +58,6 @@ This script creates 3 batches with the following configurations:
 - `--environment` (required): Environment (e.g., pr147, main)
 - `--awsAccountId` (required): AWS Account ID for S3 bucket resolution
 - `--count` (optional): Number of letters per batch (default: 835)
+- `--missing-count` (optional): Number of letters with missing PDFs (default: 5)
 - `--status` (optional): Letter status (default: PENDING)
 - `--ttl-hours` (optional): TTL in hours (default: 13140, ~18 months)

scripts/utilities/letter-test-data/README.md

@@ -13,7 +13,7 @@ describe("Create letter helpers", () => {
     jest.resetAllMocks();
   });
 
-  it("create letter", async () => {
+  it("create letter should create and upload a test letter", async () => {
     jest.useFakeTimers();
     jest.setSystemTime(new Date(2020, 1, 1));
 
@@ -30,6 +30,7 @@ describe("Create letter helpers", () => {
     const groupId = "groupId";
     const specificationId = "specificationId";
     const status = "PENDING" as LetterStatusType;
+    const testLetter = "test-letter-standard";
 
     await createLetter({
       letterId,
@@ -40,12 +41,13 @@ describe("Create letter helpers", () => {
       specificationId,
       status,
       letterRepository: mockedLetterRepository,
+      testLetter,
     });
 
     expect(mockedUploadFile).toHaveBeenCalledWith(
       "bucketName",
       "supplierId",
-      "../../test_letter.pdf",
+      "test-letter-standard.pdf",
       "targetFilename",
     );
     expect(mockPutLetter).toHaveBeenCalledWith({
@@ -63,6 +65,54 @@ describe("Create letter helpers", () => {
     });
   });
 
+  it("should not upload a letter for none", async () => {
+    jest.useFakeTimers();
+    jest.setSystemTime(new Date(2020, 1, 1));
+
+    const mockPutLetter = jest.fn();
+    const mockedLetterRepository = {
+      putLetter: mockPutLetter,
+    } as any as LetterRepository;
+    const mockedUploadFile = uploadFile as jest.Mock;
+
+    const supplierId = "supplierId";
+    const letterId = "letterId";
+    const bucketName = "bucketName";
+    const targetFilename = "targetFilename";
+    const groupId = "groupId";
+    const specificationId = "specificationId";
+    const status = "PENDING" as LetterStatusType;
+    const testLetter = "none";
+
+    await createLetter({
+      letterId,
+      bucketName,
+      supplierId,
+      targetFilename,
+      groupId,
+      specificationId,
+      status,
+      letterRepository: mockedLetterRepository,
+      testLetter,
+    });
+
+    expect(mockedUploadFile).not.toHaveBeenCalled();
+
+    expect(mockPutLetter).toHaveBeenCalledWith({
+      createdAt: "2020-02-01T00:00:00.000Z",
+      groupId: "groupId",
+      id: "letterId",
+      specificationId: "specificationId",
+      status: "PENDING",
+      supplierId: "supplierId",
+      updatedAt: "2020-02-01T00:00:00.000Z",
+      url: "s3://bucketName/supplierId/targetFilename",
+      billingRef: "specificationId",
+      source: "/data-plane/letter-rendering/letter-test-data",
+      subject: "supplier-api/letter-test-data/letterId",
+    });
+  });
+
   it("should create a letter DTO with correct fields", () => {
     jest.useFakeTimers();
     jest.setSystemTime(new Date(2020, 1, 1));

scripts/utilities/letter-test-data/src/__test__/helpers/create-letter-helpers.test.ts

@@ -26,6 +26,11 @@ async function main() {
         awsAccountId: {
           type: "string",
           demandOption: true,
+          choices: [
+            "820178564574", // Supplier Dev
+            "885964308133", // Supplier Nonprod
+            "815459455390", // Supplier Prod
+          ],
         },
         "letter-id": {
           type: "string",
@@ -61,6 +66,15 @@ async function main() {
             "DELIVERED",
           ],
         },
+        "test-letter": {
+          type: "string",
+          demandOption: true,
+          choices: [
+            "test-letter-large",
+            "test-letter-standard",
+            "none", // none exists to specify letter without pdf for error testing scenarios
+          ],
+        },
       },
       async (argv) => {
         const { supplierId } = argv;
@@ -73,6 +87,7 @@ async function main() {
         const { environment } = argv;
         const { ttlHours } = argv;
         const letterRepository = createLetterRepository(environment, ttlHours);
+        const { testLetter } = argv;
 
         createLetter({
           letterId,
@@ -83,6 +98,7 @@ async function main() {
           specificationId,
           status: status as LetterStatusType,
           letterRepository,
+          testLetter,
         });
       },
     )
@@ -101,6 +117,10 @@ async function main() {
         awsAccountId: {
           type: "string",
           demandOption: true,
+          choices: [
+            "820178564574", // Supplier Dev
+            "885964308133", // Supplier Nonprod
+          ],
         },
         "group-id": {
           type: "string",
@@ -136,6 +156,15 @@ async function main() {
             "DELIVERED",
           ],
         },
+        "test-letter": {
+          type: "string",
+          demandOption: true,
+          choices: [
+            "test-letter-large",
+            "test-letter-standard",
+            "none", // none exists to specify letter without pdf for error testing scenarios
+          ],
+        },
       },
       async (argv) => {
         // set batch ID
@@ -150,17 +179,23 @@ async function main() {
         const { ttlHours } = argv;
         const letterRepository = createLetterRepository(environment, ttlHours);
         const { count } = argv;
+        const { testLetter } = argv;
 
-        // Upload a test file for this batch
+        // Setup file attributes
         const bucketName = `nhs-${argv.awsAccountId}-eu-west-2-${argv.environment}-supapi-test-letters`;
         const targetFilename = `${batchId}-${status}.pdf`;
-        const url = `s3://${bucketName}/${batchId}/${targetFilename}`;
-        await uploadFile(
-          bucketName,
-          batchId,
-          "../../test_letter.pdf",
-          targetFilename,
-        );
+        const folder = `${supplierId}/${batchId}`;
+        const url = `s3://${bucketName}/${folder}/${targetFilename}`;
+
+        // Upload a test file for this batch if it is not an 'none' batch
+        if (testLetter !== "none") {
+          await uploadFile(
+            bucketName,
+            folder,
+            `${testLetter}.pdf`,
+            targetFilename,
+          );
+        }
 
         // Create letter DTOs
         const letterDtos = [];
@@ -180,7 +215,7 @@ async function main() {
         // Upload Letters
         await letterRepository.unsafePutLetterBatch(letterDtos);
 
-        console.log(`Created batch ${batchId} of ${letterDtos.length}`);
+        console.log(`Created batch ${batchId} of ${letterDtos.length} letters`);
       },
     )
     .demandCommand(1)

scripts/utilities/letter-test-data/src/cli/index.ts

@@ -16,17 +16,20 @@ usage() {
     echo ""
     echo "Optional parameters:"
     echo "  --count           Number of letters per batch (default: 835)"
+    echo "  --missing-count   Number of letters with missing PDFs (default: 5)"
     echo "  --status          Letter status (default: PENDING)"
     echo "  --ttl-hours       TTL in hours (default: 13140)"
     echo ""
     echo "Example:"
     echo "  $0 --supplier-id supplier-123 --environment pr147 --awsAccountId 820178564574"
     echo "  $0 --supplier-id supplier-123 --environment main --awsAccountId 820178564574 --count 25 --status ACCEPTED"
+    echo "  $0 --supplier-id supplier-123 --environment main --awsAccountId 820178564574 --count 25 --status ACCEPTED --missing-count 3"
     exit 1
 }
 
 # Default values
 COUNT=835 #3 batches = 2505 letters
+MISSING_COUNT=5 # Number of letters with missing PDFs
 STATUS="PENDING"
 TTL_HOURS=13140 # Approximately 18 months
 
@@ -49,6 +52,10 @@ while [[ $# -gt 0 ]]; do
             COUNT="$2"
             shift 2
             ;;
+        --missing-count)
+            MISSING_COUNT="$2"
+            shift 2
+            ;;
         --status)
             STATUS="$2"
             shift 2
@@ -87,11 +94,18 @@ if ! [[ "$COUNT" =~ ^[1-9][0-9]*$ ]]; then
     exit 1
 fi
 
+# Validate missing count is a positive number
+if ! [[ "$MISSING_COUNT" =~ ^[1-9][0-9]*$ ]]; then
+    echo "Error: Missing count must be a positive integer"
+    exit 1
+fi
+
 echo "Creating letter batches with the following configuration:"
 echo "  Supplier ID: $SUPPLIER_ID"
 echo "  Environment: $ENVIRONMENT"
 echo "  AWS Account ID: $AWS_ACCOUNT_ID"
 echo "  Count per batch: $COUNT"
+echo "  Letters missing PDFs count: $MISSING_COUNT"
 echo "  Status: $STATUS"
 echo "  TTL Hours: $TTL_HOURS"
 echo ""
@@ -103,11 +117,12 @@ PROJECT_DIR="$(dirname "$SCRIPT_DIR")"
 # Change to the project directory
 cd "$PROJECT_DIR"
 
-# Define the three batches with different specification and group IDs
+# Define the batches with different specification and group IDs
 BATCHES=(
-    "integration-specification-english:group-english"
-    "integration-specification-braille:group-accessible"
-    "integration-specification-arabic:group-international"
+    "integration-specification-english:group-english:test-letter-standard:${COUNT}"
+    "integration-specification-braille:group-accessible:test-letter-standard:${COUNT}"
+    "integration-specification-arabic:group-international:test-letter-large:${COUNT}"
+    "integration-specification-missing-pdf:group-error:none:${MISSING_COUNT}"
 )
 
 # Counter for tracking batch creation
@@ -120,8 +135,8 @@ echo ""
 
 # Create each batch
 for batch in "${BATCHES[@]}"; do
-    # Parse specification-id and group-id from the batch definition
-    IFS=':' read -r SPEC_ID GROUP_ID <<< "$batch"
+    # Parse specification-id, group-id and batch volume from the batch definition
+    IFS=':' read -r SPEC_ID GROUP_ID TEST_LETTER BATCH_COUNT <<< "$batch"
 
     echo "[$BATCH_COUNTER/$TOTAL_BATCHES] Creating batch with specification-id: $SPEC_ID, group-id: $GROUP_ID-$SUPPLIER_ID"
 
@@ -133,8 +148,9 @@ for batch in "${BATCHES[@]}"; do
         --specification-id "$SPEC_ID" \
         --group-id "$GROUP_ID-$SUPPLIER_ID" \
         --status "$STATUS" \
-        --count "$COUNT" \
-        --ttl-hours "$TTL_HOURS"
+        --count "$BATCH_COUNT" \
+        --ttl-hours "$TTL_HOURS" \
+        --test-letter "$TEST_LETTER"
 
     if [[ $? -eq 0 ]]; then
         echo "✓ Batch $BATCH_COUNTER completed successfully"

scripts/utilities/letter-test-data/src/create-batch-letters.sh

@@ -14,6 +14,7 @@ export async function createLetter(params: {
   groupId: string;
   status: LetterStatusType;
   letterRepository: LetterRepository;
+  testLetter: string;
 }) {
   const {
     bucketName,
@@ -24,14 +25,17 @@ export async function createLetter(params: {
     status,
     supplierId,
     targetFilename,
+    testLetter,
   } = params;
 
-  await uploadFile(
-    bucketName,
-    supplierId,
-    "../../test_letter.pdf",
-    targetFilename,
-  );
+  if (testLetter !== "none") {
+    await uploadFile(
+      bucketName,
+      supplierId,
+      `${testLetter}.pdf`,
+      targetFilename,
+    );
+  }
 
   const letter: Omit<Letter, "ttl" | "supplierStatus" | "supplierStatusSk"> = {
     id: letterId,

scripts/utilities/letter-test-data/src/helpers/create-letter-helpers.ts

@@ -4,18 +4,18 @@ import path from "node:path";
 
 export default async function uploadFile(
   bucketName: string,
-  supplierId: string,
+  folder: string,
   sourceFilename: string,
   targetFilename: string,
 ) {
   try {
     const s3 = new S3Client();
-    const filePath = path.join(__dirname, sourceFilename);
+    const filePath = path.join(__dirname, "..", "test-letters", sourceFilename);
     const fileContent = readFileSync(filePath);
 
     const uploadParams = {
       Bucket: bucketName,
-      Key: `${supplierId}/${targetFilename}`,
+      Key: `${folder}/${targetFilename}`,
       Body: fileContent,
       ContentType: "application/pdf",
     };