opennms/test/dao/V2FilterProcessor.spec.ts

Client API for the OpenNMS network monitoring platform

declare const describe, it, expect;

import {Comparators} from '../../src/api/Comparator';
import {Filter} from '../../src/api/Filter';
import {NestedRestriction} from '../../src/api/NestedRestriction';
import {OrderBy, Orders} from '../../src/api/OrderBy';
import {Restriction} from '../../src/api/Restriction';
import {SearchProperty} from '../../src/api/SearchProperty';
import {SearchPropertyTypes} from '../../src/api/SearchPropertyType';

import {Severities} from '../../src/model/OnmsSeverity';

import {V2FilterProcessor} from '../../src/dao/V2FilterProcessor';
import { Clause } from '../../src/api/Clause';
import { Operators } from '../../src/api/Operator';

describe('V2FilterProcessor', () => {
  function toSearch(filter: Filter, processor?: V2FilterProcessor) {
    if (!processor) {
      processor = new V2FilterProcessor();
    }
    return processor.getParameters(filter)._s;
  }

  it('default alarm filter', () => {
    const filter = new Filter();
    const proc = new V2FilterProcessor();
    const params = proc.getParameters(filter);
    expect(Object.keys(params).length).toEqual(1);
    expect(params.limit).toEqual('1000');
  });
  it('alarm filter with no parameters', () => {
    const filter = new Filter();
    filter.limit = undefined;
    const proc = new V2FilterProcessor();
    const params = proc.getParameters(filter);
    expect(Object.keys(params).length).toEqual(0);
  });
  it('alarm filter: id=notnull', () => {
    const filter = new Filter();
    filter.withOrRestriction(new Restriction('id', Comparators.NOTNULL));
    expect(toSearch(filter)).toEqual('id!=\u0000');
  });
  it('alarm filter: id=notnull OR ackTime=null', () => {
    const filter = new Filter();
    filter.withOrRestriction(new Restriction('id', Comparators.NOTNULL));
    filter.withOrRestriction(new Restriction('ackTime', Comparators.NULL, '1970-01-01T00:00:00.000+0000'));
    expect(toSearch(filter)).toEqual('id!=\u0000,ackTime==1970-01-01T00%3A00%3A00.000%2B0000');
  });
  it('alarm filter: id=notnull OR severity="MINOR"', () => {
    const filter = new Filter();
    filter.withOrRestriction(new Restriction('id', Comparators.NOTNULL));
    filter.withOrRestriction(new Restriction('severity', Comparators.EQ, 'MINOR'));
    expect(toSearch(filter)).toEqual('id!=\u0000,severity==MINOR');
  });
  it('alarm filter: severity=OnmsSeverity.MINOR OR id!=0', () => {
    const filter = new Filter();
    filter.withOrRestriction(new Restriction('severity', Comparators.EQ, Severities.MINOR));
    filter.withOrRestriction(new Restriction('id', Comparators.NE, 0));
    expect(toSearch(filter)).toEqual('severity==5,id!=0');
  });
  it('alarm filter: severity=OnmsSeverity.MINOR OR id!=0', () => {
    const filter = new Filter();
    filter.withOrRestriction(new Restriction('severity', Comparators.EQ, Severities.MINOR));
    filter.withOrRestriction(new Restriction('id', Comparators.NE, 0));
    expect(toSearch(filter)).toEqual('severity==5,id!=0');
  });
  it('alarm filter: severity=OnmsSeverity.MINOR OR id!=0', () => {
    const filter = new Filter();
    filter.withOrRestriction(new Restriction('severity', Comparators.EQ, Severities.MINOR));
    filter.withOrRestriction(new Restriction('id', Comparators.NE, 0));
    expect(toSearch(filter)).toEqual('severity==5,id!=0');
  });
  it('alarm filter: uei like *somethingWentWrong', () => {
    const filter = new Filter();
    filter.withOrRestriction(new Restriction('uei', Comparators.LIKE, '*somethingWentWrong'));
    expect(toSearch(filter)).toEqual('uei==*somethingWentWrong');
  });
  it('alarm filter: severity=OnmsSeverity.MINOR AND id!=0 OR uei like *somethingWentWrong', () => {
    const filter = new Filter();
    filter.withOrRestriction(new Restriction('severity', Comparators.EQ, Severities.MINOR));
    filter.withAndRestriction(new Restriction('id', Comparators.NE, 0));
    filter.withOrRestriction(new Restriction('uei', Comparators.LIKE, '*somethingWentWrong'));
    expect(toSearch(filter)).toEqual('severity==5;id!=0,uei==*somethingWentWrong');
  });
  it('alarm filter: id!=0 AND (severity=OnmsSeverity.MINOR OR uei like *somethingWentWrong)', () => {
    const filter = new Filter()
        .withOrRestriction(new Restriction('id', Comparators.NE, 0))
        .withAndRestriction(new NestedRestriction()
            .withOrRestriction(new Restriction('severity', Comparators.EQ, Severities.MINOR))
            .withOrRestriction(new Restriction('uei', Comparators.LIKE, '*somethingWentWrong')),
        );
    expect(toSearch(filter)).toEqual('id!=0;(severity==5,uei==*somethingWentWrong)');
  });
  it('alarm filter: lastEventTime=1976-04-14T00:00:00.000+0000', () => {
    const filter = new Filter();
    filter.withAndRestriction(new Restriction('lastEventTime', Comparators.EQ, new Date(198288000000)));
    expect(toSearch(filter)).toEqual('lastEventTime==1976-04-14T00%3A00%3A00.000%2B0000');
  });
  it('alarm filter: verify null replacement for EQ and NE comparators', () => {
      // the filter does not make any sense, but is there to verify that null replacement works correctly
      const filter = new Filter()
          .withAndRestriction(new Restriction('alarmAckTime', Comparators.EQ, 'null'))
          .withAndRestriction(new Restriction('alarmAckTime', Comparators.NE, 'null'))
          .withAndRestriction(new Restriction('id', Comparators.EQ, 'null'))
          .withAndRestriction(new Restriction('id', Comparators.NE, 'null'));
      const proc = new V2FilterProcessor([
        { id: 'alarmAckTime', type: SearchPropertyTypes.TIMESTAMP } as SearchProperty,
      ]);
      expect(toSearch(filter, proc)).toEqual(
          'alarmAckTime==1970-01-01T00%3A00%3A00.000%2B0000'
          + ';alarmAckTime!=1970-01-01T00%3A00%3A00.000%2B0000'
          + ';id==\u0000;id!=\u0000');
  });
  it('alarm filter: orderBy=lastEventTime&orderBy=id&order=DESC', () => {
    const filter = new Filter();
    filter
      .withOrderBy(new OrderBy('lastEventTime', Orders.DESC))
      .withOrderBy(new OrderBy('id', Orders.DESC));
    const proc = new V2FilterProcessor();
    expect(proc.getParameters(filter)).toMatchObject({
      order: 'DESC',
      orderBy: ['lastEventTime', 'id'],
    });
  });
  it('alarm filter: orderBy=lastEventTime&order=DESC&orderBy=id&order=ASC', () => {
    const clauses = [ 1, 2, 3 ].map((id) => {
      return new Clause(new Restriction('node.id', Comparators.EQ, id), Operators.OR);
    });

    const filter = new Filter();
    filter
      .withOrderBy(new OrderBy('lastEventTime', Orders.DESC))
      .withOrderBy(new OrderBy('id', Orders.ASC));
    const proc = new V2FilterProcessor();
    expect(() => { proc.getParameters(filter); }).toThrow();
  });
  it('nested query', () => {
    const clauses = [ 1, 2, 3 ].map((id) => {
      return new Clause(new Restriction('node.id', Comparators.EQ, id), Operators.OR);
    });

    const filter = new Filter()
      .withAndRestriction(new Restriction('snmpPrimary', Comparators.EQ, 'P'))
      .withAndRestriction(new NestedRestriction(...clauses));

    const proc = new V2FilterProcessor();
    expect(toSearch(filter, proc)).toEqual(
      'snmpPrimary==P;'
      + '(node.id==1,node.id==2,node.id==3)'
    );
  });
});