From dbd0f904c59561e88db17fd0f68d9182987cff99 Mon Sep 17 00:00:00 2001
From: PE39806 <185931318+PE39806@users.noreply.github.com>
Date: Wed, 27 Nov 2024 08:47:14 +0000
Subject: [PATCH] BAI-1459 add tests for modelscan client

---
 .../__snapshots__/modelScan.spec.ts.snap      |  41 ++++++
 backend/test/clients/modelScan.spec.ts        | 118 ++++++++++++++++++
 2 files changed, 159 insertions(+)
 create mode 100644 backend/test/clients/__snapshots__/modelScan.spec.ts.snap
 create mode 100644 backend/test/clients/modelScan.spec.ts

diff --git a/backend/test/clients/__snapshots__/modelScan.spec.ts.snap b/backend/test/clients/__snapshots__/modelScan.spec.ts.snap
new file mode 100644
index 000000000..84097df6f
--- /dev/null
+++ b/backend/test/clients/__snapshots__/modelScan.spec.ts.snap
@@ -0,0 +1,41 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`clients > modelScan > getModelScanInfo > success 1`] = `
+[
+  [
+    "undefined://undefined:undefined/info",
+    {
+      "headers": {
+        "Content-Type": "application/json",
+      },
+      "method": "GET",
+    },
+  ],
+]
+`;
+
+exports[`clients > modelScan > scanFile > success 1`] = `
+[
+  [
+    "undefined://undefined:undefined/scan/file",
+    {
+      "body": FormData {
+        Symbol(state): [
+          {
+            "name": "in_file",
+            "value": File {
+              Symbol(kHandle): Blob {},
+              Symbol(kLength): 0,
+              Symbol(kType): "application/x-hdf5",
+            },
+          },
+        ],
+      },
+      "headers": {
+        "accept": "application/json",
+      },
+      "method": "POST",
+    },
+  ],
+]
+`;
diff --git a/backend/test/clients/modelScan.spec.ts b/backend/test/clients/modelScan.spec.ts
new file mode 100644
index 000000000..6a6485a6a
--- /dev/null
+++ b/backend/test/clients/modelScan.spec.ts
@@ -0,0 +1,118 @@
+import { describe, expect, test, vi } from 'vitest'
+
+import { getModelScanInfo, scanFile } from '../../src/clients/modelScan.js'
+
+const configMock = vi.hoisted(() => ({
+  avScanning: {
+    modelscan: {
+      enabled: true,
+      connection: {
+        host: 'example.com',
+      },
+    },
+  },
+}))
+
+vi.mock('../../src/utils/config.js', () => ({
+  __esModule: true,
+  default: configMock,
+}))
+
+const fetchMock = vi.hoisted(() => ({
+  default: vi.fn(() => ({ ok: true, text: vi.fn(), json: vi.fn() })),
+}))
+vi.mock('node-fetch', async () => fetchMock)
+
+describe('clients > modelScan', () => {
+  test('getModelScanInfo > success', async () => {
+    const expectedResponse = {
+      apiName: 'Bailo ModelScan API',
+      apiVersion: '1.0.0',
+      scannerName: 'modelscan',
+      modelscanVersion: '0.8.1',
+    }
+    fetchMock.default.mockReturnValueOnce({
+      ok: true,
+      text: vi.fn(),
+      json: vi.fn(() => expectedResponse),
+    })
+    const response = await getModelScanInfo()
+
+    expect(fetchMock.default).toBeCalled()
+    expect(fetchMock.default.mock.calls).toMatchSnapshot()
+    expect(response).toStrictEqual(expectedResponse)
+  })
+
+  test('getModelScanInfo > bad response', async () => {
+    fetchMock.default.mockResolvedValueOnce({
+      ok: false,
+      text: vi.fn(() => 'Unrecognised response'),
+      json: vi.fn(),
+    })
+
+    expect(() => getModelScanInfo()).rejects.toThrowError(/^Unrecognised response returned by the ModelScan service./)
+  })
+
+  test('getModelScanInfo > rejected', async () => {
+    fetchMock.default.mockRejectedValueOnce('Unable to communicate with the inferencing service.')
+
+    expect(() => getModelScanInfo()).rejects.toThrowError(/^Unable to communicate with the ModelScan service./)
+  })
+
+  test('scanFile > success', async () => {
+    const expectedResponse = {
+      summary: {
+        total_issues: 0,
+        total_issues_by_severity: {
+          LOW: 0,
+          MEDIUM: 0,
+          HIGH: 0,
+          CRITICAL: 0,
+        },
+        input_path: '/foo/bar/safe_model.h5',
+        absolute_path: '/foo/bar',
+        modelscan_version: '0.8.1',
+        timestamp: '2024-11-27T12:00:00.000000',
+        scanned: {
+          total_scanned: 1,
+          scanned_files: ['safe_model.h5'],
+        },
+        skipped: {
+          total_skipped: 0,
+          skipped_files: [],
+        },
+      },
+      issues: [],
+      errors: [],
+    }
+    fetchMock.default.mockReturnValueOnce({
+      ok: true,
+      text: vi.fn(),
+      json: vi.fn(() => expectedResponse),
+    })
+    const response = await scanFile(new Blob([''], { type: 'application/x-hdf5' }), 'safe_model.h5')
+
+    expect(fetchMock.default).toBeCalled()
+    expect(fetchMock.default.mock.calls).toMatchSnapshot()
+    expect(response).toStrictEqual(expectedResponse)
+  })
+
+  test('scanFile > bad response', async () => {
+    fetchMock.default.mockResolvedValueOnce({
+      ok: false,
+      text: vi.fn(() => 'Unrecognised response'),
+      json: vi.fn(),
+    })
+    expect(() => scanFile(new Blob([''], { type: 'application/x-hdf5' }), 'safe_model.h5')).rejects.toThrowError(
+      /^Unrecognised response returned by the ModelScan service./,
+    )
+  })
+
+  test('scanFile > rejected', async () => {
+    fetchMock.default.mockRejectedValueOnce('Unable to communicate with the inferencing service.')
+
+    expect(() => scanFile(new Blob([''], { type: 'application/x-hdf5' }), 'safe_model.h5')).rejects.toThrowError(
+      /^Unable to communicate with the ModelScan service./,
+    )
+  })
+})