eclipse-scout-core/test/util/StatusSpec.js

/*
 * Copyright (c) 2010-2019 BSI Business Systems Integration AG.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     BSI Business Systems Integration AG - initial API and implementation
 */
import {Status, DefaultStatus, ParsingFailedStatus} from '../../src/index';

describe('scout.Status', function() {

  describe('convenience functions', function() {

    it('create valid status objects', function() {
      var status;

      // 1. Options argument (default)
      status = Status.error({
        message: 'Oops'
      });
      expect(status.severity).toBe(Status.Severity.ERROR);
      expect(status.message).toBe('Oops');
      expect(status.isError()).toBe(true);
      expect(status.isWarning()).toBe(false);
      expect(status.isInfo()).toBe(false);
      expect(status.isOk()).toBe(false);

      status = Status.warning({
        message: 'foo'
      });
      expect(status.severity).toBe(Status.Severity.WARNING);
      expect(status.message).toBe('foo');
      expect(status.isError()).toBe(false);
      expect(status.isWarning()).toBe(true);
      expect(status.isInfo()).toBe(false);
      expect(status.isOk()).toBe(false);

      status = Status.info({
        message: 'bar'
      });
      expect(status.severity).toBe(Status.Severity.INFO);
      expect(status.message).toBe('bar');
      expect(status.isError()).toBe(false);
      expect(status.isWarning()).toBe(false);
      expect(status.isInfo()).toBe(true);
      expect(status.isOk()).toBe(false);

      status = Status.ok({
        message: 'Okay'
      });
      expect(status.severity).toBe(Status.Severity.OK);
      expect(status.message).toBe('Okay');
      expect(status.isError()).toBe(false);
      expect(status.isWarning()).toBe(false);
      expect(status.isInfo()).toBe(false);
      expect(status.isOk()).toBe(true);

      // 2. String argument (convenience)
      status = Status.error('Oops');
      expect(status.severity).toBe(Status.Severity.ERROR);
      expect(status.message).toBe('Oops');

      status = Status.warning('foo');
      expect(status.severity).toBe(Status.Severity.WARNING);
      expect(status.message).toBe('foo');

      status = Status.info('bar');
      expect(status.severity).toBe(Status.Severity.INFO);
      expect(status.message).toBe('bar');

      status = Status.ok('Okay');
      expect(status.severity).toBe(Status.Severity.OK);
      expect(status.message).toBe('Okay');
    });

  });

  it('addStatus / hasChildren', function() {
    var status = Status.error('root');
    expect(status.hasChildren()).toBe(false);
    status.addStatus(Status.info('foo'));
    expect(status.hasChildren()).toBe(true);
    status.removeAllStatus(Status);
    expect(status.hasChildren()).toBe(false);
  });

  it('removeAllStatus', function() {
    var status = Status.error('root');
    status.addStatus(ParsingFailedStatus.error('foo'));
    status.addStatus(Status.error('bar'));
    expect(status.children.length).toEqual(2);
    status.removeAllStatus(Status);
    expect(status.hasChildren()).toBe(false); // because Status is the base-class of all status

    // only remove status with type DefaultStatus
    status.addStatus(ParsingFailedStatus.error('foo'));
    status.addStatus(DefaultStatus.error('bar'));
    status.removeAllStatus(DefaultStatus);
    expect(status.children.length).toEqual(1);
    expect(status.children[0].message).toEqual('foo');
  });

  it('containsStatus', function() {
    var status = Status.error('root');

    expect(status.containsStatus(ParsingFailedStatus)).toBe(false);
    status.addStatus(ParsingFailedStatus.error('foo'));
    expect(status.containsStatus(ParsingFailedStatus)).toBe(true);

    expect(status.containsStatus(DefaultStatus)).toBe(false);
    status.addStatus(DefaultStatus.error('bar'));
    expect(status.containsStatus(DefaultStatus)).toBe(true);
  });

  it('updateProperties', function() {
    var status = Status.ok('root');
    status.addStatus(ParsingFailedStatus.error('foo'));
    status.addStatus(DefaultStatus.warning('bar'));

    expect(status.message).toEqual('foo');
    expect(status.severity).toEqual(Status.Severity.ERROR);

    // use properties from last remaining status (DefaultStatus)
    status.removeAllStatus(ParsingFailedStatus);
    expect(status.message).toEqual('bar');
    expect(status.severity).toEqual(Status.Severity.WARNING);

    // ParsingFailed should have the higher priority than DefaultStatus
    status = Status.ok('root');
    status.addStatus(DefaultStatus.error('baz'));
    status.addStatus(ParsingFailedStatus.error('foo'));
    expect(status.message).toEqual('foo');
    expect(status.severity).toEqual(Status.Severity.ERROR);

    // when the last child is removed
    status.removeAllStatus(Status);
    expect(status.message).toEqual(null);
    expect(status.severity).toEqual(Status.Severity.OK);
  });

  it('equals', function() {
    var a = Status.ok('root');
    var b = Status.ok('root');
    expect(a.equals(b)).toBe(true);
    expect(b.equals(a)).toBe(true);

    // make sure property 'children' is checked
    a.addStatus(Status.error('foo'));
    expect(a.equals(b)).toBe(false);
    expect(b.equals(a)).toBe(false);

    b.addStatus(Status.error('foo'));
    expect(a.equals(b)).toBe(true);
    expect(b.equals(a)).toBe(true);
  });

  describe('ensureChildren', function() {

    it('status with no children should be transformed in a status with children', function() {
      var status = Status.ok('foo');
      expect(status.children).toBe(null);
      var newStatus = status.ensureChildren();
      expect(newStatus.children.length).toEqual(1);
      expect(status).toBe(newStatus.children[0]);
    });

    it('status with children should return a clone', function() {
      var status = Status.ensure({
        children: [{message: 'foo'}]
      });
      expect(status.children.length).toEqual(1);
      var newStatus = status.ensureChildren();
      expect(newStatus.children.length).toEqual(1);
      expect(status).not.toBe(newStatus);
    });

  });

});