add test letter variation to script

Author: masl2

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

@@ -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-letters/test-letter-standard.pdf",
       "targetFilename",
     );
     expect(mockPutLetter).toHaveBeenCalledWith({
@@ -63,6 +65,51 @@ 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",
+    });
+  });
+
   it("should create a letter DTO with correct fields", () => {
     jest.useFakeTimers();
     jest.setSystemTime(new Date(2020, 1, 1));

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

@@ -61,6 +61,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 +82,7 @@ async function main() {
         const { environment } = argv;
         const { ttlHours } = argv;
         const letterRepository = createLetterRepository(environment, ttlHours);
+        const testLetter = argv.testLetter;
 
         createLetter({
           letterId,
@@ -83,6 +93,7 @@ async function main() {
           specificationId,
           status: status as LetterStatusType,
           letterRepository,
+          testLetter
         });
       },
     )
@@ -136,6 +147,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 +170,22 @@ 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,
-        );
+
+        // 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`,
+            targetFilename,
+          );
+        }
 
         // Create letter DTOs
         const letterDtos = [];

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

@@ -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,
+      `../test-letters/${testLetter}.pdf`,
+      targetFilename,
+    );
+  }
 
   const letter: Omit<Letter, "ttl" | "supplierStatus" | "supplierStatusSk"> = {
     id: letterId,

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

@@ -10,7 +10,7 @@ export default async function uploadFile(
 ) {
   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 = {