chore: check for release ticket on release start (#3473)

mcasimir · addaleax · web-flow · commit f2035a5528d1 · 2022-09-15T18:32:54.000+02:00
* chore: check for release ticket on release start

* Update packages/compass/release/jira.js

Co-authored-by: Anna Henningsen &lt;anna.henningsen@mongodb.com&gt;

* update function call

* fix tests

* Update packages/compass/release/commands.js

Co-authored-by: Anna Henningsen &lt;anna.henningsen@mongodb.com&gt;

Co-authored-by: Anna Henningsen &lt;anna.henningsen@mongodb.com&gt;
diff --git a/packages/compass/release/commands.js b/packages/compass/release/commands.js
@@ -9,6 +9,7 @@ const git = require('./git');
 const npm = require('./npm');
 
 const ux = require('./ux');
+const { checkReleaseTicketInProgress } = require('./jira');
 
 async function getPackageJsonVersion() {
   return require(await pkgUp()).version;
@@ -18,7 +19,9 @@ async function getValidReleaseBranch() {
   const currentBranch = await git.getCurrentBranch();
 
   if (!branch.isReleaseBranch(currentBranch)) {
-    throw new Error(`The current branch (${currentBranch}) is not a release branch.`);
+    throw new Error(
+      `The current branch (${currentBranch}) is not a release branch.`
+    );
   }
 
   return currentBranch;
@@ -55,19 +58,23 @@ async function startRelease(bumpFn, evergreenProject) {
   const newSemver = bumpFn(packageJsonVersion, currentBranch);
 
   const answer = await cli.confirm(
-    `Are you sure you want to bump from ${chalk.bold(packageJsonVersion)} `
-    + `to ${chalk.bold(newSemver)} and release?`
+    `Are you sure you want to bump from ${chalk.bold(packageJsonVersion)} ` +
+      `to ${chalk.bold(newSemver)} and release?`
   );
 
   if (!answer) {
     cli.info('cancelled.');
     return;
   }
 
+  await checkReleaseTicketInProgress(newSemver);
+
   cli.info(
     '\n\n',
     ux.manualAction(
-      `Make sure that ${chalk.bold(evergreenProject)} is building from ${chalk.bold(currentBranch)}:\n`,
+      `Make sure that ${chalk.bold(
+        evergreenProject
+      )} is building from ${chalk.bold(currentBranch)}:\n`,
       ux.link(`https://evergreen.mongodb.com/projects##${evergreenProject}`)
     ),
     '\n'
@@ -76,10 +83,7 @@ async function startRelease(bumpFn, evergreenProject) {
   cli.info('Press enter to continue or Ctrl+C to abort....');
   ux.waitForEnter();
 
-  await commitAndPushNewVersion(
-    newSemver,
-    currentBranch
-  );
+  await commitAndPushNewVersion(newSemver, currentBranch);
 
   cli.info(
     '\n',
@@ -124,7 +128,8 @@ async function releaseCheckout(versionLike) {
       '\n',
       ux.manualAction(
         'You just checked out a new release branch that does not exist in the remote. Run:\n',
-        ux.command(`git push -u origin ${releaseBranchName}`), '\n',
+        ux.command(`git push -u origin ${releaseBranchName}`),
+        '\n',
         'to create the remote branch before proceeding with the release.'
       ),
       '\n'
@@ -137,5 +142,5 @@ async function releaseCheckout(versionLike) {
 module.exports = {
   releaseBeta,
   releaseGa,
-  releaseCheckout
+  releaseCheckout,
 };
diff --git a/packages/compass/release/index.intercept.js b/packages/compass/release/index.intercept.js
@@ -8,17 +8,31 @@ const path = require('path');
 
 nock('https://info-mongodb-com.s3.amazonaws.com')
   .get('/com-download-center/compass.json')
-  .replyWithFile(
-    200, path.resolve(__dirname, 'fixtures', 'config.json'));
+  .replyWithFile(200, path.resolve(__dirname, 'fixtures', 'config.json'));
 
 nock('https://info-mongodb-com.s3.amazonaws.com')
   .put('/com-download-center/compass.json')
   .reply(200);
 
-nock('https://downloads.mongodb.com')
-  .head(/.*/)
+nock('https://downloads.mongodb.com').head(/.*/).times(9999).reply(200);
+
+nock('https://jira.mongodb.org')
+  .get(/.*/)
   .times(9999)
-  .reply(200);
+  .reply(
+    200,
+    JSON.stringify({
+      issues: [
+        {
+          key: 'COMPASS-6087',
+          fields: {
+            status: {
+              name: 'In Progress',
+            },
+          },
+        },
+      ],
+    })
+  );
 
 require('./index');
-
diff --git a/packages/compass/release/index.spec.js b/packages/compass/release/index.spec.js
@@ -14,8 +14,8 @@ async function runReleaseCommand(args, options = {}) {
     ...options,
     env: {
       ...options.env,
-      MONGODB_COMPASS_RELEASE_MAX_WAIT_TIME: '0'
-    }
+      MONGODB_COMPASS_RELEASE_MAX_WAIT_TIME: '0',
+    },
   };
 
   const proc = execa(
@@ -40,7 +40,7 @@ async function checkoutBranch(branchName, options) {
   }
 }
 
-describe('release', function() {
+describe('release', function () {
   if (!!process.env.EVERGREEN && process.platform === 'darwin') {
     // These tests are not working well on Evergreen macOS machines and we will
     // skip them for now (they will run in GitHub CI)
@@ -49,7 +49,7 @@ describe('release', function() {
     return;
   }
 
-  afterEach(function() {
+  afterEach(function () {
     while (running.length) {
       running.shift().kill('SIGTERM', { forceKillAfterTimeout: 100 });
     }
@@ -59,7 +59,7 @@ describe('release', function() {
   let remote;
   let repoPath;
 
-  beforeEach(async function() {
+  beforeEach(async function () {
     tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'compass-release-tests-'));
 
     // create fake git remote:
@@ -89,7 +89,7 @@ describe('release', function() {
   });
 
   // eslint-disable-next-line mocha/no-sibling-hooks
-  afterEach(function() {
+  afterEach(function () {
     try {
       fs.removeSync(tempDir);
     } catch (e) {
@@ -98,134 +98,172 @@ describe('release', function() {
     }
   });
 
-  it('prints usage if no argument is passed', async function() {
-    const { stdout, failed } = await (runReleaseCommand(['']).catch(e => e));
+  it('prints usage if no argument is passed', async function () {
+    const { stdout, failed } = await runReleaseCommand(['']).catch((e) => e);
     expect(failed).to.be.true;
     expect(stdout).to.contain('USAGE');
   });
 
-  describe('checkout', function() {
-    it('creates a new branch if not exists', async function() {
+  describe('checkout', function () {
+    it('creates a new branch if not exists', async function () {
       await runReleaseCommand(['checkout', '1.12']);
-      const { stdout } = await execa('git', ['rev-parse', '--abbrev-ref', 'HEAD']);
+      const { stdout } = await execa('git', [
+        'rev-parse',
+        '--abbrev-ref',
+        'HEAD',
+      ]);
       expect(stdout).to.equal('1.12-releases');
     });
 
-    it('checks out an existing branch', async function() {
+    it('checks out an existing branch', async function () {
       await checkoutBranch('1.12-releases');
       await checkoutBranch(MAIN_BRANCH);
       await runReleaseCommand(['checkout', '1.12']);
-      const { stdout } = await execa('git', ['rev-parse', '--abbrev-ref', 'HEAD']);
+      const { stdout } = await execa('git', [
+        'rev-parse',
+        '--abbrev-ref',
+        'HEAD',
+      ]);
       expect(stdout).to.equal('1.12-releases');
     });
 
-    it('prints usage if no version is passed', async function() {
-      const { stdout, failed } = await (runReleaseCommand(['checkout']).catch(e => e));
+    it('prints usage if no version is passed', async function () {
+      const { stdout, failed } = await runReleaseCommand(['checkout']).catch(
+        (e) => e
+      );
       expect(failed).to.be.true;
       expect(stdout).to.contain('USAGE');
     });
 
-    it(`fails if branch is not ${MAIN_BRANCH}`, async function() {
+    it(`fails if branch is not ${MAIN_BRANCH}`, async function () {
       await checkoutBranch('some-branch');
-      const { stderr, failed } = await (runReleaseCommand(['checkout', '1.12']).catch(e => e));
+      const { stderr, failed } = await runReleaseCommand([
+        'checkout',
+        '1.12',
+      ]).catch((e) => e);
       expect(failed).to.be.true;
-      expect(stderr).to.contain(`The current branch is not the ${MAIN_BRANCH} branch`);
+      expect(stderr).to.contain(
+        `The current branch is not the ${MAIN_BRANCH} branch`
+      );
     });
   });
 
   [
     ['beta', '1.12.0-beta.0'],
-    ['ga', '1.12.0']
-  ].forEach(([ command, expectedVersion ]) => {
-    describe(command, function() {
-      it(`fails from ${MAIN_BRANCH}`, async function() {
+    ['ga', '1.12.0'],
+  ].forEach(([command, expectedVersion]) => {
+    describe(command, function () {
+      it(`fails from ${MAIN_BRANCH}`, async function () {
         await checkoutBranch(MAIN_BRANCH);
-        const { stderr, failed } = await (runReleaseCommand([command]).catch(e => e));
+        const { stderr, failed } = await runReleaseCommand([command]).catch(
+          (e) => e
+        );
         expect(failed).to.be.true;
-        expect(stderr).to.contain(`The current branch (${MAIN_BRANCH}) is not a release branch`);
+        expect(stderr).to.contain(
+          `The current branch (${MAIN_BRANCH}) is not a release branch`
+        );
       });
 
-      it('fails if branch is not a release branch', async function() {
+      it('fails if branch is not a release branch', async function () {
         await checkoutBranch('some-branch');
-        const { stderr, failed } = await (runReleaseCommand([command]).catch(e => e));
+        const { stderr, failed } = await runReleaseCommand([command]).catch(
+          (e) => e
+        );
         expect(failed).to.be.true;
-        expect(stderr).to.contain('The current branch (some-branch) is not a release branch');
+        expect(stderr).to.contain(
+          'The current branch (some-branch) is not a release branch'
+        );
       });
 
-      it('fails with untracked files', async function() {
+      it('fails with untracked files', async function () {
         fs.writeFileSync('README.md', '');
         await checkoutBranch('1.12-releases');
-        const { stderr, failed } = await (runReleaseCommand([command]).catch(e => e));
+        const { stderr, failed } = await runReleaseCommand([command]).catch(
+          (e) => e
+        );
         expect(failed).to.be.true;
         expect(stderr).to.contain('You have untracked or staged changes');
       });
 
-      it('fails with staged files', async function() {
+      it('fails with staged files', async function () {
         fs.writeFileSync('README.md', '');
         await checkoutBranch('1.12-releases');
         await execa('git', ['add', '.']);
-        const { stderr, failed } = await (runReleaseCommand([command]).catch(e => e));
+        const { stderr, failed } = await runReleaseCommand([command]).catch(
+          (e) => e
+        );
         expect(failed).to.be.true;
         expect(stderr).to.contain('You have untracked or staged changes');
       });
 
-      it('works with committed files', async function() {
+      it('works with committed files', async function () {
         fs.writeFileSync('README.md', '');
         await checkoutBranch('1.12-releases');
         await execa('git', ['add', '.']);
         await execa('git', ['commit', '-am', 'test']);
-        await runReleaseCommand([command], {input: 'N\n'});
+        await runReleaseCommand([command], { input: 'N\n' });
       });
 
-      it('asks for confirmation and skips if not confirmed', async function() {
-        expect(readPackageJsonVersion(
-          path.resolve(repoPath, './package.json')
-        )).to.equal('1.0.0');
+      it('asks for confirmation and skips if not confirmed', async function () {
+        expect(
+          readPackageJsonVersion(path.resolve(repoPath, './package.json'))
+        ).to.equal('1.0.0');
 
         await checkoutBranch('1.12-releases');
         const { stderr } = await runReleaseCommand([command], {
-          input: 'N\n'
+          input: 'N\n',
         });
 
         expect(stderr).to.contain(
-          `Are you sure you want to bump from 1.0.0 to ${expectedVersion} and release?`);
+          `Are you sure you want to bump from 1.0.0 to ${expectedVersion} and release?`
+        );
 
-        expect(readPackageJsonVersion(
-          path.resolve(repoPath, './package.json')
-        )).to.equal('1.0.0');
+        expect(
+          readPackageJsonVersion(path.resolve(repoPath, './package.json'))
+        ).to.equal('1.0.0');
       });
 
-      describe('from a release branch', function() {
+      describe('from a release branch', function () {
         let clonePath;
 
-        beforeEach(async function() {
+        beforeEach(async function () {
           await checkoutBranch('1.12-releases');
           await runReleaseCommand([command], {
             input: 'Y\n',
             stdout: 'inherit',
-            stderr: 'inherit'
+            stderr: 'inherit',
           });
 
           clonePath = path.resolve(tempDir, command);
-          await execa('git', ['clone', '--branch', MAIN_BRANCH, remote, clonePath]);
+          await execa('git', [
+            'clone',
+            '--branch',
+            MAIN_BRANCH,
+            remote,
+            clonePath,
+          ]);
         });
 
-        it(`does not affect ${MAIN_BRANCH}`, function() {
-          const version = readPackageJsonVersion(path.resolve(clonePath, 'package.json'));
+        it(`does not affect ${MAIN_BRANCH}`, function () {
+          const version = readPackageJsonVersion(
+            path.resolve(clonePath, 'package.json')
+          );
           expect(version).to.equal('1.0.0');
         });
 
-        it('bumps the package version', async function() {
-          await checkoutBranch('1.12-releases', {cwd: clonePath});
-          const version = readPackageJsonVersion(path.resolve(clonePath, 'package.json'));
+        it('bumps the package version', async function () {
+          await checkoutBranch('1.12-releases', { cwd: clonePath });
+          const version = readPackageJsonVersion(
+            path.resolve(clonePath, 'package.json')
+          );
           expect(version).to.equal(expectedVersion);
         });
 
-        it('pushes tags', async function() {
-          await checkoutBranch('1.12-releases', {cwd: clonePath});
+        it('pushes tags', async function () {
+          await checkoutBranch('1.12-releases', { cwd: clonePath });
           await execa('git', ['fetch', '--all', '--tags']);
 
-          const { stdout } = await execa('git', ['tag'], {cwd: clonePath});
+          const { stdout } = await execa('git', ['tag'], { cwd: clonePath });
           expect(stdout.split('\n')).to.deep.equal([`v${expectedVersion}`]);
         });
       });
diff --git a/packages/compass/release/jira.js b/packages/compass/release/jira.js
