Files
shields/services/github/github-api-provider.integration.js
chris48s c586960ce8 allow calling [github] without auth (#9427)
* allow calling [github] without auth

* set a default for authType, fix broken tests
2023-08-07 14:51:18 +00:00

124 lines
3.4 KiB
JavaScript

import { expect } from 'chai'
import config from 'config'
import { fetch } from '../../core/base-service/got.js'
import GithubApiProvider from './github-api-provider.js'
describe('Github API provider', function () {
const baseUrl = process.env.GITHUB_URL || 'https://api.github.com'
const reserveFraction = 0.333
let token
before(function () {
token = config.util.toObject().private.gh_token
if (!token) {
throw Error('The integration tests require a gh_token to be set')
}
})
let githubApiProvider
context('with no auth', function () {
before(function () {
githubApiProvider = new GithubApiProvider({
baseUrl,
authType: GithubApiProvider.AUTH_TYPES.NO_AUTH,
})
})
it('should be able to run 10 requests', async function () {
this.timeout('20s')
for (let i = 0; i < 10; ++i) {
const { res } = await githubApiProvider.fetch(
fetch,
'/repos/rust-lang/rust',
{},
)
expect(res.statusCode).to.equal(200)
}
})
})
context('with global token', function () {
before(function () {
githubApiProvider = new GithubApiProvider({
baseUrl,
authType: GithubApiProvider.AUTH_TYPES.GLOBAL_TOKEN,
globalToken: token,
reserveFraction,
})
})
it('should be able to run 10 requests', async function () {
this.timeout('20s')
for (let i = 0; i < 10; ++i) {
const { res } = await githubApiProvider.fetch(
fetch,
'/repos/rust-lang/rust',
{},
)
expect(res.statusCode).to.equal(200)
}
})
})
context('with token pool', function () {
let githubApiProvider
before(function () {
githubApiProvider = new GithubApiProvider({
baseUrl,
authType: GithubApiProvider.AUTH_TYPES.TOKEN_POOL,
reserveFraction,
})
githubApiProvider.addToken(token)
})
const headers = []
async function performOneRequest() {
const { res } = await githubApiProvider.fetch(
fetch,
'/repos/rust-lang/rust',
{},
)
expect(res.statusCode).to.equal(200)
headers.push(res.headers)
}
before('should be able to run 10 requests', async function () {
this.timeout('20s')
for (let i = 0; i < 10; ++i) {
await performOneRequest()
}
})
it('should decrement the limit remaining with each request', function () {
for (let i = 1; i < headers.length; ++i) {
const current = headers[i]
const previous = headers[i - 1]
expect(+current['x-ratelimit-remaining']).to.be.lessThan(
+previous['x-ratelimit-remaining'],
)
}
})
// Is this test failing? See https://github.com/badges/shields/pull/4590#issuecomment-708551801
it('should update the token with the final limit remaining and reset time', function () {
const lastHeaders = headers.slice(-1)[0]
const reserve = reserveFraction * +lastHeaders['x-ratelimit-limit']
const usesRemaining = +lastHeaders['x-ratelimit-remaining'] - reserve
const nextReset = +lastHeaders['x-ratelimit-reset']
const tokens = []
githubApiProvider.standardTokens.forEach(t => {
tokens.push(t)
})
// Confidence check.
expect(tokens).to.have.lengthOf(1)
const [token] = tokens
expect(token.usesRemaining).to.equal(usesRemaining)
expect(token.nextReset).to.equal(nextReset)
})
})
})