Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle missing and foreign PRs in changelog #15

Merged
merged 1 commit into from
Jan 19, 2016
Merged

Handle missing and foreign PRs in changelog #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions lib/github/parse-repository.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,10 @@ function parseRepository(repositoryField) {
if (match === null) {
throw new Error('Could not parse git repository: ' + repository);
}
var protocol = parsed.protocol === 'http:' ? 'http://' : 'https://';
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Required to have nice local mocks for the Github API without having to mess with https.

return {
baseUrl: host === 'github.com' ? PUBLIC_BASE : 'https://' + host + '/api/v3',
htmlBase: 'https://' + host,
baseUrl: host === 'github.com' ? PUBLIC_BASE : protocol + host + '/api/v3',
htmlBase: protocol + host,
username: match[1],
repository: match[2],
};
Expand Down
14 changes: 14 additions & 0 deletions lib/steps/changelog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ function addPullRequestCommits(pkg, commits, pr) {
pr.commits = commits.filter(function isPartOfPR(commit) {
return shas.indexOf(commit.sha) !== -1;
});
}).catch(function handle404(err) {
if (err.statusCode !== 404) throw err;
// If the PR doesn't exist, handle it gracefully.
pr.commits = pr.shas = null;
});
}

Expand All @@ -73,6 +77,15 @@ function extractBreakingChanges(commit) {
});
}

function removeInvalidPRs(prs) {
// Warning: We're doing something evil here and mutate the input array.
var filtered = prs.filter(function allCommitsFound(pr) {
return pr.shas && pr.shas.length === pr.commits.length;
});
prs.length = filtered.length;
_.assign(prs, filtered);
}

function generateChangeLog(cwd, pkg, options) {
var repoInfo = parseRepository(pkg.repository);
var commits = options.commits;
Expand Down Expand Up @@ -141,6 +154,7 @@ function generateChangeLog(cwd, pkg, options) {

return Bluebird
.each(prs, _.partial(addPullRequestCommits, pkg, commits))
.then(_.partial(removeInvalidPRs, prs))
.then(_.partial(removePRCommits, commits, prs))
.then(formatCommits)
.then(prependBreakingChanges)
Expand Down
183 changes: 183 additions & 0 deletions test/steps/changelog.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,67 @@ var assert = require('assertive');

var generateChangeLog = require('../../lib/steps/changelog');

function withFakeGithub() {
var httpCalls = [];
var server;

before(function (done) {
server = require('http').createServer(function (req, res) {
httpCalls.push({
method: req.method,
url: req.url,
auth: req.headers.authorization,
});
res.setHeader('Content-Type', 'application/json');
switch (req.url) {
case '/api/v3/repos/usr/proj/pulls/1':
res.end(JSON.stringify({
user: { login: 'pr-1-user', html_url: 'http://pr-1-user' },
html_url: 'http://pr-1',
title: 'PR #1 Title',
}));
break;

case '/api/v3/repos/usr/proj/pulls/1/commits':
res.end(JSON.stringify([
{ sha: '1234567890123456789012345678901234567890' },
{ sha: '2234567890123456789012345678901234567890' },
]));
break;

case '/api/v3/repos/usr/proj/pulls/2':
res.end(JSON.stringify({
user: { login: 'pr-2-user', html_url: 'http://pr-2-user' },
html_url: 'http://pr-2',
title: 'PR #2 Title',
}));
break;

case '/api/v3/repos/usr/proj/pulls/2/commits':
res.end(JSON.stringify([
// These commits are *not* part of the release.
// This could happen, for example, when a foreign PR happens to
// have an id that also exists in the current repo.
{ sha: 'e234567890123456789012345678901234567890' },
{ sha: 'f234567890123456789012345678901234567890' },
]));
break;

default:
res.statusCode = 404;
res.end('{"error":"Not found"}');
}
});
server.listen(3000, done);
});

after(function (done) {
server.close(done);
});

return httpCalls;
}

describe('generateChangeLog', function () {
it('can create an empty changelog', function () {
var pkg = { repository: 'usr/proj' };
Expand Down Expand Up @@ -111,4 +172,126 @@ describe('generateChangeLog', function () {
].join('\n'), changelog);
});
});

describe('pull request commits', function () {
var httpCalls = withFakeGithub();
var pkg = { repository: 'http://127.0.0.1:3000/usr/proj' };
var commits = [
{
sha: '1234567890123456789012345678901234567890',
type: 'fix',
subject: 'Stop doing the wrong thing',
},
{
sha: '2234567890123456789012345678901234567890',
type: 'feat',
subject: 'Do more things',
},
{
sha: '3234567890123456789012345678901234567890',
type: 'pr',
subject: 'Merge PR #1',
pullId: '1',
},
];
var options = { commits: commits };
var changelog = null;

before('generateChangeLog', function () {
return generateChangeLog(null, pkg, options)
.then(function (_changelog) {
changelog = _changelog;
});
});

it('calls out to github to get PR info', function () {
assert.equal(2, httpCalls.length);
});

it('groups commits by pull request', function () {
assert.include('* PR #1 Title', changelog);
assert.include(' - [`1234567`]', changelog);
});
});

describe('with an invalid PR', function () {
var httpCalls = withFakeGithub();
var pkg = { repository: 'http://127.0.0.1:3000/usr/proj' };
var commits = [
{
sha: '1234567890123456789012345678901234567890',
type: 'fix',
subject: 'Stop doing the wrong thing',
},
{
sha: '2234567890123456789012345678901234567890',
type: 'feat',
subject: 'Do more things',
},
{
sha: '3234567890123456789012345678901234567890',
type: 'pr',
subject: 'Merge PR #2',
pullId: '2',
},
];
var options = { commits: commits };
var changelog = null;

before('generateChangeLog', function () {
return generateChangeLog(null, pkg, options)
.then(function (_changelog) {
changelog = _changelog;
});
});

it('calls out to github to get PR info', function () {
assert.equal(2, httpCalls.length);
});

it('ignores the PR', function () {
assert.notInclude('* PR #2 Title', changelog);
assert.include('* [`1234567`]', changelog);
});
});

describe('with a missing PR', function () {
var httpCalls = withFakeGithub();
var pkg = { repository: 'http://127.0.0.1:3000/usr/proj' };
var commits = [
{
sha: '1234567890123456789012345678901234567890',
type: 'fix',
subject: 'Stop doing the wrong thing',
},
{
sha: '2234567890123456789012345678901234567890',
type: 'feat',
subject: 'Do more things',
},
{
sha: '3234567890123456789012345678901234567890',
type: 'pr',
subject: 'Merge PR #3',
pullId: '3',
},
];
var options = { commits: commits };
var changelog = null;

before('generateChangeLog', function () {
return generateChangeLog(null, pkg, options)
.then(function (_changelog) {
changelog = _changelog;
});
});

it('calls out to github to get PR info', function () {
assert.equal(2, httpCalls.length);
});

it('ignores the PR', function () {
assert.include('* [`1234567`]', changelog);
});
});
});