release-it 0.0.0-pl.0

package/test/util/setup.js

@@ -0,0 +1,5 @@
+import shelljs from 'shelljs';
+import nock from 'nock';
+
+shelljs.config.silent = true;
+nock.disableNetConnect();

package/test/utils.js

@@ -0,0 +1,97 @@
+import { EOL } from 'node:os';
+import test from 'ava';
+import mockStdIo from 'mock-stdio';
+import stripAnsi from 'strip-ansi';
+import { format, truncateLines, parseGitUrl, parseVersion } from '../lib/util.js';
+
+test('format', t => {
+  t.is(format('release v${version}', { version: '1.0.0' }), 'release v1.0.0');
+  t.is(format('release v${version} (${name})', { version: '1.0.0', name: 'foo' }), 'release v1.0.0 (foo)');
+  t.is(format('release v${version} (${name})', { version: '1.0.0', name: 'foo' }), 'release v1.0.0 (foo)');
+});
+
+test('format (throw)', t => {
+  mockStdIo.start();
+  t.throws(() => format('release v${foo}', { version: '1.0.0' }), { message: /foo is not defined/ });
+  const { stdout, stderr } = mockStdIo.end();
+  t.is(stdout, '');
+  t.regex(
+    stripAnsi(stderr),
+    /ERROR Unable to render template with context:\s+release v\${foo}\s+{"version":"1\.0\.0"}\s+ERROR ReferenceError: foo is not defined/
+  );
+});
+
+test('truncateLines', t => {
+  const input = `1${EOL}2${EOL}3${EOL}4${EOL}5${EOL}6`;
+  t.is(truncateLines(input), input);
+  t.is(truncateLines(input, 3), `1${EOL}2${EOL}3${EOL}...and 3 more`);
+  t.is(truncateLines(input, 1, '...'), `1...`);
+});
+
+test('parseGitUrl', t => {
+  t.deepEqual(parseGitUrl('https://github.com/webpro/release-it.git'), {
+    host: 'github.com',
+    owner: 'webpro',
+    project: 'release-it',
+    protocol: 'https',
+    remote: 'https://github.com/webpro/release-it.git',
+    repository: 'webpro/release-it'
+  });
+
+  t.deepEqual(parseGitUrl('git@gitlab.com:org/sub-group/repo-in-sub-group.git'), {
+    host: 'gitlab.com',
+    owner: 'org/sub-group',
+    project: 'repo-in-sub-group',
+    protocol: 'ssh',
+    remote: 'git@gitlab.com:org/sub-group/repo-in-sub-group.git',
+    repository: 'org/sub-group/repo-in-sub-group'
+  });
+
+  t.deepEqual(parseGitUrl('git@github.com:org/example.com.git'), {
+    host: 'github.com',
+    owner: 'org',
+    project: 'example.com',
+    protocol: 'ssh',
+    remote: 'git@github.com:org/example.com.git',
+    repository: 'org/example.com'
+  });
+
+  t.deepEqual(parseGitUrl('file://Users/john/doe/owner/project'), {
+    host: 'users',
+    owner: 'owner',
+    project: 'project',
+    protocol: 'file',
+    remote: 'file://users/john/doe/owner/project',
+    repository: 'owner/project'
+  });
+
+  t.deepEqual(parseGitUrl('/Users/john/doe/owner/project'), {
+    host: 'users',
+    owner: 'owner',
+    project: 'project',
+    protocol: 'file',
+    remote: 'file://users/john/doe/owner/project',
+    repository: 'owner/project'
+  });
+
+  t.deepEqual(parseGitUrl('C:\\\\Users\\john\\doe\\owner\\project'), {
+    host: 'users',
+    owner: 'owner',
+    project: 'project',
+    protocol: 'file',
+    remote: 'file://users/john/doe/owner/project',
+    repository: 'owner/project'
+  });
+});
+
+test('parseVersion', t => {
+  t.deepEqual(parseVersion(), { version: undefined, isPreRelease: false, preReleaseId: null });
+  t.deepEqual(parseVersion(0), { version: '0.0.0', isPreRelease: false, preReleaseId: null });
+  t.deepEqual(parseVersion(1), { version: '1.0.0', isPreRelease: false, preReleaseId: null });
+  t.deepEqual(parseVersion('1'), { version: '1.0.0', isPreRelease: false, preReleaseId: null });
+  t.deepEqual(parseVersion('1.0'), { version: '1.0.0', isPreRelease: false, preReleaseId: null });
+  t.deepEqual(parseVersion('1.0.0'), { version: '1.0.0', isPreRelease: false, preReleaseId: null });
+  t.deepEqual(parseVersion('1.0.0-0'), { version: '1.0.0-0', isPreRelease: true, preReleaseId: null });
+  t.deepEqual(parseVersion('1.0.0-next.1'), { version: '1.0.0-next.1', isPreRelease: true, preReleaseId: 'next' });
+  t.deepEqual(parseVersion('21.04.1'), { version: '21.04.1', isPreRelease: false, preReleaseId: null });
+});

