Hapi builds plugin for the Screwdriver API
const Hapi = require('@hapi/hapi');
const server = new Hapi.Server();
const buildsPlugin = require('./');
server.connection({ port: 3000 });
server.register({
register: buildsPlugin,
options: {}
}, () => {
server.start((err) => {
if (err) {
throw err;
}
console.log('Server running at:', server.info.uri);
});
});
GET /builds/{id}
GET /builds/{id}/steps/{name}/logs?from=0&pages=10&sort=descending
Arguments:
from
- Line number to start loading lines frompages
- Number of pages to load; a page is 100 linessort
- Order in which to fetch logs (ascending
ordescending
), defaultascending
GET /builds/{id}/steps/{name}
GET /builds/{id}/steps
GET /builds/{id}/steps?status=active
GET /builds/{id}/steps?status=failure
GET /builds/{id}/steps?status=success
PUT /builds/{id}/steps/{name}
Example payload:
{
"code": 0,
"startTime": "2038-01-19T03:15:08.131Z",
"endTime": "2038-01-19T03:15:08.532Z",
"lines": 100
}
GET /builds/statuses
GET /builds/statuses?jobIds=1&jobIds=2&numBuilds=3&offset=0
Arguments:
jobIds
- Job IDs for builds to fetchnumBuilds
- Number of builds to load (default 1)offset
- Number of build statuses to skip (default 0)
PUT /builds/{id}
Example payload:
{
"status": "FAILURE"
}
GET /builds/{id}/metrics
GET /builds/{id}/metrics?startTime=2019-02-01T12:00:00.000Z
GET /builds/{id}/metrics?startTime=2019-02-01T12:00:00.000Z&endTime=2019-03-01T12:00:00.000
The server supplies factories to plugins in the form of server app values:
// handler in buildsPlugin.js
handler: async (request, h) => {
const factory = request.server.app.buildFactory;
// ...
}