Merge pull request #736 from salesforcecli/sm/ut-cleanup

test: accurate async/await and tighter eslint

package.json

@@ -16,7 +16,7 @@
   },
   "devDependencies": {
     "@oclif/plugin-command-snapshot": "^4.0.6",
-    "@salesforce/cli-plugins-testkit": "^4.1.1",
+    "@salesforce/cli-plugins-testkit": "^4.2.0",
     "@salesforce/dev-config": "^4.0.1",
     "@salesforce/dev-scripts": "^5.4.2",
     "@salesforce/plugin-command-reference": "^3.0.7",
@@ -234,4 +234,4 @@
       "output": []
     }
   }
-}
+}

test/.eslintrc.js

@@ -12,18 +12,10 @@ module.exports = {
   rules: {
     // Allow assert style expressions. i.e. expect(true).to.be.true
     'no-unused-expressions': 'off',
-
-    // It is common for tests to stub out method.
-
     // Return types are defined by the source code. Allows for quick overwrites.
     '@typescript-eslint/explicit-function-return-type': 'off',
     // Mocked out the methods that shouldn't do anything in the tests.
     '@typescript-eslint/no-empty-function': 'off',
-    // Easily return a promise in a mocked method.
-    '@typescript-eslint/require-await': 'off',
-
     '@typescript-eslint/no-unsafe-member-access': 'off',
-    '@typescript-eslint/no-unsafe-return': 'off',
-    '@typescript-eslint/no-unsafe-assignment': 'off',
   },
 };

test/nut/legacy/sandbox.sandboxNut.ts

@@ -24,13 +24,13 @@ describe('Sandbox Orgs via legacy org:create', () => {
     });
   });
 
