ce0ddf93fc
This is a reworking of #3410 based on some feedback @calebcartwright left on that PR. The goals of injecting the secrets are threefold: 1. Simplify testing 2. Be consistent with all of the other config (which is injected) 3. Encapsulate the sensitive auth-related code in one place so it can be studied and tested thoroughly - Rather than add more code to BaseService to handle authorization logic, it delegates that to an AuthHelper class. - When the server starts, it fetches the credentials from `config` and injects them into `BaseService.register()` which passes them to `invoke()`. - In `invoke()` the service's auth configuration is checked (`static get auth()`, much like `static get route()`). - If the auth config is present, an AuthHelper instance is created and attached to the new instance. - Then within the service, the password, basic auth config, or bearer authentication can be accessed via e.g. `this.authHelper.basicAuth` and passed to `this._requestJson()` and friends. - Everything is being done very explicitly, so it should be very clear where and how the configured secrets are being used. - Testing different configurations of services can now be done by injecting the config into `invoke()` in `.spec` files instead of mocking global state in the service tests as was done before. See the new Jira spec files for a good example of this. Ref #3393
69 lines
1.5 KiB
JavaScript
69 lines
1.5 KiB
JavaScript
'use strict'
|
|
|
|
const Joi = require('@hapi/joi')
|
|
const { BaseJsonService, NotFound } = require('..')
|
|
|
|
const latestBuildSchema = Joi.object({
|
|
count: Joi.number().required(),
|
|
value: Joi.array()
|
|
.items(
|
|
Joi.object({
|
|
id: Joi.number().required(),
|
|
})
|
|
)
|
|
.required(),
|
|
}).required()
|
|
|
|
module.exports = class AzureDevOpsBase extends BaseJsonService {
|
|
static get auth() {
|
|
return { passKey: 'azure_devops_token' }
|
|
}
|
|
|
|
async fetch({ url, options, schema, errorMessages }) {
|
|
return this._requestJson({
|
|
schema,
|
|
url,
|
|
options,
|
|
errorMessages,
|
|
})
|
|
}
|
|
|
|
async getLatestCompletedBuildId(
|
|
organization,
|
|
project,
|
|
definitionId,
|
|
branch,
|
|
auth,
|
|
errorMessages
|
|
) {
|
|
// Microsoft documentation: https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/list?view=azure-devops-rest-5.0
|
|
const url = `https://dev.azure.com/${organization}/${project}/_apis/build/builds`
|
|
const options = {
|
|
qs: {
|
|
definitions: definitionId,
|
|
$top: 1,
|
|
statusFilter: 'completed',
|
|
'api-version': '5.0-preview.4',
|
|
},
|
|
auth,
|
|
}
|
|
|
|
if (branch) {
|
|
options.qs.branchName = `refs/heads/${branch}`
|
|
}
|
|
|
|
const json = await this.fetch({
|
|
url,
|
|
options,
|
|
schema: latestBuildSchema,
|
|
errorMessages,
|
|
})
|
|
|
|
if (json.count !== 1) {
|
|
throw new NotFound({ prettyMessage: 'build pipeline not found' })
|
|
}
|
|
|
|
return json.value[0].id
|
|
}
|
|
}
|