release-it 19.0.0-next.0 → 19.0.0-next.2

package/test/config.js

@@ -1,6 +1,8 @@
-import test from 'ava';
+import test, { describe, before, after, afterEach } from 'node:test';
+import assert from 'node:assert/strict';
 import { isCI } from 'ci-info';
-import Config from '../lib/config.js';
+import { MockServer, FetchMocker } from 'mentoss';
+import Config, { getRemoteConfiguration } from '../lib/config.js';
 import { readJSON } from '../lib/util.js';
 
 const defaultConfig = readJSON(new URL('../config/release-it.json', import.meta.url));
@@ -8,152 +10,260 @@ const projectConfig = readJSON(new URL('../.release-it.json', import.meta.url));
 
 const localConfig = { github: { release: true } };
 
-test("should read this project's own configuration", t => {
-  const config = new Config();
-  t.deepEqual(config.constructorConfig, {});
-  t.deepEqual(config.localConfig, projectConfig);
-  t.deepEqual(config.defaultConfig, defaultConfig);
-});
+describe('config', () => {
+  test("should read this project's own configuration", () => {
+    const config = new Config();
+    assert.deepEqual(config.constructorConfig, {});
+    assert.deepEqual(config.localConfig, projectConfig);
+    assert.deepEqual(config.defaultConfig, defaultConfig);
+  });
 
-test('should contain default values', t => {
-  const config = new Config({ configDir: './test/stub/config/default' });
-  t.deepEqual(config.constructorConfig, { configDir: './test/stub/config/default' });
-  t.deepEqual(config.localConfig, localConfig);
-  t.deepEqual(config.defaultConfig, defaultConfig);
-});
+  test('should contain default values', () => {
+    const config = new Config({ configDir: './test/stub/config/default' });
+    assert.deepEqual(config.constructorConfig, { configDir: './test/stub/config/default' });
+    assert.deepEqual(config.localConfig, localConfig);
+    assert.deepEqual(config.defaultConfig, defaultConfig);
+  });
 
-test('should merge provided options', t => {
-  const config = new Config({
-    configDir: './test/stub/config/merge',
-    increment: '1.0.0',
-    verbose: true,
-    github: {
-      release: true
-    }
-  });
-  const { options } = config;
-  t.is(config.isVerbose, true);
-  t.is(config.isDryRun, false);
-  t.is(options.increment, '1.0.0');
-  t.is(options.git.push, false);
-  t.is(options.github.release, true);
-});
+  test('should merge provided options', () => {
+    const config = new Config({
+      configDir: './test/stub/config/merge',
+      increment: '1.0.0',
+      verbose: true,
+      github: {
+        release: true
+      }
+    });
+    const { options } = config;
+    assert.equal(config.isVerbose, true);
+    assert.equal(config.isDryRun, false);
+    assert.equal(options.increment, '1.0.0');
+    assert.equal(options.git.push, false);
+    assert.equal(options.github.release, true);
+  });
 
-test('should set CI mode', t => {
-  const config = new Config({ ci: true });
-  t.is(config.isCI, true);
-});
+  test('should set CI mode', () => {
+    const config = new Config({ ci: true });
+    assert.equal(config.isCI, true);
+  });
 
-test('should detect CI mode', t => {
-  const config = new Config();
-  t.is(config.options.ci, isCI);
-  t.is(config.isCI, isCI);
-});
+  test('should detect CI mode', () => {
+    const config = new Config();
+    assert.equal(config.options.ci, isCI);
+    assert.equal(config.isCI, isCI);
+  });
 
-test('should override --no-npm.publish', t => {
-  const config = new Config({ npm: { publish: false } });
-  t.is(config.options.npm.publish, false);
-});
+  test('should override --no-npm.publish', () => {
+    const config = new Config({ npm: { publish: false } });
+    assert.equal(config.options.npm.publish, false);
+  });
 
-test('should read YAML config', t => {
-  const config = new Config({ configDir: './test/stub/config/yaml' });
-  t.deepEqual(config.options.foo, { bar: 1 });
-});
+  test('should read YAML config', () => {
+    const config = new Config({ configDir: './test/stub/config/yaml' });
+    assert.deepEqual(config.options.foo, { bar: 1 });
+  });
 
-test('should read YML config', t => {
-  const config = new Config({ configDir: './test/stub/config/yml' });
-  t.deepEqual(config.options.foo, { bar: 1 });
-});
+  test('should read YML config', () => {
+    const config = new Config({ configDir: './test/stub/config/yml' });
+    assert.deepEqual(config.options.foo, { bar: 1 });
+  });
 
-test('should read TOML config', t => {
-  const config = new Config({ configDir: './test/stub/config/toml' });
-  t.deepEqual(config.options.foo, { bar: 1 });
-});
+  test('should read TOML config', () => {
+    const config = new Config({ configDir: './test/stub/config/toml' });
+    assert.deepEqual(config.options.foo, { bar: 1 });
+  });
 
-test('should throw if provided config file is not found', t => {
-  t.throws(() => new Config({ config: 'nofile' }), { message: /no such file.+nofile/ });
-});
+  test('should throw if provided config file is not found', () => {
+    assert.throws(() => new Config({ config: 'nofile' }), /no such file.+nofile/);
+  });
 
-test('should throw if provided config file is invalid (cosmiconfig exception)', t => {
-  t.throws(() => new Config({ config: './test/stub/config/invalid-config-txt' }), {
-    message: /Invalid configuration file at/
+  test('should throw if provided config file is invalid (cosmiconfig exception)', () => {
+    assert.throws(
+      () => new Config({ config: './test/stub/config/invalid-config-txt' }),
+      /Invalid configuration file at/
+    );
   });
-});
 
-test('should throw if provided config file is invalid (no object)', t => {
-  t.throws(() => new Config({ config: './test/stub/config/invalid-config-rc' }), {
-    message: /Invalid configuration file at/
+  test('should throw if provided config file is invalid (no object)', () => {
+    assert.throws(
+      () => new Config({ config: './test/stub/config/invalid-config-rc' }),
+      /Invalid configuration file at/
+    );
   });
-});
 
-test('should not set default increment (for CI mode)', t => {
-  const config = new Config({ ci: true });
-  t.is(config.options.version.increment, undefined);
-});
+  test('should not set default increment (for CI mode)', () => {
+    const config = new Config({ ci: true });
+    assert.equal(config.options.version.increment, undefined);
+  });
 
-test('should not set default increment (for interactive mode)', t => {
-  const config = new Config({ ci: false });
-  t.is(config.options.version.increment, undefined);
-});
+  test('should not set default increment (for interactive mode)', () => {
+    const config = new Config({ ci: false });
+    assert.equal(config.options.version.increment, undefined);
+  });
 
-test('should expand pre-release shortcut', t => {
-  const config = new Config({ increment: 'major', preRelease: 'beta' });
-  t.deepEqual(config.options.version, {
-    increment: 'major',
-    isPreRelease: true,
-    preReleaseBase: undefined,
-    preReleaseId: 'beta'
+  test('should expand pre-release shortcut', () => {
+    const config = new Config({ increment: 'major', preRelease: 'beta' });
+    assert.deepEqual(config.options.version, {
+      increment: 'major',
+      isPreRelease: true,
+      preReleaseBase: undefined,
+      preReleaseId: 'beta'
+    });
   });
-});
 
-test('should expand pre-release shortcut (preRelease boolean)', t => {
-  const config = new Config({ ci: true, preRelease: true });
-  t.deepEqual(config.options.version, {
-    increment: undefined,
-    isPreRelease: true,
-    preReleaseBase: undefined,
-    preReleaseId: undefined
+  test('should expand pre-release shortcut (preRelease boolean)', () => {
+    const config = new Config({ ci: true, preRelease: true });
+    assert.deepEqual(config.options.version, {
+      increment: undefined,
+      isPreRelease: true,
+      preReleaseBase: undefined,
+      preReleaseId: undefined
+    });
   });
-});
 
-test('should expand pre-release shortcut (without increment)', t => {
-  const config = new Config({ ci: false, preRelease: 'alpha' });
-  t.deepEqual(config.options.version, {
-    increment: undefined,
-    isPreRelease: true,
-    preReleaseBase: undefined,
-    preReleaseId: 'alpha'
+  test('should expand pre-release shortcut (without increment)', () => {
+    const config = new Config({ ci: false, preRelease: 'alpha' });
+    assert.deepEqual(config.options.version, {
+      increment: undefined,
+      isPreRelease: true,
+      preReleaseBase: undefined,
+      preReleaseId: 'alpha'
+    });
   });
-});
 
-test('should expand pre-release shortcut (including increment and npm.tag)', t => {
-  const config = new Config({ increment: 'minor', preRelease: 'rc' });
-  t.deepEqual(config.options.version, {
-    increment: 'minor',
-    isPreRelease: true,
-    preReleaseBase: undefined,
-    preReleaseId: 'rc'
+  test('should expand pre-release shortcut (including increment and npm.tag)', () => {
+    const config = new Config({ increment: 'minor', preRelease: 'rc' });
+    assert.deepEqual(config.options.version, {
+      increment: 'minor',
+      isPreRelease: true,
+      preReleaseBase: undefined,
+      preReleaseId: 'rc'
+    });
+  });
+
+  test('should use pre-release base', () => {
+    const config = new Config({ increment: 'minor', preRelease: 'next', preReleaseBase: '1' });
+    assert.deepEqual(config.options.version, {
+      increment: 'minor',
+      isPreRelease: true,
+      preReleaseBase: '1',
+      preReleaseId: 'next'
+    });
   });
-});
 
-test('should use pre-release base', t => {
-  const config = new Config({ increment: 'minor', preRelease: 'next', preReleaseBase: '1' });
-  t.deepEqual(config.options.version, {
-    increment: 'minor',
-    isPreRelease: true,
-    preReleaseBase: '1',
-    preReleaseId: 'next'
+  test('should expand pre-release shortcut (snapshot)', () => {
+    const config = new Config({ snapshot: 'feat' });
+    assert.deepEqual(config.options.version, {
+      increment: 'prerelease',
+      isPreRelease: true,
+      preReleaseBase: undefined,
+      preReleaseId: 'feat'
+    });
+    assert.equal(config.options.git.tagMatch, '0.0.0-feat.[0-9]*');
+    assert.equal(config.options.git.getLatestTagFromAllRefs, true);
   });
 });
 
-test('should expand pre-release shortcut (snapshot)', t => {
-  const config = new Config({ snapshot: 'feat' });
-  t.deepEqual(config.options.version, {
-    increment: 'prerelease',
-    isPreRelease: true,
-    preReleaseBase: undefined,
-    preReleaseId: 'feat'
+describe('fetch extended configuration', () => {
+  const server = new MockServer('https://raw.githubusercontent.com');
+
+  const mocker = new FetchMocker({
+    servers: [server]
+  });
+
+  before(() => {
+    mocker.mockGlobal();
+  });
+
+  afterEach(() => {
+    mocker.clearAll();
+  });
+
+  after(() => {
+    mocker.unmockGlobal();
+  });
+
+  test('should fetch extended configuration with default file and default branch', async () => {
+    server.get('/release-it/release-it-configuration/HEAD/.release-it.json', {
+      status: 200,
+      body: { git: { commitMessage: 'Released version ${version}' } }
+    });
+
+    const config = {
+      extends: 'github:release-it/release-it-configuration'
+    };
+
+    const extendedConfiguration = {
+      git: {
+        commitMessage: 'Released version ${version}'
+      }
+    };
+
+    const response = await getRemoteConfiguration(config.extends);
+
+    assert.deepEqual(response, extendedConfiguration);
+  });
+
+  test('should fetch extended configuration with default file and specific tag', async () => {
+    server.get('/release-it/release-it-configuration/refs/tags/1.0.0/.release-it.json', {
+      status: 200,
+      body: { git: { commitMessage: 'Released version ${version}' } }
+    });
+
+    const config = {
+      extends: 'github:release-it/release-it-configuration#1.0.0'
+    };
+
+    const extendedConfiguration = {
+      git: {
+        commitMessage: 'Released version ${version}'
+      }
+    };
+
+    const response = await getRemoteConfiguration(config.extends);
+
+    assert.deepEqual(response, extendedConfiguration);
+  });
+
+  test('should fetch extended configuration with custom file and specific tag', async () => {
+    server.get('/release-it/release-it-configuration/refs/tags/1.0.0/config.json', {
+      status: 200,
+      body: { git: { commitMessage: 'Released version ${version}' } }
+    });
+
+    const config = {
+      extends: 'github:release-it/release-it-configuration:config.json#1.0.0'
+    };
+
+    const extendedConfiguration = {
+      git: {
+        commitMessage: 'Released version ${version}'
+      }
+    };
+
+    const response = await getRemoteConfiguration(config.extends);
+
+    assert.deepEqual(response, extendedConfiguration);
+  });
+
+  test('should fetch extended configuration with custom file and default branch', async () => {
+    server.get('/release-it/release-it-configuration/HEAD/config.json', {
+      status: 200,
+      body: { git: { commitMessage: 'Released version ${version}' } }
+    });
+
+    const config = {
+      extends: 'github:release-it/release-it-configuration:config.json'
+    };
+
+    const extendedConfiguration = {
+      git: {
+        commitMessage: 'Released version ${version}'
+      }
+    };
+
+    const response = await getRemoteConfiguration(config.extends);
+
+    assert.deepEqual(response, extendedConfiguration);
   });
-  t.is(config.options.git.tagMatch, '0.0.0-feat.[0-9]*');
-  t.true(config.options.git.getLatestTagFromAllRefs);
 });