package/test/version.js

@@ -0,0 +1,173 @@
+import test from 'ava';
+import sinon from 'sinon';
+import Version from '../lib/plugin/version/Version.js';
+import { factory, runTasks } from './util/index.js';
+
+test('isValidVersion', t => {
+  const v = factory(Version);
+  t.is(v.isValid('1.0.0'), true);
+  t.is(v.isValid(1.0), false);
+});
+
+test('isPreRelease', t => {
+  const v = factory(Version);
+  t.is(v.isPreRelease('1.0.0-beta.0'), true);
+  t.is(v.isPreRelease('1.0.0'), false);
+});
+
+test('should return the same version in both interactive and ci mode', async t => {
+  const v = factory(Version);
+  const options = { latestVersion: '2.0.0-beta.1', increment: null, preReleaseId: 'rc', isPreRelease: true };
+  const resultInteractiveMode = await v.getIncrementedVersion(options);
+  t.is(resultInteractiveMode, '2.0.0-rc.0');
+  const resultCiMode = v.getIncrementedVersionCI(options);
+  t.is(resultInteractiveMode, resultCiMode);
+});
+
+test('should increment latest version', t => {
+  const v = factory(Version);
+  const latestVersion = '1.0.0';
+  t.is(v.incrementVersion({ latestVersion, increment: false }), '1.0.0');
+  t.is(v.incrementVersion({ latestVersion, increment: 'foo' }), undefined);
+  t.is(v.incrementVersion({ latestVersion, increment: 'patsj' }), undefined);
+  t.is(v.incrementVersion({ latestVersion, increment: 'a.b.c' }), undefined);
+  t.is(v.incrementVersion({ latestVersion, increment: '0.9.0' }), undefined);
+  t.is(v.incrementVersion({ latestVersion, increment: '1.1.0' }), '1.1.0');
+  t.is(v.incrementVersion({ latestVersion, increment: 'major' }), '2.0.0');
+  t.is(v.incrementVersion({ latestVersion, increment: '2.0.0-beta.1' }), '2.0.0-beta.1');
+});
+
+test('should not increment latest version in interactive mode', t => {
+  const v = factory(Version, { options: { ci: false } });
+  const latestVersion = '1.0.0';
+  t.is(v.incrementVersion({ latestVersion, increment: null }), undefined);
+  t.is(v.incrementVersion({ latestVersion, increment: false }), '1.0.0');
+});
+
+test('should always set increment version in CI mode', t => {
+  const v = factory(Version, { options: { ci: true } });
+  const latestVersion = '1.0.0';
+  t.is(v.getIncrementedVersionCI({ latestVersion, increment: false }), '1.0.0');
+  t.is(v.getIncrementedVersionCI({ latestVersion, increment: null }), '1.0.1');
+  t.is(v.getIncrementedVersionCI({ latestVersion, increment: '1.1.0' }), '1.1.0');
+  t.is(v.getIncrementedVersionCI({ latestVersion, increment: 'major' }), '2.0.0');
+});
+
+test('should increment latest version (coerce)', t => {
+  const v = factory(Version);
+  t.is(v.incrementVersion({ increment: '1.2' }), '1.2.0');
+  t.is(v.incrementVersion({ increment: '1' }), '1.0.0');
+  t.is(v.incrementVersion({ increment: 'v1.2.0.0' }), '1.2.0');
+});
+
+test('should increment version (pre-release continuation)', t => {
+  const v = factory(Version);
+  t.is(v.incrementVersion({ latestVersion: '1.2.3-alpha.0', increment: 'prepatch' }), '1.2.4-0');
+});
+
+test('should increment version (prepatch)', t => {
+  const v = factory(Version);
+  t.is(v.incrementVersion({ latestVersion: '1.2.3', increment: 'prepatch', preReleaseId: 'alpha' }), '1.2.4-alpha.0');
+});
+
+test('should increment version (normalized)', t => {
+  const v = factory(Version);
+  t.is(
+    v.incrementVersion({ latestVersion: '1.2.3', increment: 'patch', preReleaseId: 'alpha', isPreRelease: true }),
+    '1.2.4-alpha.0'
+  );
+});
+
+test('should increment version (prepatch on prerelease version)', t => {
+  const v = factory(Version);
+  t.is(
+    v.incrementVersion({ latestVersion: '1.2.3-alpha.5', increment: 'prepatch', preReleaseId: 'next' }),
+    '1.2.4-next.0'
+  );
+});
+
+test('should increment version (normalized on prerelease version)', t => {
+  const v = factory(Version);
+  t.is(
+    v.incrementVersion({
+      latestVersion: '1.2.3-alpha.5',
+      increment: 'patch',
+      preReleaseId: 'next',
+      isPreRelease: true
+    }),
+    '1.2.4-next.0'
+  );
+});
+
+test('should increment version (prerelease)', t => {
+  const v = factory(Version);
+  t.is(v.incrementVersion({ latestVersion: '1.2.3', increment: 'prerelease', preReleaseId: 'alpha' }), '1.2.4-alpha.0');
+});
+
+test('should increment version (prerelease cont.)', t => {
+  const v = factory(Version);
+  t.is(v.incrementVersion({ latestVersion: '1.2.3-alpha.0', increment: 'prerelease' }), '1.2.3-alpha.1');
+});
+
+test('should increment version (preReleaseId continuation)', t => {
+  const v = factory(Version);
+  t.is(
+    v.incrementVersion({ latestVersion: '1.2.3-alpha.0', increment: 'prerelease', preReleaseId: 'alpha' }),
+    '1.2.3-alpha.1'
+  );
+});
+
+test('should increment version (prepatch/preReleaseId continuation)', t => {
+  const v = factory(Version);
+  const options = { latestVersion: '1.2.3-beta.0', increment: 'prerelease', preReleaseId: 'beta', isPreRelease: true };
+  t.is(v.incrementVersion(options), '1.2.3-beta.1');
+});
+
+test('should increment version (preReleaseId w/o preRelease)', t => {
+  const v = factory(Version);
+  t.is(v.incrementVersion({ latestVersion: '1.2.3-alpha.0', increment: 'patch', preReleaseId: 'alpha' }), '1.2.3');
+});
+
+test('should increment version (non-numeric prepatch continuation)', t => {
+  const v = factory(Version);
+  t.is(v.incrementVersion({ latestVersion: '1.2.3-alpha', increment: 'prerelease' }), '1.2.3-alpha.0');
+});
+
+test('should increment version (patch release after pre-release)', t => {
+  const v = factory(Version);
+  t.is(v.incrementVersion({ latestVersion: '1.2.3-alpha.1', increment: 'patch' }), '1.2.3');
+});
+
+test('should run tasks without errors', async t => {
+  const options = { version: { increment: 'minor' } };
+  const v = factory(Version, { options });
+  const getIncrement = sinon.spy(v, 'getIncrement');
+  const getIncrementedVersionCI = sinon.spy(v, 'getIncrementedVersionCI');
+  const incrementVersion = sinon.spy(v, 'incrementVersion');
+
+  await runTasks(v);
+
+  t.is(getIncrement.callCount, 1);
+  t.deepEqual(getIncrement.firstCall.args[0], { increment: 'minor' });
+  t.is(getIncrementedVersionCI.callCount, 1);
+  t.deepEqual(getIncrementedVersionCI.firstCall.args[0], {
+    latestVersion: '1.0.0',
+    increment: 'minor',
+    isPreRelease: false,
+    preReleaseId: null
+  });
+  t.is(await incrementVersion.firstCall.returnValue, '1.1.0');
+  t.is(incrementVersion.callCount, 1);
+  t.deepEqual(incrementVersion.firstCall.args[0], {
+    latestVersion: '1.0.0',
+    increment: 'minor',
+    isPreRelease: false,
+    preReleaseId: null
+  });
+  t.is(incrementVersion.firstCall.returnValue, '1.1.0');
+  const { latestVersion, version, isPreRelease, preReleaseId } = v.config.getContext();
+  t.is(latestVersion, '1.0.0');
+  t.is(version, '1.1.0');
+  t.is(isPreRelease, false);
+  t.is(preReleaseId, null);
+});