@salesforce/cli-plugins-testkit 1.5.34 → 2.0.1

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [2.0.1](https://github.com/salesforcecli/cli-plugins-testkit/compare/v2.0.0...v2.0.1) (2022-06-01)
+
+## [2.0.0](https://github.com/salesforcecli/cli-plugins-testkit/compare/v1.5.35...v2.0.0) (2022-05-31)
+
+### Features
+
+- parking orbit (core3, jsforce2) ([4575f9c](https://github.com/salesforcecli/cli-plugins-testkit/commit/4575f9c330528b1c6b4e6895ccde1fcd3b7d667e))
+
+### [1.5.35](https://github.com/salesforcecli/cli-plugins-testkit/compare/v1.5.34...v1.5.35) (2022-05-03)
+
 ### [1.5.34](https://github.com/salesforcecli/cli-plugins-testkit/compare/v1.5.33...v1.5.34) (2022-05-02)
 
 ### [1.5.33](https://github.com/salesforcecli/cli-plugins-testkit/compare/v1.5.32...v1.5.33) (2022-05-02)

package/lib/execCmd.d.ts

@@ -1,4 +1,4 @@
-import { SfdxError } from '@salesforce/core';
+import { SfError } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
 import { AnyJson } from '@salesforce/ts-types';
 import { ExecOptions, ShellString } from 'shelljs';
@@ -45,7 +45,7 @@ export interface SfdxExecCmdResult<T = Collection> extends ExecCmdResult {
     jsonOutput?: {
         status: number;
         result: T;
-    } & Partial<ExcludeMethods<SfdxError>>;
+    } & Partial<ExcludeMethods<SfError>>;
 }
 export interface SfExecCmdResult<T = Collection> extends ExecCmdResult {
     /**
@@ -54,7 +54,7 @@ export interface SfExecCmdResult<T = Collection> extends ExecCmdResult {
     jsonOutput?: {
         status: number;
         result: T;
-    } & Partial<ExcludeMethods<SfdxError>>;
+    } & Partial<ExcludeMethods<SfError>>;
 }
 /**
  * Synchronously execute a command with the provided options in a child process.

package/lib/execCmd.js

@@ -1,15 +1,15 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.execCmd = void 0;
 /*
  * Copyright (c) 2021, salesforce.com, inc.
  * All rights reserved.
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.execCmd = void 0;
+const fs = require("fs");
 const path_1 = require("path");
 const util_1 = require("util");
-const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const debug_1 = require("debug");
@@ -55,21 +55,22 @@ const getExitCodeError = (cmd, expectedCode, output) => {
  *
  * The executable preference order is:
  *    2. TESTKIT_EXECUTABLE_PATH env var
- *    3. `bin/run` (default)
+ *    3. `bin/dev` (default)
  *
  * @param cmdArgs The command name, args, and param as a string. E.g., `"force:user:create -a testuser1"`
  * @returns The command string with CLI executable. E.g., `"node_modules/bin/sfdx force:user:create -a testuser1"`
  */
 const buildCmd = (cmdArgs, options) => {
+    var _a;
     const debug = (0, debug_1.default)('testkit:buildCmd');
-    const bin = kit_1.env.getString('TESTKIT_EXECUTABLE_PATH') || (0, path_1.join)('bin', 'run');
+    const bin = (_a = kit_1.env.getString('TESTKIT_EXECUTABLE_PATH')) !== null && _a !== void 0 ? _a : (0, path_1.join)('bin', 'dev');
     const which = shelljs.which(bin);
     let resolvedPath = (0, path_1.resolve)(bin);
     // If which finds the path in the system path, use that.
     if (which) {
         resolvedPath = which;
     }
-    else if (!core_1.fs.fileExistsSync(bin)) {
+    else if (!fs.existsSync(bin)) {
         throw new Error(`Cannot find specified executable path: ${bin}`);
     }
     debug(`Using executable path: ${bin}`);

package/lib/hubAuth.js

@@ -9,9 +9,9 @@ exports.transferExistingAuthToEnv = exports.testkitHubAuth = exports.prepareForA
  */
 const path = require("path");
 const os = require("os");
+const fs = require("fs");
 const shell = require("shelljs");
 const debug_1 = require("debug");
-const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
 // this seems to be a known eslint error for enums
 // eslint-disable-next-line no-shadow
@@ -53,13 +53,13 @@ const formatJwtKey = () => {
 };
 const prepareForJwt = (homeDir) => {
     const jwtKey = path.join(homeDir, 'jwtKey');
-    core_1.fs.writeFileSync(jwtKey, formatJwtKey());
+    fs.writeFileSync(jwtKey, formatJwtKey());
     return jwtKey;
 };
 exports.prepareForJwt = prepareForJwt;
 const prepareForAuthUrl = (homeDir) => {
     const tmpUrl = path.join(homeDir, 'tmpUrl');
-    core_1.fs.writeFileSync(tmpUrl, kit_1.env.getString('TESTKIT_AUTH_URL', ''));
+    fs.writeFileSync(tmpUrl, kit_1.env.getString('TESTKIT_AUTH_URL', ''));
     return tmpUrl;
 };
 exports.prepareForAuthUrl = prepareForAuthUrl;
@@ -140,11 +140,11 @@ const transferExistingAuthToEnv = (authStrategy = getAuthStrategy()) => {
     logger(`reading ${devhub}.json`);
     const authFileName = `${devhub}.json`;
     const hubAuthFileSource = path.join(kit_1.env.getString('HOME') || os.homedir(), '.sfdx', authFileName);
-    const authFileContents = core_1.fs.readJsonSync(hubAuthFileSource);
+    const authFileContents = JSON.parse(fs.readFileSync(hubAuthFileSource, 'utf-8'));
     if (authFileContents.privateKey) {
         logger('copying variables to env from AuthFile for JWT');
         // this is jwt.  set the appropriate env vars
-        kit_1.env.setString('TESTKIT_JWT_KEY', core_1.fs.readFileSync(authFileContents.privateKey, 'utf-8'));
+        kit_1.env.setString('TESTKIT_JWT_KEY', fs.readFileSync(authFileContents.privateKey, 'utf-8'));
         kit_1.env.setString('TESTKIT_JWT_CLIENT_ID', authFileContents.clientId);
         kit_1.env.setString('TESTKIT_HUB_INSTANCE', authFileContents.instanceUrl);
         return;

package/lib/testProject.js

@@ -1,18 +1,18 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestProject = void 0;
 /*
  * Copyright (c) 2021, salesforce.com, inc.
  * All rights reserved.
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestProject = void 0;
+const fs = require("fs");
 const path = require("path");
 const os_1 = require("os");
 const util_1 = require("util");
 const debug_1 = require("debug");
 const shell = require("shelljs");
-const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
 const genUniqueString_1 = require("./genUniqueString");
 const zip_1 = require("./zip");
@@ -61,7 +61,7 @@ class TestProject {
             }
             // the git clone will fail if the destination dir is not empty, so after
             // a successful clone the only contents should be the cloned repo dir.
-            const cloneDirName = core_1.fs.readdirSync(destDir)[0];
+            const cloneDirName = fs.readdirSync(destDir)[0];
             this.dir = path.join(destDir, cloneDirName);
         }
         // Create a new project using the command.

package/lib/testSession.js

@@ -7,10 +7,9 @@ exports.TestSession = void 0;
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
+const fs = require("fs");
 const path = require("path");
-const ts_retry_promise_1 = require("ts-retry-promise");
 const debug_1 = require("debug");
-const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const sinon_1 = require("sinon");
@@ -69,7 +68,7 @@ class TestSession extends kit_1.AsyncOptionalCreatable {
         // Create the test session directory
         this.overriddenDir = kit_1.env.getString('TESTKIT_SESSION_DIR') || this.options.sessionDir;
         this.dir = this.overriddenDir || path.join(process.cwd(), `test_session_${this.id}`);
-        core_1.fs.mkdirpSync(this.dir);
+        fs.mkdirSync(this.dir, { recursive: true });
         // Setup a test project and stub process.cwd to be the project dir
         if (this.options.project) {
             let projectDir = kit_1.env.getString('TESTKIT_PROJECT_DIR');
@@ -77,17 +76,18 @@ class TestSession extends kit_1.AsyncOptionalCreatable {
                 this.project = new testProject_1.TestProject({ ...this.options.project, destinationDir: this.dir });
                 projectDir = this.project.dir;
             }
-            // The default bin/run in execCmd will no longer resolve properly when
+            // The default bin/dev in execCmd will no longer resolve properly when
             // a test project is used since process.cwd is changed.  If the
             // TESTKIT_EXECUTABLE_PATH env var is not being used, then set it
-            // to use the bin/run from the cwd now.
+            // to use the bin/dev from the cwd now.
             if (!kit_1.env.getString('TESTKIT_EXECUTABLE_PATH')) {
-                kit_1.env.setString('TESTKIT_EXECUTABLE_PATH', path.join(process.cwd(), 'bin', 'run'));
+                const binDev = path.join(process.cwd(), 'bin', 'dev');
+                kit_1.env.setString('TESTKIT_EXECUTABLE_PATH', fs.existsSync(binDev) ? binDev : path.join(process.cwd(), 'bin', 'run'));
             }
             this.stubCwd(projectDir);
         }
         // Write the test session options used to create this session
-        core_1.fs.writeJsonSync(path.join(this.dir, 'testSessionOptions.json'), JSON.parse(JSON.stringify(this.options)));
+        fs.writeFileSync(path.join(this.dir, 'testSessionOptions.json'), JSON.stringify(JSON.parse(JSON.stringify(this.options))));
         const authStrategy = this.options.authStrategy ? hubAuth_1.AuthStrategy[this.options.authStrategy] : undefined;
         // have to grab this before we change the home
         (0, hubAuth_1.transferExistingAuthToEnv)(authStrategy);
@@ -189,20 +189,8 @@ class TestSession extends kit_1.AsyncOptionalCreatable {
         if (this.overriddenDir) {
             return;
         }
-        // this is wrapped in a promise because shelljs isn't async/await
-        return await (0, ts_retry_promise_1.retry)(() => new Promise((resolve, reject) => {
-            this.debug(`Deleting test session dir: ${this.dir}`);
-            const rv = shell.rm('-rf', this.dir);
-            if (rv.code !== 0) {
-                reject(`Deleting the test session failed due to: ${rv.stderr}`);
-            }
-            resolve();
-        }), this.rmRetryConfig).catch((err) => {
-            if (err instanceof ts_retry_promise_1.RetryError) {
-                throw err.lastError;
-            }
-            throw err;
-        });
+        this.debug(`Deleting test session dir: ${this.dir}`);
+        return fs.promises.rm(this.dir, { recursive: true, force: true });
     }
     // Executes commands and keeps track of any orgs created.
     // Throws if any commands return a non-zero exitCode.

package/lib/zip.js

@@ -1,16 +1,16 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zipDir = void 0;
 /*
  * Copyright (c) 2021, salesforce.com, inc.
  * All rights reserved.
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.zipDir = void 0;
+const fs = require("fs");
 const path = require("path");
 const archiver_1 = require("archiver");
 const debug_1 = require("debug");
-const core_1 = require("@salesforce/core");
 /**
  * Zip the contents of a directory to a file.
  *
@@ -22,7 +22,7 @@ const zipDir = async (config) => {
     const { sourceDir, destDir, name } = config;
     const zip = (0, archiver_1.create)('zip', { zlib: { level: 3 } });
     const zipFilePath = path.join(destDir, name);
-    const output = core_1.fs.createWriteStream(zipFilePath);
+    const output = fs.createWriteStream(zipFilePath);
     debug(`Zipping contents of ${sourceDir} to ${zipFilePath}`);
     return new Promise((resolve, reject) => {
         output.on('close', () => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/cli-plugins-testkit",
   "description": "Provides test utilities to assist Salesforce CLI plug-in authors with writing non-unit tests (NUT).",
-  "version": "1.5.34",
+  "version": "2.0.1",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
   "main": "lib/index.js",
@@ -42,7 +42,7 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@salesforce/core": "^2.24.0",
+    "@salesforce/core": "^3.19.1",
     "@salesforce/kit": "^1.5.13",
     "@salesforce/ts-types": "^1.5.17",
     "archiver": "^5.2.0",
@@ -58,9 +58,6 @@
     "@salesforce/ts-sinon": "^1.3.18",
     "@types/archiver": "^5.1.0",
     "@types/debug": "^4.1.5",
-    "@types/graceful-fs": "^4.1.5",
-    "@types/jsforce": "^1.9.29",
-    "@types/mkdirp": "^1.0.1",
     "@types/shelljs": "^0.8.8",
     "@typescript-eslint/eslint-plugin": "^4.26.0",
     "@typescript-eslint/parser": "^4.26.0",