Merge remote-tracking branch 'origin/main' into sm/linter-undefined

Author: mshanemc

CHANGELOG.md

@@ -1,3 +1,33 @@
+## [3.2.5](https://github.com/salesforcecli/plugin-apex/compare/3.2.4...3.2.5) (2024-07-14)
+
+### Bug Fixes
+
+- **deps:** bump @salesforce/sf-plugins-core from 11.1.2 to 11.1.6 ([0422b2c](https://github.com/salesforcecli/plugin-apex/commit/0422b2cac21f00695c376535ac4b24801afd91b7))
+
+## [3.2.4](https://github.com/salesforcecli/plugin-apex/compare/3.2.3...3.2.4) (2024-07-07)
+
+### Bug Fixes
+
+- **deps:** bump @salesforce/apex-node from 7.0.3 to 7.0.4 ([e885af8](https://github.com/salesforcecli/plugin-apex/commit/e885af885e18ed75cadf556767a3ac494de7520f))
+
+## [3.2.3](https://github.com/salesforcecli/plugin-apex/compare/3.2.2...3.2.3) (2024-07-02)
+
+### Bug Fixes
+
+- **deps:** bump apex library ([#513](https://github.com/salesforcecli/plugin-apex/issues/513)) ([edd63e8](https://github.com/salesforcecli/plugin-apex/commit/edd63e8d629fc1976358da58e7cf75006d883159))
+
+## [3.2.2](https://github.com/salesforcecli/plugin-apex/compare/3.2.1...3.2.2) (2024-06-30)
+
+### Bug Fixes
+
+- **deps:** bump @oclif/core from 4.0.6 to 4.0.7 ([152b032](https://github.com/salesforcecli/plugin-apex/commit/152b03235a83dc7e1d8728afc8a8c4d6f213c51d))
+
+## [3.2.1](https://github.com/salesforcecli/plugin-apex/compare/3.2.0...3.2.1) (2024-06-27)
+
+### Bug Fixes
+
+- added examples to apex run and apex get ([fb56783](https://github.com/salesforcecli/plugin-apex/commit/fb5678372f63008b2089799f30ac2c1f9158c802))
+
 # [3.2.0](https://github.com/salesforcecli/plugin-apex/compare/3.1.22...3.2.0) (2024-06-18)
 
 ### Features

README.md

@@ -148,7 +148,7 @@ FLAG DESCRIPTIONS
     directory.
 ```
 
-_See code: [src/commands/apex/get/log.ts](https://github.com/salesforcecli/plugin-apex/blob/3.2.0/src/commands/apex/get/log.ts)_
+_See code: [src/commands/apex/get/log.ts](https://github.com/salesforcecli/plugin-apex/blob/3.2.5/src/commands/apex/get/log.ts)_
 
 ## `sf apex get test`
 
@@ -199,10 +199,10 @@ EXAMPLES
   default org):
 
     $ sf apex get test --test-run-id <test run id> --code-coverage --output-dir <path to outputdir> --target-org \
-      me@myorg',
+      me@myorg'
 ```
 
-_See code: [src/commands/apex/get/test.ts](https://github.com/salesforcecli/plugin-apex/blob/3.2.0/src/commands/apex/get/test.ts)_
+_See code: [src/commands/apex/get/test.ts](https://github.com/salesforcecli/plugin-apex/blob/3.2.5/src/commands/apex/get/test.ts)_
 
 ## `sf apex list log`
 
@@ -242,7 +242,7 @@ EXAMPLES
     $ sf apex list log --target-org me@my.org
 ```
 
-_See code: [src/commands/apex/list/log.ts](https://github.com/salesforcecli/plugin-apex/blob/3.2.0/src/commands/apex/list/log.ts)_
+_See code: [src/commands/apex/list/log.ts](https://github.com/salesforcecli/plugin-apex/blob/3.2.5/src/commands/apex/list/log.ts)_
 
 ## `sf apex run`
 
@@ -289,7 +289,7 @@ EXAMPLES
     $ sf apex run
 ```
 
-_See code: [src/commands/apex/run.ts](https://github.com/salesforcecli/plugin-apex/blob/3.2.0/src/commands/apex/run.ts)_
+_See code: [src/commands/apex/run.ts](https://github.com/salesforcecli/plugin-apex/blob/3.2.5/src/commands/apex/run.ts)_
 
 ## `sf apex run test`
 
@@ -369,14 +369,45 @@ EXAMPLES
 
     $ sf apex run test --test-level RunLocalTests --output-dir <path to outputdir> --target-org me@my.org
 
+  Run all tests in the org asynchronously:
+
+    $ sf apex run test --target-org myscratch
+
+  Run all tests synchronously; the command waits to display the test results until all tests finish:
+
+    $ sf apex run test --synchronous
+
+  Run specific tests using the --test-level flag:
+
+    $ sf apex run test --test-level RunLocalTests
+
+  Run Apex tests on all the methods in the specified class; output results in Test Anything Protocol (TAP) format and
+  request code coverage results:
+
+    $ sf apex run test --class-names TestA --class-names TestB --result-format tap --code-coverage
+
+  Run Apex tests on methods specified using the standard Class.method notation; if you specify a test class without a
+  method, the command runs all methods in the class:
+
+    $ sf apex run test --tests TestA.excitingMethod --tests TestA.boringMethod --tests TestB
+
+  Run Apex tests on methods specified using the standard Class.method notation with a namespace:
+
+    $ sf apex run test --tests ns.TestA.excitingMethod --tests ns.TestA.boringMethod --tests ns.TestB
+
 FLAG DESCRIPTIONS
   -l, --test-level=RunLocalTests|RunAllTestsInOrg|RunSpecifiedTests  Level of tests to run; default is RunLocalTests.
 
     Here's what the levels mean:
 
-    - RunSpecifiedTests — Only the tests that you specify are run.
-    - RunLocalTests — All tests in your org are run, except the ones that originate from installed managed packages.
-    - RunAllTestsInOrg — All tests are in your org and in installed managed packages are run
+    - RunSpecifiedTests — Only the tests that you specify in the runTests option are run. Code coverage requirements
+    differ from the default coverage requirements when using this test level. The executed tests must cover each class
+    and trigger in the deployment package for a minimum of 75% code coverage. This coverage is computed for each class
+    and triggers individually, and is different than the overall coverage percentage.
+    - RunLocalTests — All local tests in your org, including tests that originate from no-namespaced unlocked packages,
+    are run. The tests that originate from installed managed packages and namespaced unlocked packages aren't run. This
+    test level is the default for production deployments that include Apex classes or triggers.
+    - RunAllTestsInOrg — All tests are run. The tests include all tests in your org.
 
   -n, --class-names=<value>...  Apex test class names to run; default is all classes.
 
@@ -399,7 +430,7 @@ FLAG DESCRIPTIONS
     --tests Test1 --tests Test2
 ```
 
-_See code: [src/commands/apex/run/test.ts](https://github.com/salesforcecli/plugin-apex/blob/3.2.0/src/commands/apex/run/test.ts)_
+_See code: [src/commands/apex/run/test.ts](https://github.com/salesforcecli/plugin-apex/blob/3.2.5/src/commands/apex/run/test.ts)_
 
 ## `sf apex tail log`
 
@@ -442,6 +473,6 @@ EXAMPLES
     $ sf apex tail log --color --skip-trace-flag
 ```
 
-_See code: [src/commands/apex/tail/log.ts](https://github.com/salesforcecli/plugin-apex/blob/3.2.0/src/commands/apex/tail/log.ts)_
+_See code: [src/commands/apex/tail/log.ts](https://github.com/salesforcecli/plugin-apex/blob/3.2.5/src/commands/apex/tail/log.ts)_
 
 <!-- commandsstop -->

messages/gettest.md

@@ -22,7 +22,7 @@ Provide a test run ID to display test results for an enqueued or completed async
 
 - Specify a directory in which to save the test results from the org with the specified username (rather than your default org):
 
-  <%= config.bin %> <%= command.id %> --test-run-id <test run id> --code-coverage --output-dir <path to outputdir> --target-org me@myorg',
+  <%= config.bin %> <%= command.id %> --test-run-id <test run id> --code-coverage --output-dir <path to outputdir> --target-org me@myorg'
 
 # flags.test-run-id.summary
 

messages/runtest.md

@@ -34,6 +34,30 @@ NOTE: The testRunCoverage value (JSON and JUnit result formats) is a percentage
 
   <%= config.bin %> <%= command.id %> --test-level RunLocalTests --output-dir <path to outputdir> --target-org me@my.org
 
+- Run all tests in the org asynchronously:
+
+  <%= config.bin %> <%= command.id %> --target-org myscratch
+
+- Run all tests synchronously; the command waits to display the test results until all tests finish:
+
+  <%= config.bin %> <%= command.id %> --synchronous
+
+- Run specific tests using the --test-level flag:
+
+  <%= config.bin %> <%= command.id %> --test-level RunLocalTests
+
+- Run Apex tests on all the methods in the specified class; output results in Test Anything Protocol (TAP) format and request code coverage results:
+
+  <%= config.bin %> <%= command.id %> --class-names TestA --class-names TestB --result-format tap --code-coverage
+
+- Run Apex tests on methods specified using the standard Class.method notation; if you specify a test class without a method, the command runs all methods in the class:
+
+  <%= config.bin %> <%= command.id %> --tests TestA.excitingMethod --tests TestA.boringMethod --tests TestB
+
+- Run Apex tests on methods specified using the standard Class.method notation with a namespace:
+
+  <%= config.bin %> <%= command.id %> --tests ns.TestA.excitingMethod --tests ns.TestA.boringMethod --tests ns.TestB
+
 # flags.class-names.summary
 
 Apex test class names to run; default is all classes.
@@ -80,9 +104,9 @@ Level of tests to run; default is RunLocalTests.
 
 Here's what the levels mean:
 
-- RunSpecifiedTests — Only the tests that you specify are run.
-- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed packages.
-- RunAllTestsInOrg — All tests are in your org and in installed managed packages are run
+- RunSpecifiedTests — Only the tests that you specify in the runTests option are run. Code coverage requirements differ from the default coverage requirements when using this test level. The executed tests must cover each class and trigger in the deployment package for a minimum of 75% code coverage. This coverage is computed for each class and triggers individually, and is different than the overall coverage percentage.
+- RunLocalTests — All local tests in your org, including tests that originate from no-namespaced unlocked packages, are run. The tests that originate from installed managed packages and namespaced unlocked packages aren't run. This test level is the default for production deployments that include Apex classes or triggers.
+- RunAllTestsInOrg — All tests are run. The tests include all tests in your org.
 
 # flags.wait.summary
 
@@ -119,7 +143,7 @@ Encountered an error when processing test results
 
 # apexTestReportFormatHint
 
-Run "%s apex get test %s --result-format <format>" to retrieve test results in a different format.
+Run "sf apex get test %s --result-format <format>" to retrieve test results in a different format.
 
 # outputDirHint
 

package.json

@@ -1,24 +1,24 @@
 {
   "name": "@salesforce/plugin-apex",
   "description": "Apex commands",
-  "version": "3.2.0",
+  "version": "3.2.5",
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
-    "@oclif/core": "^4",
-    "@salesforce/apex-node": "^6.1.2",
-    "@salesforce/core": "^7.4.1",
+    "@salesforce/apex-node": "^7.0.4",
+    "@salesforce/core": "^8.1.0",
     "@salesforce/kit": "^3.1.6",
-    "@salesforce/sf-plugins-core": "^11.1.0",
+    "@salesforce/sf-plugins-core": "^11.1.6",
     "ansis": "^3.2.0"
   },
   "devDependencies": {
-    "@oclif/plugin-command-snapshot": "^5.2.3",
-    "@salesforce/cli-plugins-testkit": "^5.3.16",
-    "@salesforce/dev-scripts": "^10.2.0",
-    "@salesforce/plugin-command-reference": "^3.1.2",
-    "eslint-plugin-sf-plugin": "^1.18.9",
-    "oclif": "^4.12.1",
+    "@oclif/core": "^4.0.12",
+    "@oclif/plugin-command-snapshot": "^5.2.7",
+    "@salesforce/cli-plugins-testkit": "^5.3.18",
+    "@salesforce/dev-scripts": "^10.2.2",
+    "@salesforce/plugin-command-reference": "^3.1.9",
+    "eslint-plugin-sf-plugin": "^1.18.11",
+    "oclif": "^4.14.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.2"
   },

src/commands/apex/get/test.ts

@@ -58,7 +58,7 @@ export default class Test extends SfCommand<RunResult> {
     const testService = new TestService(conn);
     const result = await testService.reportAsyncResults(flags['test-run-id'], flags['code-coverage']);
 
-    const testReporter = new TestReporter(new Ux({ jsonEnabled: this.jsonEnabled() }), conn, this.config.bin);
+    const testReporter = new TestReporter(new Ux({ jsonEnabled: this.jsonEnabled() }), conn);
 
     return testReporter.report(result, {
       'output-dir': flags['output-dir'],

src/commands/apex/run/test.ts

@@ -136,7 +136,7 @@ export default class Test extends SfCommand<RunCommandResult> {
     }
 
     if ('summary' in result) {
-      const testReporter = new TestReporter(new Ux({ jsonEnabled: this.jsonEnabled() }), conn, this.config.bin);
+      const testReporter = new TestReporter(new Ux({ jsonEnabled: this.jsonEnabled() }), conn);
       return testReporter.report(result, flags);
     } else {
       // Tests were ran asynchronously or the --wait timed out.

src/reporters/testReporter.ts

@@ -31,9 +31,8 @@ export class TestReporter {
    *
    * @param ux a new Ux instance based on if the command is in json mode
    * @param connection a connection to the org the tests are being run against - used for getting username for hints
-   * @param bin the bin of the cli, used for providing suggestions in the users cli
    */
-  public constructor(private readonly ux: Ux, private readonly connection: Connection, private readonly bin: string) {}
+  public constructor(private readonly ux: Ux, private readonly connection: Connection) {}
 
   public async report(
     result: TestResult,
@@ -208,6 +207,6 @@ export class TestReporter {
     if (username) {
       reportArgs += ` -o ${username}`;
     }
-    return messages.getMessage('apexTestReportFormatHint', [this.bin, reportArgs]);
+    return messages.getMessage('apexTestReportFormatHint', [reportArgs]);
   }
 }

test/commands/apex/get/log.test.ts

@@ -5,11 +5,10 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import fs from 'node:fs';
-import { Config } from '@oclif/core';
 import sinon from 'sinon';
 import { LogService } from '@salesforce/apex-node';
 import { expect } from 'chai';
-import { SfCommand } from '@salesforce/sf-plugins-core';
+import { stubSfCommandUx } from '@salesforce/sf-plugins-core';
 import { Org } from '@salesforce/core';
 import ansis from 'ansis';
 import Log, { LogGetResult } from '../../../../src/commands/apex/get/log.js';
@@ -18,14 +17,12 @@ const strip = new ansis.Ansis().strip;
 const logStripper = (log: LogGetResult[number]) => (typeof log === 'string' ? strip(log) : { log: strip(log.log) });
 
 describe('apex:log:get', () => {
-  let config: Config;
   let sandbox: sinon.SinonSandbox;
-  let logStub: sinon.SinonStub;
+  let uxStub: ReturnType<typeof stubSfCommandUx>;
 
   beforeEach(async () => {
-    config = await Config.load(import.meta.url);
     sandbox = sinon.createSandbox();
-    logStub = sandbox.stub(SfCommand.prototype, 'log');
+    uxStub = stubSfCommandUx(sandbox);
     sandbox.stub(Org, 'create').resolves({ getConnection: () => ({}) } as Org);
   });
 
@@ -42,38 +39,38 @@ describe('apex:log:get', () => {
 
   it('0 logs to get', async () => {
     sandbox.stub(LogService.prototype, 'getLogs').resolves([]);
-    const result = await Log.run([], config);
+    const result = await Log.run([]);
     expect(result).to.deep.equal([]);
-    expect(logStub.firstCall.args[0]).to.equal('No results found');
+    expect(uxStub.log.firstCall.args[0]).to.equal('No results found');
   });
 
   it('outputdir will write to fs', async () => {
     sandbox.stub(LogService.prototype, 'getLogs').resolves([{ log: 'myLog' }]);
-    const result = await new Log(['--output-dir', 'myDirectory'], config).run();
+    const result = await Log.run(['--output-dir', 'myDirectory']);
     expect(result).to.deep.equal(['myLog']);
-    expect(logStub.firstCall.args[0]).to.equal('Log files written to myDirectory');
+    expect(uxStub.log.firstCall.args[0]).to.equal('Log files written to myDirectory');
   });
 
   it('outputdir will write to fs --json', async () => {
     sandbox.stub(LogService.prototype, 'getLogs').resolves([{ log: 'myLog' }]);
-    const result = await new Log(['--outputdir', 'myDirectory', '--json'], config).run();
+    const result = await Log.run(['--outputdir', 'myDirectory', '--json']);
     expect(result).to.deep.equal(['myLog']);
-    expect(logStub.firstCall.args[0]).to.equal('Log files written to myDirectory');
+    expect(uxStub.log.firstCall.args[0]).to.equal('Log files written to myDirectory');
   });
 
   it('multiple results', async () => {
     sandbox.stub(LogService.prototype, 'getLogs').resolves([{ log: 'myLog' }, { log: 'myLog2' }]);
-    const result = (await new Log([], config).run()).map(logStripper);
+    const result = (await Log.run([])).map(logStripper);
     expect(result).to.deep.equal([{ log: 'myLog' }, { log: 'myLog2' }]);
-    expect(logStripper(logStub.firstCall.args[0] as string)).to.equal('myLog');
-    expect(logStripper(logStub.secondCall.args[0] as string)).to.equal('myLog2');
+    expect(logStripper(uxStub.log.firstCall.args[0] as string)).to.equal('myLog');
+    expect(logStripper(uxStub.log.secondCall.args[0] as string)).to.equal('myLog2');
   });
 
   it('multiple results --json', async () => {
     sandbox.stub(LogService.prototype, 'getLogs').resolves([{ log: 'myLog' }, { log: 'myLog2' }]);
-    const result = (await new Log(['--json'], config).run()).map(logStripper);
+    const result = (await Log.run(['--json'])).map(logStripper);
     expect(result).to.deep.equal([{ log: 'myLog' }, { log: 'myLog2' }]);
-    expect(logStripper(logStub.firstCall.args[0] as string)).to.equal('myLog');
-    expect(logStripper(logStub.secondCall.args[0] as string)).to.equal('myLog2');
+    expect(logStripper(uxStub.log.firstCall.args[0] as string)).to.equal('myLog');
+    expect(logStripper(uxStub.log.secondCall.args[0] as string)).to.equal('myLog2');
   });
 });