Test factory to create maps and nodes (#323)

b310-digital · Jul 15, 2024 · 695eabb · 695eabb
1 parent dc42961
commit 695eabb
Show file tree

Hide file tree

Showing 2 changed files with 74 additions and 118 deletions.
diff --git a/teammapper-backend/src/map/controllers/maps.controller.spec.ts b/teammapper-backend/src/map/controllers/maps.controller.spec.ts
@@ -5,6 +5,7 @@ import { NotFoundException } from '@nestjs/common';
 import { MmpMap } from '../entities/mmpMap.entity';
 import { IMmpClientMap, IMmpClientPrivateMap } from '../types';
 import { MmpNode } from '../entities/mmpNode.entity';
+import { createClientRootNode, createMmpClientMap, createMmpMap } from '../utils/tests/mapFactories';
 
 describe('MapsController', () => {
   let mapsController: MapsController;
@@ -34,44 +35,15 @@ describe('MapsController', () => {
 
   describe('duplicate', () => {
     it('should duplicate a map correctly', async () => {
-        const oldMap: MmpMap = {
-            id: '6357cedd-2621-4033-8958-c50061306cb9',
-            adminId: 'old-admin-id',
-            modificationSecret: 'old-modification-secret',
-            name: 'Test Map',
-            lastModified: new Date('1970-01-01'),
-            options: {
-                fontMaxSize: 1,
-                fontMinSize: 1,
-                fontIncrement: 1
-            },
-            nodes: Array<MmpNode>()
-        };
-        const newMap: MmpMap = {
-            id: 'e7f66b65-ffd5-4387-b645-35f8e794c7e7',
-            adminId: 'new-admin-id',
-            modificationSecret: 'new-modification-secret',
-            name: 'Test Map',
-            lastModified: new Date('1970-01-01'),
-            options: {
-                fontMaxSize: 1,
-                fontMinSize: 1,
-                fontIncrement: 1
-            },
-            nodes: Array<MmpNode>()
-        };
-        const exportedMap: IMmpClientMap = {
-            uuid: 'e7f66b65-ffd5-4387-b645-35f8e794c7e7',
-            data: [],
-            deleteAfterDays: 30,
-            deletedAt: new Date('1970-01-01'),
-            lastModified: new Date('1970-01-01'),
-            options: {
-                fontMaxSize: 1,
-                fontMinSize: 1,
-                fontIncrement: 1
-            },
-        };
+        const oldMap: MmpMap = createMmpMap({
+          adminId: 'old-admin-id',
+          modificationSecret: 'old-modification-secret'
+        });
+        const newMap: MmpMap = createMmpMap({
+          adminId: 'new-admin-id',
+          modificationSecret: 'new-modification-secret'
+        });
+        const exportedMap: IMmpClientMap = createMmpClientMap();
         const result: IMmpClientPrivateMap = {
             map: exportedMap,
             adminId: 'new-admin-id',
@@ -104,18 +76,9 @@ describe('MapsController', () => {
   describe('findOne', () => {
     it('should find the correct map', async () => {
       const mapId = 'e7f66b65-ffd5-4387-b645-35f8e794c7e7';
-      const exportedMap: IMmpClientMap = {
-          uuid: 'e7f66b65-ffd5-4387-b645-35f8e794c7e7',
-          data: [],
-          deleteAfterDays: 30,
-          deletedAt: new Date('1970-01-01'),
-          lastModified: new Date('1970-01-01'),
-          options: {
-              fontMaxSize: 1,
-              fontMinSize: 1,
-              fontIncrement: 1
-          },
-      };
+      const exportedMap: IMmpClientMap = createMmpClientMap({
+        id: mapId,
+      })
 
       jest.spyOn(mapsService, 'exportMapToClient').mockResolvedValueOnce(exportedMap);
 
@@ -135,19 +98,7 @@ describe('MapsController', () => {
 
   describe('delete', () => {
     it('should delete an existing map successfully', async () => {
-      const existingMap: MmpMap = {
-          id: '6357cedd-2621-4033-8958-c50061306cb9',
-          adminId: 'old-admin-id',
-          modificationSecret: 'old-modification-secret',
-          name: 'Test Map',
-          lastModified: new Date('1970-01-01'),
-          options: {
-              fontMaxSize: 1,
-              fontMinSize: 1,
-              fontIncrement: 1
-          },
-          nodes: Array<MmpNode>()
-      };
+      const existingMap: MmpMap = createMmpMap();
 
       jest.spyOn(mapsService, 'findMap').mockResolvedValueOnce(existingMap);
       // We're not interested in testing the repository at this stage, only if the request gets past the admin ID check
@@ -162,19 +113,7 @@ describe('MapsController', () => {
     });
 
     it('should not delete a map if the wrong admin ID is given', async () => {
-      const existingMap: MmpMap = {
-          id: '6357cedd-2621-4033-8958-c50061306cb9',
-          adminId: 'old-admin-id',
-          modificationSecret: 'old-modification-secret',
-          name: 'Test Map',
-          lastModified: new Date('1970-01-01'),
-          options: {
-              fontMaxSize: 1,
-              fontMinSize: 1,
-              fontIncrement: 1
-          },
-          nodes: Array<MmpNode>()
-      };
+      const existingMap: MmpMap = createMmpMap();
 
       jest.spyOn(mapsService, 'findMap').mockResolvedValueOnce(existingMap);
 
@@ -189,54 +128,19 @@ describe('MapsController', () => {
 
   describe('create', () => {
     it('should create a new map if given a root node', async () => {
-      const newMap: MmpMap = {
-          id: '6357cedd-2621-4033-8958-c50061306cb9',
-          adminId: 'admin-id',
-          modificationSecret: 'modification-secret',
-          name: 'Test Map',
-          lastModified: new Date('1970-01-01'),
-          options: {
-              fontMaxSize: 1,
-              fontMinSize: 1,
-              fontIncrement: 1
-          },
-          nodes: Array<MmpNode>()
-      };
-      const exportedMap: IMmpClientMap = {
-          uuid: '6357cedd-2621-4033-8958-c50061306cb9',
-          data: [],
-          deleteAfterDays: 30,
-          deletedAt: new Date('1970-01-01'),
-          lastModified: new Date('1970-01-01'),
-          options: {
-              fontMaxSize: 1,
-              fontMinSize: 1,
-              fontIncrement: 1
-          },
-      };
+      const newMap: MmpMap = createMmpMap();
+
+      const exportedMap: IMmpClientMap = createMmpClientMap({
+        uuid: newMap.id,
+      })
+
       const result: IMmpClientPrivateMap = {
           map: exportedMap,
           adminId: 'admin-id',
           modificationSecret: 'modification-secret'
       };
 
-      const rootNode = {
-        colors: {
-          name: '',
-          background: '',
-          branch: '',
-        },
-        font: {
-          style: '',
-          size: 0,
-          weight: ''
-        },
-        name: 'Root node',
-        image: {
-          src: '',
-          size: 0
-        }
-      };
+      const rootNode = createClientRootNode()
 
       jest.spyOn(mapsService, 'createEmptyMap').mockResolvedValueOnce(newMap);
       jest.spyOn(mapsService, 'exportMapToClient').mockResolvedValueOnce(exportedMap);

diff --git a/teammapper-backend/src/map/utils/tests/mapFactories.ts b/teammapper-backend/src/map/utils/tests/mapFactories.ts
@@ -0,0 +1,52 @@
+import { MmpMap } from "src/map/entities/mmpMap.entity";
+import { MmpNode } from "src/map/entities/mmpNode.entity";
+import * as crypto from 'crypto'
+import { IMmpClientMap, IMmpClientNodeBasics } from "src/map/types";
+
+export const createMmpMap = (overrides = {}): MmpMap => ({
+    id: crypto.randomUUID(),
+    adminId: 'admin-id',
+    modificationSecret: 'modification-secret',
+    name: 'Test Map',
+    lastModified: new Date('1970-01-01'),
+    options: {
+        fontMaxSize: 1,
+        fontMinSize: 1,
+        fontIncrement: 1
+    },
+    nodes: Array<MmpNode>(),
+    ...overrides
+})
+
+export const createMmpClientMap = (overrides = {}): IMmpClientMap => ({
+    uuid: crypto.randomUUID(),
+    data: [],
+    deleteAfterDays: 30,
+    deletedAt: new Date('1970-01-01'),
+    lastModified: new Date('1970-01-01'),
+    options: {
+        fontMaxSize: 1,
+        fontMinSize: 1,
+        fontIncrement: 1
+    },
+    ...overrides,
+})
+
+export const createClientRootNode = (overrides = {}): IMmpClientNodeBasics => ({
+    colors: {
+        name: '',
+        background: '',
+        branch: '',
+    },
+    font: {
+        style: '',
+        size: 0,
+        weight: ''
+    },
+    name: 'Root node',
+    image: {
+        src: '',
+        size: 0
+    },
+    ...overrides
+})