add supplier mock dummy lambda function

Author: Vlasis-Perdikidis

infrastructure/terraform/components/api/module_lambda_supplier_mock.tf

@@ -0,0 +1,69 @@
+module "get_letter" {
+  source = "https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip"
+
+  function_name = "supplier_mock"
+  description   = "Mock the behaviour of a supplier"
+
+  aws_account_id = var.aws_account_id
+  component      = var.component
+  environment    = var.environment
+  project        = var.project
+  region         = var.region
+  group          = var.group
+
+  log_retention_in_days = var.log_retention_in_days
+  kms_key_arn           = module.kms.key_arn
+
+  iam_policy_document = {
+    body = data.aws_iam_policy_document.supplier_mock_lambda.json
+  }
+
+  function_s3_bucket      = local.acct.s3_buckets["lambda_function_artefacts"]["id"]
+  function_code_base_path = local.aws_lambda_functions_dir_path
+  function_code_dir       = "supplier-mock/dist"
+  function_include_common = true
+  handler_function_name   = "supplierMockHandler" // double check that the handler function name is correct
+  runtime                 = "nodejs22.x"
+  memory                  = 512
+  timeout                 = 29
+  log_level               = var.log_level
+
+  force_lambda_code_deploy = var.force_lambda_code_deploy
+  enable_lambda_insights   = false
+
+  log_destination_arn       = local.destination_arn
+  log_subscription_role_arn = local.acct.log_subscription_role_arn
+
+  lambda_env_vars = merge(local.common_lambda_env_vars, {})
+}
+
+// TODO: add lambda invoke permissions
+data "aws_iam_policy_document" "supplier_mock_lambda" {
+  statement {
+    sid    = "KMSPermissions"
+    effect = "Allow"
+
+    actions = [
+      "kms:Decrypt",
+      "kms:GenerateDataKey",
+    ]
+
+    resources = [
+      module.kms.key_arn, ## Requires shared kms module
+    ]
+  }
+
+  statement {
+    sid    = "AllowInvokeLambda"
+    effect = "Allow"
+
+    actions = [
+      "lambda:InvokeFunction",
+    ]
+
+    resources = [
+      module.get_letters.function_arn,
+      module.patch_letter.function_arn
+    ]
+  }
+}

lambdas/supplier-mock/.gitignore

@@ -0,0 +1,4 @@
+coverage
+node_modules
+dist
+.reports

lambdas/supplier-mock/jest.config.ts

@@ -0,0 +1,69 @@
+export const baseJestConfig = {
+  preset: "ts-jest",
+  extensionsToTreatAsEsm: [".ts"],
+  transform: {
+    "^.+\\.ts$": [
+      "ts-jest",
+      {
+        useESM: true,
+      },
+    ],
+  },
+  transformIgnorePatterns: [
+    "node_modules/(?!(@nhsdigital/nhs-notify-event-schemas-supplier-config)/)",
+  ],
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "./.reports/unit/coverage",
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "babel",
+
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: -10,
+    },
+  },
+
+  coveragePathIgnorePatterns: ["/__tests__/"],
+  testPathIgnorePatterns: [".build"],
+  testMatch: ["**/?(*.)+(spec|test).[jt]s?(x)"],
+
+  // Use this configuration option to add custom reporters to Jest
+  reporters: [
+    "default",
+    [
+      "jest-html-reporter",
+      {
+        pageTitle: "Test Report",
+        outputPath: "./.reports/unit/test-report.html",
+        includeFailureMsg: true,
+      },
+    ],
+  ],
+
+  // The test environment that will be used for testing
+  testEnvironment: "jsdom",
+};
+
+const utilsJestConfig = {
+  ...baseJestConfig,
+
+  testEnvironment: "node",
+
+  coveragePathIgnorePatterns: [
+    ...(baseJestConfig.coveragePathIgnorePatterns ?? []),
+    "zod-validators.ts",
+  ],
+};
+
+export default utilsJestConfig;

lambdas/supplier-mock/package.json

@@ -0,0 +1,19 @@
+{
+  "dependencies": {
+    "@internal/helpers": "^0.1.0",
+    "aws-embedded-metrics": "^4.2.1",
+    "aws-lambda": "^1.0.7",
+    "pino": "^10.3.1",
+    "zod": "^4.3.6"
+  },
+  "name": "nhs-notify-supplier-api-supplier-mock",
+  "private": true,
+  "scripts": {
+    "lambda-build": "rm -rf dist && npx esbuild --bundle --minify --sourcemap --target=es2020 --platform=node --loader:.node=file --entry-names=[name] --outdir=dist src/index.ts",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "test:unit": "jest",
+    "typecheck": "tsc --noEmit"
+  },
+  "version": "0.0.1"
+}

lambdas/supplier-mock/src/deps.ts

@@ -0,0 +1,17 @@
+import { Logger } from "pino";
+import { createLogger } from "@internal/helpers/src";
+import { EnvVars, envVars } from "./env";
+
+export type Deps = {
+  logger: Logger;
+  env: EnvVars;
+};
+
+export function createDependenciesContainer(): Deps {
+  const log = createLogger({ logLevel: envVars.PINO_LOG_LEVEL });
+
+  return {
+    logger: log,
+    env: envVars,
+  };
+}

lambdas/supplier-mock/src/env.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+
+const EnvVarsSchema = z.object({
+  PINO_LOG_LEVEL: z.coerce.string().optional(),
+});
+
+export type EnvVars = z.infer<typeof EnvVarsSchema>;
+
+export const envVars: EnvVars = EnvVarsSchema.parse(process.env);

lambdas/supplier-mock/src/index.ts

@@ -0,0 +1,7 @@
+import { createDependenciesContainer } from "./deps";
+import createHandler from "./supplier-mock";
+
+const container = createDependenciesContainer();
+
+// eslint-disable-next-line import-x/prefer-default-export
+export const handler = createHandler(container);

lambdas/supplier-mock/src/supplier-mock.ts

@@ -0,0 +1,7 @@
+import { Deps } from "./deps";
+
+export default function createHandler(deps: Deps) {
+  return async function handler() {
+    deps.logger.info("Hello from the supplier mock lambda!");
+  };
+}

lambdas/supplier-mock/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "esModuleInterop": true
+  },
+  "extends": "../../tsconfig.base.json",
+  "include": [
+    "src/**/*",
+    "jest.config.ts"
+  ]
+}