Как я могу протестировать интерфейс командной строки oclif, который использует Rest API

Question

Как я могу протестировать следующую сборку кода с помощью Typescript в Oclif? Этот CLI использует сборку rest api с node.js и express.js. Я тестирую свой api с помощью mocha/chai, с которыми я познакомился. Тем не менее, я видел пример на сайте oclif о тестировании, но кроме этого нет никакой реальной помощи с тестированием. Как я могу проверить следующий код, который является командой моего cli?

import cli from 'cli-ux'
// just prompt for input
import {Command} from '@oclif/command'
import {createConnection} from "typeorm";
import {flags} from  '@oclif/command'
const bcrypt = require('bcrypt');
var fs=require('fs');
const https = require('https')
const axios=require('axios');
const client_cert = fs.readFileSync('ca-crt.pem')
axios.defaults.httpsAgent = new https.Agent({ca : client_cert, keepAlive: true})
export class AdminCommand extends Command {
  static flags = { 
    newuser: flags.string({dependsOn:['passw'],exclusive:['newdata','userstatus','moduser']}),
    moduser: flags.string({dependsOn:['passw'],exclusive:['newuser','newdata','userstatus']}),
    passw: flags.string({dependsOn:['email']}),
    email: flags.string({dependsOn:['quota']}),
    quota: flags.string(),
    userstatus: flags.string({exclusive:['newdata','newuser','moduser']}),
    newdata: flags.string({dependsOn:['source'],exclusive:['userstatus','newuser','moduser']}),
    source: flags.string()
  }
  async run() {
    const {flags} = this.parse(AdminCommand); 
    var fs=require('fs');
    var jwt=require('jsonwebtoken');
    var token = fs.readFileSync('softeng19bAPI.token','utf-8');
    axios.defaults.headers.common['X-OBSERVATORY-AUTH']=token;
    await cli.anykey();
    //create new user
    if (`${flags.newuser}` !== "undefined" && `${flags.passw}` !== "undefined" && `${flags.email}` !== "undefined" && `${flags.quota}` !== "undefined" ){
            let hash = bcrypt.hashSync(`${flags.passw}`,10);
            let body = new Object ({
                username: `${flags.newuser}`,
                passw: `${flags.passw}`,
                email: `${flags.email}`,
                quota: `${flags.quota}` 
            })
            await axios.post('https://localhost:8765/energy/api/Admin/users',body);

    } }

Answer 1

Раздел Oclif Testing включает пример имитации HTTP-запроса с помощью nock. Чтобы проверить это, я бы:

1. Смокните свой почтовый запрос с помощью nock
2. Запрашивать сообщение об успехе, если почтовый запрос был успешным, и утверждать, что
3. Вывести сообщение об ошибке, если почтовый запрос завершился неудачно, и подтвердить это тоже

CLI является пользовательским интерфейс, это сделало мою жизнь легче думать о нем, как например при тестировании. Поэтому разработайте свои тесты для подтверждения вывода CLI и используйте модульные тесты для бизнес-логики.

// Success test case, assuming the command name is 'admin:create'

  
describe('admin', () => {

  const newUser = {...}

  test
  .stdout()
  .nock('https://localhost:8765', api =>
    api
    .persist()
    .post('/energy/api/Admin/users')
    .reply(200, newUser)
  )
  .command('admin:create')
  .it('shows success message when user is created', ctx => {
    expect(ctx.stdout).to.contain('User was successfully created.')
  })
})