Cannot test Commdn groups with click.testing.CliRunner

[kissgyorgy]

When calling CliRunner.invoke() on a subcommand with parameters and extra arguments, the extra arguments don't get passed because those are not handled by Command and BaseCommand.

There is a call to Command.ini with extra args in Multicommand but Command doesn't handle the passed in optional keywords.

I don't know how to solve this.

Here is the first call with runner.invoke which causes the problem:
https://github.com/mitsuhiko/click/blob/master/click/testing.py#L257

[kissgyorgy]

Here is the subcommand I would like to test:

@click.group()
@click.option('-c', '--config', default='config.json', type=click.Path(),
              help="Explicitly specify config file")
@click.option('-l', '--loglevel', default=None,
              type=click.Choice(['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']))
@click.pass_context
def main(ctx, config, loglevel):
    # Don't read config file when help is invoked, because with type click.File('r'), 
   # it would not be possible to look help if config.json is not in the directory
    if '--help' in ctx.args:
        return
    ctx.obj = {'LOGLEVEL': loglevel}
    try:
        with open(config) as fp:
            ctx.obj['CONFIG'] = json.load(fp)
    except FileNotFoundError:
        logging.critical('Cannot find "%s" in current directory!\n'
                         "You can set it's path with --config option.", config)
        ctx.abort()

@main.command()
@click.argument('year', type=click.INT)
@click.argument('month')
@click.argument('day')
@click.argument('hour')
@click.pass_context
def download(ctx, year, month, day, hour):
    import boto
    config = ctx.obj['CONFIG']

with this test:

import pytest
import moto

@pytest.yield_fixture
def runner():
    s3_mock = moto.mock_s3()
    s3_mock.start()

    yield CliRunner()

    s3_mock.stop()

def test_bucket_not_found(runner):
    result = runner.invoke(cli.download, ['2014', '11', '10', '14'], config="config.json")
    assert 'Aborted!' in result.output
    assert 'Bucket not found' in result.output

The problem is that the 'config' parameter is not handled, context is not passed to download subcommand and the command fail because there is no ctx.obj set.
Also, I think it would be better if CliRunner.invoke would pass default options automatically, which does not currently as far as I understand.

It is very important to write integration tests for the subcommands I work on. Any idea how to do it?

[kissgyorgy]

Ok, I might have misunderstood how the Runner invokes commands, extra keyword arguments are passed to the context constructor and main().

Do I need to manually pass every default option in the tests?

[geowurster]

@walkman did you manage to find a solution to this problem? I'm struggling with the same use case.

[kissgyorgy]

@geowurster I think you should pass every command line parameter you would pass on command line. e.g. runner.invoke(cli.download, ['2014', '11', '10', '--config', 'config.json'])
Still not totally sure though 😄

[geowurster]

Hmm no luck. I switched to testing with subprocess.check_output(), which works but isn't very flexible.

@mitsuhiko any guidance?

[untitaker]

You're supposed to do

runner.invoke(cli.main, ['download', '2014', '11', '10', '--config', 'config.json'])

Please comment if this doesn't help you.

[mesuutt]

I have a similar problem:

I have a command group which get a --config paramter shown as below:

click.group()
@click.option(
    '--config', '-c',
    type=click.Path(),
    help='Config file path'
)
@click.pass_context
def cli(context, config_file,  **kwargs):
    ....

And sub commands of group:

@cli.command(name='ls')
@click.pass_context
def list_files(context):
   ....

I am invoking ls command with --config option from command line shows as below and everything works expected:
python app.py --config ~/.myconfig ls

Now I want to write test for my commands but I don't know how to give --config option
to CliRunner

I tried as below but not worked for me:

runner = CliRunner()
result = runner.invoke(list_files, ['--config', config_file])

I think CliRunner getting --config option as option of ls command instead of group and invoking ls command as app.py ls --config ~/.myconfig instead of app.py --config ~/.myconfig ls.

How can I solve this?

[geowurster]

@mesuutt Try this:

result = runner.invoke(cli, ['--config', config_file, 'ls'])

Essentially you have to tell CliRunner() to run the main CLI group and then pass in a full list of flags, including the name of the subcommand you actually want to run.

[mesuutt]

Thanks @geowurster. This solved the problem 👍

[HalfDeadPie]

`@click.group('yum')
@click.option('--config', '-c', default='config.cfg',
help='Path of the auth config file.')
@click.option('--username', '-u', envvar='IG_USERNAME',
help='Instagram username')
@click.option('--password', '-p', envvar='IG_PASSWORD',
help='Instagram password')
@click.pass_context
def cli(ctx, config, username, password):
...

@cli.command()
@click.option('--id', '-i', help='XP Gain from the photo with ID')
@click.pass_context
def gain(ctx, id):
....`

I would like to test this, without using the options or arguments. Just "yum gain"
Can anyone help me please?

runner = CliRunner() result = runner.invoke(cli, ['gain'])

doesn't work :(