cartodb4/Windshaft-cartodb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Allow extra headers in the requests of test client

Browse Source
This commit is contained in:
Esther Lozano 2020-02-24 12:30:46 +01:00
parent e85469cc3c
commit 970be73052
1 changed files with 83 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

195
test/support/test-client.js
View File

@ -23,10 +23,11 @@ const MAPNIK_SUPPORTED_FORMATS = {
mvt: true mvt: true
}; };
function TestClient (config, apiKey) { function TestClient (config, apiKey, extraHeaders) {
this.mapConfig = isMapConfig(config) ? config : null; this.mapConfig = isMapConfig(config) ? config : null;
this.template = isTemplate(config) ? config : null; this.template = isTemplate(config) ? config : null;
this.apiKey = apiKey; this.apiKey = apiKey;
this.extraHeaders = extraHeaders || {};
this.keysToDelete = {}; this.keysToDelete = {};
this.server = new CartodbWindshaft(serverOptions); this.server = new CartodbWindshaft(serverOptions);
} }
@ -146,6 +147,8 @@ TestClient.prototype.getWidget = function (widgetName, params, callback) {
url += '?' + qs.stringify({ filters: JSON.stringify(params.filters) }); url += '?' + qs.stringify({ filters: JSON.stringify(params.filters) });
} }
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, self.extraHeaders);
step( step(
function createLayergroup () { function createLayergroup () {
var next = this; var next = this;
@ -153,10 +156,7 @@ TestClient.prototype.getWidget = function (widgetName, params, callback) {
{ {
url: url, url: url,
method: 'POST', method: 'POST',
headers: { headers,
host: 'localhost',
'Content-Type': 'application/json'
},
data: JSON.stringify(self.mapConfig) data: JSON.stringify(self.mapConfig)
}, },
{ {
@ -208,14 +208,13 @@ TestClient.prototype.getWidget = function (widgetName, params, callback) {
}); });
url = '/api/v1/map/' + layergroupId + '/0/widget/' + widgetName + '?' + qs.stringify(urlParams); url = '/api/v1/map/' + layergroupId + '/0/widget/' + widgetName + '?' + qs.stringify(urlParams);
const headers = Object.assign({ host: 'localhost' }, self.extraHeaders);
assert.response(self.server, assert.response(self.server,
{ {
url: url, url: url,
method: 'GET', method: 'GET',
headers: { headers
host: 'localhost'
}
}, },
{ {
status: 200, status: 200,
@ -258,14 +257,13 @@ TestClient.prototype.widgetSearch = function (widgetName, userQuery, params, cal
step( step(
function createLayergroup () { function createLayergroup () {
var next = this; var next = this;
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, self.extraHeaders);
assert.response(self.server, assert.response(self.server,
{ {
url: url, url: url,
method: 'POST', method: 'POST',
headers: { headers,
host: 'localhost',
'Content-Type': 'application/json'
},
data: JSON.stringify(self.mapConfig) data: JSON.stringify(self.mapConfig)
}, },
{ {
@ -315,14 +313,13 @@ TestClient.prototype.widgetSearch = function (widgetName, userQuery, params, cal
urlParams.bbox = params.bbox; urlParams.bbox = params.bbox;
} }
url = '/api/v1/map/' + layergroupId + '/0/widget/' + widgetName + '/search?' + qs.stringify(urlParams); url = '/api/v1/map/' + layergroupId + '/0/widget/' + widgetName + '/search?' + qs.stringify(urlParams);
const headers = Object.assign({ host: 'localhost' }, self.extraHeaders);
assert.response(self.server, assert.response(self.server,
{ {
url: url, url: url,
method: 'GET', method: 'GET',
headers: { headers
host: 'localhost'
}
}, },
{ {
status: 200, status: 200,
@ -367,11 +364,12 @@ TestClient.prototype.getDataview = function (dataviewName, params, callback) {
var url = '/api/v1/map'; var url = '/api/v1/map';
var urlNamed = url + '/named'; var urlNamed = url + '/named';
if (Object.keys(extraParams).length > 0) { if (Object.keys(extraParams).length > 0) {
url += '?' + qs.stringify(extraParams); url += '?' + qs.stringify(extraParams);
} }
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, self.extraHeaders);
var expectedResponse = params.response || { var expectedResponse = params.response || {
status: 200, status: 200,
headers: { headers: {
@ -397,10 +395,7 @@ TestClient.prototype.getDataview = function (dataviewName, params, callback) {
{ {
url: urlNamed + '?' + qs.stringify({ api_key: self.apiKey }), url: urlNamed + '?' + qs.stringify({ api_key: self.apiKey }),
method: 'POST', method: 'POST',
headers: { headers,
host: 'localhost',
'Content-Type': 'application/json'
},
data: JSON.stringify(self.template) data: JSON.stringify(self.template)
}, },
{ {
@ -437,15 +432,13 @@ TestClient.prototype.getDataview = function (dataviewName, params, callback) {
var path = templateId var path = templateId
? urlNamed + '/' + templateId + '?' + qs.stringify(queryParams) ? urlNamed + '/' + templateId + '?' + qs.stringify(queryParams)
: url; : url;
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, self.extraHeaders);
assert.response(self.server, assert.response(self.server,
{ {
url: path, url: path,
method: 'POST', method: 'POST',
headers: { headers,
host: 'localhost',
'Content-Type': 'application/json'
},
data: JSON.stringify(data) data: JSON.stringify(data)
}, },
{ {
@ -495,14 +488,13 @@ TestClient.prototype.getDataview = function (dataviewName, params, callback) {
urlParams.api_key = self.apiKey; urlParams.api_key = self.apiKey;
} }
url = '/api/v1/map/' + layergroupId + '/dataview/' + dataviewName + '?' + qs.stringify(urlParams); url = '/api/v1/map/' + layergroupId + '/dataview/' + dataviewName + '?' + qs.stringify(urlParams);
const headers = Object.assign({ host: 'localhost' }, self.extraHeaders);
assert.response(self.server, assert.response(self.server,
{ {
url: url, url: url,
method: 'GET', method: 'GET',
headers: { headers
host: 'localhost'
}
}, },
expectedResponse, expectedResponse,
function (res, err) { function (res, err) {
@ -543,6 +535,8 @@ TestClient.prototype.getFeatureAttributes = function (featureId, layerId, params
url += '?' + qs.stringify(extraParams); url += '?' + qs.stringify(extraParams);
} }
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, self.extraHeaders);
var expectedResponse = params.response || { var expectedResponse = params.response || {
status: 200, status: 200,
headers: { headers: {
@ -557,10 +551,7 @@ TestClient.prototype.getFeatureAttributes = function (featureId, layerId, params
{ {
url: url, url: url,
method: 'POST', method: 'POST',
headers: { headers,
host: 'localhost',
'Content-Type': 'application/json'
},
data: JSON.stringify(self.mapConfig) data: JSON.stringify(self.mapConfig)
}, },
{ {
@ -591,14 +582,13 @@ TestClient.prototype.getFeatureAttributes = function (featureId, layerId, params
var next = this; var next = this;
url = '/api/v1/map/' + layergroupId + '/' + layerId + '/attributes/' + featureId; url = '/api/v1/map/' + layergroupId + '/' + layerId + '/attributes/' + featureId;
const headers = Object.assign({ host: 'localhost' }, self.extraHeaders);
assert.response(self.server, assert.response(self.server,
{ {
url: url, url: url,
method: 'GET', method: 'GET',
headers: { headers
host: 'localhost'
}
}, },
expectedResponse, expectedResponse,
function (res, err) { function (res, err) {
@ -643,6 +633,8 @@ TestClient.prototype.getClusterFeatures = function (zoom, clusterId, layerId, pa
url += '?' + qs.stringify(extraParams); url += '?' + qs.stringify(extraParams);
} }
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, self.extraHeaders);
var expectedResponse = params.response || { var expectedResponse = params.response || {
status: 200, status: 200,
headers: { headers: {
@ -657,10 +649,7 @@ TestClient.prototype.getClusterFeatures = function (zoom, clusterId, layerId, pa
{ {
url: url, url: url,
method: 'POST', method: 'POST',
headers: { headers,
host: 'localhost',
'Content-Type': 'application/json'
},
data: JSON.stringify(self.mapConfig) data: JSON.stringify(self.mapConfig)
}, },
{ {
@ -696,14 +685,13 @@ TestClient.prototype.getClusterFeatures = function (zoom, clusterId, layerId, pa
} }
url = `/api/v1/map/${layergroupId}/${layerId}/${zoom}/cluster/${clusterId}?${queryParams}`; url = `/api/v1/map/${layergroupId}/${layerId}/${zoom}/cluster/${clusterId}?${queryParams}`;
const headers = Object.assign({ host: 'localhost' }, self.extraHeaders);
assert.response(self.server, assert.response(self.server,
{ {
url: url, url: url,
method: 'GET', method: 'GET',
headers: { headers
host: 'localhost'
}
}, },
expectedResponse, expectedResponse,
function (res, err) { function (res, err) {
@ -735,6 +723,7 @@ TestClient.prototype.getTile = function (z, x, y, params, callback) {
var url = '/api/v1/map'; var url = '/api/v1/map';
var urlNamed = url + '/named'; var urlNamed = url + '/named';
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, self.extraHeaders);
if (this.apiKey) { if (this.apiKey) {
url += '?' + qs.stringify({ api_key: this.apiKey }); url += '?' + qs.stringify({ api_key: this.apiKey });
@ -764,10 +753,7 @@ TestClient.prototype.getTile = function (z, x, y, params, callback) {
{ {
url: urlNamed + '?' + qs.stringify({ api_key: self.apiKey }), url: urlNamed + '?' + qs.stringify({ api_key: self.apiKey }),
method: 'POST', method: 'POST',
headers: { headers,
host: 'localhost',
'Content-Type': 'application/json'
},
data: JSON.stringify(self.template) data: JSON.stringify(self.template)
}, },
{ {
@ -811,14 +797,13 @@ TestClient.prototype.getTile = function (z, x, y, params, callback) {
? urlNamed + '/' + templateId + '?' + qs.stringify(queryParams) ? urlNamed + '/' + templateId + '?' + qs.stringify(queryParams)
: url; : url;
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, self.extraHeaders);
assert.response(self.server, assert.response(self.server,
{ {
url: path, url: path,
method: 'POST', method: 'POST',
headers: { headers,
host: 'localhost',
'Content-Type': 'application/json'
},
data: JSON.stringify(data) data: JSON.stringify(data)
}, },
{ {
@ -843,14 +828,12 @@ TestClient.prototype.getTile = function (z, x, y, params, callback) {
self.keysToDelete['user:localhost:mapviews:global'] = 5; self.keysToDelete['user:localhost:mapviews:global'] = 5;
url = `/api/v1/map/${layergroupidTemplate(layergroupId, params)}/`; url = `/api/v1/map/${layergroupidTemplate(layergroupId, params)}/`;
var layers = params.layers; var layers = params.layers;
if (layers !== undefined) { if (layers !== undefined) {
layers = Array.isArray(layers) ? layers : [layers]; layers = Array.isArray(layers) ? layers : [layers];
url += layers.join(',') + '/'; url += layers.join(',') + '/';
} }
var format = params.format || 'png'; var format = params.format || 'png';
if (layers === undefined && !MAPNIK_SUPPORTED_FORMATS[format]) { if (layers === undefined && !MAPNIK_SUPPORTED_FORMATS[format]) {
@ -860,6 +843,8 @@ TestClient.prototype.getTile = function (z, x, y, params, callback) {
url += [z, x, y].join('/'); url += [z, x, y].join('/');
url += '.' + format; url += '.' + format;
const headers = Object.assign({ host: 'localhost' }, self.extraHeaders);
const queryParams = {}; const queryParams = {};
if (self.apiKey) { if (self.apiKey) {
@ -873,9 +858,7 @@ TestClient.prototype.getTile = function (z, x, y, params, callback) {
var request = { var request = {
url: url, url: url,
method: 'GET', method: 'GET',
headers: { headers
host: 'localhost'
}
}; };
var expectedResponse = Object.assign({}, { var expectedResponse = Object.assign({}, {
@ -970,6 +953,7 @@ TestClient.prototype.getLayergroup = function (params, callback) {
} }
var url = '/api/v1/map'; var url = '/api/v1/map';
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, self.extraHeaders);
const queryParams = {}; const queryParams = {};
@ -989,10 +973,7 @@ TestClient.prototype.getLayergroup = function (params, callback) {
{ {
url: url, url: url,
method: 'POST', method: 'POST',
headers: { headers,
host: 'localhost',
'Content-Type': 'application/json'
},
data: JSON.stringify(self.mapConfig) data: JSON.stringify(self.mapConfig)
}, },
params.response, params.response,
@ -1022,11 +1003,12 @@ TestClient.prototype.getStaticCenter = function (params, callback) {
const { layergroupid, zoom, lat, lng, width, height, format } = params; const { layergroupid, zoom, lat, lng, width, height, format } = params;
var url = '/api/v1/map/'; var url = '/api/v1/map/';
if (this.apiKey) { if (this.apiKey) {
url += '?' + qs.stringify({ api_key: this.apiKey }); url += '?' + qs.stringify({ api_key: this.apiKey });
} }
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, self.extraHeaders);
step( step(
function createLayergroup () { function createLayergroup () {
var next = this; var next = this;
@ -1042,10 +1024,7 @@ TestClient.prototype.getStaticCenter = function (params, callback) {
{ {
url: path, url: path,
method: 'POST', method: 'POST',
headers: { headers,
host: 'localhost',
'Content-Type': 'application/json'
},
data: JSON.stringify(data) data: JSON.stringify(data)
}, },
{ {
@ -1076,13 +1055,13 @@ TestClient.prototype.getStaticCenter = function (params, callback) {
url += '?' + qs.stringify({ api_key: self.apiKey }); url += '?' + qs.stringify({ api_key: self.apiKey });
} }
const headers = Object.assign({ host: 'localhost' }, self.extraHeaders);
var request = { var request = {
url: url, url: url,
encoding: 'binary', encoding: 'binary',
method: 'GET', method: 'GET',
headers: { headers
host: 'localhost'
}
}; };
var expectedResponse = Object.assign({}, { var expectedResponse = Object.assign({}, {
@ -1126,6 +1105,8 @@ TestClient.prototype.getNodeStatus = function (nodeName, callback) {
url += '?' + qs.stringify({ api_key: this.apiKey }); url += '?' + qs.stringify({ api_key: this.apiKey });
} }
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, this.extraHeaders);
var nodes = {}; var nodes = {};
step( step(
function createLayergroup () { function createLayergroup () {
@ -1134,10 +1115,7 @@ TestClient.prototype.getNodeStatus = function (nodeName, callback) {
{ {
url: url, url: url,
method: 'POST', method: 'POST',
headers: { headers,
host: 'localhost',
'Content-Type': 'application/json'
},
data: JSON.stringify(self.mapConfig) data: JSON.stringify(self.mapConfig)
}, },
{ {
@ -1176,12 +1154,12 @@ TestClient.prototype.getNodeStatus = function (nodeName, callback) {
url += '?' + qs.stringify({ api_key: self.apiKey }); url += '?' + qs.stringify({ api_key: self.apiKey });
} }
const headers = Object.assign({ host: 'localhost' }, self.extraHeaders);
var request = { var request = {
url: url, url: url,
method: 'GET', method: 'GET',
headers: { headers
host: 'localhost'
}
}; };
var expectedResponse = { var expectedResponse = {
@ -1219,6 +1197,8 @@ TestClient.prototype.getAttributes = function (params, callback) {
url += '?' + qs.stringify({ api_key: this.apiKey }); url += '?' + qs.stringify({ api_key: this.apiKey });
} }
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, this.extraHeaders);
var layergroupid; var layergroupid;
if (params.layergroupid) { if (params.layergroupid) {
@ -1237,10 +1217,7 @@ TestClient.prototype.getAttributes = function (params, callback) {
{ {
url: url, url: url,
method: 'POST', method: 'POST',
headers: { headers,
host: 'localhost',
'Content-Type': 'application/json'
},
data: JSON.stringify(self.mapConfig) data: JSON.stringify(self.mapConfig)
}, },
{ {
@ -1271,12 +1248,12 @@ TestClient.prototype.getAttributes = function (params, callback) {
url += '?' + qs.stringify({ api_key: self.apiKey }); url += '?' + qs.stringify({ api_key: self.apiKey });
} }
const headers = Object.assign({ host: 'localhost' }, self.extraHeaders);
var request = { var request = {
url: url, url: url,
method: 'GET', method: 'GET',
headers: { headers
host: 'localhost'
}
}; };
var expectedResponse = params.response || { var expectedResponse = params.response || {
@ -1318,12 +1295,12 @@ module.exports.getStaticMap = function getStaticMap (templateName, params, callb
url += '?' + qs.stringify(params); url += '?' + qs.stringify(params);
} }
const headers = Object.assign({ host: 'localhost' }, self.extraHeaders);
var requestOptions = { var requestOptions = {
url: url, url: url,
method: 'GET', method: 'GET',
headers: { headers,
host: 'localhost'
},
encoding: 'binary' encoding: 'binary'
}; };
@ -1417,14 +1394,13 @@ TestClient.prototype.getAnalysesCatalog = function (params, callback) {
url += '&' + qs.stringify({ callback: params.jsonp }); url += '&' + qs.stringify({ callback: params.jsonp });
} }
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, this.extraHeaders);
assert.response(this.server, assert.response(this.server,
{ {
url: url, url: url,
method: 'GET', method: 'GET',
headers: { headers
host: 'localhost',
'Content-Type': 'application/json'
}
}, },
{ {
status: params.status || 200, status: params.status || 200,
@ -1447,13 +1423,12 @@ TestClient.prototype.getAnalysesCatalog = function (params, callback) {
}; };
TestClient.prototype.getNamedMapList = function (params, callback) { TestClient.prototype.getNamedMapList = function (params, callback) {
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, this.extraHeaders);
const request = { const request = {
url: `/api/v1/map/named?${qs.stringify({ api_key: this.apiKey })}`, url: `/api/v1/map/named?${qs.stringify({ api_key: this.apiKey })}`,
method: 'GET', method: 'GET',
headers: { headers
host: 'localhost',
'Content-Type': 'application/json'
}
}; };
let expectedResponse = { let expectedResponse = {
@ -1483,13 +1458,12 @@ TestClient.prototype.getNamedTile = function (name, z, x, y, format, options, ca
return callback(new Error('apiKey param is mandatory to create a new template')); return callback(new Error('apiKey param is mandatory to create a new template'));
} }
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, this.extraHeaders);
const createTemplateRequest = { const createTemplateRequest = {
url: `/api/v1/map/named?${qs.stringify({ api_key: this.apiKey })}`, url: `/api/v1/map/named?${qs.stringify({ api_key: this.apiKey })}`,
method: 'POST', method: 'POST',
headers: { headers,
host: 'localhost',
'Content-Type': 'application/json'
},
data: JSON.stringify(this.template) data: JSON.stringify(this.template)
}; };
@ -1508,12 +1482,11 @@ TestClient.prototype.getNamedTile = function (name, z, x, y, format, options, ca
const templateId = JSON.parse(res.body).template_id; const templateId = JSON.parse(res.body).template_id;
const queryParams = params ? `?${qs.stringify(params)}` : ''; const queryParams = params ? `?${qs.stringify(params)}` : '';
const url = `/api/v1/map/named/${templateId}/all/${[z, x, y].join('/')}.${format}${queryParams}`; const url = `/api/v1/map/named/${templateId}/all/${[z, x, y].join('/')}.${format}${queryParams}`;
const headers = Object.assign({ host: 'localhost' }, this.extraHeaders);
const namedTileRequest = { const namedTileRequest = {
url, url,
method: 'GET', method: 'GET',
headers: { headers,
host: 'localhost'
},
encoding: 'binary' encoding: 'binary'
}; };
@ -1565,13 +1538,12 @@ TestClient.prototype.createTemplate = function (params, callback) {
return callback(new Error('apiKey param is mandatory to create a new template')); return callback(new Error('apiKey param is mandatory to create a new template'));
} }
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json' }, this.extraHeaders);
const createTemplateRequest = { const createTemplateRequest = {
url: `/api/v1/map/named?${qs.stringify({ api_key: this.apiKey })}`, url: `/api/v1/map/named?${qs.stringify({ api_key: this.apiKey })}`,
method: 'POST', method: 'POST',
headers: { headers,
host: 'localhost',
'Content-Type': 'application/json'
},
data: JSON.stringify(this.template) data: JSON.stringify(this.template)
}; };
@ -1606,12 +1578,12 @@ TestClient.prototype.deleteTemplate = function (params, callback) {
return callback(new Error('apiKey param is mandatory to create a new template')); return callback(new Error('apiKey param is mandatory to create a new template'));
} }
const headers = Object.assign({ host: 'localhost' }, this.extraHeaders);
const deleteTemplateRequest = { const deleteTemplateRequest = {
url: `/api/v1/map/named/${params.templateId}?${qs.stringify({ api_key: this.apiKey })}`, url: `/api/v1/map/named/${params.templateId}?${qs.stringify({ api_key: this.apiKey })}`,
method: 'DELETE', method: 'DELETE',
headers: { headers
host: 'localhost'
}
}; };
let deleteTemplateResponse = { let deleteTemplateResponse = {
@ -1643,13 +1615,12 @@ TestClient.prototype.updateTemplate = function (params, callback) {
return callback(new Error('apiKey param is mandatory to create a new template')); return callback(new Error('apiKey param is mandatory to create a new template'));
} }
const headers = Object.assign({ host: 'localhost', 'Content-Type': 'application/json; charset=utf-8' }, this.extraHeaders);
const updateTemplateRequest = { const updateTemplateRequest = {
url: `/api/v1/map/named/${params.templateId}?${qs.stringify({ api_key: this.apiKey })}`, url: `/api/v1/map/named/${params.templateId}?${qs.stringify({ api_key: this.apiKey })}`,
method: 'PUT', method: 'PUT',
headers: { headers,
host: 'localhost',
'Content-Type': 'application/json; charset=utf-8'
},
data: JSON.stringify(params.templateData) data: JSON.stringify(params.templateData)
}; };
@ -1684,12 +1655,12 @@ TestClient.prototype.getTemplate = function (params, callback) {
return callback(new Error('apiKey param is mandatory to create a new template')); return callback(new Error('apiKey param is mandatory to create a new template'));
} }
const headers = Object.assign({ host: 'localhost' }, this.extraHeaders);
const getTemplateRequest = { const getTemplateRequest = {
url: `/api/v1/map/named/${params.templateId}?${qs.stringify({ api_key: this.apiKey })}`, url: `/api/v1/map/named/${params.templateId}?${qs.stringify({ api_key: this.apiKey })}`,
method: 'GET', method: 'GET',
headers: { headers
host: 'localhost'
}
}; };
let getTemplateResponse = { let getTemplateResponse = {