@salesforce/source-testkit 1.2.16 → 2.0.0

package/lib/assertions.d.ts

@@ -117,6 +117,10 @@ export declare class Assertions {
      * Expect json to have given error name
      */
     errorToHaveName(result: JsonMap, name: string): void;
+    /**
+     * Expect error json to include given message
+     */
+    errorToHaveMessage(result: JsonMap, message: string): void;
     /**
      * Expect no apex tests to be run
      */

package/lib/assertions.js

@@ -244,6 +244,13 @@ class Assertions {
         (0, chai_1.expect)(result).to.have.property('name');
         (0, chai_1.expect)(result.name, `error name to equal ${name}`).to.equal(name);
     }
+    /**
+     * Expect error json to include given message
+     */
+    errorToHaveMessage(result, message) {
+        (0, chai_1.expect)(result).to.have.property('message');
+        (0, chai_1.expect)(result.message, `error name to include ${message}`).to.include(message);
+    }
     /**
      * Expect no apex tests to be run
      */

package/lib/testkit.d.ts

@@ -1,3 +1,4 @@
+import { ScratchOrgConfig, CLI } from '@salesforce/cli-plugins-testkit';
 import { AsyncCreatable, Env } from '@salesforce/kit';
 import { AnyJson, Dictionary, JsonMap, Nullable } from '@salesforce/ts-types';
 import { NamedPackageDir } from '@salesforce/core';
@@ -22,8 +23,6 @@ import { Assertions } from './assertions';
 export declare class SourceTestkit extends AsyncCreatable<SourceTestkit.Options> {
     static Env: Env;
     private static DefaultCmdOpts;
-    private static LocalDevPath;
-    private static LocalProdPath;
     packages: NamedPackageDir[];
     packageNames: string[];
     packagePaths: string[];
@@ -36,7 +35,6 @@ export declare class SourceTestkit extends AsyncCreatable<SourceTestkit.Options>
     private commands;
     private connection;
     private debug;
-    private executable;
     private executableName;
     private executionLog;
     private fileTracker;
@@ -45,7 +43,7 @@ export declare class SourceTestkit extends AsyncCreatable<SourceTestkit.Options>
     private orgless;
     private repository;
     private session;
-    private setupCommands;
+    private scratchOrgs;
     constructor(options: SourceTestkit.Options);
     /**
      * Cleans the test session
@@ -198,10 +196,6 @@ export declare class SourceTestkit extends AsyncCreatable<SourceTestkit.Options>
      * property in the local maxRevision.json to null
      */
     spoofRemoteChange(globs: string[]): Promise<void>;
-    /**
-     * Returns true if the executable being used belongs to a local package
-     */
-    isLocalExecutable(): boolean;
     /**
      * Move the manifest file to the current working directory.
      *
@@ -232,12 +226,13 @@ export declare namespace SourceTestkit {
         readonly repository: string;
         readonly nut: string;
         readonly orgless?: boolean;
-        readonly setupCommands?: string[];
+        readonly scratchOrgs?: ScratchOrgConfig[];
     };
     type CommandOpts = {
         exitCode: number;
         args: string;
         json: boolean;
+        cli: CLI;
     };
 }
 export declare enum Executable {

package/lib/testkit.js

@@ -41,10 +41,9 @@ const fileTracker_1 = require("./fileTracker");
 class SourceTestkit extends kit_1.AsyncCreatable {
     constructor(options) {
         super(options);
-        this.executable = options.executable ?? (0, shelljs_1.which)('sfdx')?.stdout ?? 'sfdx';
         this.repository = options.repository;
         this.orgless = !!options.orgless;
-        this.setupCommands = options.setupCommands || [];
+        this.scratchOrgs = options.scratchOrgs || [];
         this.nut = path.basename(options.nut);
         this.debug = (0, debug_1.debug)(`sourceTestkit:${this.nut}`);
     }
@@ -311,12 +310,6 @@ class SourceTestkit extends kit_1.AsyncCreatable {
         }
         await this.writeMaxRevision(maxRevision);
     }
-    /**
-     * Returns true if the executable being used belongs to a local package
-     */
-    isLocalExecutable() {
-        return (this.executable.endsWith(SourceTestkit.LocalDevPath) || this.executable.endsWith(SourceTestkit.LocalProdPath));
-    }
     /**
      * Move the manifest file to the current working directory.
      *
@@ -342,9 +335,7 @@ class SourceTestkit extends kit_1.AsyncCreatable {
             this.debug(`${command} (expecting exit code: ${exitCode})`);
             await this.fileTracker.updateAll(`PRE: ${command}`);
             await this.executionLog.add(command);
-            const result = this.executableName === Executable.SF
-                ? (0, cli_plugins_testkit_1.execCmd)(command, { ensureExitCode: exitCode, cli: 'sf' })
-                : (0, cli_plugins_testkit_1.execCmd)(command, { ensureExitCode: exitCode, cli: 'sfdx' });
+            const result = (0, cli_plugins_testkit_1.execCmd)(command, { ensureExitCode: exitCode, cli: options.cli ?? 'inherit' });
             await this.fileTracker.updateAll(`POST: ${command}`);
             if (json) {
                 const jsonOutput = result.jsonOutput;
@@ -373,7 +364,6 @@ class SourceTestkit extends kit_1.AsyncCreatable {
             (0, ts_types_1.ensureString)(SourceTestkit.Env.getString('TESTKIT_JWT_CLIENT_ID'));
             (0, ts_types_1.ensureString)(SourceTestkit.Env.getString('TESTKIT_HUB_INSTANCE'));
         }
-        SourceTestkit.Env.setString('TESTKIT_EXECUTABLE_PATH', this.executable);
         try {
             this.executableName = await this.getExecutableName();
             this.commands = exports.COMMANDS[this.executableName];
@@ -407,17 +397,9 @@ class SourceTestkit extends kit_1.AsyncCreatable {
         }
     }
     async getExecutableName() {
-        if (this.isLocalExecutable()) {
-            const npmPackagePath = this.executable
-                .replace(SourceTestkit.LocalProdPath, '')
-                .replace(SourceTestkit.LocalDevPath, '');
-            const pkgJsonPath = path.join(npmPackagePath, 'package.json');
-            const pkgJson = (0, kit_1.parseJsonMap)(await fs.promises.readFile(pkgJsonPath, 'utf8'));
-            return pkgJson.oclif.bin;
-        }
-        else {
-            return path.basename(this.executable);
-        }
+        const pkgJsonPath = path.join(process.cwd(), 'package.json');
+        const pkgJson = (0, kit_1.parseJsonMap)(await fs.promises.readFile(pkgJsonPath, 'utf8'));
+        return pkgJson.oclif.bin;
     }
     getCommandString(cmdKey) {
         const cmd = this.commands[cmdKey];
@@ -425,7 +407,7 @@ class SourceTestkit extends kit_1.AsyncCreatable {
             return cmd;
         }
         else {
-            throw new Error(`${cmdKey} command not implemented for executable ${this.executable}`);
+            throw new Error(`${cmdKey} command not implemented for this executable`);
         }
     }
     /**
@@ -445,15 +427,12 @@ class SourceTestkit extends kit_1.AsyncCreatable {
         throw err;
     }
     async createSession() {
-        const setupCommands = this.orgless
+        const scratchOrgs = this.orgless
             ? []
-            : [
-                'sfdx config:set restDeploy=false --global',
-                'sfdx force:org:create -d 1 -s -f config/project-scratch-def.json',
-            ];
+            : [{ executable: 'sf', duration: 1, setDefault: true, config: path.join('config', 'project-scratch-def.json') }];
         return await cli_plugins_testkit_1.TestSession.create({
             project: { gitClone: this.repository },
-            setupCommands: [...setupCommands, ...this.setupCommands],
+            scratchOrgs: [...scratchOrgs, ...this.scratchOrgs],
             retries: 2,
         });
     }
@@ -495,9 +474,8 @@ SourceTestkit.DefaultCmdOpts = {
     exitCode: 0,
     args: '',
     json: true,
+    cli: 'inherit',
 };
-SourceTestkit.LocalDevPath = path.join('bin', 'dev');
-SourceTestkit.LocalProdPath = path.join('bin', 'run');
 var Executable;
 (function (Executable) {
     Executable["SFDX"] = "sfdx";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/source-testkit",
   "description": "testkit for running NUTs for source related commands",
-  "version": "1.2.16",
+  "version": "2.0.0",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
   "main": "lib/index.js",
@@ -30,7 +30,7 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@salesforce/cli-plugins-testkit": "^2.5.2",
+    "@salesforce/cli-plugins-testkit": "^3.0.0",
     "@salesforce/core": "^3.30.2",
     "@salesforce/kit": "^1.5.42",
     "@salesforce/source-deploy-retrieve": "^6.8.2",
@@ -71,7 +71,7 @@
     "pretty-quick": "^3.1.0",
     "sinon": "^10.0.0",
     "ts-node": "^10.0.0",
-    "typescript": "^4.8.3"
+    "typescript": "^4.8.4"
   },
   "config": {
     "commitizen": {