openmct/src/plugins/remove/pluginSpec.js

/*****************************************************************************
 * Open MCT, Copyright (c) 2014-2024, 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.
 *****************************************************************************/
import { createOpenMct, getMockObjects, resetApplicationState } from 'utils/testing';

describe('The Remove Action plugin', () => {
  let openmct;
  let removeAction;
  let childObject;
  let parentObject;

  // this setups up the app
  beforeEach((done) => {
    openmct = createOpenMct();

    childObject = getMockObjects({
      objectKeyStrings: ['folder'],
      overwrite: {
        folder: {
          name: 'Child Folder',
          identifier: {
            namespace: '',
            key: 'child-folder-object'
          }
        }
      }
    }).folder;
    parentObject = getMockObjects({
      objectKeyStrings: ['folder'],
      overwrite: {
        folder: {
          identifier: {
            namespace: '',
            key: 'parent-folder-object'
          },
          name: 'Parent Folder',
          composition: [childObject.identifier]
        }
      }
    }).folder;

    openmct.on('start', done);
    openmct.startHeadless();

    removeAction = openmct.actions._allActions.remove;
  });

  afterEach(() => {
    return resetApplicationState(openmct);
  });

  it('should be defined', () => {
    expect(removeAction).toBeDefined();
  });

  describe('when removing an object from a parent composition', () => {
    beforeEach(() => {
      spyOn(removeAction, 'removeFromComposition').and.callThrough();
      spyOn(removeAction, 'inNavigationPath').and.returnValue(false);
      spyOn(openmct.objects, 'mutate').and.callThrough();
      spyOn(openmct.objects, 'startTransaction').and.callThrough();
      spyOn(openmct.objects, 'endTransaction').and.callThrough();
      removeAction.removeFromComposition(parentObject, childObject);
    });

    it('removeFromComposition should be called with the parent and child', () => {
      expect(removeAction.removeFromComposition).toHaveBeenCalled();
      expect(removeAction.removeFromComposition).toHaveBeenCalledWith(parentObject, childObject);
    });

    it('it should mutate the parent object', () => {
      expect(openmct.objects.mutate).toHaveBeenCalled();
      expect(openmct.objects.mutate.calls.argsFor(0)[0]).toEqual(parentObject);
    });

    it('it should start a transaction', () => {
      expect(openmct.objects.startTransaction).toHaveBeenCalled();
    });

    it('it should end the transaction', (done) => {
      setTimeout(() => {
        expect(openmct.objects.endTransaction).toHaveBeenCalled();
        done();
      }, 100);
    });
  });

  describe('when determining the object is applicable', () => {
    beforeEach(() => {
      spyOn(removeAction, 'appliesTo').and.callThrough();
    });

    it('should be true when the parent is creatable and has composition', () => {
      let applies = removeAction.appliesTo([childObject, parentObject]);
      expect(applies).toBe(true);
    });

    it('should be false when the child is locked and not an alias', () => {
      childObject.locked = true;
      childObject.location = 'parent-folder-object';
      let applies = removeAction.appliesTo([childObject, parentObject]);
      expect(applies).toBe(false);
    });

    it('should be true when the child is locked and IS an alias', () => {
      childObject.locked = true;
      childObject.location = 'other-folder-object';
      let applies = removeAction.appliesTo([childObject, parentObject]);
      expect(applies).toBe(true);
    });
  });
});