Function test_subcommands

tests/test_commandset.py:522–636

(manual_command_sets_app)

def test_subcommands(manual_command_sets_app) -> None:
    base_cmds = LoadableBase(1)
    badbase_cmds = LoadableBadBase(1)
    fruit_cmds = LoadableFruits(1)
    veg_cmds = LoadableVegetables(1)

    # installing subcommands without base command present raises exception
    with pytest.raises(CommandSetRegistrationError):
        manual_command_sets_app.register_command_set(fruit_cmds)

    # if the base command is present but isn't an argparse command, expect exception
    manual_command_sets_app.register_command_set(badbase_cmds)
    with pytest.raises(CommandSetRegistrationError):
        manual_command_sets_app.register_command_set(fruit_cmds)

    # verify that the Fruit commands weren't installed
    cmds_cats, _help_topics = manual_command_sets_app._build_command_info()
    assert "Fruits" not in cmds_cats
    assert "cut" in manual_command_sets_app.get_all_commands()

    # Now install the good base commands
    manual_command_sets_app.unregister_command_set(badbase_cmds)
    manual_command_sets_app.register_command_set(base_cmds)

    # verify that we catch an attempt to register subcommands when the commandset isn't installed
    with pytest.raises(CommandSetRegistrationError):
        manual_command_sets_app._register_subcommands(fruit_cmds)

    cmd_result = manual_command_sets_app.app_cmd("cut")
    assert "This command does nothing without sub-parsers registered" in cmd_result.stderr

    # verify that command set install without problems
    manual_command_sets_app.register_command_set(fruit_cmds)
    manual_command_sets_app.register_command_set(veg_cmds)
    cmds_cats, _help_topics = manual_command_sets_app._build_command_info()
    assert "Fruits" in cmds_cats

    text = ""
    line = f"cut {text}"
    endidx = len(line)
    begidx = endidx
    completions = manual_command_sets_app.complete(text, line, begidx, endidx)

    # check that the alias shows up correctly
    assert completions.to_strings() == Completions.from_values(["banana", "bananer", "bokchoy"]).to_strings()

    cmd_result = manual_command_sets_app.app_cmd("cut banana discs")
    assert "cutting banana: discs" in cmd_result.stdout

    text = ""
    line = f"cut bokchoy {text}"
    endidx = len(line)
    begidx = endidx
    completions = manual_command_sets_app.complete(text, line, begidx, endidx)

    # verify that argparse completer in commandset functions correctly
    assert completions.to_strings() == Completions.from_values(["diced", "quartered"]).to_strings()