clap/clap-tests/run_tests.py

#!/usr/bin/env python3
import sys
import subprocess

failed = False

_help = '''claptests 0.0.1
Kevin K. <kbknapp@gmail.com>
tests clap library

USAGE:
	claptests [POSITIONAL] [FLAGS] [OPTIONS] [SUBCOMMANDS]

FLAGS:
    -f, --flag       tests flags
    -F               tests flags with exclusions
    -h, --help       Prints help information
    -v, --version    Prints version information

OPTIONS:
        --maxvals3  <maxvals>...         Tests 3 max vals
        --minvals2  <minvals>...         Tests 2 min vals
        --multvals  <one> <two>          Tests mutliple values, not mult occs
        --multvalsmo  <one> <two>        Tests mutliple values, not mult occs
    -o, --option  <opt>...               tests options
        --long-option-2  <option2>       tests long options with exclusions
    -O <option3>                         tests options with specific value sets [values: fast slow]

POSITIONAL ARGUMENTS:
    positional        tests positionals
    positional2       tests positionals with exclusions
    positional3...    tests positionals with specific values [values: emacs vi]

SUBCOMMANDS:
    help      Prints this message
    subcmd    tests subcommands'''

_sc_dym_usage = '''Subcommand "subcm" is unknown. Did you mean "subcmd" ?
USAGE:
\tclaptests [POSITIONAL] [FLAGS] [OPTIONS] [SUBCOMMANDS]
For more information try --help'''

_excluded = '''The argument '--flag' cannot be used with '-F'
USAGE:
\tclaptests [positional2] -F --long-option-2 <option2>
For more information try --help'''

_excluded_l = '''The argument -f cannot be used '-F'
USAGE:
\tclaptests [positional2] -F --long-option-2 <option2>
For more information try --help'''

_required = '''The following required arguments were not supplied:
\t'[positional2]'
\t'--long-option-2 <option2>'

USAGE:
\tclaptests [positional2] -F --long-option-2 <option2>
For more information try --help'''

_fop = '''flag present 1 times
option present 1 times with value: some
An option: some
positional present with value: value
flag2 NOT present
option2 maybe present with value of: Nothing
positional2 maybe present with value of: Nothing
option3 NOT present
positional3 NOT present
option present 1 times with value: some
An option: some
positional present with value: value
subcmd NOT present'''

_f2op = '''flag present 2 times
option present 1 times with value: some
An option: some
positional present with value: value
flag2 NOT present
option2 maybe present with value of: Nothing
positional2 maybe present with value of: Nothing
option3 NOT present
positional3 NOT present
option present 1 times with value: some
An option: some
positional present with value: value
subcmd NOT present'''

_o2p = '''flag NOT present
option present 2 times with value: some
An option: some
An option: other
positional present with value: value
flag2 NOT present
option2 maybe present with value of: Nothing
positional2 maybe present with value of: Nothing
option3 NOT present
positional3 NOT present
option present 2 times with value: some
An option: some
An option: other
positional present with value: value
subcmd NOT present'''

_schelp = '''claptests-subcmd 0.1
Kevin K. <kbknapp@gmail.com>
tests subcommands

USAGE:
	claptests subcmd [POSITIONAL] [FLAGS] [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -f, --flag       tests flags
    -v, --version    Prints version information

OPTIONS:
    -o, --option  <scoption>...    tests options

POSITIONAL ARGUMENTS:
    scpositional    tests positionals'''

_scfop = '''flag NOT present
option NOT present
positional NOT present
flag2 NOT present
option2 maybe present with value of: Nothing
positional2 maybe present with value of: Nothing
option3 NOT present
positional3 NOT present
option NOT present
positional NOT present
subcmd present
scflag present 1 times
scoption present with value: some
An scoption: some
scpositional present with value: value'''

_scf2op = '''flag NOT present
option NOT present
positional NOT present
flag2 NOT present
option2 maybe present with value of: Nothing
positional2 maybe present with value of: Nothing
option3 NOT present
positional3 NOT present
option NOT present
positional NOT present
subcmd present
scflag present 2 times
scoption present with value: some
An scoption: some
scpositional present with value: value'''

_min_vals_few = '''The argument '--minvals2 <minvals>...' requires at least 2 values, but 1 was provided
USAGE:
\tclaptests --minvals2 <minvals>...
For more information try --help'''

_exact = '''flag NOT present
option NOT present
positional NOT present
flag2 NOT present
option2 maybe present with value of: Nothing
positional2 maybe present with value of: Nothing
option3 NOT present
positional3 NOT present
option NOT present
positional NOT present
subcmd NOT present'''

_max_vals_more = '''flag NOT present
option NOT present
positional present with value: too
flag2 NOT present
option2 maybe present with value of: Nothing
positional2 maybe present with value of: Nothing
option3 NOT present
positional3 NOT present
option NOT present
positional present with value: too
subcmd NOT present'''

_mult_vals_more = '''Argument --multvals was supplied more than once, but does not support multiple values
USAGE:
\tclaptests --multvals <one> <two>
For more information try --help'''

_mult_vals_few = '''Argument '--multvals <one> <two>' requires a value but none was supplied
USAGE:
\tclaptests --multvals <one> <two>
For more information try --help'''

_mult_vals_2m1 = '''The argument '--multvalsmo <one> <two>' requires 2 values, but 1 was provided
USAGE:
\tclaptests --multvalsmo <one> <two>
For more information try --help'''

