import test from 'ava'; import sinon from 'sinon'; import { RequestError } from '@octokit/request-error'; import GitHub from '../lib/plugin/github/GitHub.js'; import { factory, runTasks } from './util/index.js'; import { interceptAuthentication, interceptCollaborator, interceptListReleases, interceptCreate, interceptUpdate, interceptAsset } from './stub/github.js'; const tokenRef = 'GITHUB_TOKEN'; const pushRepo = 'git://github.com/user/repo'; const host = 'github.com'; const git = { changelog: '' }; const requestErrorOptions = { request: { url: '', headers: {} }, response: { headers: {} } }; test.serial('should check token and perform checks', async t => { const tokenRef = 'MY_GITHUB_TOKEN'; const options = { github: { release: true, tokenRef, pushRepo } }; const github = factory(GitHub, { options }); process.env[tokenRef] = '123'; // eslint-disable-line require-atomic-updates interceptAuthentication(); interceptCollaborator(); await t.notThrowsAsync(github.init()); }); test.serial('should check token and warn', async t => { const tokenRef = 'MY_GITHUB_TOKEN'; const options = { github: { release: true, tokenRef, pushRepo } }; const github = factory(GitHub, { options }); delete process.env[tokenRef]; await t.notThrowsAsync(github.init()); t.is(github.log.warn.args[0][0], 'Environment variable "MY_GITHUB_TOKEN" is required for automated GitHub Releases.'); t.is(github.log.warn.args[1][0], 'Falling back to web-based GitHub Release.'); }); test('should release and upload assets', async t => { const options = { git, github: { pushRepo, tokenRef, release: true, releaseName: 'Release ${tagName}', releaseNotes: 'echo Custom notes', assets: 'test/resources/file-v${version}.txt' } }; const github = factory(GitHub, { options }); const exec = sinon.stub(github.shell, 'exec').callThrough(); exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves(''); exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1'); interceptAuthentication(); interceptCollaborator(); interceptCreate({ body: { tag_name: '2.0.2', name: 'Release 2.0.2', body: 'Custom notes' } }); interceptAsset({ body: '*' }); await runTasks(github); const { isReleased, releaseUrl } = github.getContext(); t.true(isReleased); t.is(releaseUrl, 'https://github.com/user/repo/releases/tag/2.0.2'); exec.restore(); }); test('should create a pre-release and draft release notes', async t => { const options = { git, github: { pushRepo, tokenRef, release: true, releaseName: 'Release ${tagName}', preRelease: true, draft: true } }; const github = factory(GitHub, { options }); const exec = sinon.stub(github.shell, 'exec').callThrough(); exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves(''); exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1'); interceptAuthentication(); interceptCollaborator(); interceptCreate({ body: { tag_name: '2.0.2', name: 'Release 2.0.2', prerelease: true, draft: true } }); await runTasks(github); const { isReleased, releaseUrl } = github.getContext(); t.true(isReleased); t.is(releaseUrl, 'https://github.com/user/repo/releases/tag/2.0.2'); exec.restore(); }); test('should create auto-generated release notes', async t => { const options = { git, github: { pushRepo, tokenRef, release: true, releaseName: 'Release ${tagName}', autoGenerate: true } }; const github = factory(GitHub, { options }); const exec = sinon.stub(github.shell, 'exec').callThrough(); exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1'); interceptAuthentication(); interceptCollaborator(); interceptCreate({ body: { tag_name: '2.0.2', name: 'Release 2.0.2', generate_release_notes: true, body: '' } }); await runTasks(github); const { isReleased, releaseUrl } = github.getContext(); t.true(isReleased); t.is(releaseUrl, 'https://github.com/user/repo/releases/tag/2.0.2'); exec.restore(); }); test('should update release and upload assets', async t => { const asset = 'file1'; const options = { increment: false, git, github: { update: true, pushRepo, tokenRef, release: true, releaseName: 'Release ${tagName}', releaseNotes: 'echo Custom notes', assets: `test/resources/${asset}` } }; const github = factory(GitHub, { options }); const exec = sinon.stub(github.shell, 'exec').callThrough(); exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves(''); exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1'); exec.withArgs('git rev-list 2.0.1 --tags --max-count=1').resolves('a123456'); exec.withArgs('git describe --tags --abbrev=0 "a123456^"').resolves('2.0.1'); interceptAuthentication(); interceptCollaborator(); interceptListReleases({ tag_name: '2.0.1' }); interceptUpdate({ body: { tag_name: '2.0.1', name: 'Release 2.0.1', body: 'Custom notes' } }); interceptAsset({ body: asset }); await runTasks(github); const { isReleased, releaseUrl } = github.getContext(); t.true(isReleased); t.is(releaseUrl, 'https://github.com/user/repo/releases/tag/2.0.1'); exec.restore(); }); test('should create new release for unreleased tag', async t => { const options = { increment: false, git, github: { update: true, pushRepo, tokenRef, release: true, releaseName: 'Release ${tagName}', releaseNotes: 'echo Custom notes' } }; const github = factory(GitHub, { options }); const exec = sinon.stub(github.shell, 'exec').callThrough(); exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves(''); exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1'); exec.withArgs('git rev-list 2.0.1 --tags --max-count=1').resolves('b123456'); exec.withArgs('git describe --tags --abbrev=0 "b123456^"').resolves('2.0.1'); interceptAuthentication(); interceptCollaborator(); interceptListReleases({ tag_name: '2.0.0' }); interceptCreate({ body: { tag_name: '2.0.1', name: 'Release 2.0.1', body: 'Custom notes' } }); await runTasks(github); const { isReleased, releaseUrl } = github.getContext(); t.true(isReleased); t.is(releaseUrl, 'https://github.com/user/repo/releases/tag/2.0.1'); exec.restore(); }); test('should release to enterprise host', async t => { const options = { git, github: { tokenRef, pushRepo: 'git://github.example.org/user/repo' } }; const github = factory(GitHub, { options }); const exec = sinon.stub(github.shell, 'exec').callThrough(); exec.withArgs('git remote get-url origin').resolves(`https://github.example.org/user/repo`); exec.withArgs('git config --get remote.origin.url').resolves(`https://github.example.org/user/repo`); exec.withArgs('git describe --tags --match=* --abbrev=0').resolves(`1.0.0`); const remote = { api: 'https://github.example.org/api/v3', host: 'github.example.org' }; interceptAuthentication(remote); interceptCollaborator(remote); interceptCreate(Object.assign({ body: { tag_name: '1.0.1' } }, remote)); await runTasks(github); const { isReleased, releaseUrl } = github.getContext(); t.true(isReleased); t.is(releaseUrl, `https://github.example.org/user/repo/releases/tag/1.0.1`); exec.restore(); }); test('should release to alternative host and proxy', async t => { const remote = { api: 'https://custom.example.org/api/v3', host: 'custom.example.org' }; interceptAuthentication(remote); interceptCollaborator(remote); interceptCreate(Object.assign({ body: { tag_name: '1.0.1' } }, remote)); const options = { git, github: { tokenRef, pushRepo: `git://custom.example.org/user/repo`, host: 'custom.example.org', proxy: 'http://proxy:8080' } }; const github = factory(GitHub, { options }); const exec = sinon.stub(github.shell, 'exec').callThrough(); exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves(''); exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('1.0.0'); await runTasks(github); const { isReleased, releaseUrl } = github.getContext(); t.true(isReleased); t.is(releaseUrl, `https://custom.example.org/user/repo/releases/tag/1.0.1`); t.is(github.options.proxy, 'http://proxy:8080'); exec.restore(); }); test('should release to git.pushRepo', async t => { const remote = { api: 'https://custom.example.org/api/v3', host: 'custom.example.org' }; interceptCreate(Object.assign({ body: { tag_name: '1.0.1' } }, remote)); const options = { git: { pushRepo: 'upstream', changelog: '' }, github: { tokenRef, skipChecks: true } }; const github = factory(GitHub, { options }); const exec = sinon.stub(github.shell, 'exec').callThrough(); exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves(''); exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('1.0.0'); exec.withArgs('git remote get-url upstream').resolves('https://custom.example.org/user/repo'); await runTasks(github); const { isReleased, releaseUrl } = github.getContext(); t.true(isReleased); t.is(releaseUrl, 'https://custom.example.org/user/repo/releases/tag/1.0.1'); exec.restore(); }); const testSkipOnActions = process.env.GITHUB_ACTIONS ? test.skip : test; testSkipOnActions('should throw for unauthenticated user', async t => { const options = { github: { tokenRef, pushRepo, host } }; const github = factory(GitHub, { options }); const stub = sinon.stub(github.client.users, 'getAuthenticated'); stub.throws(new RequestError('Bad credentials', 401, requestErrorOptions)); await t.throwsAsync(runTasks(github), { message: /^Could not authenticate with GitHub using environment variable "GITHUB_TOKEN"/ }); t.is(stub.callCount, 1); stub.restore(); }); testSkipOnActions('should throw for non-collaborator', async t => { interceptAuthentication({ username: 'john' }); const options = { github: { tokenRef, pushRepo, host } }; const github = factory(GitHub, { options }); const stub = sinon.stub(github.client.repos, 'checkCollaborator'); stub.throws(new RequestError('HttpError', 401, requestErrorOptions)); await t.throwsAsync(runTasks(github), { message: /^User john is not a collaborator for user\/repo/ }); stub.restore(); }); test.serial('should skip authentication and collaborator checks when running on GitHub Actions', async t => { const { GITHUB_ACTIONS, GITHUB_ACTOR } = process.env; if (!GITHUB_ACTIONS) { process.env.GITHUB_ACTIONS = 1; process.env.GITHUB_ACTOR = 'webpro'; } const options = { github: { tokenRef } }; const github = factory(GitHub, { options }); const authStub = sinon.stub(github, 'isAuthenticated'); const collaboratorStub = sinon.stub(github, 'isCollaborator'); await t.notThrowsAsync(github.init()); t.is(authStub.callCount, 0); t.is(collaboratorStub.callCount, 0); t.is(github.getContext('username'), process.env.GITHUB_ACTOR); authStub.restore(); collaboratorStub.restore(); if (!GITHUB_ACTIONS) { process.env.GITHUB_ACTIONS = GITHUB_ACTIONS || ''; process.env.GITHUB_ACTOR = GITHUB_ACTOR || ''; } }); test('should handle octokit client error (without retries)', async t => { const github = factory(GitHub, { options: { github: { tokenRef, pushRepo, host } } }); const stub = sinon.stub(github.client.repos, 'createRelease'); stub.throws(new RequestError('Not found', 404, requestErrorOptions)); interceptAuthentication(); interceptCollaborator(); await t.throwsAsync(runTasks(github), { message: /^404 \(Not found\)/ }); t.is(stub.callCount, 1); stub.restore(); }); test('should handle octokit client error (with retries)', async t => { const options = { github: { tokenRef, pushRepo, host, retryMinTimeout: 0 } }; const github = factory(GitHub, { options }); const stub = sinon.stub(github.client.repos, 'createRelease'); stub.throws(new RequestError('Request failed', 500, requestErrorOptions)); interceptAuthentication(); interceptCollaborator(); await t.throwsAsync(runTasks(github), { message: /^500 \(Request failed\)/ }); t.is(stub.callCount, 3); stub.restore(); }); test('should not call octokit client in dry run', async t => { const options = { 'dry-run': true, git, github: { tokenRef, pushRepo, releaseName: 'R ${version}', assets: ['*'] } }; const github = factory(GitHub, { options }); const spy = sinon.spy(github, 'client', ['get']); const exec = sinon.stub(github.shell, 'exec').callThrough(); exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves(''); exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('v1.0.0'); await runTasks(github); t.is(spy.get.callCount, 0); t.is(github.log.exec.args[1][0], 'octokit repos.createRelease "R 1.0.1" (v1.0.1)'); t.is(github.log.exec.lastCall.args[0], 'octokit repos.uploadReleaseAssets'); const { isReleased, releaseUrl } = github.getContext(); t.true(isReleased); t.is(releaseUrl, 'https://github.com/user/repo/releases/tag/v1.0.1'); spy.get.restore(); exec.restore(); }); test('should skip checks', async t => { const options = { github: { tokenRef, skipChecks: true } }; const github = factory(GitHub, { options }); await t.notThrowsAsync(github.init()); }); test('should generate GitHub web release url', async t => { const options = { github: { pushRepo, release: true, web: true, releaseName: 'Release ${tagName}', releaseNotes: 'echo Custom notes' } }; const github = factory(GitHub, { options }); const exec = sinon.stub(github.shell, 'exec').callThrough(); exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves(''); exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1'); await runTasks(github); const { isReleased, releaseUrl } = github.getContext(); t.true(isReleased); t.is( releaseUrl, 'https://github.com/user/repo/releases/new?tag=2.0.2&title=Release+2.0.2&body=Custom+notes&prerelease=false' ); exec.restore(); }); test('should generate GitHub web release url for enterprise host', async t => { const options = { git, github: { pushRepo: 'git@custom.example.org:user/repo', release: true, web: true, host: 'custom.example.org', releaseName: 'The Launch', releaseNotes: 'echo It happened' } }; const github = factory(GitHub, { options }); const exec = sinon.stub(github.shell, 'exec').callThrough(); exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves(''); exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1'); await runTasks(github); const { isReleased, releaseUrl } = github.getContext(); t.true(isReleased); t.is( releaseUrl, 'https://custom.example.org/user/repo/releases/new?tag=2.0.2&title=The+Launch&body=It+happened&prerelease=false' ); exec.restore(); }); // eslint-disable-next-line ava/no-skip-test test.skip('should truncate long body', async t => { const releaseNotes = 'a'.repeat(125001); const body = 'a'.repeat(124000) + '...'; const options = { git, github: { pushRepo, tokenRef, release: true, releaseName: 'Release ${tagName}', releaseNotes: 'echo ' + releaseNotes } }; const github = factory(GitHub, { options }); const exec = sinon.stub(github.shell, 'exec').callThrough(); exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves(''); exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1'); interceptAuthentication(); interceptCollaborator(); interceptCreate({ body: { tag_name: '2.0.2', name: 'Release 2.0.2', body } }); await runTasks(github); const { isReleased, releaseUrl } = github.getContext(); t.true(isReleased); t.is(releaseUrl, 'https://github.com/user/repo/releases/tag/2.0.2'); exec.restore(); });