Merge pull request #221 from ghiscoding/feat/extension-unit-tests

feat(tests): add all Extensions full test suite coverage

Author: ghiscoding

src/app/modules/angular-slickgrid/extensions/__tests__/cellExternalCopyManagerExtension.spec.ts

@@ -4,11 +4,13 @@ import { GridOption } from '../../models/gridOption.interface';
 import { CellExternalCopyManagerExtension } from '../cellExternalCopyManagerExtension';
 import { ExtensionUtility } from '../extensionUtility';
 import { SharedService } from '../../services/shared.service';
-import { SelectedRange } from '../../models';
+import { EditCommand, Formatter, SelectedRange } from '../../models';
+import { Formatters } from '../../formatters';
 
 declare var Slick: any;
 
 const gridStub = {
+  getData: jest.fn(),
   getOptions: jest.fn(),
   registerPlugin: jest.fn(),
   setSelectionModel: jest.fn(),
@@ -21,6 +23,7 @@ const addonStub = {
   onCopyCancelled: new Slick.Event(),
   onPasteCells: new Slick.Event(),
 };
+
 const mockAddon = jest.fn().mockImplementation(() => addonStub);
 const mockSelectionModel = jest.fn().mockImplementation(() => ({
   init: jest.fn(),
@@ -34,6 +37,7 @@ jest.mock('slickgrid/plugins/slick.cellselectionmodel', () => mockSelectionModel
 Slick.CellSelectionModel = mockSelectionModel;
 
 describe('cellExternalCopyManagerExtension', () => {
+  let queueCallback: EditCommand;
   let translate: TranslateService;
   const mockEventCallback = (e, args: { ranges: SelectedRange[] }) => { };
   const mockSelectRange = [{ fromCell: 1, fromRow: 1, toCell: 1, toRow: 1 }] as SelectedRange[];
@@ -72,6 +76,15 @@ describe('cellExternalCopyManagerExtension', () => {
     beforeEach(() => {
       jest.spyOn(SharedService.prototype, 'grid', 'get').mockReturnValue(gridStub);
       jest.spyOn(SharedService.prototype, 'gridOptions', 'get').mockReturnValue(gridOptionsMock);
+      queueCallback = {
+        execute: () => { },
+        undo: () => { },
+        row: 0,
+        cell: 0,
+        editor: {},
+        serializedValue: 'serialize',
+        prevSerializedValue: 'previous'
+      };
     });
 
     it('should register the addon', () => {
@@ -162,4 +175,181 @@ describe('cellExternalCopyManagerExtension', () => {
       expect(destroySpy).toHaveBeenCalled();
     });
   });
+
+  describe('createUndoRedo private method', () => {
+    it('should create the UndoRedoBuffer', () => {
+      extension.register();
+
+      expect(extension.undoRedoBuffer).toEqual({
+        queueAndExecuteCommand: expect.anything(),
+        undo: expect.anything(),
+        redo: expect.anything(),
+      });
+    });
+
+    it('should have called Edit Command "execute" method after creating the UndoRedoBuffer', () => {
+      extension.register();
+      const undoRedoBuffer = extension.undoRedoBuffer;
+
+      const spy = jest.spyOn(queueCallback, 'execute');
+      undoRedoBuffer.queueAndExecuteCommand(queueCallback);
+
+      expect(spy).toHaveBeenCalled();
+    });
+
+    it('should not have called Edit Command "undo" method when there is nothing to undo', () => {
+      extension.register();
+      const undoRedoBuffer = extension.undoRedoBuffer;
+
+      const spy = jest.spyOn(queueCallback, 'undo');
+      undoRedoBuffer.undo();
+
+      expect(spy).not.toHaveBeenCalled();
+    });
+
+    it('should have called Edit Command "undo" method after calling it from UndoRedoBuffer', () => {
+      extension.register();
+      const undoRedoBuffer = extension.undoRedoBuffer;
+
+      const spy = jest.spyOn(queueCallback, 'undo');
+      undoRedoBuffer.queueAndExecuteCommand(queueCallback);
+      undoRedoBuffer.undo();
+
+      expect(spy).toHaveBeenCalled();
+    });
+
+    it('should have called Edit Command "execute" method only at first queueing, the "redo" should not call the "execute" method by itself', () => {
+      extension.register();
+      const undoRedoBuffer = extension.undoRedoBuffer;
+
+      const spy = jest.spyOn(queueCallback, 'execute');
+      undoRedoBuffer.queueAndExecuteCommand(queueCallback);
+      undoRedoBuffer.redo();
+
+      expect(spy).toHaveBeenCalledTimes(1);
+    });
+
+    it('should have called Edit Command "execute" method at first queueing & then inside the "redo" since we did an "undo" just before', () => {
+      extension.register();
+      const undoRedoBuffer = extension.undoRedoBuffer;
+
+      const spy = jest.spyOn(queueCallback, 'execute');
+      undoRedoBuffer.queueAndExecuteCommand(queueCallback);
+      undoRedoBuffer.undo();
+      undoRedoBuffer.redo();
+
+      expect(spy).toHaveBeenCalledTimes(2);
+    });
+
+    it('should have a single entry in the queue buffer after calling "queueAndExecuteCommand" once', () => {
+      extension.register();
+      extension.undoRedoBuffer.queueAndExecuteCommand(queueCallback);
+      expect(extension.commandQueue).toHaveLength(1);
+    });
+
+    it('should call a redo when Ctrl+Shift+Z keyboard event occurs', () => {
+      extension.register();
+      const spy = jest.spyOn(queueCallback, 'execute');
+
+      extension.undoRedoBuffer.queueAndExecuteCommand(queueCallback);
+      const body = window.document.body;
+      body.dispatchEvent(new (window.window as any).KeyboardEvent('keydown', {
+        keyCode: 90,
+        ctrlKey: true,
+        shiftKey: true,
+        bubbles: true,
+        cancelable: true
+      }));
+
+      expect(spy).toHaveBeenCalledTimes(2);
+    });
+
+    it('should call a undo when Ctrl+Z keyboard event occurs', () => {
+      extension.register();
+      const spy = jest.spyOn(queueCallback, 'undo');
+
+      extension.undoRedoBuffer.queueAndExecuteCommand(queueCallback);
+      const body = window.document.body;
+      body.dispatchEvent(new (window.window as any).KeyboardEvent('keydown', {
+        keyCode: 90,
+        ctrlKey: true,
+        shiftKey: false,
+        bubbles: true
+      }));
+
+      expect(spy).toHaveBeenCalled();
+    });
+  });
+
+  describe('addonOptions callbacks', () => {
+    it('should expect "queueAndExecuteCommand" to be called after calling "clipboardCommandHandler" callback', () => {
+      extension.register();
+      const spy = jest.spyOn(extension.undoRedoBuffer, 'queueAndExecuteCommand');
+
+      extension.addonOptions.clipboardCommandHandler(queueCallback);
+
+      expect(spy).toHaveBeenCalled();
+    });
+
+    it('should expect "addItem" method to be called after calling "newRowCreator" callback', () => {
+      extension.register();
+      const mockGetData = { addItem: jest.fn() };
+      const getDataSpy = jest.spyOn(gridStub, 'getData').mockReturnValue(mockGetData);
+      const addItemSpy = jest.spyOn(mockGetData, 'addItem');
+
+      extension.addonOptions.newRowCreator(2);
+
+      expect(getDataSpy).toHaveBeenCalled();
+      expect(addItemSpy).toHaveBeenCalledWith(expect.objectContaining({ id: 'newRow_0' }));
+      expect(addItemSpy).toHaveBeenCalledWith(expect.objectContaining({ id: 'newRow_1' }));
+    });
+
+    it('should expect a formatted output after calling "dataItemColumnValueExtractor" callback', () => {
+      extension.register();
+      const output = extension.addonOptions.dataItemColumnValueExtractor({ firstName: 'John', lastName: 'Doe' }, { id: 'firstName', field: 'firstName', exportWithFormatter: true, formatter: Formatters.bold });
+      expect(output).toBe('<b>John</b>');
+    });
+
+    it('should expect a sanitized formatted and empty output after calling "dataItemColumnValueExtractor" callback', () => {
+      gridOptionsMock.exportOptions = { sanitizeDataExport: true };
+      const myBoldFormatter: Formatter = (row, cell, value, columnDef, dataContext) => value ? { text: `<b>${value}</b>` } : null;
+      jest.spyOn(SharedService.prototype, 'gridOptions', 'get').mockReturnValue(gridOptionsMock);
+      extension.register();
+
+      const output = extension.addonOptions.dataItemColumnValueExtractor({ firstName: '<b>John</b>', lastName: null }, { id: 'lastName', field: 'lastName', exportWithFormatter: true, formatter: myBoldFormatter });
+
+      expect(output).toBe('');
+    });
+
+    it('should expect a sanitized formatted output after calling "dataItemColumnValueExtractor" callback', () => {
+      gridOptionsMock.exportOptions = { sanitizeDataExport: true };
+      jest.spyOn(SharedService.prototype, 'gridOptions', 'get').mockReturnValue(gridOptionsMock);
+      extension.register();
+
+      const output = extension.addonOptions.dataItemColumnValueExtractor({ firstName: '<b>John</b>', lastName: 'Doe' }, { id: 'firstName', field: 'firstName', exportWithFormatter: true, formatter: Formatters.bold });
+
+      expect(output).toBe('John');
+    });
+
+    it('should expect a sanitized formatted output, from a Custom Formatter, after calling "dataItemColumnValueExtractor" callback', () => {
+      const myBoldFormatter: Formatter = (row, cell, value, columnDef, dataContext) => value ? { text: `<b>${value}</b>` } : '';
+      gridOptionsMock.exportOptions = { sanitizeDataExport: true };
+      jest.spyOn(SharedService.prototype, 'gridOptions', 'get').mockReturnValue(gridOptionsMock);
+      extension.register();
+
+      const output = extension.addonOptions.dataItemColumnValueExtractor({ firstName: '<b>John</b>', lastName: 'Doe' }, { id: 'firstName', field: 'firstName', exportWithFormatter: true, formatter: myBoldFormatter });
+
+      expect(output).toBe('John');
+    });
+
+    it('should return null when calling "dataItemColumnValueExtractor" callback without editable', () => {
+      gridOptionsMock.editable = false;
+      jest.spyOn(SharedService.prototype, 'gridOptions', 'get').mockReturnValue(gridOptionsMock);
+      extension.register();
+
+      const output = extension.addonOptions.dataItemColumnValueExtractor({ firstName: '<b>John</b>', lastName: 'Doe' }, { id: 'firstName', field: 'firstName' });
+
+      expect(output).toBeNull();
+    });
+  });
 });

src/app/modules/angular-slickgrid/extensions/__tests__/headerMenuExtension.spec.ts

@@ -5,14 +5,10 @@ import { HeaderMenuExtension } from '../headerMenuExtension';
 import { ExtensionUtility } from '../extensionUtility';
 import { SharedService } from '../../services/shared.service';
 import { Column, ColumnSort } from '../../models';
-import { ExportService, FilterService, SortService } from '../../services';
+import { FilterService, SortService } from '../../services';
 
 declare var Slick: any;
 
-const exportServiceStub = {
-  exportToFile: jest.fn(),
-} as unknown as ExportService;
-
 const filterServiceStub = {
   clearFilterByColumnId: jest.fn(),
 } as unknown as FilterService;
@@ -95,7 +91,6 @@ describe('headerMenuExtension', () => {
         HeaderMenuExtension,
         ExtensionUtility,
         SharedService,
-        { provide: ExportService, useValue: exportServiceStub },
         { provide: FilterService, useValue: filterServiceStub },
         { provide: SortService, useValue: sortServiceStub },
       ],