api/test/unit/sanitiser/get.js

var get  = require('../../../sanitiser/get'),
    _sanitize = get.sanitize,
    middleware = get.middleware,
    indeces = require('../../../query/indeces'),
    defaultIdError = 'invalid param \'id\': text length, must be >0',
    defaultTypeError = 'invalid param \'type\': text length, must be >0',
    defaultFormatError = 'invalid: must be of the format type/id for ex: \'geoname/4163334\'',
    defaultError = defaultIdError,
    defaultMissingTypeError = 'type must be one of these values - [' + indeces.join(", ") + ']',
    defaultClean = { id: '123', type: 'geoname' },
    sanitize = function(query, cb) { _sanitize({'query':query}, cb); }

module.exports.tests = {};

module.exports.tests.interface = function(test, common) {
  test('sanitize interface', function(t) {
    t.equal(typeof sanitize, 'function', 'sanitize is a function');
    t.equal(sanitize.length, 2, 'sanitize interface');
    t.end();
  });
  test('middleware interface', function(t) {
    t.equal(typeof middleware, 'function', 'middleware is a function');
    t.equal(middleware.length, 3, 'sanitizee has a valid middleware');
    t.end();
  });
};

module.exports.tests.sanitize_id_and_type = function(test, common) {
  var inputs = {
    valid: [
      'geoname/1',
      'osmnode/2',
      'admin0/53',
      'osmway/44',
      'geoname/5'
    ],
    invalid: [
      '/',
      '',
      '//',
      'geoname/',
      '/234',
      'gibberish/23'
    ]
  };

  test('invalid input', function(t) {
    inputs.invalid.forEach( function( input ){
      sanitize({ id: input }, function( err, clean ){
        switch (err) {
          case defaultIdError:
            t.equal(err, defaultIdError, input + ' is invalid (missing id)'); break;
          case defaultTypeError:
            t.equal(err, defaultTypeError, input + ' is invalid (missing type)'); break;
          case defaultFormatError:
            t.equal(err, defaultFormatError, input + ' is invalid (invalid format)'); break;
          case defaultMissingTypeError:
            t.equal(err, defaultMissingTypeError, input + ' is an unknown type'); break;
          default: break;
        }
        t.equal(clean, undefined, 'clean not set');
      });
    });
    t.end();
  });

  test('valid input', function(t) {
    inputs.valid.forEach( function( input ){
      var input_parts = input.split('/');
      var expected = { id: input_parts[1], type: input_parts[0] };
      sanitize({ id: input }, function( err, clean ){
        t.equal(err, undefined, 'no error (' + input + ')' );
        t.deepEqual(clean, expected, 'clean set correctly (' + input + ')');
      });
    });
    t.end();
  });
};

module.exports.tests.invalid_params = function(test, common) {
  test('invalid params', function(t) {
    sanitize( undefined, function( err, clean ){
      t.equal(err, defaultError, 'handle invalid params gracefully');
      t.end();
    });
  });
};

module.exports.tests.middleware_failure = function(test, common) {
  test('middleware failure', function(t) {
    var res = { status: function( code ){
      t.equal(code, 400, 'status set');
    }};
    var next = function( message ){
      t.equal(message, defaultError);
      t.end();
    };
    middleware( {}, res, next );
  });
};

module.exports.tests.middleware_success = function(test, common) {
  test('middleware success', function(t) {
    var req = { query: { id: 'geoname/123' }};
    var next = function( message ){
      t.equal(message, undefined, 'no error message set');
      t.deepEqual(req.clean, defaultClean);
      t.end();
    };
    middleware( req, undefined, next );
  });
};

module.exports.all = function (tape, common) {

  function test(name, testFunction) {
    return tape('SANTIZE /get ' + name, testFunction);
  }

  for( var testCase in module.exports.tests ){
    module.exports.tests[testCase](test, common);
  }
};