import pytest from flexmock import flexmock from borgmatic.hooks import postgresql as module def test_make_database_dump_filename_uses_name_and_hostname(): flexmock(module.os.path).should_receive('expanduser').and_return('databases') assert module.make_database_dump_filename('test', 'hostname') == 'databases/hostname/test' def test_make_database_dump_filename_without_hostname_defaults_to_localhost(): flexmock(module.os.path).should_receive('expanduser').and_return('databases') assert module.make_database_dump_filename('test') == 'databases/localhost/test' def test_make_database_dump_filename_with_invalid_name_raises(): flexmock(module.os.path).should_receive('expanduser').and_return('databases') with pytest.raises(ValueError): module.make_database_dump_filename('invalid/name') def test_dump_databases_runs_pg_dump_for_each_database(): databases = [{'name': 'foo'}, {'name': 'bar'}] flexmock(module).should_receive('make_database_dump_filename').and_return( 'databases/localhost/foo' ).and_return('databases/localhost/bar') flexmock(module.os).should_receive('makedirs') for name in ('foo', 'bar'): flexmock(module).should_receive('execute_command').with_args( ( 'pg_dump', '--no-password', '--clean', '--file', 'databases/localhost/{}'.format(name), '--format', 'custom', name, ), extra_environment=None, ).once() module.dump_databases(databases, 'test.yaml', dry_run=False) def test_dump_databases_with_dry_run_skips_pg_dump(): databases = [{'name': 'foo'}, {'name': 'bar'}] flexmock(module).should_receive('make_database_dump_filename').and_return( 'databases/localhost/foo' ).and_return('databases/localhost/bar') flexmock(module.os).should_receive('makedirs') flexmock(module).should_receive('execute_command').never() module.dump_databases(databases, 'test.yaml', dry_run=True) def test_dump_databases_without_databases_does_not_raise(): module.dump_databases([], 'test.yaml', dry_run=False) def test_dump_databases_with_invalid_database_name_raises(): databases = [{'name': 'heehee/../../etc/passwd'}] with pytest.raises(ValueError): module.dump_databases(databases, 'test.yaml', dry_run=True) def test_dump_databases_runs_pg_dump_with_hostname_and_port(): databases = [{'name': 'foo', 'hostname': 'database.example.org', 'port': 5433}] flexmock(module).should_receive('make_database_dump_filename').and_return( 'databases/database.example.org/foo' ) flexmock(module.os).should_receive('makedirs') flexmock(module).should_receive('execute_command').with_args( ( 'pg_dump', '--no-password', '--clean', '--file', 'databases/database.example.org/foo', '--host', 'database.example.org', '--port', '5433', '--format', 'custom', 'foo', ), extra_environment=None, ).once() module.dump_databases(databases, 'test.yaml', dry_run=False) def test_dump_databases_runs_pg_dump_with_username_and_password(): databases = [{'name': 'foo', 'username': 'postgres', 'password': 'trustsome1'}] flexmock(module).should_receive('make_database_dump_filename').and_return( 'databases/localhost/foo' ) flexmock(module.os).should_receive('makedirs') flexmock(module).should_receive('execute_command').with_args( ( 'pg_dump', '--no-password', '--clean', '--file', 'databases/localhost/foo', '--username', 'postgres', '--format', 'custom', 'foo', ), extra_environment={'PGPASSWORD': 'trustsome1'}, ).once() module.dump_databases(databases, 'test.yaml', dry_run=False) def test_dump_databases_runs_pg_dump_with_format(): databases = [{'name': 'foo', 'format': 'tar'}] flexmock(module).should_receive('make_database_dump_filename').and_return( 'databases/localhost/foo' ) flexmock(module.os).should_receive('makedirs') flexmock(module).should_receive('execute_command').with_args( ( 'pg_dump', '--no-password', '--clean', '--file', 'databases/localhost/foo', '--format', 'tar', 'foo', ), extra_environment=None, ).once() module.dump_databases(databases, 'test.yaml', dry_run=False) def test_dump_databases_runs_pg_dump_with_options(): databases = [{'name': 'foo', 'options': '--stuff=such'}] flexmock(module).should_receive('make_database_dump_filename').and_return( 'databases/localhost/foo' ) flexmock(module.os).should_receive('makedirs') flexmock(module).should_receive('execute_command').with_args( ( 'pg_dump', '--no-password', '--clean', '--file', 'databases/localhost/foo', '--format', 'custom', '--stuff=such', 'foo', ), extra_environment=None, ).once() module.dump_databases(databases, 'test.yaml', dry_run=False) def test_dump_databases_runs_pg_dumpall_for_all_databases(): databases = [{'name': 'all'}] flexmock(module).should_receive('make_database_dump_filename').and_return( 'databases/localhost/all' ) flexmock(module.os).should_receive('makedirs') flexmock(module).should_receive('execute_command').with_args( ('pg_dumpall', '--no-password', '--clean', '--file', 'databases/localhost/all'), extra_environment=None, ).once() module.dump_databases(databases, 'test.yaml', dry_run=False) def test_remove_database_dumps_removes_dump_for_each_database(): databases = [{'name': 'foo'}, {'name': 'bar'}] flexmock(module).should_receive('make_database_dump_filename').and_return( 'databases/localhost/foo' ).and_return('databases/localhost/bar') flexmock(module.os).should_receive('listdir').and_return([]) flexmock(module.os).should_receive('rmdir') for name in ('foo', 'bar'): flexmock(module.os).should_receive('remove').with_args( 'databases/localhost/{}'.format(name) ).once() module.remove_database_dumps(databases, 'test.yaml', dry_run=False) def test_remove_database_dumps_with_dry_run_skips_removal(): databases = [{'name': 'foo'}, {'name': 'bar'}] flexmock(module.os).should_receive('remove').never() module.remove_database_dumps(databases, 'test.yaml', dry_run=True) def test_remove_database_dumps_without_databases_does_not_raise(): module.remove_database_dumps([], 'test.yaml', dry_run=False) def test_remove_database_dumps_with_invalid_database_name_raises(): databases = [{'name': 'heehee/../../etc/passwd'}] with pytest.raises(ValueError): module.remove_database_dumps(databases, 'test.yaml', dry_run=True) def test_make_database_dump_patterns_converts_names_to_glob_paths(): flexmock(module).should_receive('make_database_dump_filename').and_return( 'databases/*/foo' ).and_return('databases/*/bar') assert module.make_database_dump_patterns(('foo', 'bar')) == [ 'databases/*/foo', 'databases/*/bar', ] def test_make_database_dump_patterns_treats_empty_names_as_matching_all_databases(): flexmock(module).should_receive('make_database_dump_filename').with_args('*', '*').and_return( 'databases/*/*' ) assert module.make_database_dump_patterns(()) == ['databases/*/*'] def test_convert_glob_patterns_to_borg_patterns_removes_leading_slash(): assert module.convert_glob_patterns_to_borg_patterns(('/etc/foo/bar',)) == ['sh:etc/foo/bar'] def test_get_database_names_from_dumps_gets_names_from_filenames_matching_globs(): flexmock(module.glob).should_receive('glob').and_return( ('databases/localhost/foo',) ).and_return(('databases/localhost/bar',)).and_return(()) assert module.get_database_names_from_dumps( ('databases/*/foo', 'databases/*/bar', 'databases/*/baz') ) == ['foo', 'bar']