import logging import pytest from flexmock import flexmock from borgmatic.hooks.data_source import mysql as module def test_database_names_to_dump_passes_through_name(): environment = flexmock() names = module.database_names_to_dump( {'name': 'foo'}, {}, 'root', 'trustsome1', environment, dry_run=False ) assert names == ('foo',) def test_database_names_to_dump_bails_for_dry_run(): environment = flexmock() flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module).should_receive('execute_command_and_capture_output').never() names = module.database_names_to_dump( {'name': 'all'}, {}, 'root', 'trustsome1', environment, dry_run=True ) assert names == () def test_database_names_to_dump_queries_mysql_for_database_names(): environment = flexmock() flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module).should_receive('execute_command_and_capture_output').with_args( ( 'mysql', '--defaults-extra-file=/dev/fd/99', '--skip-column-names', '--batch', '--execute', 'show schemas', ), environment=environment, ).and_return('foo\nbar\nmysql\n').once() names = module.database_names_to_dump( {'name': 'all'}, {}, 'root', 'trustsome1', environment, dry_run=False ) assert names == ('foo', 'bar') def test_database_names_to_dump_with_environment_password_transport_skips_defaults_file_and_passes_user_flag(): environment = flexmock() flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).never() flexmock(module).should_receive('execute_command_and_capture_output').with_args( ( 'mysql', '--user', 'root', '--skip-column-names', '--batch', '--execute', 'show schemas', ), environment=environment, ).and_return('foo\nbar\nmysql\n').once() names = module.database_names_to_dump( {'name': 'all', 'password_transport': 'environment'}, {}, 'root', 'trustsome1', environment, dry_run=False, ) assert names == ('foo', 'bar') def test_database_names_to_dump_runs_mysql_with_tls(): environment = flexmock() flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module).should_receive('execute_command_and_capture_output').with_args( ( 'mysql', '--defaults-extra-file=/dev/fd/99', '--ssl', '--skip-column-names', '--batch', '--execute', 'show schemas', ), environment=environment, ).and_return('foo\nbar\nmysql\n').once() names = module.database_names_to_dump( {'name': 'all', 'tls': True}, {}, 'root', 'trustsome1', environment, dry_run=False ) assert names == ('foo', 'bar') def test_database_names_to_dump_runs_mysql_without_tls(): environment = flexmock() flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module).should_receive('execute_command_and_capture_output').with_args( ( 'mysql', '--defaults-extra-file=/dev/fd/99', '--skip-ssl', '--skip-column-names', '--batch', '--execute', 'show schemas', ), environment=environment, ).and_return('foo\nbar\nmysql\n').once() names = module.database_names_to_dump( {'name': 'all', 'tls': False}, {}, 'root', 'trustsome1', environment, dry_run=False ) assert names == ('foo', 'bar') def test_use_streaming_true_for_any_databases(): assert module.use_streaming( databases=[flexmock(), flexmock()], config=flexmock(), ) def test_use_streaming_false_for_no_databases(): assert not module.use_streaming(databases=[], config=flexmock()) def test_dump_data_sources_dumps_each_database(): databases = [{'name': 'foo'}, {'name': 'bar'}] processes = [flexmock(), flexmock()] flexmock(module).should_receive('make_dump_path').and_return('') flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).and_return(None) flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module).should_receive('database_names_to_dump').with_args( database=databases[0], config={}, username=None, password=None, environment={'USER': 'root'}, dry_run=False, ).and_return(('foo',)) flexmock(module).should_receive('database_names_to_dump').with_args( database=databases[1], config={}, username=None, password=None, environment={'USER': 'root'}, dry_run=False, ).and_return(('bar',)) for name, process in zip(('foo', 'bar'), processes): flexmock(module).should_receive('execute_dump_command').with_args( database={'name': name}, config={}, username=None, password=None, dump_path=object, database_names=(name,), environment={'USER': 'root'}, dry_run=object, dry_run_label=object, ).and_return(process).once() assert ( module.dump_data_sources( databases, {}, config_paths=('test.yaml',), borgmatic_runtime_directory='/run/borgmatic', patterns=[], dry_run=False, ) == processes ) def test_dump_data_sources_dumps_with_password(): database = {'name': 'foo', 'username': 'root', 'password': 'trustsome1'} process = flexmock() flexmock(module).should_receive('make_dump_path').and_return('') flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module).should_receive('database_names_to_dump').with_args( database=database, config={}, username='root', password='trustsome1', environment={'USER': 'root'}, dry_run=False, ).and_return(('foo',)) flexmock(module).should_receive('execute_dump_command').with_args( database=database, config={}, username='root', password='trustsome1', dump_path=object, database_names=('foo',), environment={'USER': 'root'}, dry_run=object, dry_run_label=object, ).and_return(process).once() assert module.dump_data_sources( [database], {}, config_paths=('test.yaml',), borgmatic_runtime_directory='/run/borgmatic', patterns=[], dry_run=False, ) == [process] def test_dump_data_sources_dumps_with_environment_password_transport_passes_password_environment_variable(): database = { 'name': 'foo', 'username': 'root', 'password': 'trustsome1', 'password_transport': 'environment', } process = flexmock() flexmock(module).should_receive('make_dump_path').and_return('') flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module).should_receive('database_names_to_dump').with_args( database=database, config={}, username='root', password='trustsome1', environment={'USER': 'root', 'MYSQL_PWD': 'trustsome1'}, dry_run=False, ).and_return(('foo',)) flexmock(module).should_receive('execute_dump_command').with_args( database=database, config={}, username='root', password='trustsome1', dump_path=object, database_names=('foo',), environment={'USER': 'root', 'MYSQL_PWD': 'trustsome1'}, dry_run=object, dry_run_label=object, ).and_return(process).once() assert module.dump_data_sources( [database], {}, config_paths=('test.yaml',), borgmatic_runtime_directory='/run/borgmatic', patterns=[], dry_run=False, ) == [process] def test_dump_data_sources_dumps_all_databases_at_once(): databases = [{'name': 'all'}] process = flexmock() flexmock(module).should_receive('make_dump_path').and_return('') flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).and_return(None) flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module).should_receive('database_names_to_dump').and_return(('foo', 'bar')) flexmock(module).should_receive('execute_dump_command').with_args( database={'name': 'all'}, config={}, username=None, password=None, dump_path=object, database_names=('foo', 'bar'), environment={'USER': 'root'}, dry_run=object, dry_run_label=object, ).and_return(process).once() assert module.dump_data_sources( databases, {}, config_paths=('test.yaml',), borgmatic_runtime_directory='/run/borgmatic', patterns=[], dry_run=False, ) == [process] def test_dump_data_sources_dumps_all_databases_separately_when_format_configured(): databases = [{'name': 'all', 'format': 'sql'}] processes = [flexmock(), flexmock()] flexmock(module).should_receive('make_dump_path').and_return('') flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).and_return(None) flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module).should_receive('database_names_to_dump').and_return(('foo', 'bar')) for name, process in zip(('foo', 'bar'), processes): flexmock(module).should_receive('execute_dump_command').with_args( database={'name': name, 'format': 'sql'}, config={}, username=None, password=None, dump_path=object, database_names=(name,), environment={'USER': 'root'}, dry_run=object, dry_run_label=object, ).and_return(process).once() assert ( module.dump_data_sources( databases, {}, config_paths=('test.yaml',), borgmatic_runtime_directory='/run/borgmatic', patterns=[], dry_run=False, ) == processes ) def test_dump_data_sources_errors_for_missing_all_databases(): databases = [{'name': 'all'}] flexmock(module).should_receive('make_dump_path').and_return('') flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return( 'databases/localhost/all' ) flexmock(module).should_receive('database_names_to_dump').and_return(()) with pytest.raises(ValueError): assert module.dump_data_sources( databases, {}, config_paths=('test.yaml',), borgmatic_runtime_directory='/run/borgmatic', patterns=[], dry_run=False, ) def test_dump_data_sources_does_not_error_for_missing_all_databases_with_dry_run(): databases = [{'name': 'all'}] flexmock(module).should_receive('make_dump_path').and_return('') flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return( 'databases/localhost/all' ) flexmock(module).should_receive('database_names_to_dump').and_return(()) assert ( module.dump_data_sources( databases, {}, config_paths=('test.yaml',), borgmatic_runtime_directory='/run/borgmatic', patterns=[], dry_run=True, ) == [] ) def test_database_names_to_dump_runs_mysql_with_list_options(): database = {'name': 'all', 'list_options': '--defaults-extra-file=my.cnf --skip-ssl'} flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return(('--skip-ssl',), 'my.cnf') flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', 'my.cnf').and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module).should_receive('execute_command_and_capture_output').with_args( ( 'mysql', '--defaults-extra-file=/dev/fd/99', '--skip-ssl', '--skip-column-names', '--batch', '--execute', 'show schemas', ), environment=None, ).and_return(('foo\nbar')).once() assert module.database_names_to_dump(database, {}, 'root', 'trustsome1', None, '') == ( 'foo', 'bar', ) def test_database_names_to_dump_runs_non_default_mysql_with_list_options(): database = { 'name': 'all', 'list_options': '--defaults-extra-file=my.cnf --skip-ssl', 'mysql_command': 'custom_mysql', } flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return(('--skip-ssl',), 'my.cnf') flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', 'my.cnf').and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module).should_receive('execute_command_and_capture_output').with_args( environment=None, full_command=( 'custom_mysql', # Custom MySQL command '--defaults-extra-file=/dev/fd/99', '--skip-ssl', '--skip-column-names', '--batch', '--execute', 'show schemas', ), ).and_return(('foo\nbar')).once() assert module.database_names_to_dump(database, {}, 'root', 'trustsome1', None, '') == ( 'foo', 'bar', ) def test_execute_dump_command_runs_mysqldump(): process = flexmock() flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump') flexmock(module.os.path).should_receive('exists').and_return(False) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module.dump).should_receive('create_named_pipe_for_dump') flexmock(module).should_receive('execute_command').with_args( ( 'mysqldump', '--defaults-extra-file=/dev/fd/99', '--add-drop-database', '--databases', 'foo', '--result-file', 'dump', ), environment=None, run_to_completion=False, ).and_return(process).once() assert ( module.execute_dump_command( database={'name': 'foo'}, config={}, username='root', password='trustsome1', dump_path=flexmock(), database_names=('foo',), environment=None, dry_run=False, dry_run_label='', ) == process ) def test_execute_dump_command_with_environment_password_transport_skips_defaults_file_and_passes_user_flag(): process = flexmock() flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump') flexmock(module.os.path).should_receive('exists').and_return(False) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).never() flexmock(module.dump).should_receive('create_named_pipe_for_dump') flexmock(module).should_receive('execute_command').with_args( ( 'mysqldump', '--add-drop-database', '--user', 'root', '--databases', 'foo', '--result-file', 'dump', ), environment=None, run_to_completion=False, ).and_return(process).once() assert ( module.execute_dump_command( database={'name': 'foo', 'password_transport': 'environment'}, config={}, username='root', password='trustsome1', dump_path=flexmock(), database_names=('foo',), environment=None, dry_run=False, dry_run_label='', ) == process ) def test_execute_dump_command_runs_mysqldump_without_add_drop_database(): process = flexmock() flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump') flexmock(module.os.path).should_receive('exists').and_return(False) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module.dump).should_receive('create_named_pipe_for_dump') flexmock(module).should_receive('execute_command').with_args( ( 'mysqldump', '--defaults-extra-file=/dev/fd/99', '--databases', 'foo', '--result-file', 'dump', ), environment=None, run_to_completion=False, ).and_return(process).once() assert ( module.execute_dump_command( database={'name': 'foo', 'add_drop_database': False}, config={}, username='root', password='trustsome1', dump_path=flexmock(), database_names=('foo',), environment=None, dry_run=False, dry_run_label='', ) == process ) def test_execute_dump_command_runs_mysqldump_with_hostname_and_port(): process = flexmock() flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump') flexmock(module.os.path).should_receive('exists').and_return(False) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module.dump).should_receive('create_named_pipe_for_dump') flexmock(module).should_receive('execute_command').with_args( ( 'mysqldump', '--defaults-extra-file=/dev/fd/99', '--add-drop-database', '--host', 'database.example.org', '--port', '5433', '--protocol', 'tcp', '--databases', 'foo', '--result-file', 'dump', ), environment=None, run_to_completion=False, ).and_return(process).once() assert ( module.execute_dump_command( database={'name': 'foo', 'hostname': 'database.example.org', 'port': 5433}, config={}, username='root', password='trustsome1', dump_path=flexmock(), database_names=('foo',), environment=None, dry_run=False, dry_run_label='', ) == process ) def test_execute_dump_command_runs_mysqldump_with_tls(): process = flexmock() flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump') flexmock(module.os.path).should_receive('exists').and_return(False) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module.dump).should_receive('create_named_pipe_for_dump') flexmock(module).should_receive('execute_command').with_args( ( 'mysqldump', '--defaults-extra-file=/dev/fd/99', '--add-drop-database', '--ssl', '--databases', 'foo', '--result-file', 'dump', ), environment=None, run_to_completion=False, ).and_return(process).once() assert ( module.execute_dump_command( database={'name': 'foo', 'tls': True}, config={}, username='root', password='trustsome1', dump_path=flexmock(), database_names=('foo',), environment=None, dry_run=False, dry_run_label='', ) == process ) def test_execute_dump_command_runs_mysqldump_without_tls(): process = flexmock() flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump') flexmock(module.os.path).should_receive('exists').and_return(False) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module.dump).should_receive('create_named_pipe_for_dump') flexmock(module).should_receive('execute_command').with_args( ( 'mysqldump', '--defaults-extra-file=/dev/fd/99', '--add-drop-database', '--skip-ssl', '--databases', 'foo', '--result-file', 'dump', ), environment=None, run_to_completion=False, ).and_return(process).once() assert ( module.execute_dump_command( database={'name': 'foo', 'tls': False}, config={}, username='root', password='trustsome1', dump_path=flexmock(), database_names=('foo',), environment=None, dry_run=False, dry_run_label='', ) == process ) def test_execute_dump_command_runs_mysqldump_with_username_and_password(): process = flexmock() flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump') flexmock(module.os.path).should_receive('exists').and_return(False) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module.dump).should_receive('create_named_pipe_for_dump') flexmock(module).should_receive('execute_command').with_args( ( 'mysqldump', '--defaults-extra-file=/dev/fd/99', '--add-drop-database', '--databases', 'foo', '--result-file', 'dump', ), environment={}, run_to_completion=False, ).and_return(process).once() assert ( module.execute_dump_command( database={'name': 'foo', 'username': 'root', 'password': 'trustsome1'}, config={}, username='root', password='trustsome1', dump_path=flexmock(), database_names=('foo',), environment={}, dry_run=False, dry_run_label='', ) == process ) def test_execute_dump_command_runs_mysqldump_with_options(): process = flexmock() flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump') flexmock(module.os.path).should_receive('exists').and_return(False) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return(('--stuff=such',), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module.dump).should_receive('create_named_pipe_for_dump') flexmock(module).should_receive('execute_command').with_args( ( 'mysqldump', '--defaults-extra-file=/dev/fd/99', '--stuff=such', '--add-drop-database', '--databases', 'foo', '--result-file', 'dump', ), environment=None, run_to_completion=False, ).and_return(process).once() assert ( module.execute_dump_command( database={'name': 'foo', 'options': '--stuff=such'}, config={}, username='root', password='trustsome1', dump_path=flexmock(), database_names=('foo',), environment=None, dry_run=False, dry_run_label='', ) == process ) def test_execute_dump_command_runs_non_default_mysqldump(): process = flexmock() flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump') flexmock(module.os.path).should_receive('exists').and_return(False) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module.dump).should_receive('create_named_pipe_for_dump') flexmock(module).should_receive('execute_command').with_args( ( 'custom_mysqldump', # Custom MySQL dump command '--defaults-extra-file=/dev/fd/99', '--add-drop-database', '--databases', 'foo', '--result-file', 'dump', ), environment=None, run_to_completion=False, ).and_return(process).once() assert ( module.execute_dump_command( database={ 'name': 'foo', 'mysql_dump_command': 'custom_mysqldump', }, # Custom MySQL dump command specified config={}, username='root', password='trustsome1', dump_path=flexmock(), database_names=('foo',), environment=None, dry_run=False, dry_run_label='', ) == process ) def test_execute_dump_command_with_duplicate_dump_skips_mysqldump(): flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump') flexmock(module.os.path).should_receive('exists').and_return(True) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module.dump).should_receive('create_named_pipe_for_dump').never() flexmock(module).should_receive('execute_command').never() assert ( module.execute_dump_command( database={'name': 'foo'}, config={}, username='root', password='trustsome1', dump_path=flexmock(), database_names=('foo',), environment=None, dry_run=True, dry_run_label='SO DRY', ) is None ) def test_execute_dump_command_with_dry_run_skips_mysqldump(): flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump') flexmock(module.os.path).should_receive('exists').and_return(False) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module.dump).should_receive('create_named_pipe_for_dump') flexmock(module).should_receive('execute_command').never() assert ( module.execute_dump_command( database={'name': 'foo'}, config={}, username='root', password='trustsome1', dump_path=flexmock(), database_names=('foo',), environment=None, dry_run=True, dry_run_label='SO DRY', ) is None ) def test_restore_data_source_dump_runs_mysql_to_restore(): hook_config = [{'name': 'foo'}, {'name': 'bar'}] extract_process = flexmock(stdout=flexmock()) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args(None, None, None).and_return(()) flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module).should_receive('execute_command_with_processes').with_args( ('mysql', '--batch'), processes=[extract_process], output_log_level=logging.DEBUG, input_file=extract_process.stdout, environment={'USER': 'root'}, ).once() module.restore_data_source_dump( hook_config, {}, data_source={'name': 'foo'}, dry_run=False, extract_process=extract_process, connection_params={ 'hostname': None, 'port': None, 'username': None, 'password': None, }, borgmatic_runtime_directory='/run/borgmatic', ) def test_restore_data_source_dump_runs_mysql_with_options(): hook_config = [{'name': 'foo', 'restore_options': '--harder'}] extract_process = flexmock(stdout=flexmock()) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return(('--harder',), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args(None, None, None).and_return(()) flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module).should_receive('execute_command_with_processes').with_args( ('mysql', '--harder', '--batch'), processes=[extract_process], output_log_level=logging.DEBUG, input_file=extract_process.stdout, environment={'USER': 'root'}, ).once() module.restore_data_source_dump( hook_config, {}, data_source=hook_config[0], dry_run=False, extract_process=extract_process, connection_params={ 'hostname': None, 'port': None, 'username': None, 'password': None, }, borgmatic_runtime_directory='/run/borgmatic', ) def test_restore_data_source_dump_runs_non_default_mysql_with_options(): hook_config = [{'name': 'foo', 'mysql_command': 'custom_mysql', 'restore_options': '--harder'}] extract_process = flexmock(stdout=flexmock()) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return(('--harder',), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args(None, None, None).and_return(()) flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module).should_receive('execute_command_with_processes').with_args( ('custom_mysql', '--harder', '--batch'), processes=[extract_process], output_log_level=logging.DEBUG, input_file=extract_process.stdout, environment={'USER': 'root'}, ).once() module.restore_data_source_dump( hook_config, {}, data_source=hook_config[0], dry_run=False, extract_process=extract_process, connection_params={ 'hostname': None, 'port': None, 'username': None, 'password': None, }, borgmatic_runtime_directory='/run/borgmatic', ) def test_restore_data_source_dump_runs_mysql_with_hostname_and_port(): hook_config = [{'name': 'foo', 'hostname': 'database.example.org', 'port': 5433}] extract_process = flexmock(stdout=flexmock()) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args(None, None, None).and_return(()) flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module).should_receive('execute_command_with_processes').with_args( ( 'mysql', '--batch', '--host', 'database.example.org', '--port', '5433', '--protocol', 'tcp', ), processes=[extract_process], output_log_level=logging.DEBUG, input_file=extract_process.stdout, environment={'USER': 'root'}, ).once() module.restore_data_source_dump( hook_config, {}, data_source=hook_config[0], dry_run=False, extract_process=extract_process, connection_params={ 'hostname': None, 'port': None, 'username': None, 'password': None, }, borgmatic_runtime_directory='/run/borgmatic', ) def test_restore_data_source_dump_runs_mysql_with_tls(): hook_config = [{'name': 'foo', 'tls': True}] extract_process = flexmock(stdout=flexmock()) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args(None, None, None).and_return(()) flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module).should_receive('execute_command_with_processes').with_args( ( 'mysql', '--batch', '--ssl', ), processes=[extract_process], output_log_level=logging.DEBUG, input_file=extract_process.stdout, environment={'USER': 'root'}, ).once() module.restore_data_source_dump( hook_config, {}, data_source=hook_config[0], dry_run=False, extract_process=extract_process, connection_params={ 'hostname': None, 'port': None, 'username': None, 'password': None, }, borgmatic_runtime_directory='/run/borgmatic', ) def test_restore_data_source_dump_runs_mysql_without_tls(): hook_config = [{'name': 'foo', 'tls': False}] extract_process = flexmock(stdout=flexmock()) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args(None, None, None).and_return(()) flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module).should_receive('execute_command_with_processes').with_args( ( 'mysql', '--batch', '--skip-ssl', ), processes=[extract_process], output_log_level=logging.DEBUG, input_file=extract_process.stdout, environment={'USER': 'root'}, ).once() module.restore_data_source_dump( hook_config, {}, data_source=hook_config[0], dry_run=False, extract_process=extract_process, connection_params={ 'hostname': None, 'port': None, 'username': None, 'password': None, }, borgmatic_runtime_directory='/run/borgmatic', ) def test_restore_data_source_dump_runs_mysql_with_username_and_password(): hook_config = [{'name': 'foo', 'username': 'root', 'password': 'trustsome1'}] extract_process = flexmock(stdout=flexmock()) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',)) flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module).should_receive('execute_command_with_processes').with_args( ('mysql', '--defaults-extra-file=/dev/fd/99', '--batch'), processes=[extract_process], output_log_level=logging.DEBUG, input_file=extract_process.stdout, environment={'USER': 'root'}, ).once() module.restore_data_source_dump( hook_config, {}, data_source=hook_config[0], dry_run=False, extract_process=extract_process, connection_params={ 'hostname': None, 'port': None, 'username': None, 'password': None, }, borgmatic_runtime_directory='/run/borgmatic', ) def test_restore_data_source_with_environment_password_transport_skips_defaults_file_and_passes_user_flag(): hook_config = [ { 'name': 'foo', 'username': 'root', 'password': 'trustsome1', 'password_transport': 'environment', } ] extract_process = flexmock(stdout=flexmock()) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).never() flexmock(module.os).should_receive('environ').and_return( {'USER': 'root', 'MYSQL_PWD': 'trustsome1'} ) flexmock(module).should_receive('execute_command_with_processes').with_args( ('mysql', '--batch', '--user', 'root'), processes=[extract_process], output_log_level=logging.DEBUG, input_file=extract_process.stdout, environment={'USER': 'root', 'MYSQL_PWD': 'trustsome1'}, ).once() module.restore_data_source_dump( hook_config, {}, data_source=hook_config[0], dry_run=False, extract_process=extract_process, connection_params={ 'hostname': None, 'port': None, 'username': None, 'password': None, }, borgmatic_runtime_directory='/run/borgmatic', ) def test_restore_data_source_dump_with_connection_params_uses_connection_params_for_restore(): hook_config = [ { 'name': 'foo', 'username': 'root', 'password': 'trustsome1', 'restore_hostname': 'restorehost', 'restore_port': 'restoreport', 'restore_username': 'restoreusername', 'restore_password': 'restorepassword', } ] extract_process = flexmock(stdout=flexmock()) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('cliusername', 'clipassword', None).and_return( ('--defaults-extra-file=/dev/fd/99',) ) flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module).should_receive('execute_command_with_processes').with_args( ( 'mysql', '--defaults-extra-file=/dev/fd/99', '--batch', '--host', 'clihost', '--port', 'cliport', '--protocol', 'tcp', ), processes=[extract_process], output_log_level=logging.DEBUG, input_file=extract_process.stdout, environment={'USER': 'root'}, ).once() module.restore_data_source_dump( hook_config, {}, data_source={'name': 'foo'}, dry_run=False, extract_process=extract_process, connection_params={ 'hostname': 'clihost', 'port': 'cliport', 'username': 'cliusername', 'password': 'clipassword', }, borgmatic_runtime_directory='/run/borgmatic', ) def test_restore_data_source_dump_without_connection_params_uses_restore_params_in_config_for_restore(): hook_config = [ { 'name': 'foo', 'username': 'root', 'password': 'trustsome1', 'hostname': 'dbhost', 'port': 'dbport', 'tls': True, 'restore_username': 'restoreuser', 'restore_password': 'restorepass', 'restore_hostname': 'restorehost', 'restore_port': 'restoreport', 'restore_tls': False, } ] extract_process = flexmock(stdout=flexmock()) flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args('restoreuser', 'restorepass', None).and_return( ('--defaults-extra-file=/dev/fd/99',) ) flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module).should_receive('execute_command_with_processes').with_args( ( 'mysql', '--defaults-extra-file=/dev/fd/99', '--batch', '--host', 'restorehost', '--port', 'restoreport', '--protocol', 'tcp', '--skip-ssl', ), processes=[extract_process], output_log_level=logging.DEBUG, input_file=extract_process.stdout, environment={'USER': 'root'}, ).once() module.restore_data_source_dump( hook_config, {}, data_source=hook_config[0], dry_run=False, extract_process=extract_process, connection_params={ 'hostname': None, 'port': None, 'username': None, 'password': None, }, borgmatic_runtime_directory='/run/borgmatic', ) def test_restore_data_source_dump_with_dry_run_skips_restore(): hook_config = [{'name': 'foo'}] flexmock(module.borgmatic.hooks.credential.parse).should_receive( 'resolve_credential' ).replace_with(lambda value, config: value) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'parse_extra_options' ).and_return((), None) flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive( 'make_defaults_file_options' ).with_args(None, None, None).and_return(()) flexmock(module.os).should_receive('environ').and_return({'USER': 'root'}) flexmock(module).should_receive('execute_command_with_processes').never() module.restore_data_source_dump( hook_config, {}, data_source={'name': 'foo'}, dry_run=True, extract_process=flexmock(), connection_params={ 'hostname': None, 'port': None, 'username': None, 'password': None, }, borgmatic_runtime_directory='/run/borgmatic', )