refactor: Isolate test mocks to fix pollution (#1252)

Author: sm745052

ui/cypress/e2e/spec.cy.ts

@@ -1,4 +1,4 @@
-import mockIConv from "../../src/mocks/conv";
+import { createMockIConv } from "../../src/mocks/conv";
 
 describe('template spec', () => {
   let url = window.location.origin;
@@ -14,7 +14,7 @@ describe('template spec', () => {
 
   it('verify direct connection to mysql non-sharded database', () => {
     cy.intercept('GET', `${url}/ping`, { statusCode: 200 }).as('checkBackendHealth');
-    cy.intercept('GET', `${url}/convert/infoschema`, { statusCode: 200, body: mockIConv }).as('directConnection');
+    cy.intercept('GET', `${url}/convert/infoschema`, { statusCode: 200, body: createMockIConv() }).as('directConnection');
 
     cy.get('.primary-header').eq(0).should('have.text', 'Get started with Spanner migration tool');
     cy.get('#edit-icon').should('exist').click();

ui/src/app/components/add-index-form/add-index-form.component.spec.ts

@@ -12,7 +12,7 @@ import IRule from 'src/app/model/rule';
 import { ConversionService } from 'src/app/services/conversion/conversion.service';
 import { DataService } from 'src/app/services/data/data.service';
 import { SidenavService } from 'src/app/services/sidenav/sidenav.service';
-import mockIConv from 'src/mocks/conv';
+import { createMockIConv } from 'src/mocks/conv';
 import { AddIndexFormComponent } from './add-index-form.component';
 
 describe('AddIndexFormComponent', () => {
@@ -22,6 +22,7 @@ describe('AddIndexFormComponent', () => {
   let sidenavServiceSpy: jasmine.SpyObj<SidenavService>;
   let fb: FormBuilder;
   let conversionServiceSpy: jasmine.SpyObj<ConversionService>;
+  let localIConv: IConv;
 
   beforeEach(async () => {
     dataServiceSpy = jasmine.createSpyObj('DataService', ['conv', 'applyRule', 'dropRule']);
@@ -55,7 +56,8 @@ describe('AddIndexFormComponent', () => {
     // Added the spy methods in beforeEach block because these are referred in the ngOnInit function
     conversionServiceSpy.getColIdFromSpannerColName.withArgs(jasmine.any(String),jasmine.any(String),jasmine.objectContaining<IConv>({})).and.returnValue("TestId")
     conversionServiceSpy.getTableIdFromSpName.withArgs(jasmine.any(String), jasmine.objectContaining<IConv>({})).and.returnValue("t1")
-    dataServiceSpy.conv = of(mockIConv);
+    localIConv = createMockIConv();
+    dataServiceSpy.conv = of(localIConv);
     sidenavServiceSpy.sidenavAddIndexTable = of("t1");
     sidenavServiceSpy.displayRuleFlag = of(true)
     sidenavServiceSpy.ruleData = of()
@@ -98,10 +100,11 @@ describe('AddIndexFormComponent', () => {
     }
     sidenavServiceSpy.ruleData = of(addIndexRule)
     component.ngOnInit()
-    const columnName = mockIConv.SpSchema[addIndexRule.Data.TableId]?.ColDefs[addIndexRule.Data.Keys[0].ColId].Name;
+    component.ngOnInit()
+    const columnName = localIConv.SpSchema[addIndexRule.Data.TableId]?.ColDefs[addIndexRule.Data.Keys[0].ColId].Name;
     expect(component.ColsArray.length).toBe(1);
     expect(component.ColsArray.at(0).value.columnName).toEqual(columnName);
-    expect(component.addIndexForm.controls['tableName'].value).toEqual(mockIConv.SpSchema[addIndexRule.Data.TableId].Name);
+    expect(component.addIndexForm.controls['tableName'].value).toEqual(localIConv.SpSchema[addIndexRule.Data.TableId].Name);
     expect(component.addIndexForm.controls['indexName'].value).toEqual(addIndexRule.Data.Name)
     expect(component.addIndexForm.status).toEqual("DISABLED");
   });
@@ -136,7 +139,7 @@ describe('AddIndexFormComponent', () => {
       ],
     };
     component.setColArraysForViewRules(tableId, ruleData.Keys);
-    const columnName = mockIConv.SpSchema[tableId]?.ColDefs[ruleData.Keys[0].ColId].Name;
+    const columnName = localIConv.SpSchema[tableId]?.ColDefs[ruleData.Keys[0].ColId].Name;
     expect(component.ColsArray.length).toBe(1);
     expect(component.ColsArray.at(0).value.columnName).toEqual(columnName);
   });

ui/src/app/components/object-detail/object-detail.component.spec.ts

@@ -12,7 +12,7 @@ import { MatIconModule } from '@angular/material/icon'
 import { MatSnackBar} from '@angular/material/snack-bar'
 import { DataService } from 'src/app/services/data/data.service'
 import { ConversionService } from 'src/app/services/conversion/conversion.service'
-import mockIConv from 'src/mocks/conv'
+import { createMockIConv } from 'src/mocks/conv'
 import { of } from 'rxjs'
 import { FormBuilder } from '@angular/forms'
 import { FlatNode } from 'src/app/model/schema-object-node'
@@ -26,10 +26,13 @@ describe('ObjectDetailComponent', () => {
   let fixture: ComponentFixture<ObjectDetailComponent>
   let dataServiceSpy: jasmine.SpyObj<DataService>;
   let conversionServiceSpy: jasmine.SpyObj<ConversionService>
+  let mockIConv = createMockIConv();
   let dialogSpyObj: jasmine.SpyObj<MatDialog>;
   let rowData: IColumnTabData[]
 
-  beforeEach(async () => {    dataServiceSpy = jasmine.createSpyObj('DataService', ['updateSequence', 'dropSequence', 'updateCheckConstraint', 'reviewTableUpdate', 'setInterleave', 'dropTable', 'getConversionRate']);
+  beforeEach(async () => {
+    mockIConv = createMockIConv();
+    dataServiceSpy = jasmine.createSpyObj('DataService', ['updateSequence', 'dropSequence', 'updateCheckConstraint', 'reviewTableUpdate', 'setInterleave', 'dropTable', 'getConversionRate']);
     dataServiceSpy.updateSequence.and.returnValue(of({}));
     dataServiceSpy.dropSequence.and.returnValue(of(''));
     dataServiceSpy.reviewTableUpdate.and.returnValue(of(''));

ui/src/app/components/workspace/workspace.component.spec.ts

@@ -11,7 +11,7 @@ import { InputType, ObjectExplorerNodeType, SourceDbNames, StorageKeys } from 's
 import { of, Subscription } from 'rxjs'
 import * as JSZip from 'jszip'
 import { FetchService } from 'src/app/services/fetch/fetch.service'
-import mockIConv, { mockIConv2 } from 'src/mocks/conv'
+import { createMockIConv, createMockIConv2 } from 'src/mocks/conv'
 import mockSpannerConfig from 'src/mocks/spannerConfig'
 import { ConversionService } from 'src/app/services/conversion/conversion.service'
 import { DataService } from 'src/app/services/data/data.service'
@@ -49,6 +49,7 @@ const mockStructuredReport: IStructuredReport = {
 describe('WorkspaceComponent', () => {
   let component: WorkspaceComponent
   let fixture: ComponentFixture<WorkspaceComponent>
+  let mockIConv: IConv;
   let dialogSpyObj: jasmine.SpyObj<MatDialog>;
   let clickEventSpyObj: jasmine.SpyObj<ClickEventService>;
   let sidenavSpyObj: jasmine.SpyObj<SidenavService>;
@@ -58,6 +59,7 @@ describe('WorkspaceComponent', () => {
   let conversionServiceSpy: jasmine.SpyObj<ConversionService>;
 
   beforeEach(async () => {
+    mockIConv = createMockIConv();
     dialogSpyObj = jasmine.createSpyObj('MatDialog', ['open']);
     clickEventSpyObj = jasmine.createSpyObj('ClickEventService', ['setViewAssesmentData', 'setTabToSpanner']);
     sidenavSpyObj = jasmine.createSpyObj('SidenavService', ['openSidenav', 'setSidenavComponent', 'setSidenavDatabaseName', 'setMiddleColumnComponent']);
@@ -178,7 +180,7 @@ describe('WorkspaceComponent', () => {
   })
 
   it('existing conv and data mismatch', () => {
-    component.conv = mockIConv2
+    component.conv = createMockIConv2()
     component.ngOnInit();
     expect(component.conv).toEqual(mockIConv)
   })
@@ -357,7 +359,7 @@ describe('WorkspaceComponent', () => {
   });
 
   it('should return true when indexes are added or removed', () => {
-    let mockData = mockIConv2;
+    let mockData = createMockIConv2();
     const result = component.isIndexAddedOrRemoved(mockData);
     expect(result).toBeTruthy();
   });

ui/src/app/services/data/data.service.spec.ts

@@ -4,7 +4,7 @@ import { DataService } from './data.service'
 import { FetchService } from '../fetch/fetch.service'
 import { SnackbarService } from '../snackbar/snackbar.service'
 import { of } from 'rxjs'
-import mockIConv from 'src/mocks/conv'
+import { createMockIConv } from 'src/mocks/conv'
 import mockSpannerConfig from 'src/mocks/spannerConfig'
 
 describe('DataService', () => {
@@ -26,7 +26,7 @@ describe('DataService', () => {
         provideHttpClient(withInterceptorsFromDi()),
     ]
 })
-        fetchServiceSpy.getLastSessionDetails.and.returnValue(of(mockIConv));
+        fetchServiceSpy.getLastSessionDetails.and.returnValue(of(createMockIConv()));
         fetchServiceSpy.getSpannerConfig.and.returnValue(of(mockSpannerConfig));
         fetchServiceSpy.getIsOffline.and.returnValue(of(false));
         snackbarService = TestBed.inject(SnackbarService);

ui/src/mocks/conv.ts

@@ -1,6 +1,7 @@
 import IConv from "src/app/model/conv";
 
-const mockIConv: IConv = {
+export function createMockIConv(): IConv {
+    return {
     SpSchema: {
         "t1": {
             Name: "table1",
@@ -149,9 +150,11 @@ const mockIConv: IConv = {
         },
     },
     SrcSequences: {}
-};
+    };
+}
 
-export const mockIConv2: IConv = {
+export function createMockIConv2(): IConv {
+    return {
     SpSchema: {
         "t1": {
             Name: "table1",
@@ -291,6 +294,5 @@ export const mockIConv2: IConv = {
     IsSharded: false,
     SpSequences: {},
     SrcSequences: {}
-};
-
-export default mockIConv;
+    };
+}