_bin = './target/release/claptests'

cmds = {'help short:         ': ['{} -h'.format(_bin), _help],
		'help long:          ': ['{} --help'.format(_bin), _help],
		'help subcmd:        ': ['{} help'.format(_bin), _help],
		'excluded first:     ': ['{} -f -F'.format(_bin), _excluded],
		'excluded last:      ': ['{} -F -f'.format(_bin), _excluded_l],
		'missing required:   ': ['{} -F'.format(_bin), _required],
		'F2(ll),O(s),P:      ': ['{} value --flag --flag -o some'.format(_bin), _f2op],
		'max_vals too many:  ': ['{} --maxvals3 some other value too'.format(_bin), _max_vals_more],
		'max_vals exact:     ': ['{} --maxvals3 some other value'.format(_bin), _exact],
		'max_vals less:      ': ['{} --maxvals3 some other'.format(_bin), _exact],
		'min_vals more:      ': ['{} --minvals2 some other value too'.format(_bin), _exact],
		'min_vals exact:     ': ['{} --minvals2 some value'.format(_bin), _exact],
		'min_vals too few:   ': ['{} --minvals2 some'.format(_bin), _min_vals_few],
		'mult_vals too many: ': ['{} --multvals some other --multvals some other'.format(_bin), _mult_vals_more],
		'mult_vals too few:  ': ['{} --multvals some'.format(_bin), _mult_vals_few],
		'mult_vals exact:    ': ['{} --multvals some other'.format(_bin), _exact],
		'mult_valsmo x2:     ': ['{} --multvalsmo some other --multvalsmo some other'.format(_bin), _exact],
		'mult_valsmo x2-1:   ': ['{} --multvalsmo some other --multvalsmo some'.format(_bin), _mult_vals_2m1],
		'mult_valsmo x1:     ': ['{} --multvalsmo some other'.format(_bin), _exact],
		'F2(ss),O(s),P:      ': ['{} value -f -f -o some'.format(_bin), _f2op],
		'O2(ll)P:            ': ['{} value --option some --option other'.format(_bin), _o2p],
		'O2(l=l=)P:          ': ['{} value --option=some --option=other'.format(_bin), _o2p],
		'O2(ss)P:            ': ['{} value -o some -o other'.format(_bin), _o2p],
		'F2(s2),O(s),P:      ': ['{} value -ff -o some'.format(_bin), _f2op],
		'F(s),O(s),P:        ': ['{} value -f -o some'.format(_bin), _fop],
		'F(l),O(l),P:        ': ['{} value --flag --option some'.format(_bin), _fop],
		'F(l),O(l=),P:       ': ['{} value --flag --option=some'.format(_bin), _fop],
        'sc dym:             ': ['{} subcm'.format(_bin), _sc_dym_usage],
		'sc help short:      ': ['{} subcmd -h'.format(_bin), _schelp],
		'sc help long:       ': ['{} subcmd --help'.format(_bin), _schelp],
		'scF(l),O(l),P:      ': ['{} subcmd value --flag --option some'.format(_bin), _scfop],
		'scF(l),O(s),P:      ': ['{} subcmd value --flag -o some'.format(_bin), _scfop],
		'scF(l),O(l=),P:     ': ['{} subcmd value --flag --option=some'.format(_bin), _scfop],
		'scF(s),O(l),P:      ': ['{} subcmd value -f --option some'.format(_bin), _scfop],
		'scF(s),O(s),P:      ': ['{} subcmd value -f -o some'.format(_bin), _scfop],
		'scF(s),O(l=),P:     ': ['{} subcmd value -f --option=some'.format(_bin), _scfop],
		'scF2(s),O(l),P:     ': ['{} subcmd value -ff --option some'.format(_bin), _scf2op],
		'scF2(s),O(s),P:     ': ['{} subcmd value -ff -o some'.format(_bin), _scf2op],
		'scF2(s),O(l=),P:    ': ['{} subcmd value -ff --option=some'.format(_bin), _scf2op],
		'scF2(l2),O(l),P:    ': ['{} subcmd value --flag --flag --option some'.format(_bin), _scf2op],
		'scF2(l2),O(s),P:    ': ['{} subcmd value --flag --flag -o some'.format(_bin), _scf2op],
		'scF2(l2),O(l=),P:   ': ['{} subcmd value --flag --flag --option=some'.format(_bin), _scf2op],
		'scF2(s2),O(l),P:    ': ['{} subcmd value -f -f --option some'.format(_bin), _scf2op],
		'scF2(s2),O(s),P:    ': ['{} subcmd value -f -f -o some'.format(_bin), _scf2op],
		'scF2(s2),O(l=),P:   ': ['{} subcmd value -f -f --option=some'.format(_bin), _scf2op]
		}

def pass_fail(name, check, good):
	global failed
	print(name, end='')
	if check == good:
		print('Pass')
		return
	failed = True
	print('Fail\n\tShould be: \n{}\n\tBut is:    \n{}'.format(good, check))


def main():
	for cmd, cmd_v in cmds.items():
		with subprocess.Popen(cmd_v[0], shell=True, stdout=subprocess.PIPE, universal_newlines=True) as proc:
			out = proc.communicate()[0].strip()
			pass_fail(cmd, out, cmd_v[1])
	if failed:
		print('One or more tests failed')
		return 1
	print('All tests passed!')

if __name__ == '__main__':
	sys.exit(main())