Files
shields/services/github/auth/acceptor.spec.js
T
dependabot[bot]andjNullj d4acd740ac chore(deps): bump got from 14.6.6 to 15.0.5 (#11848)
* chore(deps): bump got from 14.6.6 to 15.0.5

Bumps [got](https://github.com/sindresorhus/got) from 14.6.6 to 15.0.5.
- [Release notes](https://github.com/sindresorhus/got/releases)
- [Commits](https://github.com/sindresorhus/got/compare/v14.6.6...v15.0.5)

---
updated-dependencies:
- dependency-name: got
  dependency-version: 15.0.5
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* migrate got promise.cancel to AbortController

breaking changes of got v14 -> v15 dropped cancel() and replaced with AbortController signal

* tests: replace 'undici' FormData with native FormData

due to got migration from v14 -> v15 usage of non native FormData is unsupported.

* fix: url usage in got.post

* fix: adjust clock tick duration in metrics test

* improve test robustness

use a promise to wait for custom metrics push to resolve rathrer then rely on timers

* fix: move abortController from function to fetch instance

* remove old comment

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: jNullj <15849761+jNullj@users.noreply.github.com>
2026-06-01 19:54:50 +00:00

123 lines
3.5 KiB
JavaScript

import { expect } from 'chai'
import Camp from '@shields_io/camp'
import sinon from 'sinon'
import portfinder from 'portfinder'
import qs from 'qs'
import nock from 'nock'
import got from '../../../core/got-test-client.js'
import GithubConstellation from '../github-constellation.js'
import { setRoutes } from './acceptor.js'
const fakeClientId = 'githubdabomb'
const fakeClientSecret = 'foobar'
describe('Github token acceptor', function () {
const oauthHelper = GithubConstellation._createOauthHelper({
private: { gh_client_id: fakeClientId, gh_client_secret: fakeClientSecret },
})
let port, baseUrl
beforeEach(async function () {
port = await portfinder.getPortPromise()
baseUrl = `http://127.0.0.1:${port}`
})
let camp
beforeEach(async function () {
camp = Camp.start({ port, hostname: '::' })
await new Promise(resolve => camp.on('listening', () => resolve()))
})
afterEach(async function () {
if (camp) {
await new Promise(resolve => camp.close(resolve))
camp = undefined
}
})
let onTokenAccepted
beforeEach(function () {
onTokenAccepted = sinon.stub()
setRoutes({
server: camp,
authHelper: oauthHelper,
onTokenAccepted,
})
})
it('should start the OAuth process', async function () {
const res = await got(`${baseUrl}/github-auth`, { followRedirect: false })
expect(res.statusCode).to.equal(302)
const queryString = qs.stringify({
client_id: fakeClientId,
redirect_uri: 'https://img.shields.io/github-auth/done',
})
const expectedLocationHeader = `https://github.com/login/oauth/authorize?${queryString}`
expect(res.headers.location).to.equal(expectedLocationHeader)
})
describe('Finishing the OAuth process', function () {
context('no code is provided', function () {
it('should return an error', async function () {
const res = await got(`${baseUrl}/github-auth/done`)
expect(res.body).to.equal(
'GitHub OAuth authentication failed to provide a code.',
)
})
})
const fakeCode = '123456789'
const fakeAccessToken = 'abcdef'
context('a code is provided', function () {
let scope
beforeEach(function () {
nock.enableNetConnect(/127\.0\.0\.1/)
scope = nock('https://github.com')
.post('/login/oauth/access_token')
.reply((url, requestBody) => {
const parsedBody = qs.parse(requestBody)
expect(parsedBody.client_id).to.equal(fakeClientId)
expect(parsedBody.client_secret).to.equal(fakeClientSecret)
expect(parsedBody.code).to.equal(fakeCode)
return [200, qs.stringify({ access_token: fakeAccessToken })]
})
})
afterEach(function () {
// Make sure other tests will make live requests even when this test
// fails.
nock.enableNetConnect()
})
afterEach(function () {
if (scope) {
scope.done()
scope = null
}
})
afterEach(function () {
nock.cleanAll()
})
it('should finish the OAuth process', async function () {
const form = new FormData()
form.append('code', fakeCode)
const res = await got.post(`${baseUrl}/github-auth/done`, {
body: form,
})
expect(
res.body.startsWith(
'<p>Shields.io has received your app-specific GitHub user token.',
),
).to.be.true
expect(onTokenAccepted).to.have.been.calledWith(fakeAccessToken)
})
})
})
})