alfresco-ng2-components/lib/content-services/document-list/components/content-action/content-action.component.spec.ts

/*!
 * @license
 * Copyright 2016 Alfresco Software, Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
import { EventEmitter } from '@angular/core';
import { async, TestBed } from '@angular/core/testing';
import { ContentService } from '@alfresco/adf-core';
import { DataTableModule } from '@alfresco/adf-core';
import { FileNode } from '../../../mock';
import { DocumentListService } from '../../services/document-list.service';
import { CustomResourcesService } from '../../services/custom-resources.service';
import { ContentActionHandler } from './../../models/content-action.model';
import { DocumentActionsService } from './../../services/document-actions.service';
import { FolderActionsService } from './../../services/folder-actions.service';
import { NodeActionsService } from './../../services/node-actions.service';
import { DocumentListComponent } from './../document-list.component';
import { ContentActionListComponent } from './content-action-list.component';
import { ContentActionComponent } from './content-action.component';
import { ContentActionModel } from './../../models/content-action.model';

describe('ContentAction', () => {

    let documentList: DocumentListComponent;
    let actionList: ContentActionListComponent;
    let documentActions: DocumentActionsService;
    let folderActions: FolderActionsService;

    let contentService: ContentService;
    let nodeActionsService: NodeActionsService;

    beforeEach(async(() => {
        TestBed.configureTestingModule({
            imports: [
                DataTableModule
            ],
            providers: [
                DocumentListService,
                CustomResourcesService
            ],
            declarations: [
                DocumentListComponent
            ],
            schemas: [
                CUSTOM_ELEMENTS_SCHEMA
            ]
        }).compileComponents();
    }));

    beforeEach(() => {
        contentService = TestBed.get(ContentService);
        nodeActionsService = new NodeActionsService(null, null, null);
        documentActions = new DocumentActionsService(nodeActionsService, null);
        folderActions = new FolderActionsService(nodeActionsService, null, contentService);

        documentList = (TestBed.createComponent(DocumentListComponent).componentInstance as DocumentListComponent);
        actionList = new ContentActionListComponent(documentList);
    });

    it('should register within parent actions list', () => {
        spyOn(actionList, 'registerAction').and.stub();

        let action = new ContentActionComponent(actionList, null, null);
        action.ngOnInit();

        expect(actionList.registerAction).toHaveBeenCalled();
    });

    it('should setup and register model', () => {
        let action = new ContentActionComponent(actionList, null, null);
        action.target = 'document';
        action.title = '<title>';
        action.icon = '<icon>';

        expect(documentList.actions.length).toBe(0);
        action.ngOnInit();

        expect(documentList.actions.length).toBe(1);

        let model = documentList.actions[0];
        expect(model.target).toBe(action.target);
        expect(model.title).toBe(action.title);
        expect(model.icon).toBe(action.icon);
    });

    it('should get action handler from document actions service', () => {

        let handler = function () {
        };
        spyOn(documentActions, 'getHandler').and.returnValue(handler);

        let action = new ContentActionComponent(actionList, documentActions, null);
        action.target = 'document';
        action.handler = '<handler>';
        action.ngOnInit();

        expect(documentActions.getHandler).toHaveBeenCalledWith(action.handler);
        expect(documentList.actions.length).toBe(1);

        let model = documentList.actions[0];
        expect(model.handler).toBe(handler);
    });

    it('should get action handler from folder actions service', () => {
        let handler = function () {
        };
        spyOn(folderActions, 'getHandler').and.returnValue(handler);

        let action = new ContentActionComponent(actionList, null, folderActions);
        action.target = 'folder';
        action.handler = '<handler>';
        action.ngOnInit();

        expect(folderActions.getHandler).toHaveBeenCalledWith(action.handler);
        expect(documentList.actions.length).toBe(1);

        let model = documentList.actions[0];
        expect(model.handler).toBe(handler);
    });

    it('should create document and folder action when there is no target', () => {
        spyOn(folderActions, 'getHandler').and.stub();
        spyOn(documentActions, 'getHandler').and.stub();

        let action = new ContentActionComponent(actionList, documentActions, folderActions);
        action.handler = '<handler>';

        action.ngOnInit();
        expect(documentList.actions.length).toBe(2);
        expect(folderActions.getHandler).toHaveBeenCalled();
        expect(documentActions.getHandler).toHaveBeenCalled();
    });

    it('should create document action when target is document', () => {
        spyOn(folderActions, 'getHandler').and.stub();
        spyOn(documentActions, 'getHandler').and.stub();

        let action = new ContentActionComponent(actionList, documentActions, folderActions);
        action.handler = '<handler>';
        action.target = 'document';

        action.ngOnInit();
        expect(documentList.actions.length).toBe(1);
        expect(folderActions.getHandler).not.toHaveBeenCalled();
        expect(documentActions.getHandler).toHaveBeenCalled();
    });

    it('should create folder action when target is folder', () => {
        spyOn(folderActions, 'getHandler').and.stub();
        spyOn(documentActions, 'getHandler').and.stub();

        let action = new ContentActionComponent(actionList, documentActions, folderActions);
        action.handler = '<handler>';
        action.target = 'folder';

        action.ngOnInit();
        expect(documentList.actions.length).toBe(1);
        expect(folderActions.getHandler).toHaveBeenCalled();
        expect(documentActions.getHandler).not.toHaveBeenCalled();
    });

    it('should be case insensitive for document target', () => {
        spyOn(documentActions, 'getHandler').and.stub();

        let action = new ContentActionComponent(actionList, documentActions, null);
        action.target = 'DoCuMeNt';
        action.handler = '<handler>';

        action.ngOnInit();
        expect(documentActions.getHandler).toHaveBeenCalledWith(action.handler);
    });

    it('should be case insensitive for folder target', () => {
        spyOn(folderActions, 'getHandler').and.stub();

        let action = new ContentActionComponent(actionList, null, folderActions);
        action.target = 'FoLdEr';
        action.handler = '<handler>';

        action.ngOnInit();
        expect(folderActions.getHandler).toHaveBeenCalledWith(action.handler);
    });

    it('should use custom "execute" emitter', (done) => {
        let emitter = new EventEmitter();

        emitter.subscribe(e => {
            expect(e.value).toBe('<obj>');
            done();
        });

        let action = new ContentActionComponent(actionList, null, null);
        action.target = 'document';
        action.execute = emitter;

        action.ngOnInit();
        expect(documentList.actions.length).toBe(1);

        let model = documentList.actions[0];
        model.execute('<obj>');
    });

    it('should not find document action handler with missing service', () => {
        let action = new ContentActionComponent(actionList, null, null);
        expect(action.getSystemHandler('document', 'name')).toBeNull();
    });

    it('should not find folder action handler with missing service', () => {
        let action = new ContentActionComponent(actionList, null, null);
        expect(action.getSystemHandler('folder', 'name')).toBeNull();
    });

    it('should find document action handler via service', () => {
        let handler = <ContentActionHandler> function (obj: any, target?: any) {
        };
        let action = new ContentActionComponent(actionList, documentActions, null);
        spyOn(documentActions, 'getHandler').and.returnValue(handler);
        expect(action.getSystemHandler('document', 'name')).toBe(handler);
    });

    it('should find folder action handler via service', () => {
        let handler = <ContentActionHandler> function (obj: any, target?: any) {
        };
        let action = new ContentActionComponent(actionList, null, folderActions);
        spyOn(folderActions, 'getHandler').and.returnValue(handler);
        expect(action.getSystemHandler('folder', 'name')).toBe(handler);
    });

    it('should not find actions for unknown target type', () => {
        spyOn(folderActions, 'getHandler').and.stub();
        spyOn(documentActions, 'getHandler').and.stub();

        let action = new ContentActionComponent(actionList, documentActions, folderActions);

        expect(action.getSystemHandler('unknown', 'name')).toBeNull();
        expect(folderActions.getHandler).not.toHaveBeenCalled();
        expect(documentActions.getHandler).not.toHaveBeenCalled();

    });

    it('should wire model with custom event handler', async(() => {
        let action = new ContentActionComponent(actionList, documentActions, folderActions);
        let file = new FileNode();

        let handler = new EventEmitter();
        handler.subscribe((e) => {
            expect(e.value).toBe(file);
        });

        action.execute = handler;

        action.ngOnInit();
        documentList.actions[0].execute(file);
    }));

    it('should allow registering model without handler', () => {
        let action = new ContentActionComponent(actionList, documentActions, folderActions);

        spyOn(actionList, 'registerAction').and.callThrough();
        action.execute = null;
        action.handler = null;
        action.target = 'document';
        action.ngOnInit();

        expect(actionList.registerAction).toHaveBeenCalledWith(documentList.actions[0]);
    });

    it('should register on init', () => {
        let action = new ContentActionComponent(actionList, null, null);
        spyOn(action, 'register').and.callThrough();

        action.ngOnInit();
        expect(action.register).toHaveBeenCalled();
    });

    it('should require action list to register action with', () => {
        const fakeModel = new ContentActionModel();
        let action = new ContentActionComponent(actionList, null, null);
        expect(action.register(fakeModel)).toBeTruthy();

        action = new ContentActionComponent(null, null, null);
        expect(action.register(fakeModel)).toBeFalsy();
    });
});