DHSCFT-50: Unit testing AI search

search-setup/README.md

@@ -25,3 +25,13 @@ npm install
 ```
 npm run create-index
 ```
+
+## Testing
+
+This project uses Jest for unit testing.
+
+### Running the Unit tests
+
+```bash
+npm run test
+```

search-setup/__tests__/search.test.ts

@@ -0,0 +1,64 @@
+import { config } from "dotenv";
+import { DocumentResponse, SearchIndexResponse } from "../types";
+
+config();
+
+const searchEndpoint = process.env["AI_SEARCH_SERVICE_ENDPOINT"];
+const indexName = process.env["AI_SEARCH_INDEX_NAME"];
+const apiKey = process.env["AI_SEARCH_API_KEY"] ?? "";
+
+describe("AI search index creation and data loading", () => {
+  const URL_PREFIX = `${searchEndpoint}/indexes('${indexName}')`;
+  const URL_SUFFIX = "?api-version=2024-07-01";
+
+  test("should create index with expected fields", async () => {
+    const url = `${URL_PREFIX}${URL_SUFFIX}`;
+
+    const response = await fetch(url, {
+      headers: {
+        "api-key": apiKey,
+      },
+    });
+
+    const index: SearchIndexResponse = await response.json();
+
+    expect(index.name).toBe(indexName);
+    expect(index.fields.length).toBe(2);
+    expect(index.fields.at(0)?.name).toBe("IID");
+    expect(index.fields.at(0)?.type).toBe("Edm.String");
+    expect(index.fields.at(0)?.key).toBe(true);
+    expect(index.fields.at(0)?.retrievable).toBe(true);
+    expect(index.fields.at(0)?.searchable).toBe(true);
+    expect(index.fields.at(0)?.sortable).toBe(true);
+    expect(index.fields.at(0)?.filterable).toBe(true);
+    expect(index.fields.at(1)?.name).toBe("Descriptive");
+    expect(index.fields.at(1)?.type).toBe("Edm.ComplexType");
+    expect(index.fields.at(1)?.fields?.length).toBe(2);
+    expect(index.fields.at(1)?.fields?.at(0)?.name).toBe("Name");
+    expect(index.fields.at(1)?.fields?.at(0)?.type).toBe("Edm.String");
+    expect(index.fields.at(1)?.fields?.at(0)?.retrievable).toBe(true);
+    expect(index.fields.at(1)?.fields?.at(0)?.searchable).toBe(true);
+    expect(index.fields.at(1)?.fields?.at(0)?.sortable).toBe(true);
+    expect(index.fields.at(1)?.fields?.at(0)?.filterable).toBe(true);
+    expect(index.fields.at(1)?.fields?.at(1)?.name).toBe("Definition");
+    expect(index.fields.at(1)?.fields?.at(1)?.type).toBe("Edm.String");
+    expect(index.fields.at(1)?.fields?.at(1)?.retrievable).toBe(true);
+    expect(index.fields.at(1)?.fields?.at(1)?.searchable).toBe(true);
+    expect(index.fields.at(1)?.fields?.at(1)?.sortable).toBe(true);
+    expect(index.fields.at(1)?.fields?.at(1)?.filterable).toBe(true);
+  });
+
+  test("should populate index with data", async () => {
+    const url = `${URL_PREFIX}/docs${URL_SUFFIX}`;
+
+    const response = await fetch(url, {
+      headers: {
+        "api-key": apiKey,
+      },
+    });
+
+    const documents: DocumentResponse = await response.json();
+
+    expect(documents.value.length).toBeGreaterThan(0);
+  });
+});

search-setup/jest.config.ts

@@ -0,0 +1,7 @@
+export default {
+  transform: { "^.+\\.ts?$": "ts-jest" },
+  testEnvironment: "node",
+  moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
+  testMatch: ["<rootDir>/**/*.test.ts"],
+  transformIgnorePatterns: ["^.+\\.js$"],
+};

search-setup/package.json

@@ -1,11 +1,13 @@
 {
   "type": "module",
   "scripts": {
-    "create-index": "tsc && node --env-file=.env main.js"
+    "create-index": "tsc && node --env-file=.env main.js",
+    "test": "jest"
   },
   "devDependencies": {
     "@types/jest": "^29.5.14",
     "@types/node": "^22.10.2",
+    "dotenv": "^16.4.7",
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",
     "typescript": "^5.7.2"

search-setup/tsconfig.json

@@ -10,5 +10,5 @@
     "resolveJsonModule": true
   },
   "include": ["./**/*"],
-  "exclude": ["node_modules"]
+  "exclude": ["node_modules", "__tests__/*", "*.config.ts"]
 }