import collections import pytest from flexmock import flexmock from borgmatic.commands import arguments as module def test_get_subaction_parsers_with_no_subactions_returns_empty_result(): assert module.get_subaction_parsers(flexmock(_subparsers=None)) == {} def test_get_subaction_parsers_with_subactions_returns_one_entry_per_subaction(): foo_parser = flexmock() bar_parser = flexmock() baz_parser = flexmock() assert module.get_subaction_parsers( flexmock( _subparsers=flexmock( _group_actions=( flexmock(choices={'foo': foo_parser, 'bar': bar_parser}), flexmock(choices={'baz': baz_parser}), ) ) ) ) == {'foo': foo_parser, 'bar': bar_parser, 'baz': baz_parser} def test_get_subactions_for_actions_with_no_subactions_returns_empty_result(): assert module.get_subactions_for_actions({'action': flexmock(_subparsers=None)}) == {} def test_get_subactions_for_actions_with_subactions_returns_one_entry_per_action(): assert module.get_subactions_for_actions( { 'action': flexmock( _subparsers=flexmock( _group_actions=( flexmock(choices={'foo': flexmock(), 'bar': flexmock()}), flexmock(choices={'baz': flexmock()}), ) ) ), 'other': flexmock( _subparsers=flexmock(_group_actions=(flexmock(choices={'quux': flexmock()}),)) ), } ) == {'action': ('foo', 'bar', 'baz'), 'other': ('quux',)} def test_omit_values_colliding_with_action_names_drops_action_names_that_have__been_parsed_as_values(): assert module.omit_values_colliding_with_action_names( ('check', '--only', 'extract', '--some-list', 'borg'), {'check': flexmock(only='extract', some_list=['borg'])}, ) == ('check', '--only', '--some-list') def test_parse_and_record_action_arguments_without_action_name_leaves_arguments_untouched(): unparsed_arguments = ('--foo', '--bar') flexmock(module).should_receive('omit_values_colliding_with_action_names').and_return( unparsed_arguments ) assert ( module.parse_and_record_action_arguments( unparsed_arguments, flexmock(), flexmock(), 'action' ) == unparsed_arguments ) def test_parse_and_record_action_arguments_updates_parsed_arguments_and_returns_remaining(): unparsed_arguments = ('action', '--foo', '--bar', '--verbosity', '1') other_parsed_arguments = flexmock() parsed_arguments = {'other': other_parsed_arguments} action_parsed_arguments = flexmock() flexmock(module).should_receive('omit_values_colliding_with_action_names').and_return( unparsed_arguments ) action_parser = flexmock() flexmock(action_parser).should_receive('parse_known_args').and_return( action_parsed_arguments, ('action', '--verbosity', '1') ) assert module.parse_and_record_action_arguments( unparsed_arguments, parsed_arguments, action_parser, 'action' ) == ('--verbosity', '1') assert parsed_arguments == {'other': other_parsed_arguments, 'action': action_parsed_arguments} def test_parse_and_record_action_arguments_with_alias_updates_canonical_parsed_arguments(): unparsed_arguments = ('action', '--foo', '--bar', '--verbosity', '1') other_parsed_arguments = flexmock() parsed_arguments = {'other': other_parsed_arguments} action_parsed_arguments = flexmock() flexmock(module).should_receive('omit_values_colliding_with_action_names').and_return( unparsed_arguments ) action_parser = flexmock() flexmock(action_parser).should_receive('parse_known_args').and_return( action_parsed_arguments, ('action', '--verbosity', '1') ) assert module.parse_and_record_action_arguments( unparsed_arguments, parsed_arguments, action_parser, 'action', canonical_name='doit' ) == ('--verbosity', '1') assert parsed_arguments == {'other': other_parsed_arguments, 'doit': action_parsed_arguments} def test_parse_and_record_action_arguments_with_borg_action_consumes_arguments_after_action_name(): unparsed_arguments = ('--verbosity', '1', 'borg', 'list') parsed_arguments = {} borg_parsed_arguments = flexmock(options=flexmock()) flexmock(module).should_receive('omit_values_colliding_with_action_names').and_return( unparsed_arguments ) borg_parser = flexmock() flexmock(borg_parser).should_receive('parse_known_args').and_return( borg_parsed_arguments, ('--verbosity', '1', 'borg', 'list') ) assert module.parse_and_record_action_arguments( unparsed_arguments, parsed_arguments, borg_parser, 'borg', ) == ('--verbosity', '1') assert parsed_arguments == {'borg': borg_parsed_arguments} assert borg_parsed_arguments.options == ('list',) @pytest.mark.parametrize( 'arguments, expected', [ # A global flag remaining from each parsed action. ( ( ('--latest', 'archive', 'prune', 'extract', 'list', '--test-flag'), ('--latest', 'archive', 'check', 'extract', 'list', '--test-flag'), ('prune', 'check', 'list', '--test-flag'), ('prune', 'check', 'extract', '--test-flag'), ), ('--test-flag',), ), # No global flags remaining. ( ( ('--latest', 'archive', 'prune', 'extract', 'list'), ('--latest', 'archive', 'check', 'extract', 'list'), ('prune', 'check', 'list'), ('prune', 'check', 'extract'), ), (), ), # No flags. ((), ()), ], ) def test_get_unparsable_arguments_returns_remaining_arguments_that_no_action_can_parse( arguments, expected ): assert module.get_unparsable_arguments(arguments) == expected def test_parse_arguments_for_actions_consumes_action_arguments_after_action_name(): action_namespace = flexmock(foo=True) remaining = flexmock() flexmock(module).should_receive('get_subaction_parsers').and_return({}) flexmock(module).should_receive('parse_and_record_action_arguments').replace_with( lambda unparsed, parsed, parser, action, canonical=None: parsed.update( {action: action_namespace} ) or remaining ) flexmock(module).should_receive('get_subactions_for_actions').and_return({}) action_parsers = {'action': flexmock(), 'other': flexmock()} global_namespace = flexmock() global_parser = flexmock() global_parser.should_receive('parse_known_args').and_return((global_namespace, ())) arguments, remaining_action_arguments = module.parse_arguments_for_actions( ('action', '--foo', 'true'), action_parsers, global_parser ) assert arguments == {'global': global_namespace, 'action': action_namespace} assert remaining_action_arguments == (remaining, ()) def test_parse_arguments_for_actions_consumes_action_arguments_with_alias(): action_namespace = flexmock(foo=True) remaining = flexmock() flexmock(module).should_receive('get_subaction_parsers').and_return({}) flexmock(module).should_receive('parse_and_record_action_arguments').replace_with( lambda unparsed, parsed, parser, action, canonical=None: parsed.update( {canonical or action: action_namespace} ) or remaining ) flexmock(module).should_receive('get_subactions_for_actions').and_return({}) action_parsers = { 'action': flexmock(), '-a': flexmock(), 'other': flexmock(), '-o': flexmock(), } global_namespace = flexmock() global_parser = flexmock() global_parser.should_receive('parse_known_args').and_return((global_namespace, ())) flexmock(module).ACTION_ALIASES = {'action': ['-a'], 'other': ['-o']} arguments, remaining_action_arguments = module.parse_arguments_for_actions( ('-a', '--foo', 'true'), action_parsers, global_parser ) assert arguments == {'global': global_namespace, 'action': action_namespace} assert remaining_action_arguments == (remaining, ()) def test_parse_arguments_for_actions_consumes_multiple_action_arguments(): action_namespace = flexmock(foo=True) other_namespace = flexmock(bar=3) flexmock(module).should_receive('get_subaction_parsers').and_return({}) flexmock(module).should_receive('parse_and_record_action_arguments').replace_with( lambda unparsed, parsed, parser, action, canonical=None: parsed.update( {action: action_namespace if action == 'action' else other_namespace} ) or () ).and_return(('other', '--bar', '3')).and_return('action', '--foo', 'true') flexmock(module).should_receive('get_subactions_for_actions').and_return({}) action_parsers = { 'action': flexmock(), 'other': flexmock(), } global_namespace = flexmock() global_parser = flexmock() global_parser.should_receive('parse_known_args').and_return((global_namespace, ())) arguments, remaining_action_arguments = module.parse_arguments_for_actions( ('action', '--foo', 'true', 'other', '--bar', '3'), action_parsers, global_parser ) assert arguments == { 'global': global_namespace, 'action': action_namespace, 'other': other_namespace, } assert remaining_action_arguments == ((), (), ()) def test_parse_arguments_for_actions_respects_command_line_action_ordering(): other_namespace = flexmock() action_namespace = flexmock(foo=True) flexmock(module).should_receive('get_subaction_parsers').and_return({}) flexmock(module).should_receive('parse_and_record_action_arguments').replace_with( lambda unparsed, parsed, parser, action, canonical=None: parsed.update( {action: other_namespace if action == 'other' else action_namespace} ) or () ).and_return(('action',)).and_return(('other', '--foo', 'true')) flexmock(module).should_receive('get_subactions_for_actions').and_return({}) action_parsers = { 'action': flexmock(), 'other': flexmock(), } global_namespace = flexmock() global_parser = flexmock() global_parser.should_receive('parse_known_args').and_return((global_namespace, ())) arguments, remaining_action_arguments = module.parse_arguments_for_actions( ('other', '--foo', 'true', 'action'), action_parsers, global_parser ) assert arguments == collections.OrderedDict( [('other', other_namespace), ('action', action_namespace), ('global', global_namespace)] ) assert remaining_action_arguments == ((), (), ()) def test_parse_arguments_for_actions_applies_default_action_parsers(): global_namespace = flexmock() namespaces = { 'global': global_namespace, 'prune': flexmock(), 'compact': flexmock(), 'create': flexmock(progress=True), 'check': flexmock(), } flexmock(module).should_receive('get_subaction_parsers').and_return({}) flexmock(module).should_receive('parse_and_record_action_arguments').replace_with( lambda unparsed, parsed, parser, action, canonical=None: parsed.update( {action: namespaces.get(action)} ) or () ).and_return(()) flexmock(module).should_receive('get_subactions_for_actions').and_return({}) action_parsers = { 'prune': flexmock(), 'compact': flexmock(), 'create': flexmock(), 'check': flexmock(), 'other': flexmock(), } global_parser = flexmock() global_parser.should_receive('parse_known_args').and_return((global_namespace, ())) arguments, remaining_action_arguments = module.parse_arguments_for_actions( ('--progress'), action_parsers, global_parser ) assert arguments == namespaces assert remaining_action_arguments == ((), (), (), (), ()) def test_parse_arguments_for_actions_consumes_global_arguments(): action_namespace = flexmock() flexmock(module).should_receive('get_subaction_parsers').and_return({}) flexmock(module).should_receive('parse_and_record_action_arguments').replace_with( lambda unparsed, parsed, parser, action, canonical=None: parsed.update( {action: action_namespace} ) or ('--verbosity', 'lots') ) flexmock(module).should_receive('get_subactions_for_actions').and_return({}) action_parsers = { 'action': flexmock(), 'other': flexmock(), } global_namespace = flexmock() global_parser = flexmock() global_parser.should_receive('parse_known_args').and_return((global_namespace, ())) arguments, remaining_action_arguments = module.parse_arguments_for_actions( ('action', '--verbosity', 'lots'), action_parsers, global_parser ) assert arguments == {'global': global_namespace, 'action': action_namespace} assert remaining_action_arguments == (('--verbosity', 'lots'), ()) def test_parse_arguments_for_actions_passes_through_unknown_arguments_before_action_name(): action_namespace = flexmock() flexmock(module).should_receive('get_subaction_parsers').and_return({}) flexmock(module).should_receive('parse_and_record_action_arguments').replace_with( lambda unparsed, parsed, parser, action, canonical=None: parsed.update( {action: action_namespace} ) or ('--wtf', 'yes') ) flexmock(module).should_receive('get_subactions_for_actions').and_return({}) action_parsers = { 'action': flexmock(), 'other': flexmock(), } global_namespace = flexmock() global_parser = flexmock() global_parser.should_receive('parse_known_args').and_return((global_namespace, ())) arguments, remaining_action_arguments = module.parse_arguments_for_actions( ('--wtf', 'yes', 'action'), action_parsers, global_parser ) assert arguments == {'global': global_namespace, 'action': action_namespace} assert remaining_action_arguments == (('--wtf', 'yes'), ()) def test_parse_arguments_for_actions_passes_through_unknown_arguments_after_action_name(): action_namespace = flexmock() flexmock(module).should_receive('get_subaction_parsers').and_return({}) flexmock(module).should_receive('parse_and_record_action_arguments').replace_with( lambda unparsed, parsed, parser, action, canonical=None: parsed.update( {action: action_namespace} ) or ('--wtf', 'yes') ) flexmock(module).should_receive('get_subactions_for_actions').and_return({}) action_parsers = { 'action': flexmock(), 'other': flexmock(), } global_namespace = flexmock() global_parser = flexmock() global_parser.should_receive('parse_known_args').and_return((global_namespace, ())) arguments, remaining_action_arguments = module.parse_arguments_for_actions( ('action', '--wtf', 'yes'), action_parsers, global_parser ) assert arguments == {'global': global_namespace, 'action': action_namespace} assert remaining_action_arguments == (('--wtf', 'yes'), ()) def test_parse_arguments_for_actions_with_borg_action_skips_other_action_parsers(): action_namespace = flexmock(options=[]) flexmock(module).should_receive('get_subaction_parsers').and_return({}) flexmock(module).should_receive('parse_and_record_action_arguments').replace_with( lambda unparsed, parsed, parser, action, canonical=None: parsed.update( {action: action_namespace} ) or () ).and_return(()) flexmock(module).should_receive('get_subactions_for_actions').and_return({}) action_parsers = { 'borg': flexmock(), 'list': flexmock(), } global_namespace = flexmock() global_parser = flexmock() global_parser.should_receive('parse_known_args').and_return((global_namespace, ())) arguments, remaining_action_arguments = module.parse_arguments_for_actions( ('borg', 'list'), action_parsers, global_parser ) assert arguments == {'global': global_namespace, 'borg': action_namespace} assert remaining_action_arguments == ((), ()) def test_parse_arguments_for_actions_raises_error_when_no_action_is_specified(): flexmock(module).should_receive('get_subaction_parsers').and_return({'bootstrap': [flexmock()]}) flexmock(module).should_receive('parse_and_record_action_arguments').and_return(flexmock()) flexmock(module).should_receive('get_subactions_for_actions').and_return( {'config': ['bootstrap']} ) action_parsers = {'config': flexmock()} global_parser = flexmock() global_parser.should_receive('parse_known_args').and_return((flexmock(), ())) with pytest.raises(ValueError): module.parse_arguments_for_actions(('config',), action_parsers, global_parser)