land: add non-interactive mode

mmarchini · priyank-p · commit 1538e2153b00 · 2020-01-02T21:47:55.000-05:00
Non-interactive mode will try to land a Pull Request without asking any
questions. This is meant to be used by scripts and CI landing tools.
diff --git a/components/git/land.js b/components/git/land.js
@@ -30,6 +30,13 @@ const landOptions = {
   abort: {
     describe: 'Abort the current landing session',
     type: 'boolean'
+  },
+  yes: {
+    type: 'boolean',
+    default: false,
+    describe: 'Assume "yes" as answer to all prompts and run ' +
+    'non-interactively. If an undesirable situation occurs, such as a pull ' +
+    'request or commit check fails, then git node land will abort.'
   }
 };
 
@@ -93,6 +100,9 @@ function handler(argv) {
 
 function land(state, argv) {
   const cli = new CLI(process.stderr);
+  if (argv.yes) {
+    cli.setAssumeYes();
+  }
   const req = new Request();
   const dir = process.cwd();
 
diff --git a/docs/git-node.md b/docs/git-node.md
@@ -40,6 +40,11 @@ Options:
   --continue, -c  Continue the landing session                         [boolean]
   --final         Verify the landed PR and clean up                    [boolean]
   --abort         Abort the current landing session                    [boolean]
+  --yes           Assume "yes" as answer to all prompts and run
+                  non-interactively. If an undesirable situation occurs, such as
+                  a pull request or commit check fails, then git node land will
+                  abort.                              [boolean] [default: false]
+
 
 Examples:
   git node land 12344       Land https://github.com/nodejs/node/pull/12344 in
diff --git a/lib/cli.js b/lib/cli.js
@@ -24,6 +24,7 @@ class CLI {
     this.spinner = ora({ stream: this.stream });
     this.SPINNER_STATUS = SPINNER_STATUS;
     this.figureIndent = '   ';
+    this.assumeYes = false;
   }
 
   get eolIndent() {
@@ -36,6 +37,9 @@ class CLI {
 
   async prompt(question, defaultAnswer = true) {
     this.separator();
+    if (this.assumeYes) {
+      return defaultAnswer;
+    }
     const { answer } = await inquirer.prompt([{
       type: 'confirm',
       name: 'answer',
@@ -45,6 +49,10 @@ class CLI {
     return answer;
   }
 
+  setAssumeYes() {
+    this.assumeYes = true;
+  }
+
   startSpinner(text) {
     this.spinner.text = text;
     this.spinner.start();
diff --git a/lib/landing_session.js b/lib/landing_session.js
@@ -22,21 +22,27 @@ class LandingSession extends Session {
     const { cli } = this;
     this.startLanding();
     const status = metadata.status ? 'should be ready' : 'is not ready';
+    // NOTE(mmarchini): default answer is yes. If --yes is given, we need to be
+    // more careful though, and we change the default to the result of our
+    // metadata check.
+    const defaultAnswer = !cli.assumeYes ? true : metadata.status;
     const shouldContinue = await cli.prompt(
-      `This PR ${status} to land, do you want to continue?`);
+      `This PR ${status} to land, do you want to continue?`, defaultAnswer);
     if (!shouldContinue) {
-      return this.abort();
+      return this.abort(false);
     }
 
     this.saveMetadata(metadata);
     this.startApplying();
     return this.apply();
   }
 
-  async abort() {
+  async abort(tryResetBranch = true) {
     const { cli } = this;
     this.cleanFiles();
-    await this.tryResetBranch();
+    if (tryResetBranch) {
+      await this.tryResetBranch();
+    }
     cli.ok(`Aborted \`git node land\` session in ${this.ncuDir}`);
   }
 
diff --git a/test/unit/cli.test.js b/test/unit/cli.test.js
@@ -165,4 +165,24 @@ describe('cli', () => {
       });
     });
   });
+
+  describe('prompt assume yes', () => {
+    beforeEach(() => {
+      stream = new LogStream();
+      cli = new CLI(stream);
+      cli.setAssumeYes();
+    });
+
+    it('should return true if no default is given', async() => {
+      assert.strictEqual(await cli.prompt('Question?'), true);
+    });
+
+    it('should return true if default is set to true', async() => {
+      assert.strictEqual(await cli.prompt('Question?', true), true);
+    });
+
+    it('should return false if default is set to false', async() => {
+      assert.strictEqual(await cli.prompt('Question?', false), false);
+    });
+  });
 });
