14b7dfa007
Previously, only a few characters of the SHA would appear on the preview link comment posted on the PR. This was usually enough for GitHub to create a link to the corresponding commit, but it was possible to have collisions with other commits with the same first characters (which prevented GitHub from identifying the correct commit and create a link.) This commit fixes this issue by including the full SHA on the commentso GitHub can identify the correct commit and create the link. GitHub will automatically truncate the link text (by default to 7 chars unless more are necessary to uniquely identify the commit).
404 lines
14 KiB
TypeScript
404 lines
14 KiB
TypeScript
// Imports
|
|
import * as express from 'express';
|
|
import * as http from 'http';
|
|
import * as supertest from 'supertest';
|
|
import {GithubPullRequests} from '../../lib/common/github-pull-requests';
|
|
import {BuildCreator} from '../../lib/upload-server/build-creator';
|
|
import {CreatedBuildEvent} from '../../lib/upload-server/build-events';
|
|
import {BuildVerifier} from '../../lib/upload-server/build-verifier';
|
|
import {uploadServerFactory as usf} from '../../lib/upload-server/upload-server-factory';
|
|
|
|
// Tests
|
|
describe('uploadServerFactory', () => {
|
|
const defaultConfig = {
|
|
buildsDir: 'builds/dir',
|
|
domainName: 'domain.name',
|
|
githubOrganization: 'organization',
|
|
githubTeamSlugs: ['team1', 'team2'],
|
|
githubToken: '12345',
|
|
repoSlug: 'repo/slug',
|
|
secret: 'secret',
|
|
};
|
|
|
|
// Helpers
|
|
const createUploadServer = (partialConfig: Partial<typeof defaultConfig> = {}) =>
|
|
usf.create({...defaultConfig, ...partialConfig});
|
|
|
|
|
|
describe('create()', () => {
|
|
let usfCreateMiddlewareSpy: jasmine.Spy;
|
|
|
|
beforeEach(() => {
|
|
usfCreateMiddlewareSpy = spyOn(usf as any, 'createMiddleware').and.callThrough();
|
|
});
|
|
|
|
|
|
it('should throw if \'buildsDir\' is missing or empty', () => {
|
|
expect(() => createUploadServer({buildsDir: ''})).
|
|
toThrowError('Missing or empty required parameter \'buildsDir\'!');
|
|
});
|
|
|
|
|
|
it('should throw if \'domainName\' is missing or empty', () => {
|
|
expect(() => createUploadServer({domainName: ''})).
|
|
toThrowError('Missing or empty required parameter \'domainName\'!');
|
|
});
|
|
|
|
|
|
it('should throw if \'githubToken\' is missing or empty', () => {
|
|
expect(() => createUploadServer({githubToken: ''})).
|
|
toThrowError('Missing or empty required parameter \'githubToken\'!');
|
|
});
|
|
|
|
|
|
it('should throw if \'githubOrganization\' is missing or empty', () => {
|
|
expect(() => createUploadServer({githubOrganization: ''})).
|
|
toThrowError('Missing or empty required parameter \'organization\'!');
|
|
});
|
|
|
|
|
|
it('should throw if \'githubTeamSlugs\' is missing or empty', () => {
|
|
expect(() => createUploadServer({githubTeamSlugs: []})).
|
|
toThrowError('Missing or empty required parameter \'allowedTeamSlugs\'!');
|
|
});
|
|
|
|
|
|
it('should throw if \'repoSlug\' is missing or empty', () => {
|
|
expect(() => createUploadServer({repoSlug: ''})).
|
|
toThrowError('Missing or empty required parameter \'repoSlug\'!');
|
|
});
|
|
|
|
|
|
it('should throw if \'secret\' is missing or empty', () => {
|
|
expect(() => createUploadServer({secret: ''})).
|
|
toThrowError('Missing or empty required parameter \'secret\'!');
|
|
});
|
|
|
|
|
|
it('should return an http.Server', () => {
|
|
const httpCreateServerSpy = spyOn(http, 'createServer').and.callThrough();
|
|
const server = createUploadServer();
|
|
|
|
expect(server).toBe(httpCreateServerSpy.calls.mostRecent().returnValue);
|
|
});
|
|
|
|
|
|
it('should create and use an appropriate BuildCreator', () => {
|
|
const usfCreateBuildCreatorSpy = spyOn(usf as any, 'createBuildCreator').and.callThrough();
|
|
|
|
createUploadServer();
|
|
const buildCreator: BuildCreator = usfCreateBuildCreatorSpy.calls.mostRecent().returnValue;
|
|
|
|
expect(usfCreateMiddlewareSpy).toHaveBeenCalledWith(jasmine.any(BuildVerifier), buildCreator);
|
|
expect(usfCreateBuildCreatorSpy).toHaveBeenCalledWith('builds/dir', '12345', 'repo/slug', 'domain.name');
|
|
});
|
|
|
|
|
|
it('should create and use an appropriate middleware', () => {
|
|
const httpCreateServerSpy = spyOn(http, 'createServer').and.callThrough();
|
|
|
|
createUploadServer();
|
|
const middleware: express.Express = usfCreateMiddlewareSpy.calls.mostRecent().returnValue;
|
|
const buildVerifier = jasmine.any(BuildVerifier);
|
|
const buildCreator = jasmine.any(BuildCreator);
|
|
|
|
expect(httpCreateServerSpy).toHaveBeenCalledWith(middleware);
|
|
expect(usfCreateMiddlewareSpy).toHaveBeenCalledWith(buildVerifier, buildCreator);
|
|
});
|
|
|
|
|
|
it('should log the server address info on \'listening\'', () => {
|
|
const consoleInfoSpy = spyOn(console, 'info');
|
|
const server = createUploadServer('builds/dir');
|
|
server.address = () => ({address: 'foo', family: '', port: 1337});
|
|
|
|
expect(consoleInfoSpy).not.toHaveBeenCalled();
|
|
|
|
server.emit('listening');
|
|
expect(consoleInfoSpy).toHaveBeenCalledWith('Up and running (and listening on foo:1337)...');
|
|
});
|
|
|
|
});
|
|
|
|
|
|
// Protected methods
|
|
|
|
describe('createBuildCreator()', () => {
|
|
let buildCreator: BuildCreator;
|
|
|
|
beforeEach(() => {
|
|
buildCreator = (usf as any).createBuildCreator(
|
|
defaultConfig.buildsDir,
|
|
defaultConfig.githubToken,
|
|
defaultConfig.repoSlug,
|
|
defaultConfig.domainName,
|
|
);
|
|
});
|
|
|
|
|
|
it('should pass the \'buildsDir\' to the BuildCreator', () => {
|
|
expect((buildCreator as any).buildsDir).toBe('builds/dir');
|
|
});
|
|
|
|
|
|
it('should post a comment on GitHub on \'build.created\'', () => {
|
|
const prsAddCommentSpy = spyOn(GithubPullRequests.prototype, 'addComment');
|
|
const commentBody = 'The angular.io preview for 1234567890 is available [here][1].\n\n' +
|
|
'[1]: https://pr42-1234567890.domain.name/';
|
|
|
|
buildCreator.emit(CreatedBuildEvent.type, {pr: 42, sha: '1234567890'});
|
|
|
|
expect(prsAddCommentSpy).toHaveBeenCalledWith(42, commentBody);
|
|
});
|
|
|
|
|
|
it('should pass the correct \'githubToken\' and \'repoSlug\' to GithubPullRequests', () => {
|
|
const prsAddCommentSpy = spyOn(GithubPullRequests.prototype, 'addComment');
|
|
|
|
buildCreator.emit(CreatedBuildEvent.type, {pr: 42, sha: '1234567890'});
|
|
const prs = prsAddCommentSpy.calls.mostRecent().object;
|
|
|
|
expect(prs).toEqual(jasmine.any(GithubPullRequests));
|
|
expect((prs as any).repoSlug).toBe('repo/slug');
|
|
expect((prs as any).requestHeaders.Authorization).toContain('12345');
|
|
});
|
|
|
|
});
|
|
|
|
|
|
describe('createMiddleware()', () => {
|
|
let buildVerifier: BuildVerifier;
|
|
let buildCreator: BuildCreator;
|
|
let agent: supertest.SuperTest<supertest.Test>;
|
|
|
|
// Helpers
|
|
const promisifyRequest = (req: supertest.Request) =>
|
|
new Promise((resolve, reject) => req.end(err => err ? reject(err) : resolve()));
|
|
const verifyRequests = (reqs: supertest.Request[], done: jasmine.DoneFn) =>
|
|
Promise.all(reqs.map(promisifyRequest)).then(done, done.fail);
|
|
|
|
beforeEach(() => {
|
|
buildVerifier = new BuildVerifier(
|
|
defaultConfig.secret,
|
|
defaultConfig.githubToken,
|
|
defaultConfig.repoSlug,
|
|
defaultConfig.githubOrganization,
|
|
defaultConfig.githubTeamSlugs,
|
|
);
|
|
buildCreator = new BuildCreator(defaultConfig.buildsDir);
|
|
agent = supertest.agent((usf as any).createMiddleware(buildVerifier, buildCreator));
|
|
|
|
spyOn(console, 'error');
|
|
});
|
|
|
|
|
|
describe('GET /create-build/<pr>/<sha>', () => {
|
|
const pr = '9';
|
|
const sha = '9'.repeat(40);
|
|
let buildVerifierVerifySpy: jasmine.Spy;
|
|
let buildCreatorCreateSpy: jasmine.Spy;
|
|
|
|
beforeEach(() => {
|
|
buildVerifierVerifySpy = spyOn(buildVerifier, 'verify').and.returnValue(Promise.resolve());
|
|
buildCreatorCreateSpy = spyOn(buildCreator, 'create').and.returnValue(Promise.resolve());
|
|
});
|
|
|
|
|
|
it('should respond with 405 for non-GET requests', done => {
|
|
verifyRequests([
|
|
agent.put(`/create-build/${pr}/${sha}`).expect(405),
|
|
agent.post(`/create-build/${pr}/${sha}`).expect(405),
|
|
agent.patch(`/create-build/${pr}/${sha}`).expect(405),
|
|
agent.delete(`/create-build/${pr}/${sha}`).expect(405),
|
|
], done);
|
|
});
|
|
|
|
|
|
it('should respond with 401 for requests without an \'AUTHORIZATION\' header', done => {
|
|
const url = `/create-build/${pr}/${sha}`;
|
|
const responseBody = `Missing or empty 'AUTHORIZATION' header in request: GET ${url}`;
|
|
|
|
verifyRequests([
|
|
agent.get(url).expect(401, responseBody),
|
|
agent.get(url).set('AUTHORIZATION', '').expect(401, responseBody),
|
|
], done);
|
|
});
|
|
|
|
|
|
it('should respond with 400 for requests without an \'X-FILE\' header', done => {
|
|
const url = `/create-build/${pr}/${sha}`;
|
|
const responseBody = `Missing or empty 'X-FILE' header in request: GET ${url}`;
|
|
|
|
const request1 = agent.get(url).set('AUTHORIZATION', 'foo');
|
|
const request2 = agent.get(url).set('AUTHORIZATION', 'foo').set('X-FILE', '');
|
|
|
|
verifyRequests([
|
|
request1.expect(400, responseBody),
|
|
request2.expect(400, responseBody),
|
|
], done);
|
|
});
|
|
|
|
|
|
it('should respond with 404 for unknown paths', done => {
|
|
verifyRequests([
|
|
agent.get(`/foo/create-build/${pr}/${sha}`).expect(404),
|
|
agent.get(`/foo-create-build/${pr}/${sha}`).expect(404),
|
|
agent.get(`/fooncreate-build/${pr}/${sha}`).expect(404),
|
|
agent.get(`/create-build/foo/${pr}/${sha}`).expect(404),
|
|
agent.get(`/create-build-foo/${pr}/${sha}`).expect(404),
|
|
agent.get(`/create-buildnfoo/${pr}/${sha}`).expect(404),
|
|
agent.get(`/create-build/pr${pr}/${sha}`).expect(404),
|
|
agent.get(`/create-build/${pr}/${sha}42`).expect(404),
|
|
], done);
|
|
});
|
|
|
|
|
|
it('should call \'BuildVerifier#verify()\' with the correct arguments', done => {
|
|
const req = agent.
|
|
get(`/create-build/${pr}/${sha}`).
|
|
set('AUTHORIZATION', 'foo').
|
|
set('X-FILE', 'bar');
|
|
|
|
promisifyRequest(req).
|
|
then(() => expect(buildVerifierVerifySpy).toHaveBeenCalledWith(9, 'foo')).
|
|
then(done, done.fail);
|
|
});
|
|
|
|
|
|
it('should propagate errors from BuildVerifier', done => {
|
|
buildVerifierVerifySpy.and.callFake(() => Promise.reject('Test'));
|
|
|
|
const req = agent.
|
|
get(`/create-build/${pr}/${sha}`).
|
|
set('AUTHORIZATION', 'foo').
|
|
set('X-FILE', 'bar').
|
|
expect(500, 'Test');
|
|
|
|
promisifyRequest(req).
|
|
then(() => {
|
|
expect(buildVerifierVerifySpy).toHaveBeenCalledWith(9, 'foo');
|
|
expect(buildCreatorCreateSpy).not.toHaveBeenCalled();
|
|
}).
|
|
then(done, done.fail);
|
|
});
|
|
|
|
|
|
it('should call \'BuildCreator#create()\' with the correct arguments', done => {
|
|
const req = agent.
|
|
get(`/create-build/${pr}/${sha}`).
|
|
set('AUTHORIZATION', 'foo').
|
|
set('X-FILE', 'bar');
|
|
|
|
promisifyRequest(req).
|
|
then(() => expect(buildCreatorCreateSpy).toHaveBeenCalledWith(pr, sha, 'bar')).
|
|
then(done, done.fail);
|
|
});
|
|
|
|
|
|
it('should propagate errors from BuildCreator', done => {
|
|
buildCreatorCreateSpy.and.callFake(() => Promise.reject('Test'));
|
|
const req = agent.
|
|
get(`/create-build/${pr}/${sha}`).
|
|
set('AUTHORIZATION', 'foo').
|
|
set('X-FILE', 'bar').
|
|
expect(500, 'Test');
|
|
|
|
verifyRequests([req], done);
|
|
});
|
|
|
|
|
|
it('should respond with 201 on successful upload', done => {
|
|
const req = agent.
|
|
get(`/create-build/${pr}/${sha}`).
|
|
set('AUTHORIZATION', 'foo').
|
|
set('X-FILE', 'bar').
|
|
expect(201, http.STATUS_CODES[201]);
|
|
|
|
verifyRequests([req], done);
|
|
});
|
|
|
|
|
|
it('should reject PRs with leading zeros', done => {
|
|
verifyRequests([agent.get(`/create-build/0${pr}/${sha}`).expect(404)], done);
|
|
});
|
|
|
|
|
|
it('should accept SHAs with leading zeros (but not trim the zeros)', done => {
|
|
const sha40 = '0'.repeat(40);
|
|
const sha41 = `0${sha40}`;
|
|
|
|
const request40 = agent.get(`/create-build/${pr}/${sha40}`).set('AUTHORIZATION', 'foo').set('X-FILE', 'bar');
|
|
const request41 = agent.get(`/create-build/${pr}/${sha41}`).set('AUTHORIZATION', 'baz').set('X-FILE', 'qux');
|
|
|
|
Promise.all([
|
|
promisifyRequest(request40.expect(201)),
|
|
promisifyRequest(request41.expect(404)),
|
|
]).then(done, done.fail);
|
|
});
|
|
|
|
});
|
|
|
|
|
|
describe('GET /health-check', () => {
|
|
|
|
it('should respond with 200', done => {
|
|
verifyRequests([
|
|
agent.get('/health-check').expect(200),
|
|
agent.get('/health-check/').expect(200),
|
|
], done);
|
|
});
|
|
|
|
|
|
it('should respond with 405 for non-GET requests', done => {
|
|
verifyRequests([
|
|
agent.put('/health-check').expect(405),
|
|
agent.post('/health-check').expect(405),
|
|
agent.patch('/health-check').expect(405),
|
|
agent.delete('/health-check').expect(405),
|
|
], done);
|
|
});
|
|
|
|
|
|
it('should respond with 404 if the path does not match exactly', done => {
|
|
verifyRequests([
|
|
agent.get('/health-check/foo').expect(404),
|
|
agent.get('/health-check-foo').expect(404),
|
|
agent.get('/health-checknfoo').expect(404),
|
|
agent.get('/foo/health-check').expect(404),
|
|
agent.get('/foo-health-check').expect(404),
|
|
agent.get('/foonhealth-check').expect(404),
|
|
], done);
|
|
});
|
|
|
|
});
|
|
|
|
|
|
describe('GET *', () => {
|
|
|
|
it('should respond with 404', done => {
|
|
const responseBody = 'Unknown resource in request: GET /some/url';
|
|
verifyRequests([agent.get('/some/url').expect(404, responseBody)], done);
|
|
});
|
|
|
|
});
|
|
|
|
|
|
describe('ALL *', () => {
|
|
|
|
it('should respond with 405', done => {
|
|
const responseFor = (method: string) => `Unsupported method in request: ${method.toUpperCase()} /some/url`;
|
|
|
|
verifyRequests([
|
|
agent.put('/some/url').expect(405, responseFor('put')),
|
|
agent.post('/some/url').expect(405, responseFor('post')),
|
|
agent.patch('/some/url').expect(405, responseFor('patch')),
|
|
agent.delete('/some/url').expect(405, responseFor('delete')),
|
|
], done);
|
|
});
|
|
|
|
});
|
|
|
|
});
|
|
|
|
});
|