openmct/platform/commonUI/edit/test/services/TransactionManagerSpec.js

/*****************************************************************************
 * Open MCT, Copyright (c) 2014-2018, United States Government
 * as represented by the Administrator of the National Aeronautics and Space
 * Administration. All rights reserved.
 *
 * Open MCT is 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.
 *
 * Open MCT includes source code licensed under additional open source
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/
/*global define,describe,it,expect,beforeEach,jasmine*/

define(
    ["../../src/services/TransactionManager"],
    function (TransactionManager) {
        describe("TransactionManager", function () {
            var mockTransactionService,
                testId,
                mockOnCommit,
                mockOnCancel,
                mockRemoves,
                mockPromise,
                manager;

            beforeEach(function () {
                mockRemoves = [];
                mockTransactionService = jasmine.createSpyObj(
                    "transactionService",
                    ["addToTransaction", "isActive"]
                );
                mockOnCommit = jasmine.createSpy('commit');
                mockOnCancel = jasmine.createSpy('cancel');
                testId = 'test-id';
                mockPromise = jasmine.createSpyObj('promise', ['then']);

                mockOnCommit.and.returnValue(mockPromise);
                mockOnCancel.and.returnValue(mockPromise);

                mockTransactionService.addToTransaction.and.callFake(function () {
                    var mockRemove =
                        jasmine.createSpy('remove-' + mockRemoves.length);
                    mockRemoves.push(mockRemove);

                    return mockRemove;
                });

                manager = new TransactionManager(mockTransactionService);
            });

            it("delegates isActive calls", function () {
                [false, true].forEach(function (state) {
                    mockTransactionService.isActive.and.returnValue(state);
                    expect(manager.isActive()).toBe(state);
                });
            });

            describe("when addToTransaction is called", function () {
                beforeEach(function () {
                    manager.addToTransaction(
                        testId,
                        mockOnCommit,
                        mockOnCancel
                    );
                });

                it("adds callbacks to the active transaction", function () {
                    expect(mockTransactionService.addToTransaction)
                        .toHaveBeenCalledWith(
                            jasmine.any(Function),
                            jasmine.any(Function)
                        );
                });

                it("invokes passed-in callbacks from its own callbacks", function () {
                    expect(mockOnCommit).not.toHaveBeenCalled();
                    mockTransactionService.addToTransaction
                        .calls.mostRecent().args[0]();
                    expect(mockOnCommit).toHaveBeenCalled();

                    expect(mockOnCancel).not.toHaveBeenCalled();
                    mockTransactionService.addToTransaction
                        .calls.mostRecent().args[1]();
                    expect(mockOnCancel).toHaveBeenCalled();
                });

                describe("Adds callbacks to transaction", function () {
                    beforeEach(function () {
                        spyOn(manager, 'clearTransactionsFor');
                        manager.clearTransactionsFor.and.callThrough();
                    });

                    it("and clears pending calls if same object", function () {
                        manager.addToTransaction(
                            testId,
                            jasmine.createSpy(),
                            jasmine.createSpy()
                        );
                        expect(manager.clearTransactionsFor).toHaveBeenCalledWith(testId);
                    });

                    it("and does not clear pending calls if different object", function () {
                        manager.addToTransaction(
                            'other-id',
                            jasmine.createSpy(),
                            jasmine.createSpy()
                        );
                        expect(manager.clearTransactionsFor).not.toHaveBeenCalled();
                    });

                    afterEach(function () {
                        expect(mockTransactionService.addToTransaction.calls.count()).toEqual(2);
                    });
                });

                it("does not remove callbacks from the transaction", function () {
                    expect(mockRemoves[0]).not.toHaveBeenCalled();
                });

                describe("and clearTransactionsFor is subsequently called", function () {
                    beforeEach(function () {
                        manager.clearTransactionsFor(testId);
                    });

                    it("removes callbacks from the transaction", function () {
                        expect(mockRemoves[0]).toHaveBeenCalled();
                    });
                });
            });
        });
    }
);