Prompt user when creating default project with env vars set (#21)

twilio · May 8, 2019 · 5c99608 · 5c99608
1 parent 272564b
commit 5c99608
Show file tree

Hide file tree

Showing 2 changed files with 82 additions and 21 deletions.
diff --git a/src/commands/project/add.js b/src/commands/project/add.js
@@ -30,17 +30,19 @@ class ProjectAdd extends BaseCommand {
 
     this.loadArguments();
 
+    if (!await this.confirmDefaultProjectAndEnvVars()) {
+      this.cancel();
+    }
+
     this.validateAccountSid();
     this.validateAuthToken();
     await this.promptForCredentials();
 
     if ((await this.confirmOverwrite()) && (await this.validateCredentials())) {
       await this.saveCredentials();
       this.logger.info(`Saved ${this.projectId}.`);
-      this.exit(0);
     } else {
-      this.logger.warn('Cancelled');
-      this.exit(1);
+      this.cancel();
     }
   }
 
@@ -107,6 +109,29 @@ class ProjectAdd extends BaseCommand {
     return overwrite;
   }
 
+  async confirmDefaultProjectAndEnvVars() {
+    let affirmative = true;
+    if (this.projectId === DEFAULT_PROJECT && this.userConfig.getProjectFromEnvironment()) {
+      const confirm = await this.inquirer.prompt([
+        {
+          type: 'confirm',
+          name: 'affirmative',
+          message: 'Account credentials are currently stored in environment variables and will take precedence over ' +
+            `the "${DEFAULT_PROJECT}" project when connecting to Twilio, unless the "${DEFAULT_PROJECT}" project is ` +
+            `explicitly specified. Continue setting up "${DEFAULT_PROJECT}" project?`,
+          default: false
+        }
+      ]);
+      affirmative = confirm.affirmative;
+    }
+    return affirmative;
+  }
+
+  cancel() {
+    this.logger.warn('Cancelled');
+    this.exit(1);
+  }
+
   getTwilioClient() {
     if (!this.twilioClient) {
       this.twilioClient = require('twilio')(this.accountSid, this.authToken, {

diff --git a/test/commands/project/add.test.js b/test/commands/project/add.test.js
@@ -1,16 +1,19 @@
 /* eslint no-unused-expressions: 0 */
 const sinon = require('sinon');
 const { expect, test, constants } = require('@twilio/cli-test');
-const { Config } = require('@twilio/cli-core').services.config;
+const { Config, ConfigData } = require('@twilio/cli-core').services.config;
 const ProjectAdd = require('../../../src/commands/project/add');
 const helpMessages = require('../../../src/services/messaging/help-messages');
 
 describe('commands', () => {
   describe('project', () => {
     describe('add', () => {
       const addTest = (commandArgs = []) => test
+        .twilioFakeProject(ConfigData)
         .twilioCliEnv(Config)
         .twilioCreateCommand(ProjectAdd, commandArgs)
+        .stdout()
+        .stderr()
         .do(ctx => {
           const fakePrompt = sinon.stub();
           fakePrompt
@@ -24,7 +27,6 @@ describe('commands', () => {
               overwrite: true
             });
           ctx.testCmd.inquirer.prompt = fakePrompt;
-          ctx.testCmd.exit = sinon.fake();
         });
 
       addTest()
@@ -37,10 +39,8 @@ describe('commands', () => {
             secret: constants.FAKE_API_SECRET
           });
         })
-        .stdout()
-        .stderr()
-        .it('runs project:add', async ctx => {
-          await ctx.testCmd.run();
+        .do(ctx => ctx.testCmd.run())
+        .it('runs project:add', ctx => {
           expect(ctx.stdout).to.equal('');
           expect(ctx.stderr).to.contain(helpMessages.AUTH_TOKEN_NOT_SAVED);
           expect(ctx.stderr).to.contain('Saved default.');
@@ -53,16 +53,55 @@ describe('commands', () => {
           );
         });
 
+      addTest(['not-an-account-sid'])
+        .do(ctx => {
+          const fakePrompt = ctx.testCmd.inquirer.prompt;
+          fakePrompt.reset();
+          fakePrompt
+            .onFirstCall()
+            .resolves({
+              authToken: constants.FAKE_API_SECRET
+            });
+
+          return ctx.testCmd.run();
+        })
+        .exit(1)
+        .it('fails for invalid account SIDs', ctx => {
+          expect(ctx.stdout).to.equal('');
+          expect(ctx.stderr).to.contain('Account SID must be "AC"');
+        });
+
+      addTest()
+        .do(ctx => {
+          process.env.TWILIO_ACCOUNT_SID = constants.FAKE_ACCOUNT_SID;
+          process.env.TWILIO_API_KEY = constants.FAKE_API_KEY;
+          process.env.TWILIO_API_SECRET = constants.FAKE_API_SECRET;
+
+          const fakePrompt = ctx.testCmd.inquirer.prompt;
+          fakePrompt.reset();
+          fakePrompt
+            .onFirstCall()
+            .resolves({
+              affirmative: false
+            });
+
+          return ctx.testCmd.run();
+        })
+        .exit(1)
+        .it('prompts when adding default project with env vars set', ctx => {
+          expect(ctx.stdout).to.equal('');
+          expect(ctx.stderr).to.contain('Cancelled');
+        });
+
       addTest()
         .nock('https://api.twilio.com', api => {
           api.get(`/2010-04-01/Accounts/${constants.FAKE_ACCOUNT_SID}.json`).reply(500, {
             error: 'oops'
           });
         })
-        .stdout()
-        .stderr()
-        .it('runs project:add with invalid credentials', async ctx => {
-          await ctx.testCmd.run();
+        .do(ctx => ctx.testCmd.run())
+        .exit(1)
+        .it('fails for invalid credentials', ctx => {
           expect(ctx.stdout).to.equal('');
           expect(ctx.stderr).to.contain('Could not validate the provided credentials');
         });
@@ -76,10 +115,9 @@ describe('commands', () => {
             error: 'oops'
           });
         })
-        .stdout()
-        .stderr()
-        .it('runs project:add but fails to create api key', async ctx => {
-          await ctx.testCmd.run();
+        .do(ctx => ctx.testCmd.run())
+        .exit(1)
+        .it('fails to create an API key', ctx => {
           expect(ctx.stdout).to.equal('');
           expect(ctx.stderr).to.contain('Could not create an API Key');
         });
@@ -94,10 +132,8 @@ describe('commands', () => {
             secret: constants.FAKE_API_SECRET
           });
         })
-        .stdout()
-        .stderr()
-        .it('supports other regions', async ctx => {
-          await ctx.testCmd.run();
+        .do(async ctx => ctx.testCmd.run())
+        .it('supports other regions', ctx => {
           expect(ctx.stdout).to.equal('');
           expect(ctx.stderr).to.contain('configuration saved');
         });