/
apimocker.js
249 lines (229 loc) · 8.11 KB
/
apimocker.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
var express = require('express'),
_ = require("underscore"),
path = require("path"),
fs = require("fs"),
apiMocker = {};
apiMocker.defaults = {
"port": "8888",
"mockDirectory": "./mocks/",
"allowedDomains": ["*"],
"webServices": {}
};
apiMocker.createServer = function(options) {
options = options || {};
apiMocker.express = express();
// apiMocker.express.use(express.bodyParser());
// switched to use express.urlencoded and express.json, instead of bodyParser
// https://github.com/senchalabs/connect/wiki/Connect-3.0
apiMocker.express.use(express.urlencoded());
apiMocker.express.use(express.json());
apiMocker.express.use(apiMocker.corsMiddleware);
apiMocker.options = _.defaults(options, apiMocker.defaults);
apiMocker.log = function(msg) {
if (!apiMocker.options.quiet) {
console.log(msg);
}
};
return apiMocker;
};
apiMocker.setConfigFile = function (file) {
if (!file) {
return apiMocker;
} else if (path.sep !== file.substr(0,1)) {
//relative path from command line
apiMocker.configFilePath = path.resolve(process.cwd(), file);
} else {
apiMocker.configFilePath = file;
}
return apiMocker;
};
apiMocker.loadConfigFile = function() {
if (apiMocker.configFilePath) {
apiMocker.log("Loading config file: " + apiMocker.configFilePath);
// Switched to use fs.readFileSync instead of "require"
// this makes testing easier, and avoids messing with require cache.
var newOptions = _.clone(apiMocker.defaults),
configJson = JSON.parse(fs.readFileSync(apiMocker.configFilePath));
newOptions = _.extend(newOptions, apiMocker.options, configJson);
apiMocker.options = newOptions;
apiMocker.options.webServices = apiMocker.normalizeWebServicesConfig(apiMocker.options.webServices);
apiMocker.setRoutes(apiMocker.options.webServices);
} else {
apiMocker.log("No config file path set.");
}
};
apiMocker.normalizeWebServicesConfig = function(webServices) {
var topLevelKeys = _.keys(webServices), newWebServices = {};
if (webServices[topLevelKeys[0]] && webServices[topLevelKeys[0]].mockFile) {
return webServices;
} else {
apiMocker.log("WARNING: apimocker config file format is deprecated.");
_.each(topLevelKeys, function(verb) {
var newSvc, serviceKeys = _.keys(webServices[verb]);
_.each(serviceKeys, function(key) {
if (newWebServices[key]) {
newSvc = newWebServices[key];
newSvc.verbs[newSvc.verbs.length] = verb;
} else {
newWebServices[key] = {
"mockFile": webServices[verb][key],
"verbs": [verb]
};
}
});
});
return newWebServices;
}
};
apiMocker.createAdminServices = function() {
apiMocker.express.all("/admin/reload", function(req, res) {
// need to wipe out all the old routes, or express will get confused.
var verbs = _.keys(apiMocker.express.routes);
_.each(verbs, function(verb) {
apiMocker.express.routes[verb] = [];
});
apiMocker.createAdminServices();
apiMocker.loadConfigFile();
res.writeHead(200, {"Content-Type": "application/json"});
res.end('{"configFilePath": "' + apiMocker.configFilePath + '", "reloaded": "true"}');
});
apiMocker.express.all("/admin/setMock", function(req, res) {
var newRoute = {};
if (req.body.serviceUrl && req.body.verb && req.body.mockFile) {
apiMocker.log("Received JSON request: " + JSON.stringify(req.body));
newRoute = req.body;
newRoute.verb = newRoute.verb.toLowerCase();
} else {
newRoute.verb = req.param('verb').toLowerCase();
newRoute.serviceUrl = req.param('serviceUrl');
newRoute.mockFile = req.param('mockFile');
newRoute.latency = req.param('latency');
newRoute.contentType = req.param('contentType');
}
apiMocker.removeRoute(newRoute);
apiMocker.setRoute(newRoute);
// also need to save in our webServices object.
delete apiMocker.options.webServices[newRoute.serviceUrl];
apiMocker.options.webServices[newRoute.serviceUrl] = newRoute;
res.writeHead(200, {"Content-Type": "application/json"});
res.end(JSON.stringify(newRoute));
});
};
apiMocker.setRoutes = function(webServices) {
var topLevelKeys = _.keys(webServices);
_.each(topLevelKeys, function(key) {
var svc = _.clone(webServices[key]);
// apiMocker.log("about to add a new service: " + JSON.stringify(svc));
_.each(svc.verbs, function(v) {
svc.verb = v.toLowerCase();
svc.serviceUrl = key;
if (typeof svc.latency === "undefined") {
svc.latency = apiMocker.options.latency ? apiMocker.options.latency : 0;
}
apiMocker.setRoute(svc);
});
});
// apiMocker.log(apiMocker.express.routes);
};
apiMocker.sendResponse = function(req, res, options) {
var originalOptions, mockPath;
if (options.switch) {
options = _.clone(options);
originalOptions = _.clone(options);
apiMocker.setMockFile(options, req);
mockPath = path.join(apiMocker.options.mockDirectory, options.mockFile);
if (!fs.existsSync(mockPath)) {
apiMocker.log("No file found: " + options.mockFile + " attempting base file: " + originalOptions.mockFile);
options = originalOptions;
}
}
mockPath = path.join(apiMocker.options.mockDirectory, options.mockFile);
apiMocker.log("Returning mock: " + options.verb.toUpperCase() + " " + options.serviceUrl + " : " +
options.mockFile);
if (options.contentType) {
// apiMocker.log("Content-Type: " + options.contentType);
res.header('Content-Type', options.contentType);
fs.readFile(mockPath, {encoding: "utf8"}, function(err, data) {
if (err) { throw err; }
var buff = new Buffer(data, 'utf8');
res.send(buff);
});
} else {
res.sendfile(options.mockFile, {root: apiMocker.options.mockDirectory});
}
};
apiMocker.setMockFile = function(options, req) {
var switchValue = "",
mockFileParts, mockFilePrefix = "", mockFileBaseName;
if (req.body[options.switch]) { // json post request
switchValue = req.body[options.switch];
} else if (req.param(options.switch)) { // query param in get request
switchValue = req.param(options.switch);
} else {
return;
}
mockFileParts = options.mockFile.split("/");
mockFileBaseName = mockFileParts.pop();
if (mockFileParts.length > 0) {
mockFilePrefix = mockFileParts.join("/") + "/";
}
options.mockFile = mockFilePrefix + options.switch + switchValue + "." + mockFileBaseName;
};
// Sets the route for express, in case it was not set yet.
apiMocker.setRoute = function(options) {
apiMocker.express[options.verb]("/" + options.serviceUrl, function(req, res) {
if (options.latency && options.latency > 0) {
setTimeout(function() {
apiMocker.sendResponse(req, res, options);
}, options.latency);
} else {
apiMocker.sendResponse(req, res, options);
}
});
apiMocker.log("Set route: " + options.verb.toUpperCase() + " " + options.serviceUrl + " : " +
options.mockFile + " " + options.latency + " ms");
if (options.switch) {
apiMocker.log(" with switch on param: " + options.switch);
}
};
apiMocker.removeRoute = function(options) {
var verbs = [options.verb];
if (options.verb === "all") {
verbs = _.keys(apiMocker.express.routes);
}
_.each(verbs, function(verb) {
var routesForVerb = apiMocker.express.routes[verb];
routesForVerb = _.reject(routesForVerb, function(path) {
return path.path === "/" + options.serviceUrl;
});
apiMocker.express.routes[verb] = routesForVerb;
});
// apiMocker.log(apiMocker.express.routes);
};
// CORS middleware
apiMocker.corsMiddleware = function(req, res, next) {
res.header('Access-Control-Allow-Origin', apiMocker.options.allowedDomains);
res.header('Access-Control-Allow-Methods', 'GET,PUT,POST,DELETE');
res.header('Access-Control-Allow-Headers', 'Content-Type');
next();
};
apiMocker.start = function (port) {
apiMocker.createAdminServices();
apiMocker.loadConfigFile();
port = port || apiMocker.options.port;
apiMocker.expressInstance = apiMocker.express.listen(port);
apiMocker.log("Mock server listening on port " + port);
return apiMocker;
};
apiMocker.stop = function() {
if (apiMocker.expressInstance) {
apiMocker.log("Stopping mock server.");
apiMocker.expressInstance.close();
}
return apiMocker;
};
// expose all the "public" methods.
exports.createServer = apiMocker.createServer;
exports.start = apiMocker.start;
exports.setConfigFile = apiMocker.setConfigFile;
exports.stop = apiMocker.stop;