[RND-513] Jest is taking too long (#222)

* Adding debug configuration for extension * Adding missing config values for tests * Update dependencies * Restore jest mongo db * Add fastify mocks to close connection * Fixing mock that was doing an actual db connection * Refactor of get test to avoid multiple setup and multiple connections * Fixing post test to mock db connection * Fixing mock on test for Put * Fix typo * Adding method to get successful frontend response for tests * Fix mocking on frontend facade * Using specific tsconfig file for spec files to have a simpler compilation * Test workers * Fixing jest config import * Moving maxWorkers to default config * Adding max workers explicitly on action * Adding jest cache * Adding script for unit tests on CI
Ed-Fi-Exchange-OSS · Mar 17, 2023 · 9db1d62 · 9db1d62
1 parent 0141edc
commit 9db1d62
Show file tree

Hide file tree

Showing 26 changed files with 707 additions and 404 deletions.
diff --git a/.github/workflows/on-pullrequest.yml b/.github/workflows/on-pullrequest.yml
@@ -150,13 +150,10 @@ jobs:
       matrix:
         tests:
           [
-            {
-              type: "Unit",
-              command: "npm run test:unit:coverage -- --ci",
-            },
+            { type: "Unit", command: "npm run test:unit:coverage:ci" },
             {
               type: "Integration",
-              command: "npm run test:integration -- --ci ",
+              command: "npm run test:integration -- --ci",
             },
           ]
 
@@ -190,6 +187,13 @@ jobs:
         if: ${{ steps.modules-cache.outputs.cache-hit != 'true' }}
         run: npm install
 
+      - name: Jest cache
+        id: cache-jest
+        uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7 #v3.0.11
+        with:
+          path: /tmp/jest_rt
+          key: ${{ runner.os }}-jest-${{ hashFiles('**/package-lock.json') }}
+
       - name: Configure postgres
         if: ${{ matrix.tests.type != 'Unit' }}
         run: |
@@ -251,6 +255,13 @@ jobs:
       - name: Install required dependencies
         run: npm install -D cross-env
 
+      - name: Jest cache
+        id: cache-jest
+        uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7 #v3.0.11
+        with:
+          path: /tmp/jest_rt
+          key: ${{ runner.os }}-jest-${{ hashFiles('**/package-lock.json') }}
+
       - name: Create .env file
         run: |
           touch .env

diff --git a/Meadowlark-js/.vscode/launch.json b/Meadowlark-js/.vscode/launch.json
@@ -40,6 +40,17 @@
       "console": "integratedTerminal",
       "sourceMaps": true
     },
