Merge pull request #809 from salesforcecli/er/remove-category-on-test-suite-run

W-19757640: do not include category when running apex test suite

Author: mdonnalley

src/shared/TestRunService.ts

@@ -120,7 +120,7 @@ export class TestRunService {
     config: TestRunConfig,
     cancellationToken: CancellationTokenSource
   ): Promise<TestResult> {
-    const testCategory = TestRunService.getTestCategory(flags, config);
+    const testCategory = TestRunService.getTestCategory(flags, config, testLevel);
     const payload = {
       ...(await testService.buildSyncPayload(
         testLevel,
@@ -149,7 +149,7 @@ export class TestRunService {
     config: TestRunConfig,
     cancellationToken: CancellationTokenSource
   ): Promise<TestRunIdResult> {
-    const testCategory = TestRunService.getTestCategory(flags, config);
+    const testCategory = TestRunService.getTestCategory(flags, config, testLevel);
     const payload = {
       ...(await testService.buildAsyncPayload(
         testLevel,
@@ -178,11 +178,14 @@ export class TestRunService {
 
   /**
    * Get test category based on command type and flags
-   * - apex command: always returns 'Apex'
+   * - apex command: returns empty string for RunSpecifiedTests, 'Apex' for other test levels
    * - logic command: returns test-category flag value or defaults to all categories
    */
-  private static getTestCategory(flags: TestRunFlags, config: TestRunConfig): string {
+  private static getTestCategory(flags: TestRunFlags, config: TestRunConfig, testLevel: string): string {
     if (config.commandType === 'apex') {
+      if (testLevel === 'RunSpecifiedTests') {
+        return '';
+      }
       return 'Apex';
     }
     // logic command

test/commands/apex/run/test.nut.ts

@@ -38,7 +38,7 @@ describe('apex run test', () => {
         },
       ],
     });
-
+    addTestSuiteFile(session.project.dir);
     execCmd('project:deploy:start -o org --source-dir force-app', { ensureExitCode: 0, cli: 'sf' });
   });
 
@@ -210,6 +210,16 @@ describe('apex run test', () => {
     expect(result2).to.match(/Tests Ran\s+10/);
   });
 
+  it('will run specified test suites --class-names', async () => {
+    const result = execCmd('apex:run:test -w 10 --suite-names DreamhouseTestSuite', { ensureExitCode: 0 })
+      .shellOutput.stdout;
+    expect(result).to.match(/Tests Ran\s+10/);
+    expect(result).to.include('FileUtilitiesTest.');
+    expect(result).to.include('TestPropertyController.');
+    expect(result).to.include('GeocodingServiceTest.');
+    expect(result).to.include('GeocodingServiceTest.');
+  });
+
   it('will run specified tests --tests', async () => {
     const result = execCmd('apex:run:test -w 10 --tests TestPropertyController', { ensureExitCode: 0 }).shellOutput
       .stdout;
@@ -263,3 +273,19 @@ describe('apex run test', () => {
     execCmd(`apex:get:test -i ${id}`, { ensureExitCode: 0 });
   });
 });
+
+function addTestSuiteFile(projectDir: string): void {
+  const testSuitesDir = path.join(projectDir, 'force-app', 'main', 'default', 'testSuites');
+  if (!fs.existsSync(testSuitesDir)) {
+    fs.mkdirSync(testSuitesDir, { recursive: true });
+  }
+  
+  const xmlContent = `<?xml version="1.0" encoding="UTF-8"?>
+                      <ApexTestSuite xmlns="http://soap.sforce.com/2006/04/metadata">
+                        <testClassName>FileUtilitiesTest</testClassName>
+                        <testClassName>GeocodingServiceTest</testClassName>
+                        <testClassName>TestPropertyController</testClassName>
+                      </ApexTestSuite>`;
+  const filePath = path.join(testSuitesDir, 'DreamhouseTestSuite.testSuite-meta.xml');  
+  fs.writeFileSync(filePath, xmlContent, 'utf8');
+}

test/commands/apex/run/test.test.ts

@@ -148,7 +148,7 @@ describe('apex:test:run', () => {
       ]);
       expect(buildPayloadSpy.calledOnce).to.be.true;
       expect(runTestSynchronousSpy.calledOnce).to.be.true;
-      expect(buildPayloadSpy.firstCall.args).to.deep.equal(['RunSpecifiedTests', undefined, 'myApex', 'Apex']);
+      expect(buildPayloadSpy.firstCall.args).to.deep.equal(['RunSpecifiedTests', undefined, 'myApex', '']);
       expect(runTestSynchronousSpy.firstCall.args[0]).to.deep.equal({
         skipCodeCoverage: false,
         testLevel: 'RunSpecifiedTests',
@@ -166,31 +166,26 @@ describe('apex:test:run', () => {
         .stub(TestService.prototype, 'runTestAsynchronous')
         .resolves(runWithCoverage);
       await Test.run([
-        '--class-names',
-        'myApex',
         '--code-coverage',
         '--result-format',
         'human',
         '--test-level',
-        'RunSpecifiedTests',
+        'RunLocalTests',
       ]);
       expect(buildPayloadSpy.calledOnce).to.be.true;
       expect(runTestSynchronousSpy.calledOnce).to.be.true;
       expect(buildPayloadSpy.firstCall.args).to.deep.equal([
-        'RunSpecifiedTests',
+        'RunLocalTests',
+        undefined,
         undefined,
-        'myApex',
         undefined,
         'Apex',
       ]);
       expect(runTestSynchronousSpy.firstCall.args[0]).to.deep.equal({
+        category: ['Apex'],
         skipCodeCoverage: false,
-        testLevel: 'RunSpecifiedTests',
-        tests: [
-          {
-            className: 'myApex',
-          },
-        ],
+        suiteNames: undefined,
+        testLevel: 'RunLocalTests',
       });
     });
 
@@ -208,7 +203,7 @@ describe('apex:test:run', () => {
         undefined,
         'myApex',
         undefined,
-        'Apex',
+        '',
       ]);
       expect(runTestSynchronousSpy.firstCall.args[0]).to.deep.equal({
         skipCodeCoverage: true,
@@ -228,7 +223,7 @@ describe('apex:test:run', () => {
       await Test.run(['--class-names', 'myApex', '--synchronous', '--test-level', 'RunSpecifiedTests']);
       expect(buildPayloadSpy.calledOnce).to.be.true;
       expect(runTestSynchronousSpy.calledOnce).to.be.true;
-      expect(buildPayloadSpy.firstCall.args).to.deep.equal(['RunSpecifiedTests', undefined, 'myApex', 'Apex']);
+      expect(buildPayloadSpy.firstCall.args).to.deep.equal(['RunSpecifiedTests', undefined, 'myApex', '']);
       expect(runTestSynchronousSpy.firstCall.args[0]).to.deep.equal({
         skipCodeCoverage: true,
         testLevel: 'RunSpecifiedTests',
@@ -331,7 +326,6 @@ describe('apex:test:run', () => {
 
       await Test.run(['--suite-names', 'MyApexTests,MySecondTest', '--result-format', 'human']);
       expect(apexStub.firstCall.args[0]).to.deep.equal({
-        category: ['Apex'],
         skipCodeCoverage: true,
         testLevel: 'RunSpecifiedTests',
         suiteNames: 'MyApexTests,MySecondTest',
@@ -343,7 +337,6 @@ describe('apex:test:run', () => {
 
       await Test.run(['-s', 'MyApexTests', '-s', 'MySecondTest', '--result-format', 'human']);
       expect(apexStub.firstCall.args[0]).to.deep.equal({
-        category: ['Apex'],
         skipCodeCoverage: true,
         testLevel: 'RunSpecifiedTests',
         suiteNames: 'MyApexTests,MySecondTest',
@@ -416,7 +409,7 @@ describe('apex:test:run', () => {
       ]);
       expect(buildPayloadSpy.calledOnce).to.be.true;
       expect(runTestSynchronousSpy.calledOnce).to.be.true;
-      expect(buildPayloadSpy.firstCall.args).to.deep.equal(['RunSpecifiedTests', undefined, 'myApex', 'Apex']);
+      expect(buildPayloadSpy.firstCall.args).to.deep.equal(['RunSpecifiedTests', undefined, 'myApex', '']);
       expect(runTestSynchronousSpy.firstCall.args[0]).to.deep.equal({
         skipCodeCoverage: false,
         testLevel: 'RunSpecifiedTests',
@@ -434,31 +427,26 @@ describe('apex:test:run', () => {
         .stub(TestService.prototype, 'runTestAsynchronous')
         .resolves(runWithCoverage);
       await Test.run([
-        '--class-names',
-        'myApex',
         '--code-coverage',
         '--result-format',
         'human',
         '--test-level',
-        'RunSpecifiedTests',
+        'RunLocalTests',
       ]);
       expect(buildPayloadSpy.calledOnce).to.be.true;
       expect(runTestSynchronousSpy.calledOnce).to.be.true;
       expect(buildPayloadSpy.firstCall.args).to.deep.equal([
-        'RunSpecifiedTests',
+        'RunLocalTests',
+        undefined,
         undefined,
-        'myApex',
         undefined,
         'Apex',
       ]);
       expect(runTestSynchronousSpy.firstCall.args[0]).to.deep.equal({
+        category: ['Apex'],
         skipCodeCoverage: false,
-        testLevel: 'RunSpecifiedTests',
-        tests: [
-          {
-            className: 'myApex',
-          },
-        ],
+        suiteNames: undefined,
+        testLevel: 'RunLocalTests'
       });
     });
 
@@ -474,7 +462,7 @@ describe('apex:test:run', () => {
         undefined,
         'myApex',
         undefined,
-        'Apex',
+        '',
       ]);
       expect(runTestSynchronousSpy.firstCall.args[0]).to.deep.equal({
         skipCodeCoverage: true,
@@ -494,7 +482,7 @@ describe('apex:test:run', () => {
       await Test.run(['--class-names', 'myApex', '--synchronous', '--test-level', 'RunSpecifiedTests']);
       expect(buildPayloadSpy.calledOnce).to.be.true;
       expect(runTestSynchronousSpy.calledOnce).to.be.true;
-      expect(buildPayloadSpy.firstCall.args).to.deep.equal(['RunSpecifiedTests', undefined, 'myApex', 'Apex']);
+      expect(buildPayloadSpy.firstCall.args).to.deep.equal(['RunSpecifiedTests', undefined, 'myApex', '']);
       expect(runTestSynchronousSpy.firstCall.args[0]).to.deep.equal({
         skipCodeCoverage: true,
         testLevel: 'RunSpecifiedTests',