spektr_test.ts

import {
  afterEach,
  beforeEach,
  describe,
  it,
} from 'https://deno.land/std@0.224.0/testing/bdd.ts'
import { expect } from 'https://deno.land/std@0.224.0/expect/mod.ts'
import {
  assertSpyCall,
  Spy,
  spy,
} from 'https://deno.land/std@0.224.0/testing/mock.ts'
import { CLI } from './spektr.ts'
import { Plugin, Positionals } from './types.ts'
import { ParsedOptions } from './types.ts'

describe('CLI', () => {
  it('is initialized properly', () => {
    const cli = new CLI({ name: 'cli' })

    expect(cli.name).toEqual('cli')
    expect(cli.prefix).toEqual('')
    expect(cli.plugins).toEqual([])
  })
  describe('commands', () => {
    it('matching command is handled', () => {
      const cli = new CLI({ name: 'cli' })

      const action = () => {
        return 'hello world'
      }

      const actionSpy = spy(action)

      cli.command('test', actionSpy)

      cli.handle(['test'])

      assertSpyCall(actionSpy, 0, {
        returned: 'hello world',
      })
    })
    it('args and positionals are passed to the action', () => {
      const cli = new CLI({ name: 'cli' })

      const options = [{
        name: 'value',
        short: 'v',
        type: 'string',
      }] as const

      const actionSpy = spy(
        (pos: Positionals, args: ParsedOptions<typeof options>) => {
          return `${pos[0]}: ${JSON.stringify(args)}`
        },
      )

      cli.command('test', actionSpy, { options })

      cli.handle(['test', 'pos', '--value=str'])

      assertSpyCall(actionSpy, 0, {
        args: [['pos'], { value: 'str' }],
        returned: 'pos: {"value":"str"}',
      })
    })
    it('basic nesting works', () => {
      const cli = new CLI()

      const deploy = cli.program('deploy')

      const actionSpy = spy((_pos: Positionals) => {
        return 'deploy start'
      })

      deploy.command('start', actionSpy)

      cli.handle(['deploy', 'start'])

      assertSpyCall(actionSpy, 0, {
        args: [[], {}],
        returned: 'deploy start',
      })
    })
    it('deep nesting also works', () => {
      const cli = new CLI()

      const deploy = cli.program('deploy')

      const manage = deploy.program('manage')

      const actionSpy = spy((_pos: Positionals) => {
        return 'deploy manage start'
      })

      manage.command('start', actionSpy)

      cli.handle(['deploy', 'manage', 'start'])

      assertSpyCall(actionSpy, 0, {
        args: [[], {}],
        returned: 'deploy manage start',
      })
    })
    it('default command is used if no command is passed', () => {
      const cli = new CLI()

      const actionSpy = spy(() => `Default command`)

      cli.command('test', actionSpy, { default: true })

      cli.handle([])

      assertSpyCall(actionSpy, 0, {
        returned: 'Default command',
      })
    })
    it('default command without name is used if no command is passed', () => {
      const cli = new CLI()

      const actionSpy = spy(() => `Default command`)

      cli.command(actionSpy, { default: true })

      cli.handle([])

      assertSpyCall(actionSpy, 0, {
        returned: 'Default command',
      })
    })
    it('throws if command is not found', () => {
      const cli = new CLI()

      cli.command('test', () => `test`)

      expect(() => cli.handle(['test2'])).toThrow('Command not found')
    })
    it('throws if trying to use a default command which is not defined', () => {
      const cli = new CLI()

      expect(() => cli.handle(['--arg'])).toThrow(
        'Command not found',
      )
    })
  })
  describe('cli.help()', () => {
    const originalConsoleLog = console.log
    let consoleSpy: Spy<typeof console['log']>

    beforeEach(() => {
      consoleSpy = spy(originalConsoleLog)
      console.log = consoleSpy
    })
    afterEach(() => {
      console.log = originalConsoleLog
    })
    it('help message is returned if no default command was defined', () => {
      const cli = new CLI()

      cli.command('test', () => {})

      cli.handle([])

      assertSpyCall(consoleSpy, 0, {
        args: ['Usage:  [command] \n\nCommands:\n    test      \n'],
      })
    })
    it('prints out help for defined commands', () => {
      const cli = new CLI({ name: 'player' })

      cli.command('run', () => 'Run', {
        options: [{
          name: 'speed',
          short: 's',
          type: 'string',
          description: 'speed in km/h',
        }],
      })

      cli.help()

      cli.handle(['--help'])

      assertSpyCall(consoleSpy, 0, {
        args: [
          'Usage: player [command] [-h]\n' +
          '\n' +
          'Commands:\n' +
          '    run      \n' +
          '\n' +
          'Options:\n' +
          '    --help, -h     shows this message \n',
        ],
      })

      cli.handle(['run', '--help'])

      assertSpyCall(consoleSpy, 1, {
        args: [
          'Usage: run [args]\n' +
          '    --speed, -s     speed in km/h      \n' +
          '    --help, -h      shows this message \n',
        ],
      })
    })
    it('prints out help for defined programs', () => {
      const cli = new CLI({ name: 'player' })

      const run = cli.program('knight')

      run.command('fight', () => 'Fight')

      cli.help()

      cli.handle(['--help'])

      assertSpyCall(consoleSpy, 0, {
        args: [
          'Usage: player [command] [-h]\n' +
          '\n' +
          'Commands for player knight:\n' +
          '    fight      \n' +
          '\n' +
          'Options:\n' +
          '    --help, -h     shows this message \n',
        ],
      })
    })
  })
  describe('cli.version()', () => {
    const originalConsoleLog = console.log
    let consoleSpy: Spy<typeof console['log']>
    beforeEach(() => {
      consoleSpy = spy(originalConsoleLog)
      console.log = consoleSpy
    })
    afterEach(() => {
      console.log = originalConsoleLog
    })
    it('version is 0.0.0 by default', () => {
      const cli = new CLI({ name: 'cli' })

      cli.version()

      cli.handle(['--version'])

      assertSpyCall(consoleSpy, 0, { args: ['cli: 0.0.0'] })
    })
    it('name is Spektr by default', () => {
      const cli = new CLI({})

      cli.version()

      cli.handle(['--version'])

      assertSpyCall(consoleSpy, 0, { args: ['Spektr: 0.0.0'] })
    })
    it('subcommand version() invokes its root parent version', () => {
      const cli = new CLI({ name: 'root' })

      const sub = new CLI({ name: 'sub' })

      cli.version('1.1.1')
      sub.version()

      cli.handle(['sub', '--version'])

      assertSpyCall(consoleSpy, 0, { args: ['root: 1.1.1'] })
    })
  })
  describe('middleware', () => {
    describe('wildcard', () => {
      it('runs for all commands of the CLI', () => {
        const cli = new CLI()

        const mwSpy = spy(() => `Middleware`)

        cli.middleware('*', mwSpy)

        cli.command('hello', () => 'Hello')
        cli.command('bye', () => 'Bye')

        cli.handle(['hello'])

        assertSpyCall(mwSpy, 0)
        cli.handle(['hello'])
        assertSpyCall(mwSpy, 1)
        cli.handle(['bye'])
      })
      it('runs for the default command', () => {
        const cli = new CLI()

        const mwSpy = spy(() => `Middleware`)

        cli.middleware('*', mwSpy)

        cli.command('hello', () => 'Hello', {
          default: true,
          options: [{ name: 'option', type: 'boolean' }],
        })

        cli.handle([])
        assertSpyCall(mwSpy, 0)
        cli.handle(['--option'])
        assertSpyCall(mwSpy, 1)
      })
    })
    it('runs for a matching path', () => {
      const cli = new CLI()
      const mwSpy = spy(() => `Middleware`)

      cli.middleware('hey', mwSpy)

      cli.command('hello', () => 'Hello')
      cli.command('hey', () => 'Hey')

      cli.handle(['hello']) // doesn't match
      cli.handle(['hey'])
      assertSpyCall(mwSpy, 0)
    })
    it('runs for subgprograms matching the path', () => {
      const cli = new CLI()
      const mwSpy = spy(() => `Middleware`)

      cli.middleware('sub', mwSpy)
      const sub = cli.program('sub')

      sub.command('hello', () => 'Hello')

      cli.handle(['sub', 'hello'])
      assertSpyCall(mwSpy, 0)
    })
    it('asterisk matches subprograms', () => {
      const cli = new CLI()

      const mwSpy = spy(() => `Middleware`)

      cli.middleware('*', mwSpy)
      const sub = cli.program('sub')

      sub.command('hello', () => 'Hello')

      cli.handle(['sub', 'hello'])
      assertSpyCall(mwSpy, 0)
    })
  })
  describe('plugins', () => {
    it('should apply them', () => {
      const helpFnSpy = spy(() => `Plugin`)
      const myPlugin: Plugin = () => ({
        helpFn: () => 'Help',
        helpMessage: helpFnSpy,
      })

      const cli = new CLI({ plugins: [myPlugin] })
      cli.help()

      cli.handle(['--help'])

      assertSpyCall(helpFnSpy, 0)

      expect(cli.plugins).toEqual([myPlugin])
    })
    it('should nest plugins', () => {
      const helpFnSpy = spy(() => `Plugin`)
      const myPlugin: Plugin = () => ({
        helpFn: () => 'Help',
        helpMessage: helpFnSpy,
      })

      const cli = new CLI({ plugins: [myPlugin] })
      cli.help()

      const sub = cli.program('sub')

      sub.help()

      expect(sub.plugins).toEqual([myPlugin])

      cli.handle(['sub', '--help'])

      assertSpyCall(helpFnSpy, 0)
    })
    it('should append plugins to parent plugins', () => {
      const myPlugin: Plugin = () => ({
        helpFn: () => 'Help',
        helpMessage: () => 'Helloo',
      })

      const cli = new CLI({ plugins: [myPlugin] })
      cli.help()

      const anotherPlugin: Plugin = () => ({
        helpFn: () => 'Sub help',
        helpMessage: () => 'Sub hello',
      })

      const sub = new CLI({
        name: 'sub',
        prefix: 'sub',
        plugins: [anotherPlugin],
      })

      cli.program('sub', sub)

      sub.help()

      expect(sub.plugins).toEqual([myPlugin, anotherPlugin])
    })
  })
  describe('program', () => {
    it('sets prefix and plugins', () => {
      const cli = new CLI()

      const test = cli.program('test')

      expect(test).toBeInstanceOf(CLI)

      expect(test.prefix, 'test')
      expect(test.parent).toEqual(cli)
      expect(cli.programs).toEqual([test])
    })
  })
  describe('createVersionMessage', () => {
    it('has version to 0.0.0 and name to Spektr by default', () => {
      const cli = new CLI()

      expect(cli.createVersionMessage()).toEqual('Spektr: 0.0.0')
    })
    it('allows passing custom version and misc info', () => {
      const cli = new CLI()

      expect(cli.createVersionMessage('1.0.0', '\nhello')).toEqual(
        'Spektr: 1.0.0\nhello',
      )
    })
  })
})