Merge pull request #14 from salesforcecli/wr/userRegression

fix: standardized capitalization issues with config file

Author: WillieRuemmele

src/commands/force/user/create.ts

@@ -18,7 +18,7 @@ import {
   User,
   UserFields,
 } from '@salesforce/core';
-import { get, Dictionary, isArray } from '@salesforce/ts-types';
+import { getString, Dictionary, isArray } from '@salesforce/ts-types';
 import { flags, FlagsConfig, SfdxCommand } from '@salesforce/command';
 
 Messages.importMessagesDirectory(__dirname);
@@ -136,13 +136,13 @@ export class UserCreateCommand extends SfdxCommand {
   private async catchCreateUser(respBody: Error, fields: UserFields): Promise<void> {
     // For Gacks, the error message is on response.body[0].message but for handled errors
     // the error message is on response.body.Errors[0].description.
-    const errMessage = (get(respBody, 'message') as string) || 'Unknown Error';
+    const errMessage = getString(respBody, 'message') || 'Unknown Error';
     const conn: Connection = this.org.getConnection();
 
     // Provide a more user friendly error message for certain server errors.
     if (errMessage.includes('LICENSE_LIMIT_EXCEEDED')) {
       const res = await conn.query(`SELECT name FROM profile WHERE id='${fields.profileId}'`);
-      const profileName = get(res, 'records[0].Name') as string;
+      const profileName = getString(res, 'records[0].Name');
       throw SfdxError.create('@salesforce/plugin-user', 'create', 'licenseLimitExceeded', [profileName]);
     } else if (errMessage.includes('DUPLICATE_USERNAME')) {
       throw SfdxError.create('@salesforce/plugin-user', 'create', 'duplicateUsername', [fields.username]);
@@ -151,19 +151,24 @@ export class UserCreateCommand extends SfdxCommand {
     }
   }
 
+  private lowerFirstLetter(word: string): string {
+    return word[0].toLowerCase() + word.substr(1);
+  }
+
   private async aggregateFields(defaultFields: UserFields): Promise<UserFields & Dictionary<string>> {
     // start with the default fields, then add the fields from the file, then (possibly overwritting) add the fields from the cli varargs param
     if (this.flags.definitionfile) {
       const content = await fs.readJson(this.flags.definitionfile);
       Object.keys(content).forEach((key) => {
-        defaultFields[key] = content[key];
+        // cast entries to lowercase to standardize
+        defaultFields[this.lowerFirstLetter(key)] = content[key];
       });
     }
 
     if (this.varargs) {
       Object.keys(this.varargs).forEach((key) => {
         if (defaultFields[key]) {
-          defaultFields[key] = this.varargs[key];
+          defaultFields[this.lowerFirstLetter(key)] = this.varargs[key];
         }
       });
     }
@@ -174,7 +179,7 @@ export class UserCreateCommand extends SfdxCommand {
       this.logger.debug(`Querying org for profile name [${name}]`);
       const profileQuery = `SELECT id FROM profile WHERE name='${name}'`;
       const response = await this.org.getConnection().query(profileQuery);
-      defaultFields.profileId = get(response, 'records[0].Id') as string;
+      defaultFields.profileId = getString(response, 'records[0].Id');
       delete defaultFields['profileName'];
     }
 

src/commands/force/user/display.ts

@@ -8,7 +8,7 @@
 import * as os from 'os';
 import { SfdxCommand } from '@salesforce/command';
 import { Aliases, AuthFields, AuthInfo, Connection, Logger, Messages } from '@salesforce/core';
-import { get } from '@salesforce/ts-types';
+import { getString } from '@salesforce/ts-types';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/plugin-user', 'display');
@@ -50,24 +50,24 @@ export class UserDisplayCommand extends SfdxCommand {
       // the user executing this command may not have access to the Profile sObject.
       if (!profileName) {
         const PROFILE_NAME_QUERY = `SELECT name FROM Profile WHERE Id IN (SELECT ProfileId FROM User WHERE username='${username}')`;
-        profileName = get(await conn.query(PROFILE_NAME_QUERY), 'records[0].Name') as string;
+        profileName = getString(await conn.query(PROFILE_NAME_QUERY), 'records[0].Name');
       }
     } catch (err) {
       profileName = 'unknown';
       this.logger.debug(
-        `Query for the profile name failed for username: ${username} with message: ${get(err, 'message') as string}`
+        `Query for the profile name failed for username: ${username} with message: ${getString(err, 'message')}`
       );
     }
 
     try {
       if (!userId) {
         const USER_QUERY = `SELECT id FROM User WHERE username='${username}'`;
-        userId = get(await conn.query(USER_QUERY), 'records[0].Id') as string;
+        userId = getString(await conn.query(USER_QUERY), 'records[0].Id');
       }
     } catch (err) {
       userId = 'unknown';
       this.logger.debug(
-        `Query for the user ID failed for username: ${username} with message: ${get(err, 'message') as string}`
+        `Query for the user ID failed for username: ${username} with message: ${getString(err, 'message')}`
       );
     }
 

test/commands/user/create.test.ts

@@ -5,13 +5,62 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
+/* eslint-disable  @typescript-eslint/ban-ts-ignore */
+
 import { $$, expect, test } from '@salesforce/command/lib/test';
 import { Aliases, Connection, DefaultUserFields, fs, Org, User } from '@salesforce/core';
 import { stubMethod } from '@salesforce/ts-sinon';
+import { IConfig } from '@oclif/config';
+import UserCreateCommand from '../../../src/commands/force/user/create';
 
 const username = 'defaultusername@test.com';
 
 describe('force:user:create', () => {
+  it('will properly merge fields regardless of capitalization', async () => {
+    // notice the varied capitalization
+    stubMethod($$.SANDBOX, fs, 'readJson').resolves({
+      id: '0052D0000043PawWWR',
+      Username: '1605130295132_test-j6asqt5qoprs@example.com',
+      Alias: 'testAlias',
+      Email: username,
+      EmailEncodingKey: 'UTF-8',
+      LanguageLocaleKey: 'en_US',
+      localeSidKey: 'en_US',
+      ProfileId: '00e2D000000bNexWWR',
+      LastName: 'User',
+      timeZoneSidKey: 'America/Los_Angeles',
+    });
+
+    const createCommand = new UserCreateCommand(['-f', 'userConfig.json'], {} as IConfig);
+
+    // @ts-ignore
+    createCommand.flags = { definitionfile: 'testing' };
+
+    // @ts-ignore private method
+    const res = await createCommand.aggregateFields({
+      id: '00555000006lCspAAE',
+      emailEncodingKey: 'UTF-8',
+      languageLocaleKey: 'en_US',
+      localeSidKey: 'en_US',
+      profileId: '00e55000000fvDdAAI',
+      lastName: 'User',
+      timeZoneSidKey: 'America/Los_Angeles',
+    });
+
+    expect(res).to.deep.equal({
+      alias: 'testAlias',
+      email: 'defaultusername@test.com',
+      emailEncodingKey: 'UTF-8',
+      id: '0052D0000043PawWWR',
+      languageLocaleKey: 'en_US',
+      lastName: 'User',
+      localeSidKey: 'en_US',
+      profileId: '00e2D000000bNexWWR',
+      timeZoneSidKey: 'America/Los_Angeles',
+      username: '1605130295132_test-j6asqt5qoprs@example.com',
+    });
+  });
+
   async function prepareStubs(throws: { license?: boolean; duplicate?: boolean } = {}, readsFile = false) {
     stubMethod($$.SANDBOX, Org.prototype, 'getConnection').callsFake(() => Connection.prototype);
     stubMethod($$.SANDBOX, DefaultUserFields, 'create').resolves({