Files
shields/services/testspace/testspace-base.js
chris48s 14892e3943 Implement a pattern for dealing with upstream APIs which are slow on the first hit; affects [endpoint] (#9233)
* allow serviceData to override cacheSeconds with a longer value

* prevent [endpoint] json cacheSeconds property exceeding service default

* allow ShieldsRuntimeError to specify a cacheSeconds property

By default error responses use the cacheLength of
the service class throwing the error.

This allows error to tell the handling layer the maxAge
that should be set on the error badge response.

* add customExceptions param

This

1. allows us to specify custom properties to pass to the exception
   constructor if we throw any of the standard got errors
   e.g: `ETIMEDOUT`, `ECONNRESET`, etc
2. uses a custom `cacheSeconds` property (if set on the exception)
   to set the response maxAge

* customExceptions --> systemErrors

* errorMessages --> httpErrors
2023-06-13 21:08:43 +01:00

60 lines
1.7 KiB
JavaScript

import Joi from 'joi'
import { nonNegativeInteger } from '../validators.js'
import { BaseJsonService, NotFound } from '../index.js'
// https://help.testspace.com/reference/web-api#list-results
// case_counts|array|The contained cases [passed, failed, na, errored, untested]|counters of result
// session_* fields are for manual runs
// There are instances where the api returns a 200 status code with an empty array
// notably in cases where a space id is used
const schema = Joi.array()
.items(
Joi.object({
case_counts: Joi.array()
.items(nonNegativeInteger)
.min(5)
.max(5)
.required(),
})
)
.required()
// https://help.testspace.com/dashboard/overview#navigate
// Org is owner/account
// Project is generally a repository
// Space is a container, often a branch
export default class TestspaceBase extends BaseJsonService {
static category = 'test-results'
static defaultBadgeData = { label: 'tests' }
async fetch({ org, project, space }) {
// https://help.testspace.com/docs/reference/web-api#list-results
const url = `https://${org}.testspace.com/api/projects/${encodeURIComponent(
project
)}/spaces/${space}/results`
return this._requestJson({
schema,
url,
httpErrors: {
403: 'org not found or not authorized',
404: 'org, project, or space not found',
},
})
}
transformCaseCounts(json) {
if (json.length === 0) {
throw new NotFound({ prettyMessage: 'space not found or results purged' })
}
const [
{
case_counts: [passed, failed, skipped, errored, untested],
},
] = json
const total = passed + failed + skipped + errored + untested
return { passed, failed, skipped, errored, untested, total }
}
}