api/test/unit/sanitiser/reverse.js

// @todo: refactor this test, it's pretty messy, brittle and hard to follow

var reverse  = require('../../../sanitiser/reverse'),
    sanitize = reverse.sanitize,
    middleware = reverse.middleware,
    defaultError = 'missing param \'lat\'',
    defaultClean =  { lat:0,
                      types: {
                      },
                      lon: 0,
                      size: 10,
                      private: false,
                      categories: [],
                      boundary: { }
                    };

// these are the default values you would expect when no input params are specified.
// @todo: why is this different from $defaultClean?
var emptyClean = { boundary: {}, categories: [], private: false, size: 10, types: {} };

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.sanitisers = function(test, common) {
  test('check sanitiser list', function (t) {
    var expected = ['layers', 'sources', 'size', 'private', 'geo_reverse', 'categories', 'boundary_country'];
    t.deepEqual(Object.keys(reverse.sanitiser_list), expected);
    t.end();
  });
};

module.exports.tests.sanitize_lat = function(test, common) {
  var lats = {
    invalid: [],
    valid: [ 0, 45, 90, -0, '0', '45', '90', -181, -120, -91, 91, 120, 181 ],
    missing: ['', undefined, null]
  };
  test('invalid lat', function(t) {
    lats.invalid.forEach( function( lat ){
      var req = { query: { 'point.lat': lat, 'point.lon': 0 } };
      sanitize(req, function(){
        t.equal(req.errors[0], 'invalid param \'lat\': must be >-90 and <90', lat + ' is an invalid latitude');
        t.deepEqual(req.clean, emptyClean, 'clean only has default values set');
      });
    });
    t.end();
  });
  test('valid lat', function(t) {
    lats.valid.forEach( function( lat ){
      var req = { query: { 'point.lat': lat, 'point.lon': 0 } };
      sanitize(req, function(){
        var expected = JSON.parse(JSON.stringify( defaultClean ));
        expected.lat = parseFloat( lat );
        t.deepEqual(req.errors, [], 'no errors');
        t.equal(req.clean.lat, parseFloat(lat), 'clean set correctly (' + lat + ')');
      });
    });
    t.end();
  });
  test('missing lat', function(t) {
    lats.missing.forEach( function( lat ){
      var req = { query: { 'point.lat': lat, 'point.lon': 0 } };
      sanitize(req, function(){
        t.equal(req.errors[0], 'missing param \'lat\'', 'latitude is a required field');
        t.deepEqual(req.clean, emptyClean, 'clean only has default values set');
      });
    });
    t.end();
  });
};

module.exports.tests.sanitize_lon = function(test, common) {
  var lons = {
    valid: [ -360, -181, 181, -180, -1, -0, 0, 45, 90, '-180', '0', '180' ],
    missing: ['', undefined, null]
  };
  test('valid lon', function(t) {
    lons.valid.forEach( function( lon ){
      var req = { query: { 'point.lat': 0, 'point.lon': lon } };
      sanitize(req, function(){
        var expected = JSON.parse(JSON.stringify( defaultClean ));
        expected.lon = parseFloat( lon );
        t.deepEqual(req.errors, [], 'no errors');
        t.equal(req.clean.lon, parseFloat(lon), 'clean set correctly (' + lon + ')');
      });
    });
    t.end();
  });
  test('missing lon', function(t) {
    lons.missing.forEach( function( lon ){
      var req = { query: { 'point.lat': 0, 'point.lon': lon } };

      // @todo: why is lat set?
      var expected = { boundary: {}, categories: [], lat: 0, private: false, size: 10, types: {} };
      sanitize(req, function(){
        t.equal(req.errors[0], 'missing param \'lon\'', 'longitude is a required field');
        t.deepEqual(req.clean, expected, 'clean only has default values set');
      });
    });
    t.end();
  });
};

module.exports.tests.sanitize_size = function(test, common) {
  test('invalid size value', function(t) {
    var req = { query: { size: 'a', 'point.lat': 0, 'point.lon': 0 } };
    sanitize(req, function(){
      t.equal(req.clean.size, 10, 'default size set');
      t.end();
    });
  });
  test('below min size value', function(t) {
    var req = { query: { size: -100, 'point.lat': 0, 'point.lon': 0 } };
    sanitize(req, function(){
      t.equal(req.clean.size, 1, 'min size set');
      t.end();
    });
  });
  test('above max size value', function(t) {
    var req = { query: { size: 9999, 'point.lat': 0, 'point.lon': 0 } };
    sanitize(req, function(){
      t.equal(req.clean.size, 40, 'max size set');
      t.end();
    });
  });
};

module.exports.tests.sanitize_private = function(test, common) {
  var invalid_values = [null, -1, 123, NaN, 'abc'];
  invalid_values.forEach(function(value) {
    test('invalid private param ' + value, function(t) {
      var req = { query: { 'point.lat': 0, 'point.lon': 0, 'private': value } };
      sanitize(req, function(){
        t.equal(req.clean.private, false, 'default private set (to false)');
        t.end();
      });
    });
  });

  var valid_values = ['true', true, 1, '1'];
  valid_values.forEach(function(value) {
    test('valid private param ' + value, function(t) {
      var req = { query: { 'point.lat': 0, 'point.lon': 0, 'private': value } };
      sanitize(req, function(){
        t.equal(req.clean.private, true, 'private set to true');
        t.end();
      });
    });
  });

  var valid_false_values = ['false', false, 0];
  valid_false_values.forEach(function(value) {
    test('test setting false explicitly ' + value, function(t) {
      var req = { query: { 'point.lat': 0, 'point.lon': 0, 'private': value } };
      sanitize(req, function(){
        t.equal(req.clean.private, false, 'private set to false');
        t.end();
      });
    });
  });

  test('test default behavior', function(t) {
    var req = { query: { 'point.lat': 0, 'point.lon': 0 } };
    sanitize(req, function(){
      t.equal(req.clean.private, false, 'private set to false');
      t.end();
    });
  });
};

module.exports.tests.sanitize_categories = function(test, common) {
  var req = { query: { 'point.lat': 0, 'point.lon': 0 } };
  test('unspecified', function(t) {
    req.query.categories = undefined;
    sanitize(req, function(){
      t.deepEqual(req.clean.categories, defaultClean.categories, 'default to empty categories array');
      t.end();
    });
  });
  test('single category', function(t) {
    req.query.categories = 'food';
    sanitize(req, function(){
      t.deepEqual(req.clean.categories, ['food'], 'category set');
      t.end();
    });
  });
  test('multiple categories', function(t) {
    req.query.categories = 'food,education,nightlife';
    sanitize(req, function(){
      t.deepEqual(req.clean.categories, ['food', 'education', 'nightlife'], 'categories set');
      t.end();
    });
  });
  test('whitespace and empty strings', function(t) {
    req.query.categories = 'food, , nightlife ,';
    sanitize(req, function(){
      t.deepEqual(req.clean.categories, ['food', 'nightlife'], 'categories set');
      t.end();
    });
  });
  test('all empty strings', function(t) {
    req.query.categories = ', ,  ,';
    sanitize(req, function(){
      t.deepEqual(req.clean.categories, defaultClean.categories, 'empty strings filtered out');
      t.end();
    });
  });
};

module.exports.tests.middleware_success = function(test, common) {
  test('middleware success', function(t) {
    var req = { query: { 'point.lat': 0, 'point.lon': 0 }};
    var next = function(){
      t.deepEqual(req.errors, [], '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 /reverse ' + name, testFunction);
  }

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