Files
shields/services/github/github-api-provider.spec.js
2019-01-10 21:30:23 -05:00

124 lines
3.9 KiB
JavaScript

'use strict'
const { expect } = require('chai')
const sinon = require('sinon')
const GithubApiProvider = require('./github-api-provider')
describe('Github API provider', function() {
const baseUrl = 'https://github-api.example.com'
const reserveFraction = 0.333
let mockStandardToken, mockSearchToken, provider
beforeEach(function() {
provider = new GithubApiProvider({ baseUrl, reserveFraction })
mockStandardToken = { update: sinon.spy(), invalidate: sinon.spy() }
sinon.stub(provider.standardTokens, 'next').returns(mockStandardToken)
mockSearchToken = { update: sinon.spy(), invalidate: sinon.spy() }
sinon.stub(provider.searchTokens, 'next').returns(mockSearchToken)
})
context('a search API request', function() {
const mockRequest = (options, callback) => {
callback()
}
it('should obtain an appropriate token', function(done) {
provider.request(mockRequest, '/search', {}, (err, res, buffer) => {
expect(err).to.be.undefined
expect(provider.searchTokens.next).to.have.been.calledOnce
expect(provider.standardTokens.next).not.to.have.been.called
done()
})
})
})
context('a core API request', function() {
const mockRequest = (options, callback) => {
callback()
}
it('should obtain an appropriate token', function(done) {
provider.request(mockRequest, '/repo', {}, (err, res, buffer) => {
expect(err).to.be.undefined
expect(provider.searchTokens.next).not.to.have.been.called
expect(provider.standardTokens.next).to.have.been.calledOnce
done()
})
})
})
context('a valid response', function() {
const rateLimit = 12500
const remaining = 7955
const nextReset = 123456789
const mockResponse = {
statusCode: 200,
headers: {
'x-ratelimit-limit': rateLimit,
'x-ratelimit-remaining': remaining,
'x-ratelimit-reset': nextReset,
},
}
const mockBuffer = Buffer.alloc(0)
const mockRequest = (...args) => {
const callback = args.pop()
callback(null, mockResponse, mockBuffer)
}
it('should invoke the callback', function(done) {
provider.request(mockRequest, '/foo', {}, (err, res, buffer) => {
expect(err).to.equal(null)
expect(Object.is(res, mockResponse)).to.be.true
expect(Object.is(buffer, mockBuffer)).to.be.true
done()
})
})
it('should update the token with the expected values', function(done) {
provider.request(mockRequest, '/foo', {}, (err, res, buffer) => {
expect(err).to.equal(null)
const expectedUsesRemaining = remaining - reserveFraction * rateLimit
expect(
mockStandardToken.update.withArgs(expectedUsesRemaining, nextReset)
.calledOnce
).to.be.true
expect(mockStandardToken.invalidate).not.to.have.been.called
done()
})
})
})
context('an unauthorized response', function() {
const mockResponse = { statusCode: 401 }
const mockBuffer = Buffer.alloc(0)
const mockRequest = (...args) => {
const callback = args.pop()
callback(null, mockResponse, mockBuffer)
}
it('should invoke the callback and update the token with the expected values', function(done) {
provider.request(mockRequest, '/foo', {}, (err, res, buffer) => {
expect(err).to.equal(null)
expect(mockStandardToken.invalidate).to.have.been.calledOnce
expect(mockStandardToken.update).not.to.have.been.called
done()
})
})
})
context('a connection error', function() {
const mockRequest = (...args) => {
const callback = args.pop()
callback(Error('connection timeout'))
}
it('should pass the error to the callback', function(done) {
provider.request(mockRequest, '/foo', {}, (err, res, buffer) => {
expect(err).to.be.an.instanceof(Error)
expect(err.message).to.equal('connection timeout')
done()
})
})
})
})