test/lib/cli/Command.spec.js

import expect from 'unexpected';
import Command from '../../../src/lib/cli/Command';
import Option from '../../../src/lib/cli/Option';

/** @test {Command} */
describe('Command', function () {
  const name = 'command';
  const desc = 'Command description.';
  const opts = {};
  const args = '<required> [optional...]';

  /** @test {Command#constructor} */
  describe('#constructor', function () {
    it('should fail if options.maxArguments is less than options.maxArguments', function () {
      expect(
        () =>
          new Command(
            name,
            desc,
            Object.assign(
              {
                minArguments: 1,
                maxArguments: 0,
              },
              opts
            )
          ),
        'to throw error',
        'options.maxArguments must not be less than options.minArguments'
      );
    });

    it('should store name, description and options', function () {
      const command = new Command(name, desc, opts);

      expect(command.name, 'to equal', name);
      expect(command.description, 'to equal', desc);
      expect(command._options, 'to equal', opts);
    });
  });

  /** @test {Command#run} */
  describe('#run', function () {
    it('must be implmented by all subclasses', function () {
      expect(
        new Command(name, desc, opts).run,
        'to throw',
        new Error('Must be implemented by all subclasses')
      );
    });
  });

  /** @test {Command#usage} */
  describe('#usage', function () {
    it('should be only name with no options.arguments set', function () {
      expect(new Command(name, desc, opts).usage, 'to equal', name);
    });

    it('should be name followed by arguments with options.arguments set', function () {
      expect(
        new Command(name, desc, Object.assign({ arguments: args }, opts)).usage,
        'to equal',
        `${name} ${args}`
      );
    });
  });

  /** @test {Command#options} */
  describe('#options', function () {
    it('should be empty object if options.options were not set', function () {
      expect(new Command(name, desc, opts).options, 'to equal', {});
    });

    it('should return all options passed as options.options', function () {
      const options = { test: new Option('description') };

      expect(
        new Command(name, desc, Object.assign({ options }, opts)).options,
        'to equal',
        options
      );
    });
  });

  /** @test {Command#demandCommand} */
  describe('#demandCommand', function () {
    it('should default to [0]', function () {
      expect(new Command(name, desc, opts).demandCommand, 'to equal', [0]);
    });

    it('should be use options.maxArguments if set', function () {
      expect(
        new Command(name, desc, Object.assign({ maxArguments: 13 }, opts)).demandCommand,
        'to equal',
        [0, 13]
      );
    });

    it('should be use options.minArguments if set', function () {
      expect(
        new Command(name, desc, Object.assign({ minArguments: 13 }, opts)).demandCommand,
        'to equal',
        [13]
      );
    });

    it('should be use options.minArguments and options.maxArguments if set', function () {
      expect(
        new Command(
          name,
          desc,
          Object.assign(
            {
              minArguments: 1,
              maxArguments: 2,
            },
            opts
          )
        ).demandCommand,
        'to equal',
        [1, 2]
      );
    });
  });

  /** @test {Command#strict} */
  describe('#strict', function () {
    it('should default to `true`', function () {
      expect(new Command(name, desc, opts).strict, 'to be', true);
    });

    it('should return the value passed to the constructor', function () {
      expect(
        new Command(
          name,
          desc,
          Object.assign({
            strict: false,
          }),
          opts
        ).strict,
        'to be',
        false
      );
      expect(
        new Command(
          name,
          desc,
          Object.assign({
            strict: true,
          }),
          opts
        ).strict,
        'to be',
        true
      );
    });
  });
});