add error spec to set and rename batch folder location

Author: masl2

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

@@ -4,7 +4,7 @@
     "@internal/datastore": "*",
     "esbuild": "^0.25.11",
     "pino": "^9.7.0",
-    "yargs": "^18.0.0"
+    "yargs": "^17.7.2"
   },
   "devDependencies": {
     "@tsconfig/node22": "^22.0.2",

scripts/utilities/letter-test-data/package.json

@@ -23,6 +23,10 @@ async function main() {
         awsAccountId: {
           type: "string",
           demandOption: true,
+          choices: [
+            "820178564574", // Supplier Dev
+            "885964308133" //Supplier Nonprod
+          ],
         },
         "letter-id": {
           type: "string",
@@ -111,6 +115,10 @@ async function main() {
         awsAccountId: {
           type: "string",
           demandOption: true,
+          choices: [
+            "820178564574", // Supplier Dev
+            "885964308133" //Supplier Nonprod
+          ],
         },
         "group-id": {
           type: "string",
@@ -177,14 +185,15 @@ async function main() {
         // 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}`;
+        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,
-            supplierId,
-            `../test-letters/${testLetter}.pdf`,
+            folder,
+            `${testLetter}.pdf`,
             targetFilename,
           );
         }
@@ -205,7 +214,7 @@ async function main() {
         // Upload Letters
         await letterRepository.putLetterBatch(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 ""
@@ -105,9 +119,10 @@ cd "$PROJECT_DIR"
 
 # Define the three batches with different specification and group IDs
 BATCHES=(
-    "integration-specification-english:group-english:test-letter-standard"
-    "integration-specification-braille:group-accessible:test-letter-standard"
-    "integration-specification-arabic:group-international:test-letter-large"
+    "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
@@ -121,7 +136,7 @@ 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 TEST_LETTER <<< "$batch"
+    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,7 +148,7 @@ for batch in "${BATCHES[@]}"; do
         --specification-id "$SPEC_ID" \
         --group-id "$GROUP_ID-$SUPPLIER_ID" \
         --status "$STATUS" \
-        --count "$COUNT" \
+        --count "$BATCH_COUNT" \
         --ttl-hours "$TTL_HOURS" \
         --test-letter "$TEST_LETTER"
 

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

@@ -32,7 +32,7 @@ export async function createLetter(params: {
     await uploadFile(
       bucketName,
       supplierId,
-      `../test-letters/${testLetter}.pdf`,
+      `${testLetter}.pdf`,
       targetFilename,
     );
   }

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

@@ -3,15 +3,15 @@ import { readFileSync } from "fs";
 import path from "path";
 
 
-export async function uploadFile(bucketName: string, supplierId: string, sourceFilename: string, targetFilename: string) {
+export async function uploadFile(bucketName: string, folder: string, sourceFilename: string, targetFilename: string) {
   try {
     const s3 = new S3Client();
-    const filePath = path.join(__dirname, 'test-letters', 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",
     };