Merge pull request #975 from salesforcecli/sh/refresh-sandbox

fix: fix NUTs for sbx refresh

Author: shetzel

test/nut/async-create-resume.nut.ts

@@ -7,7 +7,7 @@
 
 import fs from 'node:fs';
 import path from 'node:path';
-import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
+import { execCmd, TestSession, genUniqueString } from '@salesforce/cli-plugins-testkit';
 import { assert, expect } from 'chai';
 import { AuthFields, Global, ScratchOrgCache } from '@salesforce/core';
 import { CachedOptions } from '@salesforce/core/lib/org/scratchOrgCache.js';
@@ -37,8 +37,10 @@ describe('env:create:scratch async/resume', () => {
   };
 
   before(async () => {
+    const uid = genUniqueString('acr_%s');
     session = await TestSession.create({
       project: { name: 'asyncCreateResume' },
+      sessionDir: path.join(process.cwd(), `test_session_${uid}`),
       devhubAuthStrategy: 'AUTO',
     });
     cacheFilePath = path.join(session.dir, '.sf', ScratchOrgCache.getFileName());

test/nut/listAndDisplay.nut.ts

@@ -8,7 +8,7 @@
 import { join } from 'node:path';
 import os from 'node:os';
 import { expect, config, assert } from 'chai';
-import { TestSession } from '@salesforce/cli-plugins-testkit';
+import { TestSession, genUniqueString } from '@salesforce/cli-plugins-testkit';
 import { execCmd } from '@salesforce/cli-plugins-testkit';
 import { OrgListResult, defaultHubEmoji, defaultOrgEmoji } from '../../src/commands/org/list.js';
 import { OrgOpenOutput } from '../../src/commands/org/open.js';
@@ -52,8 +52,10 @@ describe('Org Command NUT', () => {
   let aliasUserOrgId: string;
 
   before(async () => {
+    const uid = genUniqueString('listAndDisplay_%s');
     session = await TestSession.create({
       project: { name: 'listAndDisplay' },
+      sessionDir: join(process.cwd(), `test_session_${uid}`),
       devhubAuthStrategy: 'AUTO',
       scratchOrgs: [
         {

test/nut/metadata.nut.ts

@@ -7,17 +7,19 @@
 import path from 'node:path';
 import fs from 'node:fs';
 import { expect } from 'chai';
-import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
+import { execCmd, TestSession, genUniqueString } from '@salesforce/cli-plugins-testkit';
 import type { DescribeMetadataResult } from 'jsforce/lib/api/metadata/schema.js';
 import type { ListMetadataCommandResult } from '../../src/commands/org/list/metadata.js';
 
 describe('org list metadata*', () => {
   let session: TestSession;
   before(async () => {
+    const uid = genUniqueString('listMetadata_%s');
     session = await TestSession.create({
       project: {
         gitClone: 'https://github.com/trailheadapps/dreamhouse-lwc.git',
       },
+      sessionDir: path.join(process.cwd(), `test_session_${uid}`),
       devhubAuthStrategy: 'AUTO',
       scratchOrgs: [
         {

test/nut/open.nut.ts

@@ -7,7 +7,7 @@
 
 import path from 'node:path';
 import fs from 'node:fs';
-import { TestSession, execCmd } from '@salesforce/cli-plugins-testkit';
+import { TestSession, execCmd, genUniqueString } from '@salesforce/cli-plugins-testkit';
 import { expect, config, assert } from 'chai';
 import { AuthFields } from '@salesforce/core';
 import { ComponentSetBuilder } from '@salesforce/source-deploy-retrieve';
@@ -24,10 +24,12 @@ describe('test org:open command', () => {
   const flowPath = path.join('force-app', 'main', 'default', 'flows', 'Create_property.flow-meta.xml');
 
   before(async () => {
+    const uid = genUniqueString('orgOpen_%s');
     session = await TestSession.create({
       project: {
         gitClone: 'https://github.com/trailheadapps/dreamhouse-lwc.git',
       },
+      sessionDir: path.join(process.cwd(), `test_session_${uid}`),
       devhubAuthStrategy: 'AUTO',
       scratchOrgs: [
         {

test/nut/sandboxRefresh.nut.ts

@@ -9,7 +9,7 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { assert, expect } from 'chai';
 import sinon from 'sinon';
-import { TestSession } from '@salesforce/cli-plugins-testkit';
+import { TestSession, genUniqueString } from '@salesforce/cli-plugins-testkit';
 import { Org, SandboxProcessObject, SandboxRequestCache, SfError, Messages, AuthInfo } from '@salesforce/core';
 import { stubSfCommandUx, stubSpinner, stubUx } from '@salesforce/sf-plugins-core';
 import RefreshSandbox from '../../src/commands/org/refresh/sandbox.js';
@@ -30,7 +30,7 @@ import {
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-org', 'sandboxbase');
 
-describe.skip('Sandbox Refresh', () => {
+describe('Sandbox Refresh', () => {
   let session: TestSession;
   let hubOrgUsername: string;
   let cacheFilePath: string;
@@ -43,9 +43,11 @@ describe.skip('Sandbox Refresh', () => {
   const sandboxProcessSoql = getSandboxProcessSoql();
 
   before(async () => {
+    const uid = genUniqueString('sbxRefresh_%s');
     session = await TestSession.create({
       project: { name: 'sandboxRefresh' },
-      devhubAuthStrategy: 'AUTO',
+      devhubAuthStrategy: 'AUTH_URL',
+      sessionDir: path.join(process.cwd(), `test_session_${uid}`),
     });
     assert(session.hubOrg.username);
     hubOrgUsername = session.hubOrg.username;
@@ -67,13 +69,13 @@ describe.skip('Sandbox Refresh', () => {
     await session?.clean();
   });
 
-  afterEach(async () => {
-    sinonSandbox.restore();
+  afterEach(() => {
     try {
-      await deleteSandboxCacheFile(cacheFilePath);
+      deleteSandboxCacheFile(cacheFilePath);
     } catch (err) {
       // ignore since there isn't always a cache file written
     }
+    sinonSandbox.restore();
   });
 
   //
@@ -110,7 +112,7 @@ describe.skip('Sandbox Refresh', () => {
     expect(toolingQueryStub.calledOnce).to.be.true;
 
     // check the sandbox cache entry
-    const cache = await readSandboxCacheFile(cacheFilePath);
+    const cache = readSandboxCacheFile(cacheFilePath);
     expect(cache).to.have.property(sbxName);
     expect(cache[sbxName]).to.have.property('action', 'Refresh');
     expect(cache[sbxName]).to.have.property('prodOrgUsername', hubOrgUsername);
@@ -154,7 +156,7 @@ describe.skip('Sandbox Refresh', () => {
     expect(toolingQueryStub.calledOnce).to.be.true;
 
     // check the sandbox cache entry
-    const cache = await readSandboxCacheFile(cacheFilePath);
+    const cache = readSandboxCacheFile(cacheFilePath);
     expect(cache).to.have.property(sbxName);
     expect(cache[sbxName]).to.have.property('action', 'Refresh');
     expect(cache[sbxName]).to.have.property('prodOrgUsername', hubOrgUsername);
@@ -190,6 +192,7 @@ describe.skip('Sandbox Refresh', () => {
 
     try {
       await RefreshSandbox.run(['--name', sbxName, '-o', hubOrgUsername, '--async', '--json']);
+      assert(false, 'Expected SandboxNotFoundError');
     } catch (e) {
       assert(e instanceof SfError, 'Expect error to be an instance of SfError');
       expect(e.name).to.equal('SandboxNotFoundError');
@@ -238,7 +241,7 @@ describe.skip('Sandbox Refresh', () => {
     expect(toolingQueryStub.calledOnce).to.be.true;
 
     // check the sandbox cache entry
-    const cache = await readSandboxCacheFile(cacheFilePath);
+    const cache = readSandboxCacheFile(cacheFilePath);
     expect(cache).to.have.property(sbxName);
     expect(cache[sbxName]).to.have.property('action', 'Refresh');
     expect(cache[sbxName]).to.have.property('prodOrgUsername', hubOrgUsername);
@@ -283,7 +286,7 @@ describe.skip('Sandbox Refresh', () => {
     expect(querySandboxProcessByIdStub.callCount).to.be.greaterThan(2);
 
     // check the sandbox cache entry
-    const cache = await readSandboxCacheFile(cacheFilePath);
+    const cache = readSandboxCacheFile(cacheFilePath);
     expect(cache).to.have.property(sbxName);
     expect(cache[sbxName]).to.have.property('action', 'Refresh');
     expect(cache[sbxName]).to.have.property('prodOrgUsername', hubOrgUsername);
@@ -299,7 +302,7 @@ describe.skip('Sandbox Refresh', () => {
     expect(sfCommandUxStubs.info.firstCall.args[0]).to.equal(sbxStatusMsg);
   });
 
-  it.skip('should poll and report a success and write an auth file', async () => {
+  it('should poll and report a success and write an auth file', async () => {
     const sbxInfo = getSandboxInfo();
     const sbxName = sbxInfo.SandboxName;
     const sbxProcess = getSandboxProcess();
@@ -334,7 +337,7 @@ describe.skip('Sandbox Refresh', () => {
 
     // Stub AuthInfo functions so an auth file is written without making http calls
     // @ts-expect-error stubbing private function
-    const authInfoCreateStub = sinonSandbox.stub(AuthInfo.prototype, 'exchangeToken').resolves({
+    const authInfoExchangeTokenStub = sinonSandbox.stub(AuthInfo.prototype, 'exchangeToken').resolves({
       username: sbxAuthResponse.authUserName,
       parentUsername: hubOrgUsername,
       instanceUrl: sbxAuthResponse.instanceUrl,
@@ -366,10 +369,10 @@ describe.skip('Sandbox Refresh', () => {
     expect(toolingQueryStub.calledOnce, 'toolingQueryStub called').to.be.true;
     expect(querySandboxProcessByIdStub.called, 'querySandboxProcessByIdStub called').to.be.true;
     expect(sandboxSignupCompleteStub.called, 'sandboxSignupCompleteStub called').to.be.true;
-    expect(authInfoCreateStub.called, 'authInfoCreateStub called').to.be.true;
+    expect(authInfoExchangeTokenStub.called, 'authInfoExchangeTokenStub called').to.be.true;
 
     // Check auth files exist
-    const authFileContents = await readAuthFile(session.homeDir, sbxAuthResponse.authUserName);
+    const authFileContents = readAuthFile(session.homeDir, sbxAuthResponse.authUserName);
     expect(authFileContents).to.be.ok;
     expect(authFileContents).to.have.property('username', sbxAuthResponse.authUserName);
     expect(authFileContents).to.have.property('parentUsername', hubOrgUsername);
@@ -379,7 +382,7 @@ describe.skip('Sandbox Refresh', () => {
 
     // check sandbox auth file doesn't exist
     try {
-      await readSandboxCacheFile(cacheFilePath);
+      readSandboxCacheFile(cacheFilePath);
       assert(false, 'should not have found a sandbox cache file');
     } catch (err) {
       // ignore

test/nut/scratchCreate.nut.ts

@@ -29,9 +29,11 @@ describe('env create scratch NUTs', () => {
   };
 
   before(async () => {
+    const uid = genUniqueString('sbxCreate_%s');
     session = await TestSession.create({
       project: { name: 'scratchOrgCreate' },
       devhubAuthStrategy: 'AUTO',
+      sessionDir: path.join(process.cwd(), `test_session_${uid}`),
     });
   });
 

test/nut/scratchDelete.nut.ts

@@ -7,7 +7,7 @@
 
 import path from 'node:path';
 import fs from 'node:fs';
-import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
+import { execCmd, TestSession, genUniqueString } from '@salesforce/cli-plugins-testkit';
 import { assert, expect } from 'chai';
 import { ScratchDeleteResponse } from '../../src/commands/org/delete/scratch.js';
 
@@ -18,8 +18,10 @@ describe('org:delete:scratch NUTs', () => {
   let session: TestSession;
 
   before(async () => {
+    const uid = genUniqueString('scratchDelete_%s');
     session = await TestSession.create({
       project: { name: 'scratchOrgDelete' },
+      sessionDir: path.join(process.cwd(), `test_session_${uid}`),
       devhubAuthStrategy: 'AUTO',
       scratchOrgs: [
         {

test/nut/tracking.nut.ts

@@ -5,23 +5,25 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-
-import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
+import path from 'node:path';
+import { execCmd, TestSession, genUniqueString } from '@salesforce/cli-plugins-testkit';
 import { expect } from 'chai';
 import { Messages } from '@salesforce/core';
 import { OrgEnableTrackingResult } from '../../src/commands/org/enable/tracking.js';
 import { OrgDisableTrackingResult } from '../../src/commands/org/disable/tracking.js';
 
-Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-org', 'org.enable.tracking');
 
 describe('org enable/disable tracking NUTs', () => {
   let session: TestSession;
 
   before(async () => {
+    const uid = genUniqueString('tracking_%s');
     session = await TestSession.create({
       devhubAuthStrategy: 'AUTO',
       project: { name: 'orgEnableDisableTrackingNut' },
+      sessionDir: path.join(process.cwd(), `test_session_${uid}`),
       scratchOrgs: [{ setDefault: true, edition: 'developer' }],
     });
   });

test/shared/sandboxMockUtils.ts

@@ -74,12 +74,12 @@ export const updateSuccessResponse: SaveResult = {
   errors: [],
 };
 
-export const readSandboxCacheFile = async (cacheFilePath: string): Promise<Record<string, CachedOptions>> =>
-  JSON.parse(await fs.promises.readFile(cacheFilePath, 'utf8')) as unknown as Record<string, CachedOptions>;
-export const deleteSandboxCacheFile = async (cacheFilePath: string): Promise<void> => fs.promises.unlink(cacheFilePath);
-export const readAuthFile = async (homeDir: string, username: string): Promise<AuthFields> => {
+export const readSandboxCacheFile = (cacheFilePath: string): Record<string, CachedOptions> =>
+  JSON.parse(fs.readFileSync(cacheFilePath, 'utf8')) as unknown as Record<string, CachedOptions>;
+export const deleteSandboxCacheFile = (cacheFilePath: string): void => fs.unlinkSync(cacheFilePath);
+export const readAuthFile = (homeDir: string, username: string): AuthFields => {
   const filePath = path.join(homeDir, Global.STATE_FOLDER, `${username}.json`);
-  return JSON.parse(await fs.promises.readFile(filePath, 'utf8')) as AuthFields;
+  return JSON.parse(fs.readFileSync(filePath, 'utf8')) as AuthFields;
 };
 export const getSandboxInfo = (overrides?: Partial<SandboxInfo>): SandboxInfo =>
   Object.assign({}, sandboxInfo, overrides);
@@ -114,7 +114,7 @@ export const stubProdOrgConnection = async (
     .stub(Org, 'create')
     .withArgs({ aliasOrUsername: username })
     .callsFake(async (opts) => {
-      const org = (await orgCreateFn.call(Org, opts)) as Org;
+      const org = (await orgCreateFn(opts)) as Org;
       // @ts-expect-error re-assigning a private property
       org.connection = connection;
       return org;