Refactor test fixture creation to reduce repeat

Author: mjewildnhs

tools/client-subscriptions-management/src/__tests__/domain/client-config-validator.test.ts

@@ -1,28 +1,7 @@
 import { validateClientConfig } from "src/domain/client-config-validator";
+import { createPopulatedClientSubscriptionConfig } from "src/__tests__/helpers/client-subscription-fixtures";
 
-const TARGET_ID = "00000000-0000-4000-8000-000000000001";
-
-const createValidConfig = () => ({
-  clientId: "client-1",
-  subscriptions: [
-    {
-      subscriptionId: "00000000-0000-0000-0000-000000000001",
-      subscriptionType: "MessageStatus",
-      messageStatuses: ["DELIVERED"],
-      targetIds: [TARGET_ID],
-    },
-  ],
-  targets: [
-    {
-      targetId: TARGET_ID,
-      type: "API",
-      invocationEndpoint: "https://example.com/webhook",
-      invocationMethod: "POST",
-      invocationRateLimit: 10,
-      apiKey: { headerName: "x-api-key", headerValue: "secret" },
-    },
-  ],
-});
+const createValidConfig = () => createPopulatedClientSubscriptionConfig();
 
 describe("validateClientConfig", () => {
   it("returns the config unchanged when parsing succeeds", () => {

tools/client-subscriptions-management/src/__tests__/entrypoint/cli/clients-get.test.ts

@@ -9,12 +9,9 @@ jest.mock("src/entrypoint/cli/helper", () => ({
 }));
 
 import * as cli from "src/entrypoint/cli/clients-get";
+import { createClientSubscriptionConfig } from "src/__tests__/helpers/client-subscription-fixtures";
 
-const validConfig = {
-  clientId: "client-1",
-  subscriptions: [],
-  targets: [],
-};
+const validConfig = createClientSubscriptionConfig();
 
 describe("clients-get CLI", () => {
   const originalLog = console.log;

tools/client-subscriptions-management/src/__tests__/entrypoint/cli/clients-put.test.ts

@@ -19,12 +19,9 @@ jest.mock("node:fs", () => ({
 }));
 
 import * as cli from "src/entrypoint/cli/clients-put";
+import { createClientSubscriptionConfig } from "src/__tests__/helpers/client-subscription-fixtures";
 
-const validConfig = {
-  clientId: "client-1",
-  subscriptions: [],
-  targets: [],
-};
+const validConfig = createClientSubscriptionConfig();
 
 describe("clients-put CLI", () => {
   const originalLog = console.log;

tools/client-subscriptions-management/src/__tests__/entrypoint/cli/helper.test.ts

@@ -1,9 +1,3 @@
-import type {
-  CallbackTarget,
-  ChannelStatusSubscriptionConfiguration,
-  ClientSubscriptionConfiguration,
-  MessageStatusSubscriptionConfiguration,
-} from "@nhs-notify-client-callbacks/models";
 import {
   createRepository,
   deriveBucketName,
@@ -16,6 +10,13 @@ import {
   resolveRegion,
   runTerraformApply,
 } from "src/entrypoint/cli/helper";
+import {
+  DEFAULT_TARGET_ID as TARGET_ID,
+  createChannelStatusSubscription,
+  createClientSubscriptionConfig,
+  createMessageStatusSubscription,
+  createTarget,
+} from "src/__tests__/helpers/client-subscription-fixtures";
 
 jest.mock("src/container", () => ({
   createClientSubscriptionRepository: jest.fn(),
@@ -32,39 +33,16 @@ jest.mock("@aws-sdk/client-sts", () => ({
   GetCallerIdentityCommand: jest.fn(),
 }));
 
-const TARGET_ID = "00000000-0000-4000-8000-000000000001";
-
 describe("cli helper", () => {
-  const target: CallbackTarget = {
-    targetId: TARGET_ID,
-    type: "API",
-    invocationEndpoint: "https://example.com/webhook",
-    invocationMethod: "POST",
-    invocationRateLimit: 10,
-    apiKey: { headerName: "x-api-key", headerValue: "secret" },
-  };
+  const target = createTarget();
+  const messageSubscription = createMessageStatusSubscription();
+  const channelSubscription = createChannelStatusSubscription();
 
-  const messageSubscription: MessageStatusSubscriptionConfiguration = {
-    subscriptionId: "sub-001",
-    subscriptionType: "MessageStatus",
-    messageStatuses: ["DELIVERED"],
-    targetIds: [TARGET_ID],
-  };
-
-  const channelSubscription: ChannelStatusSubscriptionConfiguration = {
-    subscriptionId: "sub-002",
-    subscriptionType: "ChannelStatus",
-    channelType: "SMS",
-    channelStatuses: ["DELIVERED"],
-    supplierStatuses: ["delivered"],
-    targetIds: [TARGET_ID],
-  };
-
-  const config: ClientSubscriptionConfiguration = {
+  const config = createClientSubscriptionConfig({
     clientId: "client-a",
     subscriptions: [messageSubscription, channelSubscription],
     targets: [target],
-  };
+  });
 
   it("formats subscriptions as a table string", () => {
     const result = formatSubscriptionsTable(config.subscriptions);
@@ -96,21 +74,19 @@ describe("cli helper", () => {
   });
 
   it("shows (none) when subscriptions is empty", () => {
-    const empty: ClientSubscriptionConfiguration = {
+    const empty = createClientSubscriptionConfig({
       clientId: "empty-client",
-      subscriptions: [],
       targets: [target],
-    };
+    });
 
     expect(formatClientConfig(empty)).toContain("Subscriptions: (none)");
   });
 
   it("shows (none) when targets is empty", () => {
-    const empty: ClientSubscriptionConfiguration = {
+    const empty = createClientSubscriptionConfig({
       clientId: "empty-client",
       subscriptions: [messageSubscription],
-      targets: [],
-    };
+    });
 
     expect(formatClientConfig(empty)).toContain("Targets: (none)");
   });

tools/client-subscriptions-management/src/__tests__/entrypoint/cli/subscriptions-add.test.ts

@@ -18,8 +18,9 @@ jest.mock("src/entrypoint/cli/helper", () => ({
 }));
 
 import * as cli from "src/entrypoint/cli/subscriptions-add";
+import { createClientSubscriptionConfig } from "src/__tests__/helpers/client-subscription-fixtures";
 
-const resultConfig = { clientId: "client-1", subscriptions: [], targets: [] };
+const resultConfig = createClientSubscriptionConfig();
 
 describe("subscriptions-add CLI", () => {
   const originalLog = console.log;

tools/client-subscriptions-management/src/__tests__/entrypoint/cli/subscriptions-del.test.ts

@@ -11,8 +11,9 @@ jest.mock("src/entrypoint/cli/helper", () => ({
 }));
 
 import * as cli from "src/entrypoint/cli/subscriptions-del";
+import { createClientSubscriptionConfig } from "src/__tests__/helpers/client-subscription-fixtures";
 
-const resultConfig = { clientId: "client-1", subscriptions: [], targets: [] };
+const resultConfig = createClientSubscriptionConfig();
 
 describe("subscriptions-del CLI", () => {
   const originalLog = console.log;

tools/client-subscriptions-management/src/__tests__/entrypoint/cli/subscriptions-list.test.ts

@@ -11,19 +11,18 @@ jest.mock("src/entrypoint/cli/helper", () => ({
 }));
 
 import * as cli from "src/entrypoint/cli/subscriptions-list";
+import {
+  createClientSubscriptionConfig,
+  createMessageStatusSubscription,
+} from "src/__tests__/helpers/client-subscription-fixtures";
 
-const validConfig = {
-  clientId: "client-1",
+const validConfig = createClientSubscriptionConfig({
   subscriptions: [
-    {
-      subscriptionId: "sub-001",
-      subscriptionType: "MessageStatus",
-      messageStatuses: ["DELIVERED"],
+    createMessageStatusSubscription({
       targetIds: ["target-001"],
-    },
+    }),
   ],
-  targets: [],
-};
+});
 
 describe("subscriptions-list CLI", () => {
   const originalLog = console.log;

tools/client-subscriptions-management/src/__tests__/entrypoint/cli/subscriptions-set-states.test.ts

@@ -11,8 +11,9 @@ jest.mock("src/entrypoint/cli/helper", () => ({
 }));
 
 import * as cli from "src/entrypoint/cli/subscriptions-set-states";
+import { createClientSubscriptionConfig } from "src/__tests__/helpers/client-subscription-fixtures";
 
-const resultConfig = { clientId: "client-1", subscriptions: [], targets: [] };
+const resultConfig = createClientSubscriptionConfig();
 
 describe("subscriptions-set-states CLI", () => {
   const originalLog = console.log;

tools/client-subscriptions-management/src/__tests__/entrypoint/cli/targets-add.test.ts

@@ -16,21 +16,16 @@ jest.mock("src/entrypoint/cli/helper", () => ({
 }));
 
 import * as cli from "src/entrypoint/cli/targets-add";
+import {
+  createClientSubscriptionConfig,
+  createTarget,
+} from "src/__tests__/helpers/client-subscription-fixtures";
 
-const builtTarget = {
-  targetId: "00000000-0000-4000-8000-000000000001",
-  type: "API",
-  invocationEndpoint: "https://example.com/webhook",
-  invocationMethod: "POST",
-  invocationRateLimit: 10,
-  apiKey: { headerName: "x-api-key", headerValue: "secret" },
-};
-
-const resultConfig = {
-  clientId: "client-1",
-  subscriptions: [],
+const builtTarget = createTarget();
+
+const resultConfig = createClientSubscriptionConfig({
   targets: [builtTarget],
-};
+});
 
 describe("targets-add CLI", () => {
   const originalLog = console.log;

tools/client-subscriptions-management/src/__tests__/entrypoint/cli/targets-del.test.ts

@@ -11,8 +11,9 @@ jest.mock("src/entrypoint/cli/helper", () => ({
 }));
 
 import * as cli from "src/entrypoint/cli/targets-del";
+import { createClientSubscriptionConfig } from "src/__tests__/helpers/client-subscription-fixtures";
 
-const resultConfig = { clientId: "client-1", subscriptions: [], targets: [] };
+const resultConfig = createClientSubscriptionConfig();
 
 describe("targets-del CLI", () => {
   const originalLog = console.log;