@oclif/test

What is @oclif/test?

@oclif/test is a testing framework specifically designed for testing oclif-based CLI applications. It provides utilities to simulate command execution, check outputs, and handle various test scenarios.

What are @oclif/test's main functionalities?

Simulate Command Execution

This feature allows you to simulate the execution of a CLI command and check the output. In this example, the command 'hello --name world' is executed, and the test checks if the output contains 'hello world'.

const {expect, test} = require('@oclif/test');

test
  .stdout()
  .command(['hello', '--name', 'world'])
  .it('runs hello --name world', ctx => {
    expect(ctx.stdout).to.contain('hello world');
  });

Check Command Errors

This feature allows you to test how your CLI handles errors. In this example, the command 'hello --name' is missing a required value, and the test checks if the error message contains 'Missing required flag'.

const {expect, test} = require('@oclif/test');

test
  .stderr()
  .command(['hello', '--name'])
  .catch(err => {
    expect(err.message).to.contain('Missing required flag');
  })
  .it('runs hello --name with missing value', ctx => {});

Mocking HTTP Requests

This feature allows you to mock HTTP requests during your tests. In this example, a GET request to 'https://api.example.com/data' is mocked to return 'test data', and the test checks if the command 'fetch-data' outputs 'test data'.

const {expect, test} = require('@oclif/test');
const nock = require('nock');

test
  .nock('https://api.example.com', api => api
    .get('/data')
    .reply(200, {data: 'test data'})
  )
  .stdout()
  .command(['fetch-data'])
  .it('runs fetch-data and mocks HTTP request', ctx => {
    expect(ctx.stdout).to.contain('test data');
  });

Other packages similar to @oclif/test

mocha

Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple and fun. While Mocha is a general-purpose testing framework, @oclif/test is specifically designed for testing oclif-based CLI applications.

jest

Jest is a delightful JavaScript Testing Framework with a focus on simplicity. It works with projects using Babel, TypeScript, Node.js, React, Angular, Vue.js, and Svelte. Jest is more general-purpose compared to @oclif/test, which is tailored for oclif CLI applications.

chai

Chai is a BDD / TDD assertion library for node and the browser that can be paired with any JavaScript testing framework. Chai provides assertions that can be used in conjunction with @oclif/test, but it does not provide the CLI-specific testing utilities that @oclif/test offers.

README

@oclif/test

test helpers for oclif CLIs

Migration

See the V4 Migration Guide if you are migrating from v3 or older.

Usage

@oclif/test provides a handful of utilities that make it easy to test your oclif CLI.

NOTE for jest users - in order for these utilities to capture all output to the terminal, you must set verbose: true in your jest config to prevent jest from supressing any output. See https://jestjs.io/docs/configuration#verbose-boolean for more

captureOutput

captureOutput allows you to get the stdout, stderr, return value, and error of the callback you provide it. This makes it possible to assert that certain strings were printed to stdout and stderr or that the callback failed with the expected error or succeeded with the expected result.

Options

• print - Print everything that goes to stdout and stderr.
• stripAnsi - Strip ansi codes from everything that goes to stdout and stderr. Defaults to true.
• testNodeEnv - Sets the NODE_ENV value when capturing output. Defaults to 'test'.

See the tests for example usage.

runCommand

runCommand allows you to get the stdout, stderr, return value, and error of a command in your CLI.

See the tests for example usage.

runHook

runHook allows you to get the stdout, stderr, return value, and error of a hook in your CLI.

See the tests for example usage.

Changelog

4.1.2 (2024-11-18)

Bug Fixes

• don't destructure error object (2190a61)