@salesforce/source-testkit 2.0.2 → 2.0.4

package/lib/assertions.js

@@ -16,6 +16,7 @@ const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
 const debug_1 = require("debug");
 const fileTracker_1 = require("./fileTracker");
 (0, chai_1.use)(chaiEach);
+/* eslint-disable no-await-in-loop */
 /**
  * Assertions is a class that is designed to encapsulate common assertions we want to
  * make during NUT testings
@@ -147,6 +148,7 @@ class Assertions {
     /**
      * Expects files to exist in convert output directory
      */
+    // eslint-disable-next-line class-methods-use-this
     async filesToBeConverted(directory, globs) {
         directory = directory.split(path.sep).join('/');
         const fullGlobs = globs.map((glob) => [directory, glob].join('/'));
@@ -203,6 +205,7 @@ class Assertions {
     /**
      * Expect status to return no results
      */
+    // eslint-disable-next-line class-methods-use-this
     statusToBeEmpty(result) {
         (0, chai_1.expect)(result.length, 'status to have no results').to.equal(0);
     }
@@ -218,6 +221,7 @@ class Assertions {
     /**
      * Expect given file to have the given state
      */
+    // eslint-disable-next-line class-methods-use-this
     statusFileToHaveState(result, state, file) {
         const expectedFile = result.find((r) => r.filePath === file);
         (0, chai_1.expect)(expectedFile, `${file} to be present in json response`).to.not.be.undefined;
@@ -226,6 +230,7 @@ class Assertions {
     /**
      * Expect all given files to have the given state
      */
+    // eslint-disable-next-line class-methods-use-this
     statusToOnlyHaveState(result, state) {
         const allStates = result.every((r) => r.state === state);
         (0, chai_1.expect)(allStates, `all files to have ${state}`).to.be.true;
@@ -233,6 +238,7 @@ class Assertions {
     /**
      * Expect all files to have a conflict state
      */
+    // eslint-disable-next-line class-methods-use-this
     statusToOnlyHaveConflicts(result) {
         const allConflicts = result.every((r) => r.state.includes('Conflict'));
         (0, chai_1.expect)(allConflicts, 'all results to show conflict state').to.be.true;
@@ -240,6 +246,7 @@ class Assertions {
     /**
      * Expect json to have given error name
      */
+    // eslint-disable-next-line class-methods-use-this
     errorToHaveName(result, name) {
         (0, chai_1.expect)(result).to.have.property('name');
         (0, chai_1.expect)(result.name, `error name to equal ${name}`).to.equal(name);
@@ -247,6 +254,7 @@ class Assertions {
     /**
      * Expect error json to include given message
      */
+    // eslint-disable-next-line class-methods-use-this
     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);
@@ -277,20 +285,20 @@ class Assertions {
         const classIds = apexClasses.map((c) => c.Id);
         const executionTimestamp = this.executionLog.getLatestTimestamp(this.commands.deploy);
         const testResults = await this.retrieveApexTestResults();
-        const testsRunAfterTimestamp = testResults.filter((r) => {
-            return new Date(r.TestTimestamp) > executionTimestamp && classIds.includes(r.ApexClassId);
-        });
+        const testsRunAfterTimestamp = testResults.filter((r) => new Date(r.TestTimestamp) > executionTimestamp && classIds.includes(r.ApexClassId));
         (0, chai_1.expect)(testsRunAfterTimestamp.length, 'tests to be run during deploy').to.be.greaterThan(0);
     }
     /**
      * Expect result to have given property
      */
+    // eslint-disable-next-line class-methods-use-this
     toHaveProperty(result, prop) {
         (0, chai_1.expect)(result).to.have.property(prop);
     }
     /**
      * Expect result to have given property and for that property to equal the given value
      */
+    // eslint-disable-next-line class-methods-use-this
     toHavePropertyAndValue(result, prop, value) {
         (0, chai_1.expect)(result).to.have.property(prop);
         (0, chai_1.expect)(result[prop], `${prop} to have value ${value.toString()}`).to.equal(value);
@@ -298,6 +306,7 @@ class Assertions {
     /**
      * Expect result to have given property and for that property to NOT equal the given value
      */
+    // eslint-disable-next-line class-methods-use-this
     toHavePropertyAndNotValue(result, prop, value) {
         (0, chai_1.expect)(result).to.have.property(prop);
         (0, chai_1.expect)(result[prop], `${prop} to have value that does not equal ${value.toString()}`).to.not.equal(value);
@@ -307,7 +316,7 @@ class Assertions {
         const latestSourceMembers = await this.retrieveSourceMembers(globs, ignore);
         for (const sourceMember of latestSourceMembers) {
             const assertionMessage = `expect RevisionCounter for ${sourceMember.MemberName} (${sourceMember.MemberType}) to be incremented`;
-            const preCommandExecution = sourceMembers.find((s) => s.MemberType === sourceMember.MemberType && s.MemberName === sourceMember.MemberName) || { RevisionCounter: 0 };
+            const preCommandExecution = sourceMembers.find((s) => s.MemberType === sourceMember.MemberType && s.MemberName === sourceMember.MemberName) ?? { RevisionCounter: 0 };
             (0, chai_1.expect)(sourceMember.RevisionCounter, assertionMessage).to.be.greaterThan(preCommandExecution.RevisionCounter);
         }
     }
@@ -323,7 +332,7 @@ class Assertions {
         else {
             for (const sourceMember of latestSourceMembers) {
                 const assertionMessage = `expect RevisionCounter for ${sourceMember.MemberName} (${sourceMember.MemberType}) to NOT be incremented`;
-                const preCommandExecution = sourceMembers.find((s) => s.MemberType === sourceMember.MemberType && s.MemberName === sourceMember.MemberName) || { RevisionCounter: 0 };
+                const preCommandExecution = sourceMembers.find((s) => s.MemberType === sourceMember.MemberType && s.MemberName === sourceMember.MemberName) ?? { RevisionCounter: 0 };
                 (0, chai_1.expect)(sourceMember.RevisionCounter, assertionMessage).to.equal(preCommandExecution.RevisionCounter);
             }
         }
@@ -332,7 +341,7 @@ class Assertions {
         const sourceMembers = this.executionLog.getLatest(command)?.sourceMembers || [];
         const latestSourceMembers = await this.retrieveSourceMembers(globs);
         const someAreNotUpdated = latestSourceMembers.some((sourceMember) => {
-            const preCommandExecution = sourceMembers.find((s) => s.MemberType === sourceMember.MemberType && s.MemberName === sourceMember.MemberName) || { RevisionCounter: 0 };
+            const preCommandExecution = sourceMembers.find((s) => s.MemberType === sourceMember.MemberType && s.MemberName === sourceMember.MemberName) ?? { RevisionCounter: 0 };
             return sourceMember.RevisionCounter === preCommandExecution.RevisionCounter;
         });
         (0, chai_1.expect)(someAreNotUpdated, 'expect some SourceMembers to not be updated').to.be.true;
@@ -359,19 +368,17 @@ class Assertions {
                 }
             }
         }
-        return (result?.records || []).filter((sourceMember) => {
-            return membersMap.get(sourceMember.MemberType)?.has(sourceMember.MemberName);
-        });
+        return (result?.records ?? []).filter((sourceMember) => membersMap.get(sourceMember.MemberType)?.has(sourceMember.MemberName));
     }
     async retrieveApexTestResults() {
         const query = 'SELECT TestTimestamp, ApexClassId FROM ApexTestResult';
         const result = await this.connection?.tooling.query(query, { autoFetch: true, maxFetch: 50000 });
-        return result?.records || [];
+        return result?.records ?? [];
     }
     async retrieveApexClasses(classNames) {
         const query = 'SELECT Name,Id FROM ApexClass';
         const result = await this.connection?.tooling.query(query, { autoFetch: true, maxFetch: 50000 });
-        const records = result?.records || [];
+        const records = result?.records ?? [];
         return classNames ? records.filter((r) => classNames.includes(r.Name)) : records;
     }
     async doGlob(globs, assert = true) {

package/lib/executionLog.js

@@ -22,8 +22,8 @@ class ExecutionLog {
      * Add a command to the execution log
      */
     async add(cmd) {
-        const baseCmd = (0, ts_types_1.ensureString)(Object.values(this.context.commands).find((c) => cmd.startsWith(c)) || cmd.split(' -')[0]);
-        const existingEntries = this.log.get(baseCmd) || [];
+        const baseCmd = (0, ts_types_1.ensureString)(Object.values(this.context.commands).find((c) => cmd.startsWith(c)) ?? cmd.split(' -')[0]);
+        const existingEntries = this.log.get(baseCmd) ?? [];
         const sourceMembers = baseCmd.includes(this.context.commands.deploy) || baseCmd.includes(this.context.commands.push)
             ? await this.querySourceMembers()
             : [];
@@ -44,7 +44,7 @@ class ExecutionLog {
      * Return the most recent entry for a command
      */
     getLatest(cmd) {
-        const log = this.log.get(cmd) || [];
+        const log = this.log.get(cmd) ?? [];
         const sorted = log.sort((a, b) => (a.timestamp < b.timestamp ? 1 : -1));
         return sorted[0];
     }
@@ -54,7 +54,7 @@ class ExecutionLog {
             autoFetch: true,
             maxFetch: 50000,
         });
-        return result?.records || [];
+        return result?.records ?? [];
     }
 }
 exports.ExecutionLog = ExecutionLog;

package/lib/fileTracker.js

@@ -10,6 +10,7 @@ exports.countFiles = exports.traverseForFiles = exports.FileTracker = void 0;
 const fs = require("fs");
 const path = require("path");
 const crypto = require("crypto");
+/* eslint-disable no-await-in-loop */
 /**
  * This class maintains a map of tracked files. This is particularly useful
  * for determining if files have changed after a command has been executed
@@ -35,7 +36,7 @@ class FileTracker {
      * Returns tracked file's history
      */
     get(file) {
-        return this.files.get(file) || [];
+        return this.files.get(file) ?? [];
     }
     /**
      * Returns latest entry for file

package/lib/testkit.d.ts

@@ -209,14 +209,12 @@ export declare class SourceTestkit extends AsyncCreatable<SourceTestkit.Options>
      */
     execute<T>(cmd: string, options?: Partial<SourceTestkit.CommandOpts>): Promise<Nullable<Result<T>>>;
     protected init(): Promise<void>;
-    private getExecutableName;
     private getCommandString;
     /**
      * Log error to console with helpful debugging information
      */
     private handleError;
     private createSession;
-    private getDefaultUsername;
     private createConnection;
     private doGlob;
 }

package/lib/testkit.js

@@ -8,6 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.COMMANDS = exports.Executable = exports.SourceTestkit = void 0;
 /* eslint-disable no-console */
+/* eslint-disable no-await-in-loop */
 const path = require("path");
 const os = require("os");
 const fs = require("fs");
@@ -43,7 +44,7 @@ class SourceTestkit extends kit_1.AsyncCreatable {
         super(options);
         this.repository = options.repository;
         this.orgless = !!options.orgless;
-        this.scratchOrgs = options.scratchOrgs || [];
+        this.scratchOrgs = options.scratchOrgs ?? [];
         this.nut = path.basename(options.nut);
         this.debug = (0, debug_1.debug)(`sourceTestkit:${this.nut}`);
     }
@@ -118,6 +119,7 @@ class SourceTestkit extends kit_1.AsyncCreatable {
      * Installs a package into the scratch org. This method uses shelljs instead of testkit because
      * we can't add plugin-package as a dev plugin yet.
      */
+    // eslint-disable-next-line class-methods-use-this
     installPackage(id) {
         (0, shelljs_1.exec)(`sfdx force:package:install --noprompt --package ${id} --wait 5 --json 2> /dev/null`, { silent: true });
     }
@@ -127,7 +129,7 @@ class SourceTestkit extends kit_1.AsyncCreatable {
      * @param options
      */
     async assignPermissionSet(options = {}) {
-        return await this.execute('force:user:permset:assign', options);
+        return this.execute('force:user:permset:assign', options);
     }
     /**
      * Adds given files to FileTracker for tracking
@@ -181,6 +183,7 @@ class SourceTestkit extends kit_1.AsyncCreatable {
     /**
      * Write file
      */
+    // eslint-disable-next-line class-methods-use-this
     async writeFile(filename, contents) {
         return fs.promises.writeFile(filename, contents);
     }
@@ -317,6 +320,7 @@ class SourceTestkit extends kit_1.AsyncCreatable {
      * in the same location as toolbelt so we have to find it within the output
      * dir, move it, and delete the generated dir.
      */
+    // eslint-disable-next-line class-methods-use-this
     findAndMoveManifest(dir) {
         const manifest = (0, shelljs_1.find)(dir).filter((file) => file.endsWith('package.xml'));
         if (!manifest?.length) {
@@ -365,7 +369,7 @@ class SourceTestkit extends kit_1.AsyncCreatable {
             (0, ts_types_1.ensureString)(SourceTestkit.Env.getString('TESTKIT_HUB_INSTANCE'));
         }
         try {
-            this.executableName = await this.getExecutableName();
+            this.executableName = await getExecutableName();
             this.commands = exports.COMMANDS[this.executableName];
             this.metadataResolver = new source_deploy_retrieve_1.MetadataResolver();
             this.session = await this.createSession();
@@ -375,7 +379,7 @@ class SourceTestkit extends kit_1.AsyncCreatable {
             this.packageNames = this.packages.map((p) => p.name);
             this.packagePaths = this.packages.map((p) => p.fullPath);
             this.packageGlobs = this.packages.map((p) => `${p.path}/**/*`);
-            this.username = await this.getDefaultUsername();
+            this.username = await getDefaultUsername();
             this.connection = await this.createConnection();
             const context = {
                 connection: this.connection,
@@ -396,11 +400,6 @@ class SourceTestkit extends kit_1.AsyncCreatable {
             await this.handleError(error, true);
         }
     }
-    async getExecutableName() {
-        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];
         if (cmd) {
@@ -430,22 +429,13 @@ class SourceTestkit extends kit_1.AsyncCreatable {
         const scratchOrgs = this.orgless
             ? []
             : [{ executable: 'sf', duration: 1, setDefault: true, config: path.join('config', 'project-scratch-def.json') }];
-        return await cli_plugins_testkit_1.TestSession.create({
+        return cli_plugins_testkit_1.TestSession.create({
             project: { gitClone: this.repository },
             devhubAuthStrategy: 'AUTO',
             scratchOrgs: [...scratchOrgs, ...this.scratchOrgs],
             retries: 2,
         });
     }
-    async getDefaultUsername() {
-        const configVar = 'target-org';
-        const configResult = (0, cli_plugins_testkit_1.execCmd)(`config:get ${configVar} --json`).jsonOutput?.result;
-        // depending on which version of config:get the user has available, there may be a name or key
-        // eventually, drop the `key` option and the deprecated SfdxPropertyKeys
-        const possibleKeys = [configVar, core_1.SfdxPropertyKeys.DEFAULT_USERNAME];
-        const username = configResult?.find((r) => (r.key && possibleKeys.includes(r.key)) || (r.name && possibleKeys.includes(r.name)))?.value;
-        return username;
-    }
     async createConnection() {
         if (this.orgless)
             return;
@@ -498,4 +488,19 @@ exports.COMMANDS = {
         retrieve: 'retrieve metadata',
     },
 };
+const getDefaultUsername = async () => {
+    const configVar = 'target-org';
+    const configResult = (0, cli_plugins_testkit_1.execCmd)(`config:get ${configVar} --json`)
+        .jsonOutput?.result;
+    // depending on which version of config:get the user has available, there may be a name or key
+    // eventually, drop the `key` option and the deprecated SfdxPropertyKeys
+    const possibleKeys = [configVar, core_1.SfdxPropertyKeys.DEFAULT_USERNAME];
+    const username = configResult?.find((r) => (r.key && possibleKeys.includes(r.key)) || (r.name && possibleKeys.includes(r.name)))?.value;
+    return username;
+};
+const getExecutableName = async () => {
+    const pkgJsonPath = path.join(process.cwd(), 'package.json');
+    const pkgJson = (0, kit_1.parseJsonMap)(await fs.promises.readFile(pkgJsonPath, 'utf8'));
+    return pkgJson.oclif.bin;
+};
 //# sourceMappingURL=testkit.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/source-testkit",
   "description": "testkit for running NUTs for source related commands",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
   "main": "lib/index.js",
@@ -30,8 +30,8 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@salesforce/cli-plugins-testkit": "^3.0.2",
-    "@salesforce/core": "^3.30.2",
+    "@salesforce/cli-plugins-testkit": "^3.2.0",
+    "@salesforce/core": "^3.30.11",
     "@salesforce/kit": "^1.5.42",
     "@salesforce/source-deploy-retrieve": "^6.8.2",
     "@salesforce/ts-types": "^1.5.21",
@@ -44,40 +44,34 @@
   },
   "devDependencies": {
     "@salesforce/dev-config": "^3.0.0",
-    "@salesforce/dev-scripts": "^2.0.2",
+    "@salesforce/dev-scripts": "^3.1.0",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.4.0",
     "@types/archiver": "^5.1.0",
     "@types/debug": "^4.1.5",
     "@types/shelljs": "^0.8.11",
-    "@typescript-eslint/eslint-plugin": "^4.15.2",
-    "@typescript-eslint/parser": "^4.15.2",
+    "@typescript-eslint/eslint-plugin": "^5.39.0",
+    "@typescript-eslint/parser": "^5.39.0",
     "chai": "^4.3.0",
     "copyfiles": "^2.4.1",
-    "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^7.27.0",
-    "eslint-config-prettier": "^8.1.0",
-    "eslint-config-salesforce": "^0.1.6",
+    "eslint": "^8.25.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-salesforce": "^1.1.0",
     "eslint-config-salesforce-license": "^0.1.6",
-    "eslint-config-salesforce-typescript": "^0.2.8",
+    "eslint-config-salesforce-typescript": "^1.1.1",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-jsdoc": "^35.1.2",
-    "eslint-plugin-prettier": "^3.3.1",
+    "eslint-plugin-jsdoc": "^39.3.6",
     "husky": "^7.0.4",
     "mocha": "^9.1.3",
     "nyc": "^15.1.0",
-    "prettier": "^2.0.5",
+    "prettier": "^2.7.1",
     "pretty-quick": "^3.1.0",
     "sinon": "^10.0.0",
     "ts-node": "^10.0.0",
     "typescript": "^4.8.4"
   },
-  "config": {
-    "commitizen": {
-      "path": "cz-conventional-changelog"
-    }
-  },
+  "config": {},
   "publishConfig": {
     "access": "public"
   }