maskdata/tests/testPhone.js

Node module to mask various kinds of data in the required formats

'use strict';
const maskData = require('../index');
const expect = require('chai').expect;

describe('Masking phone numbers', function () {
  describe('Mask with default options', function () {
    // default options are this - let tests fail when defaults change
    // const phoneMaskOptions = {
    //   maskWith: "*",
    //   unmaskedStartDigits: 4,
    //   unmaskedEndDigits: 1
    // };

    let testData = [
      {
        title: 'test default number',
        input: '1234-56781234',
        output: '1234********4'
      },
      {
        title: 'test number length equal than start + end',
        input: '12345',
        output: '12345'
      },
      {
        title: 'test shorter number than start + end',
        input: '1234',
        output: '1234'
      }
    ];

    testData.forEach(({ title, input, output }) => {
      it(`default mask - ${title}`, function () {
        const masked = maskData.maskPhone(input);
        expect(masked).to.equal(output, 'masked output does not match expected value');
      });
    });
  });

  describe('Mask with custom options', function () {
    const maskOptions = {
      maskWith: 'x',
      unmaskedStartDigits: 2, // use different numbers for start / end to check correct masking
      unmaskedEndDigits: 3
    };

    let testData = [
      {
        title: 'test default string',
        input: '1234567812345678',
        output: '12xxxxxxxxxxx678'
      },
      {
        title: 'test number length equal than start + end',
        input: '12-34',
        output: '12-34'
      },
      {
        title: 'test shorter number than start + end',
        input: '1234',
        output: '1234'
      }
    ];

    testData.forEach(({ title, input, output }) => {
      it(`custom mask - ${title}`, function () {
        const masked = maskData.maskPhone(input, maskOptions);
        expect(masked).to.equal(output, 'masked output does not match expected value');
      });
    });

    it('test with negative unmaskedStartDigits', function () {
      const negativeStartOption = {
        maskWith: 'x',
        unmaskedStartDigits: -2, // internal set to 0
        unmaskedEndDigits: 3
      };
      const input = '1234-5678';
      const output = 'xxxxxx678';
      const masked = maskData.maskPhone(input, negativeStartOption);
      expect(masked).to.equal(output, 'masked output does not match expected value');
    });

    it('test with negative unmaskedEndDigits', function () {
      const negativeEndOption = {
        maskWith: 'x',
        unmaskedStartDigits: 2,
        unmaskedEndDigits: -3 // internal set to 0
      };
      const input = '1234-5678';
      const output = '12xxxxxxx';
      const masked = maskData.maskPhone(input, negativeEndOption);
      expect(masked).to.equal(output, 'masked output does not match expected value');
    });
  });

  describe('Mask with special input strings', function () {
    const maskOptions = {
      maskWith: 'x',
      unmaskedStartDigits: 2,
      unmaskedEndDigits: 2
    };

    describe('Mask with special input - input will generate an output', function () {
      // first set with input generating an masked output
      let testData = [
        {
          title: 'test with string length zero',
          input: '',
          output: ''
        },
        {
          title: 'test input null',
          input: null,
          output: null
        },
        {
          title: 'test input as number',
          input: 1234567,
          output: '12xxx67'
        }
      ];

      testData.forEach(({ title, input, output }) => {
        it(`special input - ${title}`, function () {
          const masked = maskData.maskPhone(input, maskOptions);
          expect(masked).to.equal(output, 'masked output does not match expected value');
        });
      });
    });

    describe("Mask with special input - input won't be masked", function () {
      // set with input generating an error / exception
      let testData = [
        {
          title: 'test input as array',
          input: ['12', '34']
        },
        {
          title: 'test input as object',
          input: { a: 'b', x: 'y' }
        }
      ];

      testData.forEach(({ title, input, output }) => {
        it(`special input - ${title}`, function () {
          const masked = maskData.maskPhone(input, maskOptions);
          expect(masked).to.equal(input, "input won't be masked");
        });
      });
    });
  });
});