Import credentials from environment if they are present.

Completes #5.

Author: philnash

src/cli.js

@@ -30,7 +30,14 @@ function cli(cwd) {
           type: 'string'
         },
         'skip-credentials': {
-          describe: "Don't ask for Twilio account credentials",
+          describe:
+            "Don't ask for Twilio account credentials or import them from the environment",
+          type: 'boolean',
+          default: false
+        },
+        'import-credentials': {
+          describe:
+            'Import credentials from the environment variables TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN',
           type: 'boolean',
           default: false
         }

src/create-twilio-function.js

@@ -6,6 +6,7 @@ const {
   createPackageJSON
 } = require('./create-twilio-function/create-files');
 const createGitignore = require('./create-twilio-function/create-gitignore');
+const importCredentials = require('./create-twilio-function/import-credentials');
 const {
   installDependencies
 } = require('./create-twilio-function/install-dependencies');
@@ -17,7 +18,7 @@ async function createTwilioFunction(config) {
   try {
     await createDirectory(config.path, config.name);
   } catch (e) {
-    console.log(
+    console.error(
       `A directory called '${
         config.name
       }' already exists. Please create your function in a new directory.`
@@ -26,7 +27,10 @@ async function createTwilioFunction(config) {
   }
 
   // Get account sid and auth token
-  accountDetails = await promptForAccountDetails(config);
+  let accountDetails = await importCredentials(config);
+  if (Object.keys(accountDetails).length === 0) {
+    accountDetails = await promptForAccountDetails(config);
+  }
   config = { ...accountDetails, ...config };
 
   // Scaffold project

src/create-twilio-function/import-credentials.js

@@ -0,0 +1,35 @@
+const inquirer = require('inquirer');
+
+async function importCredentials(config) {
+  if (
+    config.skipCredentials ||
+    (typeof process.env.TWILIO_ACCOUNT_SID === 'undefined' &&
+      typeof process.env.TWILIO_AUTH_TOKEN === 'undefined')
+  ) {
+    return {};
+  }
+
+  const credentials = {
+    accountSid: process.env.TWILIO_ACCOUNT_SID,
+    authToken: process.env.TWILIO_AUTH_TOKEN
+  };
+  if (config.importCredentials) {
+    return credentials;
+  }
+  const { importCredentials } = await inquirer.prompt([
+    {
+      type: 'confirm',
+      name: 'importCredentials',
+      message:
+        'Your account credentials have been found in your environment variables. Import them?',
+      default: true
+    }
+  ]);
+  if (importCredentials) {
+    return credentials;
+  } else {
+    return {};
+  }
+}
+
+module.exports = importCredentials;

tests/create-twilio-function.test.js

@@ -75,13 +75,13 @@ describe('createTwilioFunction', () => {
   it("doesn't scaffold if the target folder name already exists", async () => {
     const name = 'test-function';
     await mkdir('./scratch/test-function');
-    console.log = jest.fn();
+    console.error = jest.fn();
 
     await createTwilioFunction({ name, path: './scratch' });
 
     expect.assertions(2);
 
-    expect(console.log).toHaveBeenCalledTimes(1);
+    expect(console.error).toHaveBeenCalledTimes(1);
 
     try {
       await stat(`./scratch/${name}/package.json`);

tests/import-credentials.test.js

@@ -0,0 +1,79 @@
+const importCredentials = require('../src/create-twilio-function/import-credentials');
+const inquirer = require('inquirer');
+
+describe('importCredentials', () => {
+  beforeEach(() => jest.clearAllMocks());
+
+  describe('if credentials are present in the env', () => {
+    afterEach(() => {
+      delete process.env.TWILIO_ACCOUNT_SID;
+      delete process.env.TWILIO_AUTH_TOKEN;
+    });
+
+    test('it should prompt to ask if to use credentials and return them if affirmative', async () => {
+      process.env.TWILIO_ACCOUNT_SID = 'AC1234';
+      process.env.TWILIO_AUTH_TOKEN = 'auth-token';
+
+      inquirer.prompt = jest.fn(() =>
+        Promise.resolve({
+          importCredentials: true
+        })
+      );
+
+      const credentials = await importCredentials({});
+      expect(inquirer.prompt).toHaveBeenCalledTimes(1);
+      expect(inquirer.prompt).toHaveBeenCalledWith(expect.any(Array));
+      expect(credentials.accountSid).toBe('AC1234');
+      expect(credentials.authToken).toBe('auth-token');
+    });
+
+    test('it should prompt to ask if to use credentials and return an empty object if negative', async () => {
+      process.env.TWILIO_ACCOUNT_SID = 'AC1234';
+      process.env.TWILIO_AUTH_TOKEN = 'auth-token';
+
+      inquirer.prompt = jest.fn(() =>
+        Promise.resolve({
+          importCredentials: false
+        })
+      );
+
+      const credentials = await importCredentials({});
+      expect(inquirer.prompt).toHaveBeenCalledTimes(1);
+      expect(inquirer.prompt).toHaveBeenCalledWith(expect.any(Array));
+      expect(credentials.accountSid).toBe(undefined);
+      expect(credentials.authToken).toBe(undefined);
+    });
+
+    test('it should return credentials if the option importCredentials is true', async () => {
+      process.env.TWILIO_ACCOUNT_SID = 'AC1234';
+      process.env.TWILIO_AUTH_TOKEN = 'auth-token';
+
+      const credentials = await importCredentials({ importCredentials: true });
+      expect(inquirer.prompt).not.toHaveBeenCalled();
+      expect(credentials.accountSid).toBe('AC1234');
+      expect(credentials.authToken).toBe('auth-token');
+    });
+
+    test('it should not return credentials if skipCredentials is true', async () => {
+      process.env.TWILIO_ACCOUNT_SID = 'AC1234';
+      process.env.TWILIO_AUTH_TOKEN = 'auth-token';
+
+      const credentials = await importCredentials({
+        skipCredentials: true,
+        importCredentials: true
+      });
+      expect(inquirer.prompt).not.toHaveBeenCalled();
+      expect(credentials.accountSid).toBe(undefined);
+      expect(credentials.authToken).toBe(undefined);
+    });
+  });
+
+  describe('if there are no credentials in the env', () => {
+    test('it should not ask about importing credentials', async () => {
+      delete process.env.TWILIO_ACCOUNT_SID;
+      delete process.env.TWILIO_AUTH_TOKEN;
+      await importCredentials({});
+      expect(inquirer.prompt).not.toHaveBeenCalled();
+    });
+  });
+});