shell-command-mock

    1.0.0 • Public • Published

    shell-command-mock

    Mock shell commands with JavaScript

    Intended for testing scripts where specific commands should be mocked. It gives access to the input and output for each mock, which can be used for making assertions.

    Build Status codecov

    Example

    In this script, we use curl to make a network request, then grep to filter by the letter F:

    # example.sh 
     
    curl "<some-example-url>" | grep F

    When testing the script, we decide to mock curl, but not grep:

    const spawn = require('shell-command-mock').spawnPromise
    const assert = require('assert')
     
    const testFile = './example.sh'
     
    const options = {
      mocks: {
        // Creating the mock:
        curl: (input) => {
          assert.strictEqual(input, '<some-example-url>')
          // Defining the mock output:
          return {
            exit: 0,
            stdout: ['Frog', 'Shrimp', 'Crab'].join('\n'),
            stderr: ''
          }
        }
      }
    }
     
    const data = await spawn('sh', [testFile], options)
     
    assert.deepStrictEqual(data, {
      code: 0,
      signal: '',
      // grep is not being mocked, so the
      // actual grep command will be used
      stdout: 'Frog\n',
      stderr: ''
    })

    API

    spawn (command[, args][, options])

    Wrapper for child_process.spawn, with a new option called mocks. It returns a new ChildProcess.

    options.mocks

    Each key is a shell command, and the values are functions that should return an Object, Number, or String.

    Object

    When returning objects, they can have the following properties:

    • code

      • type: Number

      • default: 0

      • exit the command with this status code

    • stdout

      • type: String

      • default: ''

      • pipe this to stdout

    • stderr

      • type: String

      • default: ''

      • pipe this to stderr

    Number

    If a mock returns a number, it will be used as code (stdout and stderr will be "").

    String

    If a mock returns a string, it will be used as stdout (code will be 0 and stderr will be "").

    options.stdio

    type: String|Array

    The function also modifies the native stdio option. The last element of stdio will always be 'ipc', because the library uses that to message the spawned process. A ChildProcess can only have one IPC channel, so 'ipc' should not be set by the input options.

    spawnPromise (command[, args][, options])

    Like spawn, but it returns a Promise that resolves when the ChildProcess fires the close event. The resolved value is an object with these properties:

    {
      // The process exit code
      code: Number,
      // The signal that terminated the process
      signal: String,
      // The stdout from the process
      stdout: String,
      // The stderr from the process
      stderr: String
    }

    How it Works

    Each mock is an executable that's stored in a temporary PATH directory. Currently, the mocks do not work for all commands (such as builtins). This could be changed in a future version by using shell functions to create the mocks.

    LICENSE

    MIT

    Install

    npm i shell-command-mock

    DownloadsWeekly Downloads

    4

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    12.5 kB

    Total Files

    10

    Last publish

    Collaborators

    • raingerber