+    {
+      "type": "node",
+      "name": "vscode-jest-tests",
+      "request": "launch",
+      "console": "integratedTerminal",
+      "program": "${workspaceRoot}/node_modules/jest-cli/bin/jest.js",
+      "args": [
+        "jest",
+        "--runInBand",
+      ]
+    },
     {
       "type": "node",
       "name": "MongoDb Integration Tests",

diff --git a/Meadowlark-js/backends/meadowlark-mongodb-backend/test/middleware/SecurityMiddleware.test.ts b/Meadowlark-js/backends/meadowlark-mongodb-backend/test/middleware/SecurityMiddleware.test.ts
@@ -3,7 +3,7 @@
 // The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0.
 // See the LICENSE and NOTICES files in the project root for more information.
 
-import { FrontendRequest, FrontendResponse, newFrontendRequest, newFrontendResponse } from '@edfi/meadowlark-core';
+import { FrontendRequest, FrontendResponse, newFrontendRequest, newFrontendResponseSuccess } from '@edfi/meadowlark-core';
 import { newFrontendRequestMiddleware } from '@edfi/meadowlark-core/src/handler/FrontendRequest';
 import { newPathComponents } from '@edfi/meadowlark-core/src/model/PathComponents';
 import { securityMiddleware } from '../../src/security/SecurityMiddleware';
@@ -13,7 +13,7 @@ jest.setTimeout(40000);
 
 describe('given the upsert where response already posted', () => {
   let result;
-  const mongoClienttMock = {};
+  const mongoClientMock = {};
 
   const frontendRequest: FrontendRequest = {
     ...newFrontendRequest(),
@@ -24,13 +24,10 @@ describe('given the upsert where response already posted', () => {
     },
   };
 
-  const frontendResponse: FrontendResponse = {
-    ...newFrontendResponse(),
-    statusCode: 200,
-  };
+  const frontendResponse: FrontendResponse = newFrontendResponseSuccess();
 
   beforeAll(async () => {
-    result = await securityMiddleware({ frontendRequest, frontendResponse }, mongoClienttMock as any);
+    result = await securityMiddleware({ frontendRequest, frontendResponse }, mongoClientMock as any);
   });
 
   it('should return the original arguments without modification', async () => {
@@ -49,7 +46,7 @@ describe('given the upsert where response already posted', () => {
 
 describe('given the upsert where authorization strategy type is different than OWNERSHIP_BASED', () => {
   let result;
-  const mongoClienttMock = {};
+  const mongoClientMock = {};
   const frontendResponse: any = null;
 
   const frontendRequest: FrontendRequest = {
@@ -62,7 +59,7 @@ describe('given the upsert where authorization strategy type is different than O
   };
 
   beforeAll(async () => {
-    result = await securityMiddleware({ frontendRequest, frontendResponse }, mongoClienttMock as any);
+    result = await securityMiddleware({ frontendRequest, frontendResponse }, mongoClientMock as any);
   });
 
   it('should return the original arguments without modification', async () => {
@@ -81,7 +78,7 @@ describe('given the upsert where authorization strategy type is different than O
 
 describe('given the upsert where AuthorizationStrategy type is equal to OWNERSHIP_BASED and SecurityResult equal to ACCESS_APPROVED', () => {
   let result;
-  const mongoClienttMock = {};
+  const mongoClientMock = {};
   const frontendResponse: any = null;
 
   const frontendRequest: FrontendRequest = {
@@ -102,7 +99,7 @@ describe('given the upsert where AuthorizationStrategy type is equal to OWNERSHI
   beforeAll(async () => {
     jest.spyOn(OwnershipSecurity, 'rejectByOwnershipSecurity').mockResolvedValueOnce('ACCESS_APPROVED');
 
-    result = await securityMiddleware({ frontendRequest, frontendResponse }, mongoClienttMock as any);
+    result = await securityMiddleware({ frontendRequest, frontendResponse }, mongoClientMock as any);
   });
 
   it('should return the original arguments without modification', async () => {
@@ -126,7 +123,7 @@ describe('given the upsert where AuthorizationStrategy type is equal to OWNERSHI
 
 describe('given the upsert where AuthorizationStrategy type is equal to OWNERSHIP_BASED and SecurityResult equal to NOT_APPLICABLE', () => {
   let result;
-  const mongoClienttMock = {};
+  const mongoClientMock = {};
   const frontendResponse: any = null;
 
   const frontendRequest: FrontendRequest = {
@@ -147,7 +144,7 @@ describe('given the upsert where AuthorizationStrategy type is equal to OWNERSHI
   beforeAll(async () => {
     jest.spyOn(OwnershipSecurity, 'rejectByOwnershipSecurity').mockResolvedValueOnce('NOT_APPLICABLE');
 
-    result = await securityMiddleware({ frontendRequest, frontendResponse }, mongoClienttMock as any);
+    result = await securityMiddleware({ frontendRequest, frontendResponse }, mongoClientMock as any);
   });
 
   it('should return the original arguments without modification', async () => {
@@ -171,7 +168,7 @@ describe('given the upsert where AuthorizationStrategy type is equal to OWNERSHI
 
 describe('given the upsert where AuthorizationStrategy type is equal to OWNERSHIP_BASED and SecurityResult equal to UNKNOWN_FAILURE', () => {
   let result;
-  const mongoClienttMock = {};
+  const mongoClientMock = {};
   const frontendResponse: any = null;
 
   const frontendRequest: FrontendRequest = {
@@ -192,7 +189,7 @@ describe('given the upsert where AuthorizationStrategy type is equal to OWNERSHI
   beforeAll(async () => {
     jest.spyOn(OwnershipSecurity, 'rejectByOwnershipSecurity').mockResolvedValueOnce('UNKNOWN_FAILURE');
 
-    result = await securityMiddleware({ frontendRequest, frontendResponse }, mongoClienttMock as any);
+    result = await securityMiddleware({ frontendRequest, frontendResponse }, mongoClientMock as any);
   });
 
   it('should respond with an internal server error code', async () => {
@@ -220,7 +217,7 @@ describe('given the upsert where AuthorizationStrategy type is equal to OWNERSHI
 
 describe('given the upsert where AuthorizationStrategy type is equal to OWNERSHIP_BASED and SecurityResult equal to ACCESS_DENIED', () => {
   let result;
-  const mongoClienttMock = {};
+  const mongoClientMock = {};
   const frontendResponse: any = null;
 
   const frontendRequest: FrontendRequest = {
@@ -241,7 +238,7 @@ describe('given the upsert where AuthorizationStrategy type is equal to OWNERSHI
   beforeAll(async () => {
     jest.spyOn(OwnershipSecurity, 'rejectByOwnershipSecurity').mockResolvedValueOnce('ACCESS_DENIED');
 
-    result = await securityMiddleware({ frontendRequest, frontendResponse }, mongoClienttMock as any);
+    result = await securityMiddleware({ frontendRequest, frontendResponse }, mongoClientMock as any);
   });
 
   it('should respond with a Forbidden error code', async () => {

diff --git a/Meadowlark-js/backends/meadowlark-mongodb-backend/test/repository/Delete.test.ts b/Meadowlark-js/backends/meadowlark-mongodb-backend/test/repository/Delete.test.ts
@@ -7,7 +7,7 @@ jest.setTimeout(40000);
 
 describe('given a transaction on a resource', () => {
   const retryNumberOfTimes = 2;
-  let mongoClienttMock = {};
+  let mongoClientMock = {};
   let deleteOneMock = jest.fn();
   const error = {
     codeName: 'WriteConflict',
@@ -20,7 +20,7 @@ describe('given a transaction on a resource', () => {
       deleteOne: deleteOneMock,
     } as any);
 
-    mongoClienttMock = {
+    mongoClientMock = {
       startSession: jest.fn().mockReturnValue({
         withTransaction: async (cb: any) => {
           await cb();
@@ -44,7 +44,7 @@ describe('given a transaction on a resource', () => {
     describe('given that a number of retries greater than zero has been configured', () => {
       beforeAll(async () => {
         jest.spyOn(utilities.Config, 'get').mockReturnValue(retryNumberOfTimes);
-        result = await deleteDocumentById(newDeleteRequest(), mongoClienttMock as any);
+        result = await deleteDocumentById(newDeleteRequest(), mongoClientMock as any);
       });
 
       it('returns error', async () => {
@@ -63,7 +63,7 @@ describe('given a transaction on a resource', () => {
     describe('given that a number of retries equal to zero has been configured', () => {
       beforeAll(async () => {
         jest.spyOn(utilities.Config, 'get').mockReturnValue(0);
-        result = await deleteDocumentById(newDeleteRequest(), mongoClienttMock as any);
+        result = await deleteDocumentById(newDeleteRequest(), mongoClientMock as any);
       });
 
       it('should not retry', () => {
@@ -77,7 +77,7 @@ describe('given a transaction on a resource', () => {
 
     describe('given that a number of retries was not configured', () => {
       beforeAll(async () => {
-        result = await deleteDocumentById(newDeleteRequest(), mongoClienttMock as any);
+        result = await deleteDocumentById(newDeleteRequest(), mongoClientMock as any);
       });
 
       it('should not retry', () => {

diff --git a/Meadowlark-js/backends/meadowlark-mongodb-backend/test/repository/Update.test.ts b/Meadowlark-js/backends/meadowlark-mongodb-backend/test/repository/Update.test.ts
@@ -15,7 +15,7 @@ jest.setTimeout(40000);
 
 describe('given a transaction on a resource', () => {
   const retryNumberOfTimes = 2;
-  let mongoClienttMock = {};
+  let mongoClientMock = {};
   let replaceOneMock = jest.fn();
   const error = {
     codeName: 'WriteConflict',
@@ -29,7 +29,7 @@ describe('given a transaction on a resource', () => {
       updateMany: jest.fn(),
     } as any);
 
-    mongoClienttMock = {
+    mongoClientMock = {
       startSession: jest.fn().mockReturnValue({
         withTransaction: async (cb: any) => {
           await cb();
@@ -57,7 +57,7 @@ describe('given a transaction on a resource', () => {
       beforeAll(async () => {
         jest.spyOn(DB, 'writeLockReferencedDocuments').mockImplementationOnce(async () => Promise.resolve());
         jest.spyOn(utilities.Config, 'get').mockReturnValue(retryNumberOfTimes);
-        result = await updateDocumentById(newUpdateRequest(), mongoClienttMock as any);
+        result = await updateDocumentById(newUpdateRequest(), mongoClientMock as any);
       });
 
       it('returns error', async () => {
@@ -77,7 +77,7 @@ describe('given a transaction on a resource', () => {
       beforeAll(async () => {
         jest.spyOn(DB, 'writeLockReferencedDocuments').mockImplementationOnce(async () => Promise.resolve());
         jest.spyOn(utilities.Config, 'get').mockReturnValue(0);
-        result = await updateDocumentById(newUpdateRequest(), mongoClienttMock as any);
+        result = await updateDocumentById(newUpdateRequest(), mongoClientMock as any);
       });
 
       it('should not retry', () => {
@@ -92,7 +92,7 @@ describe('given a transaction on a resource', () => {
     describe('given that a number of retries was not configured', () => {
       beforeAll(async () => {
         jest.spyOn(DB, 'writeLockReferencedDocuments').mockImplementationOnce(async () => Promise.resolve());
-        result = await updateDocumentById(newUpdateRequest(), mongoClienttMock as any);
+        result = await updateDocumentById(newUpdateRequest(), mongoClientMock as any);
       });
 
       it('should not retry', () => {

diff --git a/Meadowlark-js/backends/meadowlark-mongodb-backend/test/repository/Upsert.test.ts b/Meadowlark-js/backends/meadowlark-mongodb-backend/test/repository/Upsert.test.ts
@@ -7,7 +7,7 @@ jest.setTimeout(40000);
 
 describe('given a transaction on a resource', () => {
   const retryNumberOfTimes = 2;
-  let mongoClienttMock = {};
+  let mongoClientMock = {};
   let replaceOneMock = jest.fn();
   const error = {
     codeName: 'WriteConflict',
@@ -22,7 +22,7 @@ describe('given a transaction on a resource', () => {
       updateMany: jest.fn(),
     } as any);
 
-    mongoClienttMock = {
+    mongoClientMock = {
       startSession: jest.fn().mockReturnValue({
         withTransaction: async (cb: any) => {
           await cb();
@@ -49,7 +49,7 @@ describe('given a transaction on a resource', () => {
       beforeAll(async () => {
         jest.spyOn(DB, 'writeLockReferencedDocuments').mockImplementationOnce(async () => Promise.resolve());
         jest.spyOn(utilities.Config, 'get').mockReturnValue(retryNumberOfTimes);
-        result = await upsertDocument(newUpsertRequest(), mongoClienttMock as any);
+        result = await upsertDocument(newUpsertRequest(), mongoClientMock as any);
       });
 
       it('returns error', async () => {
@@ -69,7 +69,7 @@ describe('given a transaction on a resource', () => {
       beforeAll(async () => {
         jest.spyOn(DB, 'writeLockReferencedDocuments').mockImplementationOnce(async () => Promise.resolve());
         jest.spyOn(utilities.Config, 'get').mockReturnValue(0);
-        result = await upsertDocument(newUpsertRequest(), mongoClienttMock as any);
+        result = await upsertDocument(newUpsertRequest(), mongoClientMock as any);
       });
 
       it('should not retry', () => {
@@ -84,7 +84,7 @@ describe('given a transaction on a resource', () => {
     describe('given that a number of retries was not configured', () => {
       beforeAll(async () => {
         jest.spyOn(DB, 'writeLockReferencedDocuments').mockImplementationOnce(async () => Promise.resolve());
-        result = await upsertDocument(newUpsertRequest(), mongoClienttMock as any);
+        result = await upsertDocument(newUpsertRequest(), mongoClientMock as any);
       });
 
       it('should not retry', () => {

diff --git a/Meadowlark-js/jest.config.js b/Meadowlark-js/jest.config.js
@@ -1,5 +1,3 @@
-const { defaults: tsjPreset } = require('ts-jest/presets');
-
 module.exports = {
   projects: [
     '<rootDir>/tests/config/unit/jest.config.js',