node-modification.spec.ts

/********************************************************************************
 * Copyright (c) 2023 STMicroelectronics and others.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License v. 2.0 are satisfied: GNU General Public License, version 2
 * with the GNU Classpath Exception which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 ********************************************************************************/
/* eslint-disable max-len */
import { expect } from 'chai';
import { Dimension, Point } from 'sprotty-protocol';
import { ChangeBoundsOperation, ChangeContainerOperation } from './node-modification';

/**
 * The schema of an GModelElement describes its serializable form. The actual class-based model is derived
 * its schema whenever the client or server deserializes a received schema`.
 * Each model element must have a unique ID and a type that is used on the client to  look up its view.
 */

describe('Node modification actions', () => {
    describe('is', () => {
        it('should return true for an object having the correct type and a value for all required interface properties', () => {
            const operation: ChangeBoundsOperation = {
                kind: 'changeBounds',
                isOperation: true,
                newBounds: []
            };
            expect(ChangeBoundsOperation.is(operation)).to.be.true;
        });
        it('should return false for `undefined`', () => {
            expect(ChangeBoundsOperation.is(undefined)).to.be.false;
        });
        it('should return false for an object that does not have all required interface properties', () => {
            expect(ChangeBoundsOperation.is({ kind: 'notTheRightOne' })).to.be.false;
        });
    });

    describe('create', () => {
        it('should return an object conforming to the interface with matching properties for the given required arguments', () => {
            const expected: ChangeBoundsOperation = {
                kind: 'changeBounds',
                isOperation: true,
                newBounds: [{ elementId: 'someElement', newSize: Dimension.EMPTY, newPosition: Point.ORIGIN }]
            };
            const { newBounds } = expected;
            expect(ChangeBoundsOperation.create(newBounds)).to.deep.equals(expected);
        });
    });
});

describe('ChangeContainerOperation', () => {
    describe('is', () => {
        it('should return true for an object having the correct type and a value for all required interface properties', () => {
            const action: ChangeContainerOperation = {
                kind: 'changeContainer',
                isOperation: true,
                elementId: '',
                targetContainerId: ''
            };
            expect(ChangeContainerOperation.is(action)).to.be.true;
        });
        it('should return false for `undefined`', () => {
            expect(ChangeContainerOperation.is(undefined)).to.be.false;
        });
        it('should return false for an object that does not have all required interface properties', () => {
            expect(ChangeContainerOperation.is({ kind: 'notTheRightOne' })).to.be.false;
        });
    });

    describe('create', () => {
        it('should return an object conforming to the interface with matching properties for the given required arguments and default values for the optional arguments', () => {
            const expected: ChangeContainerOperation = {
                kind: 'changeContainer',
                isOperation: true,
                elementId: 'myElement',
                targetContainerId: 'myContainer'
            };
            const { elementId, targetContainerId } = expected;
            expect(ChangeContainerOperation.create({ elementId, targetContainerId })).to.deep.equals(expected);
        });
        it('should return an object conforming to the interface with matching properties for the given required and optional arguments', () => {
            const expected: ChangeContainerOperation = {
                kind: 'changeContainer',
                isOperation: true,
                elementId: 'myElement',
                targetContainerId: 'myContainer',
                location: Point.ORIGIN
            };
            const { elementId, targetContainerId, location } = expected;
            expect(ChangeContainerOperation.create({ elementId, targetContainerId, location })).to.deep.equals(expected);
        });
    });
});