updates

Author: airatyusuff-nhs

.github/workflows/stage-2-test.yaml

@@ -47,7 +47,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - name: "Checkout code"
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: "Repo setup"
         run: |
           npm ci
@@ -61,7 +61,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - name: "Checkout code"
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: "Repo setup"
         run: |
           npm ci
@@ -89,7 +89,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - name: "Checkout code"
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: "Repo setup"
         run: |
           npm ci
@@ -105,7 +105,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - name: "Checkout code"
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: "Repo setup"
         run: |
           npm ci

packages/event-builder/README.md

@@ -1,26 +1,46 @@
-# CSV to Event Generator CLI
+# About
 
-## Usage
+CLI tool for client configuration using events.
 
-1. Place the CSV file in the `event-builder/inputs` folder e.g `sample.csv`. All headers must be provided with values:
-    - `Client ID` - the ID of the client you want to create. This can be generated with an online UUID generator.
-    - `Client Name` - the name of the client
-    - `APIM ID` - the APIM Application ID for the client
+## Global Options
 
-    Multiple rows can be added to process more than one client.
+- --environment - The name of the environment to run the command on e.g 'de2-', 'int'. Required.
+- --format - print data in JSON or tabular format. Default is JSON.
 
-2. From the `event-builder` folder, run:
+## Client Config Commands
+
+- Create Client
+
+## Create Client
+
+- creates client using the most minimal client details required and defaults.
+
+### Options
+
+`--csv-file`: the path to the CSV file containing client details
+
+**Note:** All headers in the CSV file must be provided with values:
+
+- `Client ID` - the ID of the client you want to create. This can be generated with an online UUID generator.
+- `Client Name` - the name of the client.
+- `APIM ID` - the APIM Application ID for the client.
+
+Multiple rows can be added to process more than one client.
+
+### Usage
+
+From the root folder i.e `nhs-notify-client-config`, run:
 
 ```bash
-npm run --workspace=nhs-notify-client-config-event-builder cli -- generate-event \
+npm run --workspace=nhs-notify-client-config-event-builder cli -- create-client \
   --csv-file <path to file> \
   --environment <<env>>
 ```
 
 ## Example
 
 ```bash
-npm run --workspace=nhs-notify-client-config-event-builder cli -- generate-event \
-  --csv-file ../inputs/sample.csv \
+npm run --workspace=nhs-notify-client-config-event-builder cli -- create-client \
+  --csv-file inputs/sample.csv \
   --environment de2-aiyu1
 ```

packages/event-builder/src/__tests__/convert-csv-to-client-input.spec.ts

@@ -1,15 +1,16 @@
+import path from "path";
 import { convertCSV } from "../csv-to-client-input";
 
 const invalidCases = [
-  { type: "invalid headers", path: "test-data/invalid-headers.csv", msg: "CSV headers do not match expected." },
-  { type: "empty rows", path: "test-data/empty-rows.csv", msg: "No client data provided." },
-  { type: "missing data in row", path: "test-data/missing-data.csv", msg: "Missing data in row for client ID: client-id-1." }
+  { type: "invalid headers", relativePath: "test-data/invalid-headers.csv", msg: "CSV headers do not match expected." },
+  { type: "empty rows", relativePath: "test-data/empty-rows.csv", msg: "No client data provided." },
+  { type: "missing data in row", relativePath: "test-data/missing-data.csv", msg: "Missing data in row for client ID: client-id-1." }
 ]
 
 describe("test that csv inputs get parsed as expected", () => {
 
   it("should successfully parse csv", () => {
-    const filePath = "test-data/valid.csv";
+    const filePath = path.join(__dirname, "test-data/valid.csv");
 
     const result = convertCSV(filePath);
 
@@ -19,8 +20,11 @@ describe("test that csv inputs get parsed as expected", () => {
     expect(result.map(item => item.clientId)).toEqual((["1","2","3","4"]));
   });
 
-  it.each(invalidCases)('should throw error: "%s" for case: %s:', ({ msg, type, path }) => {
-    expect(() => convertCSV(path)).toThrow(msg);
+  it.each(invalidCases)('should throw error: "%s" for case: %s:', ({ msg, type, relativePath }) => {
+
+    const filePath = path.join(__dirname, relativePath);
+
+    expect(() => convertCSV(filePath)).toThrow(msg);
   });
 
 });

…ent-builder/src/test-data/empty-rows.csv …r/src/__tests__/test-data/empty-rows.csvpackages/event-builder/src/test-data/empty-rows.csv renamed to packages/event-builder/src/__tests__/test-data/empty-rows.csv packages/event-builder/src/test-data/empty-rows.csv renamed to packages/event-builder/src/__tests__/test-data/empty-rows.csv

@@ -41,7 +41,7 @@ async function main() {
     })
     .middleware(setGlobals)
     .command(
-      'generate-event',
+      'create-client',
       'generates the client mutated event and saved onto a queue',
       {
         'csv-file': {

…uilder/src/test-data/invalid-headers.csv …/__tests__/test-data/invalid-headers.csvpackages/event-builder/src/test-data/invalid-headers.csv renamed to packages/event-builder/src/__tests__/test-data/invalid-headers.csv packages/event-builder/src/test-data/invalid-headers.csv renamed to packages/event-builder/src/__tests__/test-data/invalid-headers.csv

@@ -1,5 +1,4 @@
 import fs from "fs";
-import path from "path";
 import { parse } from "csv-parse/sync";
 import { ClientInput } from './input'
 
@@ -16,7 +15,7 @@ const csvHeaders = [
 ]
 
 export const convertCSV = (filePath: string): ClientInput[] => {
-  const csvFile = fs.readFileSync(path.join(__dirname, filePath), "utf-8");
+  const csvFile = fs.readFileSync(filePath, "utf-8");
 
   if(!validateHeaders(csvFile, csvHeaders)) {
     throw new Error("CSV headers do not match expected.");