| 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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282 | 1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
2
2
2
2
2
2
2
2
2
1
1
1
1
1
6
6
6
1
5
4
5
7
3
3
3
1
3
3
1
2
2
1
2
5
5
6
6
6
6
6
6
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1 | var _ = require('lodash');
var async = require('async');
var ConsoleStream = require('./consolestream');
var feedparser = require('feedparser');
var req = require('bagofrequest');
var request = require('request');
var util = require('./util');
/**
* Create a job with specified configuration.
*
* @param {String} name: Jenkins job name
* @param {String} config: Jenkins job config.xml
* @param {Function} cb: standard cb(err, result) callback
*/
function create(name, config, cb) {
this.opts.queryStrings = { name: name };
this.opts.headers = { 'content-type': 'application/xml' };
this.opts.body = config;
this.opts.handlers[200] = util.passThroughSuccess;
this.opts.handlers[400] = util.htmlError;
req.request('post', this.url + '/createItem/api/json', this.opts, cb);
}
/**
* Retrieve information about a job.
* Information contains job status and reports among other things.
*
* @param {String} name: Jenkins job name
* @param {Function} cb: standard cb(err, result) callback
*/
function read(name, cb) {
this.opts.handlers[200] = util.passThroughSuccessJson;
this.opts.handlers[404] = util.jobNotFoundError(name);
req.request('get', this.url + '/job/' + name + '/api/json', this.opts, cb);
}
/**
* Retrieve information about the latest build of a job.
*
* @param {String} name: Jenkins job name
* @param {Function} cb: standard cb(err, result) callback
*/
function readLatest(name, cb) {
this.opts.handlers[200] = util.passThroughSuccessJson;
this.opts.handlers[404] = util.jobNotFoundError(name);
req.request('get', this.url + '/job/' + name + '/lastBuild/api/json', this.opts, cb);
}
/**
* Update a job with specified configuration
*
* @param {String} name: Jenkins job name
* @param {String} config: Jenkins job config.xml
* @param {Function} cb: standard cb(err, result) callback
*/
function update(name, config, cb) {
this.opts.body = config;
this.opts.handlers[200] = util.passThroughSuccess;
this.opts.handlers[404] = util.jobNotFoundError(name);
req.request('post', this.url + '/job/' + name + '/config.xml', this.opts, cb);
}
/**
* Delete a job.
*
* @param {String} name: Jenkins job name
* @param {Function} cb: standard cb(err, result) callback
*/
function _delete(name, cb) {
this.opts.handlers[200] = util.passThroughSuccess;
this.opts.handlers[404] = util.jobNotFoundError(name);
req.request('post', this.url + '/job/' + name + '/doDelete', this.opts, cb);
}
/**
* Build a job.
*
* @param {String} name: Jenkins job name
* @param {Object} params: build parameters key-value pairs
* @param {Function} cb: standard cb(err, result) callback
*/
function build(name, params, cb) {
var body = { parameter: [] } ;
_.keys(params).forEach(function (key) {
body.parameter.push({ name: key, value: params[key] });
});
this.opts.queryStrings = { token: 'nestor', json: JSON.stringify(body) };
this.opts.handlers[200] = util.passThroughSuccess; // backward compatibility for old Jenkins versions
this.opts.handlers[201] = util.passThroughSuccess;
this.opts.handlers[404] = util.jobNotFoundError(name);
this.opts.handlers[405] = util.jobRequireParamsError(name); // backward compatibility for old Jenkins versions
req.request('post', this.url + '/job/' + name + '/build', this.opts, cb);
}
/**
* Stop a running/building job.
*
* @param {String} name: Jenkins job name
* @param {Function} cb: standard cb(err, result) callback
*/
function stop(name, cb) {
this.opts.handlers[200] = util.passThroughSuccess;
this.opts.handlers[404] = util.jobNotFoundError(name);
req.request('post', this.url + '/job/' + name + '/lastBuild/stop', this.opts, cb);
}
/**
* Stream a Jenkins job console output (readable stream).
* Jenkins uses the following headers:
* - x-more-data to determine whether there are still more content coming through
* - x-text-size to determine the starting point of progressive text output (this was obviously badly named, but stayed there for backward compatibility reason)
*
* @param {String} name: Jenkins job name
* @param {Number} interval: interval between console requests in milliseconds
* @param {Function} cb: standard cb(err, result) callback
* @return {ConsoleStream} readable console output stream
*/
function streamConsole(name, interval, cb) {
var stream = new ConsoleStream();
var url = this.url + '/job/' + name + '/lastBuild/logText/progressiveText';
var self = this;
function _success(result, cb) {
if (result.body) {
stream.emit('data', result.body);
}
// stream while there are more data
async.whilst(
function () {
return result.headers['x-more-data'] === 'true';
},
function (cb) {
var params = {
url: url,
qs: { start: parseInt(result.headers['x-text-size'], 10) }
};
var envProxy = req.proxy(url);
if (envProxy) {
params.proxy = envProxy;
}
request.get(params, function (err, _result) {
if (err) {
cb(err);
} else {
result = _result;
if (_result.body) {
stream.emit('data', _result.body);
}
setTimeout(cb, interval);
}
});
},
function (err) {
stream.emit('end');
cb(err);
}
);
}
this.opts.queryStrings = { start: 0 }; // the first chunk
this.opts.handlers[200] = _success;
this.opts.handlers[404] = util.jobNotFoundError(name);
process.nextTick(function () {
req.request('get', url, self.opts, cb);
});
return stream;
}
/**
* Enable a job.
* If job was disabled, then it will be enabled.
* If job was already enabled, then it will stay as-is, no error.
*
* @param {String} name: Jenkins job name
* @param {Function} cb: standard cb(err, result) callback
*/
function enable(name, cb) {
this.opts.handlers[200] = util.passThroughSuccess;
this.opts.handlers[404] = util.jobNotFoundError(name);
req.request('post', this.url + '/job/' + name + '/enable', this.opts, cb);
}
/**
* Disable a job.
* If job was enabled, then it will be disabled.
* If job was already disabled, then it will stay as-is, no error.
*
* @param {String} jobName: Jenkins job name
* @param {Function} cb: standard cb(err, result) callback
*/
function disable(name, cb) {
this.opts.handlers[200] = util.passThroughSuccess;
this.opts.handlers[404] = util.jobNotFoundError(name);
req.request('post', this.url + '/job/' + name + '/disable', this.opts, cb);
}
/**
* Copy an existing job into a new job.
*
* @param {String} existingName: existing Jenkins job name to copy from
* @param {String} newName: new Jenkins job name to copy to
* @param {Function} cb: standard cb(err, result) callback
*/
function copy(existingName, newName, cb) {
this.opts.queryStrings = { name: newName, mode: 'copy', from: existingName };
this.opts.headers = { 'content-type': 'text/plain' };
this.opts.handlers[200] = util.passThroughSuccess;
this.opts.handlers[400] = util.htmlError;
req.request('post', this.url + '/createItem', this.opts, cb);
}
/**
* Fetch a job configuration.
*
* @param {String} name: Jenkins job name
* @param {Function} cb: standard cb(err, result) callback
*/
function fetchConfig(name, cb) {
this.opts.handlers[200] = util.passThroughSuccess;
this.opts.handlers[404] = util.jobNotFoundError(name);
req.request('get', this.url + '/job/' + name + '/config.xml', this.opts, cb);
}
/**
* Parse job feed.
*
* @param {String} name: Jenkins job name
* @param {Function} cb: standard cb(err, result) callback
*/
function parseFeed(name, cb) {
var url = this.url + '/job/' + name + '/rssAll';
feedparser.parseUrl(url, function (err, meta, articles) {
cb(err, articles);
});
}
exports.create = create;
exports.read = read;
exports.readLatest = readLatest;
exports.update = update;
exports.delete = _delete;
exports.build = build;
exports.stop = stop;
exports.streamConsole = streamConsole;
exports.enable = enable;
exports.disable = disable;
exports.copy = copy;
exports.fetchConfig = fetchConfig;
exports.parseFeed = parseFeed; |