@oclif/test

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');
  });