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

added tests for placeholder service

pull/850/head
Stephen Hess 8 years ago
parent
5e746d7ad4
commit
50e3121f9a
2 changed files with 226 additions and 98 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 7
      schema.js
  2. 283
      test/unit/schema.js

7
schema.js
Unescape View File

@ -27,7 +27,12 @@ module.exports = Joi.object().keys({
flipNumberAndStreetCountries: Joi.array().items(Joi.string().regex(/^[A-Z]{3}$/))
}).unknown(false),
pipService: Joi.string().uri({ scheme: /https?/ }),
placeholderService: Joi.string().uri({ scheme: /https?/ })
placeholderService: Joi.any().forbidden(), // got moved to services
services: Joi.object().keys({
placeholder: Joi.object().keys({
url: Joi.string().uri({ scheme: /https?/ })
}).unknown(false).requiredKeys('url')
}).unknown(false).default({}) // default api.services to an empty object
}).requiredKeys('version', 'indexName', 'host').unknown(true),
esclient: Joi.object().keys({

283
test/unit/schema.js
Unescape View File

@ -3,14 +3,6 @@
const Joi = require('joi');
const schema = require('../../schema');
function validate(config) {
Joi.validate(config, schema, (err, value) => {
if (err) {
throw new Error(err.details[0].message);
}
});
}
module.exports.tests = {};
module.exports.tests.completely_valid = (test, common) => {
@ -26,19 +18,26 @@ module.exports.tests.completely_valid = (test, common) => {
localization: {
flipNumberAndStreetCountries: ['ABC', 'DEF']
},
requestRetries: 19
requestRetries: 19,
services: {
placeholder: {
url: 'http://locahost'
}
}
},
esclient: {
requestTimeout: 17
}
};
t.doesNotThrow(validate.bind(config));
const result = Joi.validate(config, schema);
t.notOk(result.error);
t.end();
});
test('basic valid configuration should not throw error', (t) => {
test('basic valid configuration should not throw error and have defaults set', (t) => {
var config = {
api: {
version: 'version value',
@ -50,7 +49,10 @@ module.exports.tests.completely_valid = (test, common) => {
}
};
t.doesNotThrow(validate.bind(config));
const result = Joi.validate(config, schema);
t.notOk(result.error);
t.deepEquals(result.value.api.services, {}, 'missing api.services should default to empty object');
t.end();
});
@ -63,7 +65,10 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(validate.bind(null, config), /"api" is required/, 'api should exist');
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"api" is required');
t.end();
});
@ -79,7 +84,9 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.doesNotThrow(validate.bind(null, config), 'unknown properties should be allowed');
const result = Joi.validate(config, schema);
t.notOk(result.error);
t.end();
});
@ -95,7 +102,10 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(validate.bind(null, config), /"version" must be a string/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"version" must be a string');
});
@ -114,7 +124,10 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(validate.bind(null, config), /"indexName" must be a string/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"indexName" must be a string');
});
@ -133,7 +146,10 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(validate.bind(null, config), /"host" must be a string/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"host" must be a string');
});
@ -153,7 +169,10 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(validate.bind(null, config), /"legacyUrl" must be a string/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"legacyUrl" must be a string');
});
@ -173,7 +192,10 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(validate.bind(null, config), /"accessLog" must be a string/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"accessLog" must be a string');
});
@ -193,7 +215,10 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(validate.bind(null, config), /"relativeScores" must be a boolean/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"relativeScores" must be a boolean');
});
@ -213,7 +238,10 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(validate.bind(null, config), /"localization" must be an object/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"localization" must be an object');
});
@ -234,7 +262,10 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(validate.bind(null, config), /"unknown_property" is not allowed/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"unknown_property" is not allowed');
t.end();
@ -254,9 +285,10 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(
validate.bind(null, config),
/"flipNumberAndStreetCountries" must be an array/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"flipNumberAndStreetCountries" must be an array');
});
@ -278,7 +310,10 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(validate.bind(null, config), /"0" must be a string/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"0" must be a string');
});
@ -300,7 +335,11 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(validate.bind(null, config), /fails to match the required pattern/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, `"0" with value "${value}" fails to match the required pattern: /^[A-Z]{3}$/`);
});
t.end();
@ -319,9 +358,10 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(
validate.bind(null, config),
/"requestRetries" must be a number/, 'api.requestRetries should be a number');
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"requestRetries" must be a number');
});
@ -340,10 +380,10 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(
validate.bind(null, config),
/"requestRetries" must be an integer/, 'api.requestRetries should be an integer');
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"requestRetries" must be an integer');
t.end();
});
@ -359,10 +399,10 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(
validate.bind(null, config),
/"requestRetries" must be larger than or equal to 0/, 'api.requestRetries must be positive');
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"requestRetries" must be larger than or equal to 0');
t.end();
});
@ -379,7 +419,10 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(validate.bind(null, config), /"pipService" must be a string/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"pipService" must be a string');
});
@ -387,19 +430,22 @@ module.exports.tests.api_validation = (test, common) => {
});
test('non-URI-formatted api.pipService should throw error', (t) => {
['this is not a URI'].forEach((value) => {
test('non-http/https api.pipService should throw error', (t) => {
['ftp', 'git', 'unknown'].forEach((scheme) => {
var config = {
api: {
version: 'version value',
indexName: 'index name value',
host: 'host value',
pipService: value
pipService: `${scheme}://localhost`
},
esclient: {}
};
t.throws(validate.bind(null, config), /"pipService" must be a valid uri/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"pipService" must be a valid uri with a scheme matching the https? pattern');
});
@ -407,8 +453,8 @@ module.exports.tests.api_validation = (test, common) => {
});
test('non-http/https api.pipService should throw error', (t) => {
['ftp', 'git', 'unknown'].forEach((scheme) => {
test('http/https api.pipService should not throw error', (t) => {
['http', 'https'].forEach((scheme) => {
var config = {
api: {
version: 'version value',
@ -419,7 +465,9 @@ module.exports.tests.api_validation = (test, common) => {
esclient: {}
};
t.throws(validate.bind(null, config), /"pipService" must be a valid uri/);
const result = Joi.validate(config, schema);
t.notOk(result.error);
});
@ -427,19 +475,23 @@ module.exports.tests.api_validation = (test, common) => {
});
test('http/https api.pipService should not throw error', (t) => {
['http', 'https'].forEach((scheme) => {
// api.placeholderService has been moved to api.services.placeholder.url
test('any api.placeholderService value should be disallowed', (t) => {
[null, 17, {}, [], true, 'http://localhost'].forEach((value) => {
var config = {
api: {
version: 'version value',
indexName: 'index name value',
host: 'host value',
pipService: `${scheme}://localhost`
placeholderService: value
},
esclient: {}
};
t.doesNotThrow(validate.bind(null, config), `${scheme} should be allowed`);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"placeholderService" is not allowed');
});
@ -447,39 +499,96 @@ module.exports.tests.api_validation = (test, common) => {
});
test('non-string api.placeholderService should throw error', (t) => {
[null, 17, {}, [], true].forEach((value) => {
};
module.exports.tests.api_services_validation = (test, common) => {
test('unsupported children of api.services should be disallowed', (t) => {
var config = {
api: {
version: 'version value',
indexName: 'index name value',
host: 'host value',
placeholderService: value
services: {
unknown_property: 'value'
}
},
esclient: {}
};
t.throws(validate.bind(null, config), /"placeholderService" must be a string/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"unknown_property" is not allowed');
t.end();
});
test('non-url children of api.services.placeholder should be disallowed', (t) => {
var config = {
api: {
version: 'version value',
indexName: 'index name value',
host: 'host value',
services: {
placeholder: {
url: 'http://localhost',
unknown_property: 'value'
}
}
},
esclient: {}
};
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"unknown_property" is not allowed');
t.end();
});
test('non-URI-formatted api.placeholderService should throw error', (t) => {
['this is not a URI'].forEach((value) => {
test('when api.services.placeholder is defined, url is required', (t) => {
var config = {
api: {
version: 'version value',
indexName: 'index name value',
host: 'host value',
placeholderService: value
services: {
placeholder: {
}
}
},
esclient: {}
};
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"url" is required');
t.end();
});
test('non-string api.services.placeholder.url should throw error', (t) => {
[null, 17, {}, [], true].forEach((value) => {
var config = {
api: {
version: 'version value',
indexName: 'index name value',
host: 'host value',
services: {
placeholder: {
url: value
}
}
},
esclient: {}
};
t.throws(validate.bind(null, config), /"placeholderService" must be a valid uri/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"url" must be a string');
});
@ -487,19 +596,26 @@ module.exports.tests.api_validation = (test, common) => {
});
test('non-http/https api.placeholderService should throw error', (t) => {
test('non-http/https api.services.placeholder.url should throw error', (t) => {
['ftp', 'git', 'unknown'].forEach((scheme) => {
var config = {
api: {
version: 'version value',
indexName: 'index name value',
host: 'host value',
placeholderService: `${scheme}://localhost`
services: {
placeholder: {
url: `${scheme}://localhost`
}
}
},
esclient: {}
};
t.throws(validate.bind(null, config), /"placeholderService" must be a valid uri/);
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"url" must be a valid uri with a scheme matching the https\? pattern');
});
@ -507,22 +623,26 @@ module.exports.tests.api_validation = (test, common) => {
});
test('http/https api.placeholderService should not throw error', (t) => {
['http', 'https'].forEach((scheme) => {
test('non-url children of api.services.placeholder should be disallowed', (t) => {
var config = {
api: {
version: 'version value',
indexName: 'index name value',
host: 'host value',
placeholderService: `${scheme}://localhost`
services: {
placeholder: {
url: 'http://localhost',
unknown_property: 'value'
}
}
},
esclient: {}
};
t.doesNotThrow(validate.bind(null, config), `${scheme} should be allowed`);
});
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"unknown_property" is not allowed');
t.end();
});
@ -539,9 +659,10 @@ module.exports.tests.esclient_validation = (test, common) => {
}
};
t.throws(
validate.bind(null, config),
/"esclient" is required/, 'esclient should exist');
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"esclient" is required');
t.end();
});
@ -557,9 +678,10 @@ module.exports.tests.esclient_validation = (test, common) => {
esclient: value
};
t.throws(
validate.bind(null, config),
/"esclient" must be an object/, 'esclient should be an object');
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"esclient" must be an object');
});
@ -580,9 +702,10 @@ module.exports.tests.esclient_validation = (test, common) => {
}
};
t.throws(
validate.bind(null, config),
/"requestTimeout" must be a number/, 'esclient.requestTimeout should be a number');
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"requestTimeout" must be a number');
});
@ -602,10 +725,10 @@ module.exports.tests.esclient_validation = (test, common) => {
}
};
t.throws(
validate.bind(null, config),
/"requestTimeout" must be an integer/, 'esclient.requestTimeout should be an integer');
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"requestTimeout" must be an integer');
t.end();
});
@ -622,10 +745,10 @@ module.exports.tests.esclient_validation = (test, common) => {
}
};
t.throws(
validate.bind(null, config),
/"requestTimeout" must be larger than or equal to 0/, 'esclient.requestTimeout must be positive');
const result = Joi.validate(config, schema);
t.equals(result.error.details.length, 1);
t.equals(result.error.details[0].message, '"requestTimeout" must be larger than or equal to 0');
t.end();
});

Write Preview
Loading…
Cancel
Save