pelias
/
api
mirror of https://github.com/pelias/api.git
1
0
Fork 0
Code Issues Releases Activity
Browse Source

refactored search sanitiser tests 

the tests removed were testing far more than was appropriate since the functionality of the individual sanitisers is tested elsewhere.  in this case, the test has been reduced to just testing that all the sanitisers were actually called.
pull/666/head
Stephen Hess 9 years ago
parent
486f25663a
commit
85dab16869
3 changed files with 99 additions and 295 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 5
      query/search.js
  2. 6
      sanitiser/search.js
  3. 367
      test/unit/sanitiser/search.js

5
query/search.js
Unescape View File

@ -123,8 +123,9 @@ function generateQuery( clean ){
textParser( clean.parsed_text, vs ); textParser( clean.parsed_text, vs );
} }
var q = query.render(vs); var q = getQuery(vs);
console.log(JSON.stringify(q, null, 2));
//console.log(JSON.stringify(q, null, 2));
return q; return q;
} }

6
sanitiser/search.js
Unescape View File

@ -8,7 +8,7 @@ var sanitizeAll = require('../sanitiser/sanitizeAll'),
size: require('../sanitiser/_size')(/* use defaults*/), size: require('../sanitiser/_size')(/* use defaults*/),
layers: require('../sanitiser/_targets')('layers', type_mapping.layer_mapping), layers: require('../sanitiser/_targets')('layers', type_mapping.layer_mapping),
sources: require('../sanitiser/_targets')('sources', type_mapping.source_mapping), sources: require('../sanitiser/_targets')('sources', type_mapping.source_mapping),
// depends on the layers and sources sanitisers, must be run after them // // depends on the layers and sources sanitisers, must be run after them
sources_and_layers: require('../sanitiser/_sources_and_layers'), sources_and_layers: require('../sanitiser/_sources_and_layers'),
private: require('../sanitiser/_flag_bool')('private', false), private: require('../sanitiser/_flag_bool')('private', false),
geo_search: require('../sanitiser/_geo_search'), geo_search: require('../sanitiser/_geo_search'),
@ -18,10 +18,6 @@ var sanitizeAll = require('../sanitiser/sanitizeAll'),
var sanitize = function(req, cb) { sanitizeAll(req, sanitizers, cb); }; var sanitize = function(req, cb) { sanitizeAll(req, sanitizers, cb); };
// export sanitize for testing
module.exports.sanitize = sanitize;
module.exports.sanitiser_list = sanitizers;
// middleware // middleware
module.exports.middleware = function( req, res, next ){ module.exports.middleware = function( req, res, next ){
sanitize( req, function( err, clean ){ sanitize( req, function( err, clean ){

367
test/unit/sanitiser/search.js
Unescape View File

@ -1,299 +1,106 @@
var extend = require('extend'), var proxyquire = require('proxyquire').noCallThru();
search = require('../../../sanitiser/search'),
text_analyzer = require('pelias-text-analyzer'),
sanitize = search.sanitize,
middleware = search.middleware,
defaultError = 'invalid param \'text\': text length, must be >0';
// these are the default values you would expect when no input params are specified.
var emptyClean = { private: false, size: 10 };
module.exports.tests = {}; module.exports.tests = {};
module.exports.tests.interface = function(test, common) { module.exports.tests.sanitize = function(test, common) {
test('sanitize interface', function(t) { test('verify that all sanitisers were called as expected', function(t) {
t.equal(typeof sanitize, 'function', 'sanitize is a function'); var called_sanitisers = [];
t.equal(sanitize.length, 2, 'sanitize interface');
t.end(); // rather than re-verify the functionality of all the sanitisers, this test just verifies that they
}); // were all called correctly
test('middleware interface', function(t) { var search = proxyquire('../../../sanitiser/search', {
t.equal(typeof middleware, 'function', 'middleware is a function'); '../sanitiser/_deprecate_quattroshapes': function() {
t.equal(middleware.length, 3, 'sanitize has a valid middleware'); called_sanitisers.push('_deprecate_quattroshapes');
t.end(); return { errors: [], warnings: [] };
}); },
}; '../sanitiser/_single_scalar_parameters': function() {
called_sanitisers.push('_single_scalar_parameters');
module.exports.tests.sanitisers = function(test, common) { return { errors: [], warnings: [] };
test('check sanitiser list', function (t) { },
var expected = ['quattroshapes_deprecation', 'singleScalarParameters', 'text', 'size', '../sanitiser/_text': function() {
'layers', 'sources', 'sources_and_layers', 'private', 'geo_search', 'boundary_country', 'categories' ]; called_sanitisers.push('_text');
t.deepEqual(Object.keys(search.sanitiser_list), expected); return { errors: [], warnings: [] };
t.end(); },
}); '../sanitiser/_size': function() {
}; if (arguments.length === 0) {
return function() {
module.exports.tests.sanitize_invalid_text = function(test, common) { called_sanitisers.push('_size');
test('invalid text', function(t) { return { errors: [], warnings: [] };
var invalid = [ '', 100, null, undefined ]; };
invalid.forEach( function( text ){
var req = { query: { text: text } }; } else {
sanitize(req, function(){ throw new Error('should not have passed any parameters to _size');
t.equal(req.errors[0], 'invalid param \'text\': text length, must be >0', text + ' is an invalid text'); }
t.deepEqual(req.clean, emptyClean, 'clean only has default values set');
});
});
t.end();
});
};
module.exports.tests.sanitise_valid_text = function(test, common) {
test('valid short text', function(t) {
var req = { query: { text: 'a' } };
sanitize(req, function(){
t.equal(req.errors[0], undefined, 'no error');
});
t.end();
});
test('valid not-quite-as-short text', function(t) {
var req = { query: { text: 'aa' } };
sanitize(req, function(){
t.equal(req.errors[0], undefined, 'no error');
});
t.end();
});
test('valid longer text', function(t) {
var req = { query: { text: 'aaaaaaaa' } };
sanitize(req, function(){
t.equal(req.errors[0], undefined, 'no error');
});
t.end();
});
};
module.exports.tests.sanitize_text_with_delim = function(test, common) {
var texts = [ 'a,bcd', '123 main st, region', ',,,', ' ' ];
test('valid texts with a comma', function(t) {
texts.forEach( function( text ){
var req = { query: { text: text } };
sanitize( req, function( ){
var expected_text = text;
var expected_parsed_text = text_analyzer.parse(text);
t.equal(req.errors[0], undefined, 'no error');
t.equal(req.clean.parsed_text.name, expected_parsed_text.name, 'clean name set correctly');
t.equal(req.clean.text, expected_text, 'text should match');
});
});
t.end();
});
};
module.exports.tests.sanitize_private_no_value = function(test, common) {
test('default private should be set to true', function(t) {
var req = { query: { text: 'test' } };
sanitize(req, function(){
t.equal(req.clean.private, false, 'private set to false');
});
t.end();
});
};
module.exports.tests.sanitize_private_explicit_true_value = function(test, common) {
test('explicit private should be set to true', function(t) {
var req = { query: { text: 'test', private: true } };
sanitize(req, function(){
t.equal(req.clean.private, true, 'private set to true');
});
t.end();
});
};
module.exports.tests.sanitize_private_explicit_false_value = function(test, common) {
test('explicit private should be set to false', function(t) {
var req = { query: { text: 'test', private: false } };
sanitize(req, function(){
t.equal(req.clean.private, false, 'private set to false');
});
t.end();
});
};
module.exports.tests.sanitize_lat = function(test, common) {
var valid_lats = [ 0, 45, 90, -0, '0', '45', '90', -181, -120, -91, 91, 120, 181 ];
test('valid lat', function(t) {
valid_lats.forEach( function( lat ){
var req = { query: { text: 'test', 'focus.point.lat': lat, 'focus.point.lon': 0 } };
sanitize(req, function(){
var expected_lat = parseFloat( lat );
t.equal(req.errors[0], undefined, 'no error');
});
});
t.end();
});
};
module.exports.tests.sanitize_lon = function(test, common) {
var lons = {
valid: [ -381, -181, -180, -1, -0, 0, 45, 90, '-180', '0', '180', 181 ]
};
test('valid lon', function(t) {
lons.valid.forEach( function( lon ){
var req = { query: { text: 'test', 'focus.point.lat': 0, 'focus.point.lon': lon } };
sanitize( req, function(){
var expected_lon = parseFloat( lon );
t.equal(req.errors[0], undefined, 'no error');
});
});
t.end();
});
};
module.exports.tests.sanitize_optional_geo = function(test, common) { },
test('no lat/lon', function(t) { '../sanitiser/_targets': function(type) {
var req = { query: { text: 'test' } }; if (['layers', 'sources'].indexOf(type) !== -1) {
sanitize(req, function(){ return function() {
t.equal(req.errors[0], undefined, 'no error'); called_sanitisers.push('_targets/' + type);
t.equal(req.clean['focus.point.lat'], undefined, 'clean set without lat'); return { errors: [], warnings: [] };
t.equal(req.clean['focus.point.lon'], undefined, 'clean set without lon');
});
t.end();
});
test('no lat', function(t) {
var req = { query: { text: 'test', 'focus.point.lon': 0 } };
sanitize(req, function(){
var expected_lon = 0;
t.equal(req.errors[0], 'parameters focus.point.lat and focus.point.lon must both be specified');
t.equal(req.clean['focus.point.lat'], undefined);
t.equal(req.clean['focus.point.lon'], undefined);
});
t.end();
});
test('no lon', function(t) {
var req = { query: { text: 'test', 'focus.point.lat': 0 } };
sanitize(req, function(){
var expected_lat = 0;
t.equal(req.errors[0], 'parameters focus.point.lat and focus.point.lon must both be specified');
t.equal(req.clean['focus.point.lat'], undefined);
t.equal(req.clean['focus.point.lon'], undefined);
});
t.end();
});
}; };
module.exports.tests.sanitize_bounding_rect = function(test, common) {
test('valid bounding rect', function(t) {
var req = {
query: {
text: 'test',
'boundary.rect.min_lat': -40.659,
'boundary.rect.max_lat': -41.614,
'boundary.rect.min_lon': 174.612,
'boundary.rect.max_lon': 176.333
} }
}; else {
throw new Error('incorrect parameters passed to _targets');
sanitize(req, function(){ }
t.equal(req.errors[0], undefined, 'no error');
t.equal(req.clean['boundary.rect.min_lon'], parseFloat(req.query['boundary.rect.min_lon']));
t.equal(req.clean['boundary.rect.max_lat'], parseFloat(req.query['boundary.rect.max_lat']));
t.equal(req.clean['boundary.rect.max_lon'], parseFloat(req.query['boundary.rect.max_lon']));
t.equal(req.clean['boundary.rect.min_lat'], parseFloat(req.query['boundary.rect.min_lat']));
t.end();
});
});
};
module.exports.tests.sanitize_size = function(test, common) { },
test('invalid size value', function(t) { '../sanitiser/_sources_and_layers': function() {
var req = { query: { size: 'a', text: 'test', lat: 0, lon: 0 } }; called_sanitisers.push('_sources_and_layers');
sanitize(req, function(){ return { errors: [], warnings: [] };
t.equal(req.clean.size, 10, 'default size set'); },
t.end(); '../sanitiser/_flag_bool': function() {
}); if (arguments[0] === 'private' && arguments[1] === false) {
}); return function() {
test('below min size value', function(t) { called_sanitisers.push('_flag_bool');
var req = { query: { size: -100, text: 'test', lat: 0, lon: 0 } }; return { errors: [], warnings: [] };
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, text: 'test', lat: 0, 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']; else {
invalid_values.forEach(function(value) { throw new Error('incorrect parameters passed to _flag_bool');
test('invalid private param ' + value, function(t) { }
var req = { query: { text: 'test', lat: 0, 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 ' + value, function(t) {
var req = { query: { text: 'test', 'private': value } };
sanitize(req, function(){
t.equal(req.clean.private, true, 'private set to true');
t.end();
});
});
});
var valid_false_values = ['false', false, 0, '0'];
valid_false_values.forEach(function(value) {
test('test setting false explicitly ' + value, function(t) {
var req = { query: { text: 'test', '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: { text: 'test' } };
sanitize(req, function(){
t.equal(req.clean.private, false, 'private set to false');
t.end();
});
});
};
module.exports.tests.invalid_params = function(test, common) { },
test('invalid text params', function(t) { '../sanitiser/_geo_search': function() {
var req = { query: {} }; called_sanitisers.push('_geo_search');
sanitize( req, function(){ return { errors: [], warnings: [] };
t.equal(req.errors[0], defaultError, 'handle invalid params gracefully'); },
'../sanitiser/_boundary_country': function() {
called_sanitisers.push('_boundary_country');
return { errors: [], warnings: [] };
},
'../sanitiser/_categories': function() {
called_sanitisers.push('_categories');
return { errors: [], warnings: [] };
},
});
var expected_sanitisers = [
'_deprecate_quattroshapes',
'_single_scalar_parameters',
'_text',
'_size',
'_targets/layers',
'_targets/sources',
'_sources_and_layers',
'_flag_bool',
'_geo_search',
'_boundary_country',
'_categories'
];
var req = {};
var res = {};
search.middleware(req, res, function(){
t.deepEquals(called_sanitisers, expected_sanitisers);
t.end(); t.end();
}); });
}); });
}; };
module.exports.tests.middleware_success = function(test, common) {
test('middleware success', function(t) {
var req = { query: { text: 'test' }};
var next = function( message ){
t.deepEqual(req.errors, [], 'no error messages set');
t.end();
};
middleware( req, undefined, next );
});
};
module.exports.all = function (tape, common) { module.exports.all = function (tape, common) {
function test(name, testFunction) { function test(name, testFunction) {

Write Preview
Loading…
Cancel
Save