feat: add TAP reporter for Apex test results (#91)

* feat: add TAP reporter for Apex test results * chore: added tests * feat: trap parsing errors for TAP test format
forcedotcom · Nov 20, 2020 · 5b7ecae · 5b7ecae
1 parent 9c6f293
commit 5b7ecae
Show file tree

Hide file tree

Showing 3 changed files with 104 additions and 2 deletions.
diff --git a/packages/plugin-apex/messages/run.json b/packages/plugin-apex/messages/run.json
@@ -50,5 +50,8 @@
   "runTestReportCommandErr": "Run 'sfdx force:apex:test:report -i %s -u %s' to retrieve test results",
   "classSuiteTestErr": "Specify either classnames, suitenames, or tests",
   "syncClassErr": "Synchronous test runs can include test methods from only one Apex class. Omit the --synchronous flag or include tests from only one class",
-  "testLevelErr": "When specifying classnames, suitenames, or tests, indicate RunSpecifiedTests as the testlevel"
+  "testLevelErr": "When specifying classnames, suitenames, or tests, indicate RunSpecifiedTests as the testlevel",
+  "testResultProcessErr": "Encountered an error when processing test results\n%s",
+  "apexTestReportFormatHint":
+  "Run \"sfdx force:apex:test:report %s --resultformat <format>\" to retrieve test results in a different format."
 }
diff --git a/packages/plugin-apex/src/commands/force/apex/test/run.ts b/packages/plugin-apex/src/commands/force/apex/test/run.ts
@@ -4,7 +4,7 @@
  * 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
  */
-import { TestService } from '@salesforce/apex-node';
+import { TapReporter, TestService } from '@salesforce/apex-node';
 import {
   AsyncTestConfiguration,
   AsyncTestArrayConfiguration,
@@ -190,6 +190,10 @@ export default class Run extends SfdxCommand {
         this.ux.log(this.formatHuman(result, this.flags.detailedcoverage));
       }
 
+      if (this.flags.resultformat === 'tap') {
+        this.formatTap(result);
+      }
+
       if (!this.flags.resultformat) {
         const id = result.summary.testRunId;
         const username = result.summary.username;
@@ -447,4 +451,25 @@ export default class Run extends SfdxCommand {
     }
     return processedLines;
   }
+
+  private formatTap(result: TestResult): void {
+    try {
+      const reporter = new TapReporter();
+      const hint = this.formatReportHint(result);
+      this.ux.log(reporter.format(result, [hint]));
+    } catch (err) {
+      this.ux.logJson(result);
+      const msg = messages.getMessage('testResultProcessErr', [err]);
+      this.ux.error(msg);
+    }
+  }
+
+  private formatReportHint(result: TestResult): string {
+    let reportArgs = `-i ${result.summary.testRunId}`;
+    if (this.flags.targetusername) {
+      reportArgs += ` -u ${this.flags.targetusername}`;
+    }
+    const hint = messages.getMessage('apexTestReportFormatHint', [reportArgs]);
+    return hint;
+  }
 }
diff --git a/packages/plugin-apex/test/commands/force/apex/test/run.test.ts b/packages/plugin-apex/test/commands/force/apex/test/run.test.ts
@@ -65,6 +65,55 @@ describe('force:apex:test:run', () => {
       expect(result).to.not.contain('Apex Code Coverage by Class');
     });
 
+  test
+    .withOrg({ username: TEST_USERNAME }, true)
+    .loadConfig({
+      root: __dirname
+    })
+    .stub(process, 'cwd', () => projectPath)
+    .stub(TestService.prototype, 'runTestAsynchronous', () => testRunSimple)
+    .stdout()
+    .command([
+      'force:apex:test:run',
+      '--tests',
+      'MyApexTests',
+      '--resultformat',
+      'tap'
+    ])
+    .it('should return a success tap format message with async run', ctx => {
+      const result = ctx.stdout;
+      expect(result).to.not.be.empty;
+      expect(result).to.contain('1..1');
+      expect(result).to.contain('ok 1 MyApexTests.testConfig');
+      expect(result).to.contain('# Run "sfdx force:apex:test:report');
+      expect(result).to.not.contain('Apex Code Coverage by Class');
+    });
+
+  test
+    .withOrg({ username: TEST_USERNAME }, true)
+    .loadConfig({
+      root: __dirname
+    })
+    .stub(process, 'cwd', () => projectPath)
+    .stub(TestService.prototype, 'runTestAsynchronous', () => ({ tests: [] }))
+    .stdout()
+    .stderr()
+    .command([
+      'force:apex:test:run',
+      '--tests',
+      'MyApexTests',
+      '--resultformat',
+      'tap'
+    ])
+    .it('should handle a tap format parsing error', ctx => {
+      expect(ctx.stdout).to.contain('{\n  "tests": []\n}\n');
+      expect(ctx.stderr).to.contain(
+        messages.getMessage('testResultProcessErr', [
+          "TypeError: Cannot read property 'testRunId' of undefined"
+        ])
+      );
+    });
+
   test
     .withOrg({ username: TEST_USERNAME }, true)
     .loadConfig({
@@ -89,6 +138,31 @@ describe('force:apex:test:run', () => {
       expect(result).to.not.contain('Apex Code Coverage by Class');
     });
 
+  test
+    .withOrg({ username: TEST_USERNAME }, true)
+    .loadConfig({
+      root: __dirname
+    })
+    .stub(process, 'cwd', () => projectPath)
+    .stub(TestService.prototype, 'runTestSynchronous', () => testRunSimple)
+    .stdout()
+    .command([
+      'force:apex:test:run',
+      '--tests',
+      'MyApexTests',
+      '--resultformat',
+      'tap',
+      '--synchronous'
+    ])
+    .it('should return a success tap format message with sync run', ctx => {
+      const result = ctx.stdout;
+      expect(result).to.not.be.empty;
+      expect(result).to.contain('1..1');
+      expect(result).to.contain('ok 1 MyApexTests.testConfig');
+      expect(result).to.contain('# Run "sfdx force:apex:test:report');
+      expect(result).to.not.contain('Apex Code Coverage by Class');
+    });
+
   test
     .withOrg({ username: TEST_USERNAME }, true)
     .loadConfig({