Paul MelnikowandGitHub
5c665a70da
Because `server.js` was long a monolith, there are a bunch of shims in place to facilitate unit testing. A few of the test suites share port 1111 which means if one of them fails to set up, the port won't be freed and other unrelated tests will fail. Some of the tests which trigger server setup include timeouts which were added to give setup code time to run. In one the test suites, we actually modify `process.argv`, which seems completely gross. This implements a few changes which improve this: 1. Separate the server from the server startup script, splitting out `lib/server.js`. 2. Inject config into the server and validate the config schema. 3. Inject config into the service test runner. 4. Use `portfinder`, a popular utility for grabbing open ports during testing. 5. Switch more of the setup code from callbacks to async-await. Overall it leaves everything acting more reliably and looking rather cleaner, if in a few places more verbose. It also fixes the root cause of #1455, a `setTimeout` in `rate-limit`. Off and on during development of this changeset, Mocha would decide not to exit, and that turned out to be the culprit. Fix #1455
112 lines
3.1 KiB
JavaScript
112 lines
3.1 KiB
JavaScript
'use strict'
|
|
|
|
const { expect } = require('chai')
|
|
const Camp = require('camp')
|
|
const got = require('got')
|
|
const portfinder = require('portfinder')
|
|
const queryString = require('query-string')
|
|
const nock = require('nock')
|
|
const serverSecrets = require('../../../lib/server-secrets')
|
|
const acceptor = require('./acceptor')
|
|
|
|
const fakeClientId = 'githubdabomb'
|
|
|
|
describe('Github token acceptor', function() {
|
|
// Frustratingly, potentially undefined properties can't reliably be stubbed
|
|
// with Sinon.
|
|
// https://github.com/sinonjs/sinon/pull/1557
|
|
before(function() {
|
|
serverSecrets.gh_client_id = fakeClientId
|
|
serverSecrets.shieldsIps = []
|
|
})
|
|
after(function() {
|
|
delete serverSecrets.gh_client_id
|
|
delete serverSecrets.shieldsIps
|
|
})
|
|
|
|
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
|
|
}
|
|
})
|
|
|
|
beforeEach(function() {
|
|
acceptor.setRoutes(camp)
|
|
})
|
|
|
|
it('should start the OAuth process', async function() {
|
|
const res = await got(`${baseUrl}/github-auth`, { followRedirect: false })
|
|
|
|
expect(res.statusCode).to.equal(302)
|
|
|
|
const qs = queryString.stringify({
|
|
client_id: fakeClientId,
|
|
redirect_uri: 'https://img.shields.io/github-auth/done',
|
|
})
|
|
const expectedLocationHeader = `https://github.com/login/oauth/authorize?${qs}`
|
|
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) => {
|
|
expect(queryString.parse(requestBody).code).to.equal(fakeCode)
|
|
return queryString.stringify({ access_token: fakeAccessToken })
|
|
})
|
|
})
|
|
|
|
afterEach(function() {
|
|
if (scope) {
|
|
scope.done()
|
|
scope = null
|
|
}
|
|
})
|
|
|
|
afterEach(function() {
|
|
nock.enableNetConnect()
|
|
nock.cleanAll()
|
|
})
|
|
|
|
it('should finish the OAuth process', async function() {
|
|
const res = await got(`${baseUrl}/github-auth/done`, {
|
|
form: true,
|
|
body: { code: fakeCode },
|
|
})
|
|
expect(res.body).to.startWith(
|
|
'<p>Shields.io has received your app-specific GitHub user token.'
|
|
)
|
|
})
|
|
})
|
|
})
|
|
})
|