Added tests for the scanText() method

Author: nagarjun

.gitignore

@@ -1,3 +1,4 @@
+/coverage
 /dist
 /node_modules
 tsconfig.tsbuildinfo

jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

package-lock.json

@@ -10,13 +10,18 @@
   "scripts": {
     "build": "tsc",
     "prepare": "npm run build",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest --coverage"
   },
   "keywords": [],
   "author": "Nagarjun Palavalli <nag@nightfall.ai>",
   "license": "ISC",
   "dependencies": {
-    "axios": "^0.21.4",
-    "typescript": "^4.4.3"
+    "axios": "^0.21.4"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.0.2",
+    "jest": "^27.3.1",
+    "ts-jest": "^27.0.7",
+    "typescript": "^4.4.4"
   }
 }

package.json

@@ -0,0 +1,64 @@
+import { Detector, ScanText } from "../types"
+
+// Requests
+export const creditCardPayload = ['My credit card number is 4242424242424242']
+export const creditCardConfig: ScanText.RequestConfig = {
+  detectionRules: [
+    {
+      name: 'Find credit cards',
+      logicalOp: 'ANY',
+      detectors: [
+        {
+          detectorType: Detector.Type.Nightfall,
+          nightfallDetector: 'CREDIT_CARD_NUMBER',
+          minNumFindings: 1,
+          minConfidence: Detector.Confidence.Likely,
+          displayName: 'Credit Card Number'
+        }
+      ],
+    }
+  ]
+}
+
+// Responses
+export const errorResponse = {
+  code: 40015,
+  message: 'Invalid Request',
+  description: "detectionRuleUUIDs and detectionRules can't both be empty",
+  additionalData: {
+    "InspectRequest.Config.DetectionRuleUUIDs": "at least one of (DetectionRuleUUIDs or DetectionRules) must have length greater than 0",
+    "InspectRequest.Config.DetectionRules": "at least one of (DetectionRuleUUIDs or DetectionRules) must have length greater than 0"
+  },
+}
+
+export const scanTextResponse = {
+  "findings": [
+    [
+      {
+        "finding": "4242424242424242",
+        "detector": {
+          "name": "Credit Card Number",
+          "uuid": "74c1815e-c0c3-4df5-8b1e-6cf98864a454"
+        },
+        "confidence": "LIKELY",
+        "location": {
+          "byteRange": {
+            "start": 25,
+            "end": 41
+          },
+          "codepointRange": {
+            "start": 25,
+            "end": 41
+          }
+        },
+        "matchedDetectionRuleUUIDs": [],
+        "matchedDetectionRules": [
+          "Find credit cards"
+        ]
+      }
+    ]
+  ],
+  "redactedPayload": [
+    ""
+  ]
+}

src/tests/mocks.ts

@@ -0,0 +1,43 @@
+import { Nightfall } from '../nightfall'
+import { creditCardConfig, creditCardPayload, errorResponse } from './mocks'
+
+describe('should test the text scanning method', () => {
+  // Set API key and other dependencies
+  if (!process.env.NIGHTFALL_API_KEY) {
+    throw new Error("NIGHTFALL_API_KEY environment variable is required")
+  }
+
+  const apiKey = process.env.NIGHTFALL_API_KEY
+
+  // Run tests
+  it('should create a new nightfall client and check if the scanText method exists', () => {
+    const client = new Nightfall(apiKey)
+
+    expect(client).toBeDefined()
+    expect(typeof client.scanText).toBe('function')
+  })
+
+  it('should return an error if the request was configured incorrectly', async () => {
+    const client = new Nightfall(apiKey)
+    const scanTextSpy = jest.spyOn(client, 'scanText')
+
+    const response = await client.scanText(creditCardPayload, {})
+    expect(scanTextSpy).toHaveBeenCalledWith(creditCardPayload, {})
+    expect(response.data).toBeUndefined()
+    expect(response.isError).toBe(true)
+    const error = response.getError()
+    expect(error).toEqual(errorResponse)
+  })
+
+  it('should return findings', async () => {
+    const client = new Nightfall(apiKey)
+    const scanTextSpy = jest.spyOn(client, 'scanText')
+
+    const response = await client.scanText(creditCardPayload, creditCardConfig)
+    expect(scanTextSpy).toHaveBeenCalledWith(creditCardPayload, creditCardConfig)
+    expect(response.isError).toBe(false)
+    expect(response.data).toBeDefined()
+    expect(response.data).toHaveProperty('findings')
+    expect(response.data?.findings).toHaveLength(1)
+  })
+})

src/tests/scanText.test.ts

@@ -14,5 +14,5 @@
     "sourceMap": true,
     "rootDir": "src"
   },
-  "exclude": ["dist", "node_modules"]
+  "exclude": ["dist", "node_modules", "src/tests"]
 }