fix: exit with error code when anyonmous apex failed to compile or run

BREAKING CHANGE: force:apex:execute now returns an error exit code (1)
when the compilation or execution of the Anonymous Apex failed.

Author: matthiasrolke-sage

messages/execute.json

@@ -5,5 +5,7 @@
     "logLevelDescription": "logging level for this command invocation",
     "logLevelLongDescription": "The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.",
     "executeCompileSuccess": "Compiled successfully.",
-    "executeRuntimeSuccess": "Executed successfully."
-}
+    "executeCompileFailure": "Compilation failed.",
+    "executeRuntimeSuccess": "Executed successfully.",
+    "executeRuntimeFailure": "Execution failed."
+}

src/commands/force/apex/execute.ts

@@ -6,7 +6,7 @@
  */
 import { ApexExecuteOptions, ExecuteService, ExecuteAnonymousResponse } from '@salesforce/apex-node';
 import { flags, SfdxCommand } from '@salesforce/command';
-import { Messages } from '@salesforce/core';
+import { Messages, SfError } from '@salesforce/core';
 import { AnyJson } from '@salesforce/ts-types';
 import { buildDescription, colorSuccess, colorError, logLevels } from '../../../utils';
 
@@ -15,7 +15,9 @@ const messages = Messages.load('@salesforce/plugin-apex', 'execute', [
   'apexCodeFileDescription',
   'commandDescription',
   'executeCompileSuccess',
+  'executeCompileFailure',
   'executeRuntimeSuccess',
+  'executeRuntimeFailure',
   'logLevelDescription',
   'logLevelLongDescription',
   'longDescription',
@@ -63,8 +65,19 @@ export default class Execute extends SfdxCommand {
       };
 
       const result = await exec.executeAnonymous(execAnonOptions);
+      const formattedResult = this.formatJson(result);
       this.ux.log(this.formatDefault(result));
-      return this.formatJson(result);
+      if (!result.compiled || !result.success) {
+        let err: SfError;
+        if (!result.compiled) {
+          err = new SfError(messages.getMessage('executeCompileFailure'), 'executeCompileFailure');
+        } else {
+          err = new SfError(messages.getMessage('executeRuntimeFailure'), 'executeRuntimeFailure');
+        }
+        err.setData(formattedResult);
+        throw err;
+      }
+      return formattedResult;
     } catch (e) {
       return Promise.reject(e);
     }

test/commands/force/apex/execute.test.ts

@@ -148,13 +148,14 @@ describe('force:apex:execute', () => {
   test
     .withOrg({ username: 'test@org.com' }, true)
     .withConnectionRequest(() => Promise.resolve(soapCompileProblem))
-    .stub(ExecuteService.prototype, 'getUserInput', () => 'System.assert(true)')
+    .stub(ExecuteService.prototype, 'getUserInput', () => 'ThisStatementShouldntCompile')
     .stub(ExecuteService.prototype, 'buildExecRequest', () => {
       'fakeData';
     })
     .stdout()
     .command(['force:apex:execute', '--targetusername', 'test@org.com', '--json'])
     .it('runs default command with json flag and compile problem', (ctx) => {
+      expect(process.exitCode).to.eql(1);
       const result = ctx.stdout;
       expect(result).to.not.be.empty;
       const resultJSON = JSON.parse(result);
@@ -165,7 +166,7 @@ describe('force:apex:execute', () => {
   test
     .withOrg({ username: 'test@org.com' }, true)
     .withConnectionRequest(() => Promise.resolve(soapResponse))
-    .stub(ExecuteService.prototype, 'getUserInput', () => 'System.assert(true)')
+    .stub(ExecuteService.prototype, 'getUserInput', () => 'System.assert(true);')
     .stub(ExecuteService.prototype, 'buildExecRequest', () => {
       'fakeData';
     })
@@ -180,13 +181,16 @@ describe('force:apex:execute', () => {
   test
     .withOrg({ username: 'test@org.com' }, true)
     .withConnectionRequest(() => Promise.resolve(soapCompileProblem))
-    .stub(ExecuteService.prototype, 'getUserInput', () => 'System.assert(true)')
+    .stub(ExecuteService.prototype, 'getUserInput', () => 'ThisStatementShouldntCompile')
     .stub(ExecuteService.prototype, 'buildExecRequest', () => {
       'fakeData';
     })
     .stdout()
+    .stderr()
     .command(['force:apex:execute', '--targetusername', 'test@org.com'])
     .it('runs default command with compile issue in human readable output', (ctx) => {
+      expect(process.exitCode).to.eql(1);
+      expect(ctx.stderr).to.contain('Compilation failed.');
       const result = ctx.stdout;
       expect(result).to.not.be.empty;
       expect(result).to.eql(compileResponse);
@@ -195,13 +199,16 @@ describe('force:apex:execute', () => {
   test
     .withOrg({ username: 'test@org.com' }, true)
     .withConnectionRequest(() => Promise.resolve(soapRuntimeProblem))
-    .stub(ExecuteService.prototype, 'getUserInput', () => 'System.assert(true)')
+    .stub(ExecuteService.prototype, 'getUserInput', () => 'System.assert(false);')
     .stub(ExecuteService.prototype, 'buildExecRequest', () => {
       'fakeData';
     })
     .stdout()
+    .stderr()
     .command(['force:apex:execute', '--targetusername', 'test@org.com'])
     .it('runs default command with runtime issue in human readable output', (ctx) => {
+      expect(process.exitCode).to.eql(1);
+      expect(ctx.stderr).to.contain('Execution failed.');
       const result = ctx.stdout;
       expect(result).to.not.be.empty;
       expect(result).to.eql(runtimeResponse);