-  it('will create a sandbox, verify it can be opened, and then attempt to delete it', async () => {
+  it('will create a sandbox, verify it can be opened, and then attempt to delete it', () => {
     let result: SandboxProcessObject | undefined;
     try {
-      Lifecycle.getInstance().on(SandboxEvents.EVENT_STATUS, async (results: StatusEvent) => {
+      Lifecycle.getInstance().on(SandboxEvents.EVENT_STATUS, async (results: StatusEvent) =>
         // eslint-disable-next-line no-console
-        console.log('sandbox copy progress', results.sandboxProcessObj.CopyProgress);
-      });
+        Promise.resolve(console.log('sandbox copy progress', results.sandboxProcessObj.CopyProgress))
+      );
       result = execCmd<SandboxProcessObject>(
         // escaped, pending outcome W-12683861
         // eslint-disable-next-line sf-plugin/no-execcmd-double-quotes

test/nut/legacy/status.sandboxNut.ts

@@ -67,7 +67,7 @@ describe('test sandbox status command', () => {
     logoutSandbox(hubOrgUsername);
   });
 
-  it('sandbox status command', async () => {
+  it('sandbox status command', () => {
     const orgStatusResult = execCmd<SandboxProcessObject>(
       `force:org:status --sandboxname ${sandboxName} -u ${hubOrgUsername} --json`,
       {
@@ -91,7 +91,7 @@ describe('test sandbox status command', () => {
     ]);
   });
 
-  it('sandbox status command sets setdefaultusername', async () => {
+  it('sandbox status command sets setdefaultusername', () => {
     const orgStatusResult = execCmd<SandboxProcessObject>(
       `force:org:status --sandboxname ${sandboxName} -u ${hubOrgUsername} -s --json`,
       {
@@ -107,7 +107,7 @@ describe('test sandbox status command', () => {
     expect(result.stdout).to.contain(`"${hubOrgUsername}.${sandboxName.toLowerCase()}"`);
   });
 
-  it('sandbox status command set alias', async () => {
+  it('sandbox status command set alias', () => {
     const orgStatusResult = execCmd<SandboxProcessObject>(
       `force:org:status --sandboxname ${sandboxName} -u ${hubOrgUsername} -a ${sandboxName} --json`,
       {

test/nut/sandbox.sandboxNut.ts

@@ -25,13 +25,13 @@ describe('Sandbox Orgs', () => {
     hubOrgUsername = session.hubOrg.username;
   });
 
-  it('will create a sandbox, verify it can be opened, and then attempt to delete it', async () => {
+  it('will create a sandbox, verify it can be opened, and then attempt to delete it', () => {
     let result: SandboxProcessObject | undefined;
     try {
-      Lifecycle.getInstance().on(SandboxEvents.EVENT_STATUS, async (results: StatusEvent) => {
+      Lifecycle.getInstance().on(SandboxEvents.EVENT_STATUS, async (results: StatusEvent) =>
         // eslint-disable-next-line no-console
-        console.log('sandbox copy progress', results.sandboxProcessObj.CopyProgress);
-      });
+        Promise.resolve(console.log('sandbox copy progress', results.sandboxProcessObj.CopyProgress))
+      );
       let rawResult = execCmd(
         `env:create:sandbox -a mySandbox -s -l Developer -o ${hubOrgUsername} --no-prompt --json --async`,
         { timeout: 3600000 }

test/shared/orgListUtil.test.ts

@@ -123,7 +123,7 @@ describe('orgListUtil tests', () => {
       sandbox.stub(utils, 'getAliasByUsername').withArgs('[email protected]').resolves('gaz');
     });
 
-    afterEach(async () => {
+    afterEach(() => {
       sandbox.restore();
     });
 
@@ -221,7 +221,7 @@ describe('orgListUtil tests', () => {
       stubMethod(sandbox, fs, 'readdir').resolves(['00D000000000000001.json', '00D000000000000002.json']);
     });
 
-    afterEach(async () => {
+    afterEach(() => {
       sandbox.restore();
     });
 

test/shared/sandboxProgress.test.ts

@@ -30,7 +30,7 @@ describe('sandbox progress', () => {
     sandboxProgress = new SandboxProgress();
   });
   describe('getSandboxProgress', () => {
-    it('will calculate the correct human readable message (1h 33min 00seconds seconds left)', async () => {
+    it('will calculate the correct human readable message (1h 33min 00seconds seconds left)', () => {
       const data: StatusEvent = {
         // 186*30 = 5580 = 1 hour, 33 min, 0 seconds. so 186 attempts left, at a 30 second polling interval
         sandboxProcessObj,
@@ -45,7 +45,7 @@ describe('sandbox progress', () => {
       expect(res).to.have.property('remainingWaitTimeHuman', '01:33:00 until timeout.');
     });
 
-    it('will calculate the correct human readable message (5 min 30seconds seconds left)', async () => {
+    it('will calculate the correct human readable message (5 min 30seconds seconds left)', () => {
       const data: StatusEvent = {
         sandboxProcessObj,
         interval: 30,

test/shared/sandboxReporter.test.ts

@@ -28,7 +28,7 @@ const sandboxProcessObj: SandboxProcessObject = {
 
 describe('sandboxReporter', () => {
   describe('sandboxProgress', () => {
-    it('will calculate the correct human readable message (1h 33min 00seconds seconds left)', async () => {
+    it('will calculate the correct human readable message (1h 33min 00seconds seconds left)', () => {
       const data = {
         sandboxProcessObj,
         interval: 30,
@@ -41,7 +41,7 @@ describe('sandboxReporter', () => {
       );
     });
 
-    it('will calculate the correct human readable message (5 min 30seconds seconds left)', async () => {
+    it('will calculate the correct human readable message (5 min 30seconds seconds left)', () => {
       const data: StatusEvent = {
         sandboxProcessObj,
         interval: 30,

test/shared/utils.test.ts

@@ -12,7 +12,7 @@ import { getAliasByUsername } from '../../src/shared/utils';
 
 describe('getAliasByUsername', () => {
   const sandbox = sinon.createSandbox();
-  beforeEach(async () => {
+  beforeEach(() => {
     const getAllStub = sandbox.stub();
     getAllStub.withArgs('username1').returns(['alias1']);
     getAllStub.withArgs('username2').returns(['alias2', 'alias2b']);

test/unit/force/org/sandboxCreate.test.ts

@@ -141,6 +141,7 @@ describe('org:create (sandbox paths)', () => {
         expect(result).to.deep.equal(data);
         const logs = $$.TEST_LOGGER.getBufferedRecords();
         expect(logs.some((line) => line.msg.includes('Set defaultUsername:')));
+        return Promise.resolve();
       });
 
       const sandboxRes: SandboxUserAuthResponse = {

test/unit/org/createSandbox.test.ts

@@ -37,8 +37,10 @@ const fakeOrg: AuthFields = {
 
 describe('org:create:sandbox', () => {
   beforeEach(() => {
-    stubMethod(sandbox, OrgAccessor.prototype, 'read').callsFake(async (): Promise<AuthFields> => fakeOrg);
-    stubMethod(sandbox, OrgAccessor.prototype, 'write').callsFake(async (): Promise<AuthFields> => fakeOrg);
+    // stubMethod(sandbox, OrgAccessor.prototype, 'read').callsFake(async (): Promise<AuthFields> => fakeOrg);
+    // stubMethod(sandbox, OrgAccessor.prototype, 'write').callsFake(async (): Promise<AuthFields> => fakeOrg);
+    stubMethod(sandbox, OrgAccessor.prototype, 'read').resolves(fakeOrg);
+    stubMethod(sandbox, OrgAccessor.prototype, 'write').resolves(fakeOrg);
     sfCommandUxStubs = stubSfCommandUx(sandbox);
     stubUx(sandbox);
     stubSpinner(sandbox);
@@ -63,6 +65,7 @@ describe('org:create:sandbox', () => {
       Lifecycle.getInstance().on(SandboxEvents.EVENT_ASYNC_RESULT, async (result) => {
         expect(result).to.deep.equal(sandboxProcessObj);
         expect(sfCommandUxStubs.info.firstCall.firstArg).to.include(sandboxProcessObj.Id);
+        return Promise.resolve();
       });
 
       await Lifecycle.getInstance().emit(SandboxEvents.EVENT_ASYNC_RESULT, sandboxProcessObj);

test/unit/org/display.test.ts

@@ -147,17 +147,18 @@ describe('org:display', () => {
     await $$.stubAuths(testOrg, testHub);
 
     $$.SANDBOX.stub(Connection.prototype, 'sobject').returns({
-      // @ts-expect-error we all know this is not the full type
-      find: async () => [
-        {
-          Status: 'Active',
-          ExpirationDate: '2021-01-23',
-          CreatedBy: { Username: testHub.username },
-          Edition: 'Developer',
-          OrgName: 'MyOrg',
-          CreatedDate: '2020-12-24T15:18:55.000+0000',
-        },
-      ],
+      find: async () =>
+        // @ts-expect-error we all know this is not the full type
+        Promise.resolve([
+          {
+            Status: 'Active',
+            ExpirationDate: '2021-01-23',
+            CreatedBy: { Username: testHub.username },
+            Edition: 'Developer',
+            OrgName: 'MyOrg',
+            CreatedDate: '2020-12-24T15:18:55.000+0000',
+          },
+        ]),
     });
 
     const result = await OrgDisplayCommand.run(['--json', '--targetusername', testOrg.username]);

test/unit/org/list.test.ts

@@ -20,7 +20,7 @@ describe('org:list', () => {
   // done automatically by the TestContext.
   const $$ = new TestContext();
 
-  beforeEach(async () => {
+  beforeEach(() => {
     // Stub the ux methods on SfCommand so that you don't get any command output in your tests.
     stubSfCommandUx($$.SANDBOX);
     stubMethod($$.SANDBOX, AuthInfo, 'listAllAuthorizations').resolves([
@@ -33,7 +33,7 @@ describe('org:list', () => {
   });
 
   describe('hub org defined', () => {
-    beforeEach(async () => {
+    beforeEach(() => {
       stubMethod($$.SANDBOX, OrgListUtil, 'readLocallyValidatedMetaConfigsGroupedByOrgType').resolves(
         OrgListMock.AUTH_INFO
       );

yarn.lock

@@ -892,10 +892,10 @@
     mv "~2"
     safe-json-stringify "~1"
 
-"@salesforce/cli-plugins-testkit@^4.1.1":
-  version "4.1.1"
-  resolved "https://registry.yarnpkg.com/@salesforce/cli-plugins-testkit/-/cli-plugins-testkit-4.1.1.tgz#3504d7b05f63bf15a706385efb90c1c5f46c6c38"
-  integrity sha512-aGeiVYdWW6O/Q5LHCc4ZVNKihz0oiCljplbT2EmjyTyo+3Bxj1iyuo3o428+wo9BIc/Qk0jkKjqrSGS5HPDs/A==
+"@salesforce/cli-plugins-testkit@^4.2.0":
+  version "4.2.0"
+  resolved "https://registry.yarnpkg.com/@salesforce/cli-plugins-testkit/-/cli-plugins-testkit-4.2.0.tgz#3dc2393050a2b505316b381af64f514c5799f7ce"
+  integrity sha512-eM8nucE074lZxKfYGd1Q6jB/dSudPCW5Tt76V2wSMpLmT90FdHQKoDn81DSoweL1YAifWZFSEzyCt1c0z98Ymw==
   dependencies:
     "@salesforce/core" "^4.1.3"
     "@salesforce/kit" "^3.0.2"