85dd69b3a2
Add several fixes and improvements in the identification of the last release gitHead: - If there is no last release, unshallow the repo in order to retrieve all existing commits - If git head is not present in last release, try to retrieve it from git tag with format ‘v\<version\>’ or ‘\<version\>’ - If the last release git head cannot be determined and found in commit history, unshallow the repo and try again - Throw a ENOGITHEAD error if the gitHead for the last release cannot be found in the npm metadata nor in the git tags, preventing to make release based on the all the commits in the repo as before - Add integration test for the scenario with a packed repo from which `npm republish` fails to read the git head Fix #447, Fix #393, Fix #280, Fix #276
239 lines
10 KiB
JavaScript
239 lines
10 KiB
JavaScript
import test from 'ava';
|
|
import {gitRepo, gitCommits, gitCheckout, gitTagVersion, gitShallowClone, gitTags, gitLog} from './helpers/git-utils';
|
|
import proxyquire from 'proxyquire';
|
|
import {stub} from 'sinon';
|
|
import SemanticReleaseError from '@semantic-release/error';
|
|
|
|
// Stub to capture the log messages
|
|
const errorLog = stub();
|
|
// Module to test
|
|
const getCommits = proxyquire('../src/lib/get-commits', {npmlog: {error: errorLog}});
|
|
|
|
test.beforeEach(t => {
|
|
// Save the current working diretory
|
|
t.context.cwd = process.cwd();
|
|
// Reset the stub call history
|
|
errorLog.resetHistory();
|
|
});
|
|
|
|
test.afterEach.always(t => {
|
|
// Restore the current working directory
|
|
process.chdir(t.context.cwd);
|
|
});
|
|
|
|
test.serial('Get all commits when there is no last release', async t => {
|
|
// Create a git repository, set the current working directory at the root of the repo
|
|
await gitRepo();
|
|
// Add commits to the master branch
|
|
const commits = await gitCommits(['fix: First fix', 'feat: Second feature']);
|
|
|
|
// Retrieve the commits with the commits module
|
|
const result = await getCommits({lastRelease: {}, options: {branch: 'master'}});
|
|
|
|
// Verify the commits created and retrieved by the module are identical
|
|
t.is(result.length, 2);
|
|
t.is(result[0].hash.substring(0, 7), commits[0].hash);
|
|
t.is(result[0].message, commits[0].message);
|
|
t.is(result[1].hash.substring(0, 7), commits[1].hash);
|
|
t.is(result[1].message, commits[1].message);
|
|
});
|
|
|
|
test.serial('Get all commits when there is no last release, including the ones not in the shallow clone', async t => {
|
|
// Create a git repository, set the current working directory at the root of the repo
|
|
const repo = await gitRepo();
|
|
// Add commits to the master branch
|
|
const commits = await gitCommits(['fix: First fix', 'feat: Second feature']);
|
|
// Create a shallow clone with only 1 commit
|
|
await gitShallowClone(repo);
|
|
|
|
// Verify the shallow clone contains only one commit
|
|
t.is((await gitLog()).length, 1);
|
|
|
|
// Retrieve the commits with the commits module
|
|
const result = await getCommits({lastRelease: {}, options: {branch: 'master'}});
|
|
|
|
// Verify the commits created and retrieved by the module are identical
|
|
t.is(result.length, 2);
|
|
t.is(result[0].hash.substring(0, 7), commits[0].hash);
|
|
t.is(result[0].message, commits[0].message);
|
|
t.is(result[1].hash.substring(0, 7), commits[1].hash);
|
|
t.is(result[1].message, commits[1].message);
|
|
});
|
|
|
|
test.serial('Get all commits since gitHead (from lastRelease)', async t => {
|
|
// Create a git repository, set the current working directory at the root of the repo
|
|
await gitRepo();
|
|
// Add commits to the master branch
|
|
const commits = await gitCommits(['fix: First fix', 'feat: Second feature', 'feat: Third feature']);
|
|
|
|
// Retrieve the commits with the commits module
|
|
const result = await getCommits({
|
|
lastRelease: {gitHead: commits[commits.length - 1].hash},
|
|
options: {branch: 'master'},
|
|
});
|
|
|
|
// Verify the commits created and retrieved by the module are identical
|
|
t.is(result.length, 2);
|
|
t.is(result[0].hash.substring(0, 7), commits[0].hash);
|
|
t.is(result[0].message, commits[0].message);
|
|
t.is(result[1].hash.substring(0, 7), commits[1].hash);
|
|
t.is(result[1].message, commits[1].message);
|
|
});
|
|
|
|
test.serial('Get all commits since gitHead (from tag) ', async t => {
|
|
// Create a git repository, set the current working directory at the root of the repo
|
|
await gitRepo();
|
|
// Add commits to the master branch
|
|
let commits = await gitCommits(['fix: First fix']);
|
|
// Create the tag corresponding to version 1.0.0
|
|
await gitTagVersion('1.0.0');
|
|
// Add new commits to the master branch
|
|
commits = (await gitCommits(['feat: Second feature', 'feat: Third feature'])).concat(commits);
|
|
|
|
// Retrieve the commits with the commits module
|
|
const result = await getCommits({lastRelease: {version: `1.0.0`}, options: {branch: 'master'}});
|
|
|
|
// Verify the commits created and retrieved by the module are identical
|
|
t.is(result.length, 2);
|
|
t.is(result[0].hash.substring(0, 7), commits[0].hash);
|
|
t.is(result[0].message, commits[0].message);
|
|
t.is(result[1].hash.substring(0, 7), commits[1].hash);
|
|
t.is(result[1].message, commits[1].message);
|
|
});
|
|
|
|
test.serial('Get all commits since gitHead (from tag formatted like v<version>) ', async t => {
|
|
// Create a git repository, set the current working directory at the root of the repo
|
|
await gitRepo();
|
|
// Add commits to the master branch
|
|
let commits = await gitCommits(['fix: First fix']);
|
|
// Create the tag corresponding to version 1.0.0
|
|
await gitTagVersion('v1.0.0');
|
|
// Add new commits to the master branch
|
|
commits = (await gitCommits(['feat: Second feature', 'feat: Third feature'])).concat(commits);
|
|
|
|
// Retrieve the commits with the commits module
|
|
const result = await getCommits({lastRelease: {version: `1.0.0`}, options: {branch: 'master'}});
|
|
|
|
// Verify the commits created and retrieved by the module are identical
|
|
t.is(result.length, 2);
|
|
t.is(result[0].hash.substring(0, 7), commits[0].hash);
|
|
t.is(result[0].message, commits[0].message);
|
|
t.is(result[1].hash.substring(0, 7), commits[1].hash);
|
|
t.is(result[1].message, commits[1].message);
|
|
});
|
|
|
|
test.serial('Get all commits since gitHead from tag, when tags are mising from the shallow clone', async t => {
|
|
// Create a git repository, set the current working directory at the root of the repo
|
|
const repo = await gitRepo();
|
|
// Add commits to the master branch
|
|
let commits = await gitCommits(['fix: First fix']);
|
|
// Create the tag corresponding to version 1.0.0
|
|
await gitTagVersion('v1.0.0');
|
|
// Add new commits to the master branch
|
|
commits = (await gitCommits(['feat: Second feature', 'feat: Third feature'])).concat(commits);
|
|
// Create a shallow clone with only 1 commit and no tags
|
|
await gitShallowClone(repo);
|
|
|
|
// Verify the shallow clone does not contains any tags
|
|
t.is((await gitTags()).length, 0);
|
|
|
|
// Retrieve the commits with the commits module
|
|
const result = await getCommits({lastRelease: {version: `1.0.0`}, options: {branch: 'master'}});
|
|
|
|
// Verify the commits created and retrieved by the module are identical
|
|
t.is(result.length, 2);
|
|
t.is(result[0].hash.substring(0, 7), commits[0].hash);
|
|
t.is(result[0].message, commits[0].message);
|
|
t.is(result[1].hash.substring(0, 7), commits[1].hash);
|
|
t.is(result[1].message, commits[1].message);
|
|
});
|
|
|
|
test.serial('Return empty array if there is no commits', async t => {
|
|
// Create a git repository, set the current working directory at the root of the repo
|
|
await gitRepo();
|
|
// Add commits to the master branch
|
|
const commits = await gitCommits(['fix: First fix', 'feat: Second feature']);
|
|
|
|
// Retrieve the commits with the commits module
|
|
const result = await getCommits({lastRelease: {gitHead: commits[0].hash}, options: {branch: 'master'}});
|
|
|
|
// Verify no commit is retrieved
|
|
t.deepEqual(result, []);
|
|
});
|
|
|
|
test.serial('Return empty array if lastRelease.gitHead is the last commit', async t => {
|
|
// Create a git repository, set the current working directory at the root of the repo
|
|
await gitRepo();
|
|
|
|
// Retrieve the commits with the commits module
|
|
const result = await getCommits({lastRelease: {}, options: {branch: 'master'}});
|
|
|
|
// Verify no commit is retrieved
|
|
t.deepEqual(result, []);
|
|
});
|
|
|
|
test.serial('Throws ENOGITHEAD error if the gitHead of the last release cannot be found', async t => {
|
|
// Create a git repository, set the current working directory at the root of the repo
|
|
await gitRepo();
|
|
// Add commits to the master branch
|
|
await gitCommits(['fix: First fix', 'feat: Second feature']);
|
|
|
|
// Retrieve the commits with the commits module
|
|
const error = await t.throws(getCommits({lastRelease: {version: '1.0.0'}, options: {branch: 'master'}}));
|
|
|
|
// Verify error code and message
|
|
t.is(error.code, 'ENOGITHEAD');
|
|
t.true(error instanceof SemanticReleaseError);
|
|
// Verify the log function has been called with a message explaining the error
|
|
t.regex(
|
|
errorLog.firstCall.args[1],
|
|
/The commit the last release of this package was derived from cannot be determined from the release metadata not from the repository tags/
|
|
);
|
|
});
|
|
|
|
test.serial('Throws ENOTINHISTORY error if gitHead is not in history', async t => {
|
|
// Create a git repository, set the current working directory at the root of the repo
|
|
await gitRepo();
|
|
// Add commits to the master branch
|
|
await gitCommits(['fix: First fix', 'feat: Second feature']);
|
|
|
|
// Retrieve the commits with the commits module
|
|
const error = await t.throws(getCommits({lastRelease: {gitHead: 'notinhistory'}, options: {branch: 'master'}}));
|
|
|
|
// Verify error code and message
|
|
t.is(error.code, 'ENOTINHISTORY');
|
|
t.true(error instanceof SemanticReleaseError);
|
|
// Verify the log function has been called with a message mentionning the branch
|
|
t.regex(errorLog.firstCall.args[1], /history of the "master" branch/);
|
|
// Verify the log function has been called with a message mentionning the missing gitHead
|
|
t.regex(errorLog.firstCall.args[1], /restoring the commit "notinhistory"/);
|
|
});
|
|
|
|
test.serial('Throws ENOTINHISTORY error if gitHead is not in branch history but present in others', async t => {
|
|
// Create a git repository, set the current working directory at the root of the repo
|
|
await gitRepo();
|
|
// Add commits to the master branch
|
|
await gitCommits(['First', 'Second']);
|
|
// Create the new branch 'other-branch' from master
|
|
await gitCheckout('other-branch');
|
|
// Add commits to the 'other-branch' branch
|
|
const commitsBranch = await gitCommits(['Third', 'Fourth']);
|
|
// Create the new branch 'another-branch' from 'other-branch'
|
|
await gitCheckout('another-branch');
|
|
|
|
// Retrieve the commits with the commits module
|
|
const error = await t.throws(
|
|
getCommits({lastRelease: {version: '1.0.1', gitHead: commitsBranch[0].hash}, options: {branch: 'master'}})
|
|
);
|
|
|
|
// Verify error code and message
|
|
t.is(error.code, 'ENOTINHISTORY');
|
|
t.true(error instanceof SemanticReleaseError);
|
|
// Verify the log function has been called with a message mentionning the branch
|
|
t.regex(errorLog.firstCall.args[1], /history of the "master" branch/);
|
|
// Verify the log function has been called with a message mentionning the missing gitHead
|
|
t.regex(errorLog.firstCall.args[1], new RegExp(`restoring the commit "${commitsBranch[0].hash}"`));
|
|
// Verify the log function has been called with a message mentionning the branches that contains the gitHead
|
|
t.regex(errorLog.firstCall.args[1], /\* another-branch\s+\* other-branch/);
|
|
});
|