chore: fixed aliased default username, added tests

Author: WillieRuemmele

.gitignore

@@ -1,5 +1,5 @@
 # -- CLEAN
-
+tmp/
 # use yarn by default, so ignore npm
 package-lock.json
 
@@ -33,4 +33,3 @@ node_modules
 # os specific files
 .DS_Store
 .idea
-/tmp/

src/commands/force/user/create.ts

@@ -18,6 +18,7 @@ import {
   User,
   UserFields,
 } from '@salesforce/core';
+import { QueryResult } from 'jsforce';
 import { getString, Dictionary, isArray } from '@salesforce/ts-types';
 import { flags, FlagsConfig, SfdxCommand } from '@salesforce/command';
 
@@ -176,9 +177,10 @@ export class UserCreateCommand extends SfdxCommand {
     if (defaultFields['profileName']) {
       const name: string = defaultFields['profileName'] || 'Standard User';
       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 = getString(response, 'records[0].Id');
+      const response: QueryResult<{ Id: string }> = await this.org
+        .getConnection()
+        .query(`SELECT id FROM profile WHERE name='${name}'`);
+      defaultFields.profileId = response.records[0].Id;
       delete defaultFields['profileName'];
     }
 

src/commands/force/user/list.ts

@@ -45,9 +45,9 @@ export class UserListCommand extends SfdxCommand {
       // if they passed in a alias and it maps to something we have an Alias.
       const alias = aliases.getKeysByValue(authData.getUsername())[0];
       const configAgg = ConfigAggregator.getInstance();
-      const defaultUser = configAgg.getLocalConfig().get('defaultusername');
+      const defaultUserOrAlias = configAgg.getLocalConfig().get('defaultusername');
       return {
-        defaultMarker: defaultUser === username ? '(A)' : '',
+        defaultMarker: defaultUserOrAlias === username || defaultUserOrAlias === alias ? '(A)' : '',
         alias: alias || '',
         username,
         profileName: profileInfos[userInfos[username].ProfileId],

test/commands/user/create.test.ts

@@ -8,7 +8,7 @@
 /* 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 { Aliases, Connection, DefaultUserFields, fs, Logger, Org, User } from '@salesforce/core';
 import { stubMethod } from '@salesforce/ts-sinon';
 import { IConfig } from '@oclif/config';
 import UserCreateCommand from '../../../src/commands/force/user/create';
@@ -61,7 +61,7 @@ describe('force:user:create', () => {
     });
   });
 
-  async function prepareStubs(throws: { license?: boolean; duplicate?: boolean } = {}, readsFile = false) {
+  async function prepareStubs(throws: { license?: boolean; duplicate?: boolean } = {}, readsFile?) {
     stubMethod($$.SANDBOX, Org.prototype, 'getConnection').callsFake(() => Connection.prototype);
     stubMethod($$.SANDBOX, DefaultUserFields, 'create').resolves({
       getFields: () => {
@@ -94,7 +94,11 @@ describe('force:user:create', () => {
     }
 
     if (readsFile) {
-      stubMethod($$.SANDBOX, fs, 'readJson').resolves({ generatepassword: true });
+      stubMethod($$.SANDBOX, Connection.prototype, 'query').resolves({
+        records: [{ Id: '12345678' }],
+      });
+      stubMethod($$.SANDBOX, Logger.prototype, 'debug');
+      stubMethod($$.SANDBOX, fs, 'readJson').resolves(readsFile);
     }
   }
 
@@ -131,7 +135,7 @@ describe('force:user:create', () => {
 
   test
     .do(async () => {
-      await prepareStubs({}, true);
+      await prepareStubs({}, { generatepassword: true });
     })
     .stdout()
     .command([
@@ -165,6 +169,48 @@ describe('force:user:create', () => {
       expect(result).to.deep.equal(expected);
     });
 
+  test
+    .do(async () => {
+      await prepareStubs({}, { generatepassword: true, profileName: 'System Administrator' });
+    })
+    .stdout()
+    .command([
+      'force:user:create',
+      '--json',
+      '--definitionfile',
+      'parent/child/file.json',
+      '--targetusername',
+      'testUser1@test.com',
+      '--targetdevhubusername',
+      'devhub@test.com',
+      'email=me@my.org',
+      'generatepassword=false',
+      "profileName='Chatter Free User'",
+    ])
+    // we set generatepassword=false in the varargs, in the definitionfile we have generatepassword=true, so we SHOULD NOT generate a password
+    // we should override the profileName with 'Chatter Free User'
+    .it(
+      'will merge fields from the cli args, and the definitionfile correctly, preferring cli args, cli args > file > default',
+      (ctx) => {
+        const expected = {
+          alias: 'testAlias',
+          email: 'me@my.org',
+          emailEncodingKey: 'UTF-8',
+          id: '0052D0000043PawWWR',
+          languageLocaleKey: 'en_US',
+          lastName: 'User',
+          localeSidKey: 'en_US',
+          orgId: 'abc123',
+          // note the new profileId 12345678 -> Chatter Free User from var args
+          profileId: '12345678',
+          timeZoneSidKey: 'America/Los_Angeles',
+          username: '1605130295132_test-j6asqt5qoprs@example.com',
+        };
+        const result = JSON.parse(ctx.stdout).result;
+        expect(result).to.deep.equal(expected);
+      }
+    );
+
   test
     .do(async () => {
       await prepareStubs({ license: true }, false);

test/commands/user/list.test.ts

@@ -6,11 +6,11 @@
  */
 
 import { $$, expect, test } from '@salesforce/command/lib/test';
-import { Aliases, Connection, Org } from '@salesforce/core';
+import { Aliases, ConfigAggregator, Connection, Org } from '@salesforce/core';
 import { stubMethod } from '@salesforce/ts-sinon';
 
 describe('force:user:list', () => {
-  async function prepareStubs() {
+  async function prepareStubs(defaultUser?: boolean) {
     stubMethod($$.SANDBOX, Org.prototype, 'getConnection').callsFake(() => Connection.prototype);
     stubMethod($$.SANDBOX, Org.prototype, 'readUserAuthFiles').returns([
       {
@@ -29,6 +29,10 @@ describe('force:user:list', () => {
     ]);
     stubMethod($$.SANDBOX, Org.prototype, 'getOrgId').returns('abc123');
     stubMethod($$.SANDBOX, Aliases.prototype, 'getKeysByValue').returns(['testAlias']);
+    if (defaultUser) {
+      const cfa = ConfigAggregator.getInstance();
+      stubMethod($$.SANDBOX, cfa, 'getLocalConfig').returns({ get: () => 'testAlias' });
+    }
     stubMethod($$.SANDBOX, Connection.prototype, 'query')
       .withArgs('SELECT username, profileid, id FROM User')
       .resolves({
@@ -60,6 +64,31 @@ describe('force:user:list', () => {
       });
   }
 
+  test
+    .do(async () => {
+      await prepareStubs();
+    })
+    .stdout()
+    .command(['force:user:list', '--json', '--targetusername', 'testUser', '--targetdevhubusername', 'devhub@test.com'])
+    .it('should display the correct information from the default user', (ctx) => {
+      // testUser1@test.com is aliased to testUser
+      const expected = [
+        {
+          defaultMarker: '',
+          alias: 'testAlias',
+          username: 'testuser@test.com',
+          profileName: 'Analytics Cloud Integration User',
+          orgId: 'abc123',
+          accessToken: 'accessToken',
+          instanceUrl: 'instanceURL',
+          loginUrl: 'login.test.com',
+          userId: '0052D0000043PbGQAU',
+        },
+      ];
+      const result = JSON.parse(ctx.stdout).result;
+      expect(result).to.deep.equal(expected);
+    });
+
   test
     .do(async () => {
       await prepareStubs();
@@ -73,7 +102,7 @@ describe('force:user:list', () => {
       '--targetdevhubusername',
       'devhub@test.com',
     ])
-    .it('should display the correct information from the default user', (ctx) => {
+    .it('should display the correct information from the default user with alias', (ctx) => {
       // testUser1@test.com is aliased to testUser
       const expected = [
         {
@@ -91,4 +120,36 @@ describe('force:user:list', () => {
       const result = JSON.parse(ctx.stdout).result;
       expect(result).to.deep.equal(expected);
     });
+
+  test
+    .do(async () => {
+      await prepareStubs(true);
+    })
+    .stdout()
+    .command([
+      'force:user:list',
+      '--json',
+      '--targetusername',
+      'testUser1@test.com',
+      '--targetdevhubusername',
+      'devhub@test.com',
+    ])
+    .it('should display the correct information from the default user with alias and it default', (ctx) => {
+      // testUser1@test.com is aliased to testUser
+      const expected = [
+        {
+          defaultMarker: '(A)',
+          alias: 'testAlias',
+          username: 'testuser@test.com',
+          profileName: 'Analytics Cloud Integration User',
+          orgId: 'abc123',
+          accessToken: 'accessToken',
+          instanceUrl: 'instanceURL',
+          loginUrl: 'login.test.com',
+          userId: '0052D0000043PbGQAU',
+        },
+      ];
+      const result = JSON.parse(ctx.stdout).result;
+      expect(result).to.deep.equal(expected);
+    });
 });