Merge pull request #10 from jonabc/raise-on-exec-failure

Raise on exec failure

README.md

@@ -100,10 +100,10 @@ The `@actions/exec` mock catches all calls to `@actions/exec.exec` and
 2. output provided `stdout` using the passed in options
 3. output provided `stderr` using the passed in options
 4. return an exit code
-   - if the command doesn't match a configured mock, returns 127
-   - if the command matches a configured mock, returns the configured `exitCode` or 0 if not set
+   - if the command doesn't match a configured mock, rejects with an error for exit code 127
+   - if the command matches a configured mock, resolves to the configured `exitCode` if 0 or rejects with an error for non-0 values
 
-The mocked call returns a promise that is resolved for a 0 exit code and rejected for all other exit codes.  Calls to `@actions/exec.exec` that specify `options: { ignoreReturnCode: true }` will never be rejected.
+The mocked call returns a promise that is resolved for a 0 exit code and rejected with an error for all other exit codes.  Calls to `@actions/exec.exec` that specify `options: { ignoreReturnCode: true }` will never be rejected.
 
 ```javascript
 // with a resolved mocked command

lib/mocks/exec.js

@@ -48,7 +48,7 @@ sinon.stub(exec, 'exec').callsFake(async (command, args = [], options = {}) => {
   }
 
   if (exitCode !== 0 && !options.ignoreReturnCode) {
-    return Promise.reject(exitCode);
+    return Promise.reject(new Error(`Failed with exit code ${exitCode}`));
   }
 
   return Promise.resolve(exitCode);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jonabc/actions-mocks",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Mocks and utilities to help when testing GitHub Actions",
   "main": "index.js",
   "directories": {

test/mocks/exec.test.js

@@ -37,7 +37,9 @@ it('logs the mocked command', async () => {
 it('returns a rejected promise if ignoreReturnCode is not set with an error exit code', async () => {
   mocks.setLog(() => {});
   mocks.mock({ command: 'command', exitCode: 2 });
-  await expect(exec.exec('command', ['test'])).rejects.toEqual(2);
+  await expect(exec.exec('command', ['test'])).rejects.toThrow(
+    'Failed with exit code 2'
+  );
 });
 
 it('includes process.env.EXEC_MOCKS on load', async () => {
@@ -49,7 +51,9 @@ it('includes process.env.EXEC_MOCKS on load', async () => {
 it('returns a failure exit code if a command isn\'t mocked', async () => {
   mocks.setLog(() => {});
   mocks.clear();
-  await expect(exec.exec('command', ['test'])).rejects.toEqual(127);
+  await expect(exec.exec('command', ['test'])).rejects.toThrow(
+    'Failed with exit code 127'
+  );
 });
 
 describe('mock', () => {

test/runner.test.js

@@ -23,7 +23,7 @@ describe('run', () => {
     expect(out).toMatch('test-not-mocked exited with status 1');
 
     expect(out).toMatch('test-not-ignored');
-    expect(out).toMatch('test-not-ignored caught with status 3');
+    expect(out).toMatch('test-not-ignored caught with status Error: Failed with exit code 3');
   });