feat: Added support to make profile input mandatory based on config property (#135)

* feat: Added support to make profile input mandatory based on config property

* removing duplicate test

Author: kridai

src/base-commands/twilio-client-command.js

@@ -24,6 +24,12 @@ class TwilioClientCommand extends BaseCommand {
   async run() {
     await super.run();
 
+    // check if profile flag is required as per the config
+    if (this.userConfig.requireProfileInput && !this.flags.profile) {
+      throw new TwilioCliError(
+        `Error: Missing required flag:\n -p, --profile PROFILE  ${TwilioClientCommand.flags.profile.description} To disable this check run:\n\n  twilio config:set --no-require-profile-input`,
+      );
+    }
     this.currentProfile = this.userConfig.getProfileById(this.flags.profile);
     let keytarFlag = false;
 

src/services/config.js

@@ -32,6 +32,7 @@ class ConfigData {
     this.projects = [];
     this.activeProfile = null;
     this.profiles = {};
+    this.requireProfileInput = undefined;
   }
 
   getProfileFromEnvironment() {
@@ -182,6 +183,7 @@ class ConfigData {
   loadFromObject(configObj) {
     this.edge = configObj.edge;
     this.email = configObj.email || {};
+    this.requireProfileInput = configObj.requireProfileInput;
     this.prompts = configObj.prompts || {};
     // Note the historical 'projects' naming.
     configObj.projects = configObj.projects || [];
@@ -217,6 +219,7 @@ class Config {
     configData = {
       edge: configData.edge,
       email: configData.email,
+      requireProfileInput: configData.requireProfileInput,
       prompts: configData.prompts,
       // Note the historical 'projects' naming.
       projects: configData.projects,

test/base-commands/twilio-client-command.test.js

@@ -42,12 +42,14 @@ describe('base-commands', () => {
         envEdge,
         configRegion = 'configRegion',
         configEdge,
+        configRequireProfileInput,
       } = {},
     ) => {
       return test
         .do((ctx) => {
           ctx.userConfig = new ConfigData();
           ctx.userConfig.edge = configEdge;
+          ctx.userConfig.requireProfileInput = configRequireProfileInput;
 
           if (envRegion) {
             process.env.TWILIO_REGION = envRegion;
@@ -89,6 +91,27 @@ describe('base-commands', () => {
         });
     };
 
+    setUpTest([], { configRequireProfileInput: true })
+      .exit(1)
+      .it('should fail if requireProfileInput attribute in config is set but flag is not passed', (ctx) => {
+        expect(ctx.stderr).to.contain('Error: Missing required flag:');
+        expect(ctx.stderr).to.contain('-p, --profile PROFILE');
+      });
+
+    setUpTest(['-p', ''], { configRequireProfileInput: true })
+      .exit(1)
+      .it('should fail if requireProfileInput attribute in config is set but flag is passed as empty string', (ctx) => {
+        expect(ctx.stderr).to.contain('Error: Missing required flag:');
+        expect(ctx.stderr).to.contain('-p, --profile PROFILE');
+      });
+
+    setUpTest(['-p', 'region-edge-testing'], { configRequireProfileInput: true }).it(
+      'should use the profile passed, when requireProfileInput flag is set in config and valid profile is passed',
+      (ctx) => {
+        expect(ctx.testCmd.currentProfile.id).to.equal('region-edge-testing');
+      },
+    );
+
     setUpTest(['-l', 'debug']).it('should create a client for the active profile', (ctx) => {
       expect(ctx.stderr).to.contain('MyFirstProfile');
       expect(ctx.testCmd.twilioClient.accountSid).to.equal(constants.FAKE_ACCOUNT_SID);