Function test_load_commandset_errors

tests/test_commandset.py:336–387

(manual_command_sets_app, capsys)

def test_load_commandset_errors(manual_command_sets_app, capsys) -> None:
    cmd_set = CommandSetA()

    # create a conflicting command before installing CommandSet to verify rollback behavior
    manual_command_sets_app._install_command_function("do_durian", cmd_set.do_durian)
    with pytest.raises(CommandSetRegistrationError):
        manual_command_sets_app.register_command_set(cmd_set)

    # verify that the commands weren't installed
    cmds_cats, _help_topics = manual_command_sets_app._build_command_info()

    assert "Alone" not in cmds_cats
    assert "Fruits" not in cmds_cats
    assert not manual_command_sets_app._installed_command_sets

    delattr(manual_command_sets_app, "do_durian")

    # pre-create intentionally conflicting macro and alias names
    manual_command_sets_app.app_cmd("macro create apple run_pyscript")
    manual_command_sets_app.app_cmd("alias create banana run_pyscript")

    # now install a command set and verify the commands are now present
    manual_command_sets_app.register_command_set(cmd_set)
    _out, err = capsys.readouterr()

    # verify aliases and macros are deleted with warning if they conflict with a command
    assert "Deleting alias 'banana'" in err
    assert "Deleting macro 'apple'" in err

    # verify command functions which don't start with "do_" raise an exception
    with pytest.raises(CommandSetRegistrationError):
        manual_command_sets_app._install_command_function("new_cmd", cmd_set.do_banana)

    # verify methods which don't start with "do_" raise an exception
    with pytest.raises(CommandSetRegistrationError):
        manual_command_sets_app._install_command_function("do_new_cmd", cmd_set.on_register)

    # verify duplicate commands are detected
    with pytest.raises(CommandSetRegistrationError):
        manual_command_sets_app._install_command_function("do_banana", cmd_set.do_banana)

    # verify bad command names are detected
    with pytest.raises(CommandSetRegistrationError):
        manual_command_sets_app._install_command_function("do_bad command", cmd_set.do_banana)

    # verify error conflict with existing completer function
    with pytest.raises(CommandSetRegistrationError):
        manual_command_sets_app._install_completer_function("durian", cmd_set.complete_durian)

    # verify error conflict with existing help function
    with pytest.raises(CommandSetRegistrationError):
        manual_command_sets_app._install_help_function("cranberry", cmd_set.help_cranberry)


class LoadableBase(cmd2.CommandSet):