trove/trove/tests/api/backups.py

508 lines
19 KiB
Python

# Copyright 2011 OpenStack Foundation
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from proboscis.asserts import assert_equal
from proboscis.asserts import assert_not_equal
from proboscis.asserts import assert_raises
from proboscis.asserts import assert_true
from proboscis.asserts import fail
from proboscis.decorators import time_out
from proboscis import SkipTest
from proboscis import test
from troveclient.compat import exceptions
from trove.common import cfg
from trove.common import exception
from trove.common.utils import generate_uuid
from trove.common.utils import poll_until
from trove import tests
from trove.tests.api.instances import instance_info
from trove.tests.api.instances import TIMEOUT_INSTANCE_CREATE
from trove.tests.api.instances import TIMEOUT_INSTANCE_DELETE
from trove.tests.api.instances import TIMEOUT_INSTANCE_RESTORE
from trove.tests.api.instances import WaitForGuestInstallationToFinish
from trove.tests.config import CONFIG
from trove.tests.util import create_dbaas_client
from trove.tests.util.users import Requirements
BACKUP_NAME = 'backup_test'
BACKUP_DESC = 'test description'
TIMEOUT_BACKUP_CREATE = 60 * 30
TIMEOUT_BACKUP_DELETE = 120
backup_info = None
incremental_info = None
incremental_db = generate_uuid()
incremental_restore_instance_id = None
total_num_dbs = 0
backup_count_prior_to_create = 0
backup_count_for_instance_prior_to_create = 0
@test(depends_on_groups=[tests.DBAAS_API_INSTANCE_ACTIONS],
groups=[tests.DBAAS_API_BACKUPS],
enabled=CONFIG.swift_enabled)
class CreateBackups(object):
@test
def test_backup_create_instance(self):
"""Test create backup for a given instance."""
# Necessary to test that the count increases.
global backup_count_prior_to_create
backup_count_prior_to_create = len(instance_info.dbaas.backups.list())
global backup_count_for_instance_prior_to_create
backup_count_for_instance_prior_to_create = len(
instance_info.dbaas.instances.backups(instance_info.id))
datastore_version = instance_info.dbaas.datastore_versions.get(
instance_info.dbaas_datastore,
instance_info.dbaas_datastore_version)
result = instance_info.dbaas.backups.create(BACKUP_NAME,
instance_info.id,
BACKUP_DESC)
global backup_info
backup_info = result
assert_equal(BACKUP_NAME, result.name)
assert_equal(BACKUP_DESC, result.description)
assert_equal(instance_info.id, result.instance_id)
assert_equal('NEW', result.status)
instance = instance_info.dbaas.instances.get(instance_info.id)
assert_true(instance.status in ['ACTIVE', 'BACKUP', 'HEALTHY'])
assert_equal(instance_info.dbaas_datastore,
result.datastore['type'])
assert_equal(instance_info.dbaas_datastore_version,
result.datastore['version'])
assert_equal(datastore_version.id, result.datastore['version_id'])
class BackupRestoreMixin(object):
def verify_backup(self, backup_id):
def result_is_active():
backup = instance_info.dbaas.backups.get(backup_id)
if backup.status == "COMPLETED":
return True
else:
assert_not_equal("FAILED", backup.status)
return False
poll_until(result_is_active)
def instance_is_totally_gone(self, instance_id):
def instance_is_gone():
try:
instance_info.dbaas.instances.get(
instance_id)
return False
except exceptions.NotFound:
return True
poll_until(
instance_is_gone, time_out=TIMEOUT_INSTANCE_DELETE)
def backup_is_totally_gone(self, backup_id):
def backup_is_gone():
try:
instance_info.dbaas.backups.get(backup_id)
return False
except exceptions.NotFound:
return True
poll_until(backup_is_gone, time_out=TIMEOUT_BACKUP_DELETE)
def verify_instance_is_active(self, instance_id):
# This version just checks the REST API status.
def result_is_active():
instance = instance_info.dbaas.instances.get(instance_id)
if instance.status in CONFIG.running_status:
return True
else:
# If its not ACTIVE, anything but BUILD must be
# an error.
assert_equal("BUILD", instance.status)
if instance_info.volume is not None:
assert_equal(instance.volume.get('used', None), None)
return False
poll_until(result_is_active, sleep_time=5,
time_out=TIMEOUT_INSTANCE_CREATE)
@test(depends_on_classes=[CreateBackups],
groups=[tests.DBAAS_API_BACKUPS],
enabled=CONFIG.swift_enabled)
class WaitForBackupCreateToFinish(BackupRestoreMixin):
"""Wait until the backup creation is finished."""
@test
@time_out(TIMEOUT_BACKUP_CREATE)
def test_backup_created(self):
"""Wait for the backup to be finished."""
self.verify_backup(backup_info.id)
@test(depends_on=[WaitForBackupCreateToFinish],
groups=[tests.DBAAS_API_BACKUPS],
enabled=CONFIG.swift_enabled)
class ListBackups(object):
@test
def test_backup_list(self):
"""Test list backups."""
result = instance_info.dbaas.backups.list()
assert_equal(backup_count_prior_to_create + 1, len(result))
backup = result[0]
assert_equal(BACKUP_NAME, backup.name)
assert_equal(BACKUP_DESC, backup.description)
assert_not_equal(0.0, backup.size)
assert_equal(instance_info.id, backup.instance_id)
assert_equal('COMPLETED', backup.status)
@test
def test_backup_list_filter_datastore(self):
"""Test list backups and filter by datastore."""
result = instance_info.dbaas.backups.list(
datastore=instance_info.dbaas_datastore)
assert_equal(backup_count_prior_to_create + 1, len(result))
backup = result[0]
assert_equal(BACKUP_NAME, backup.name)
assert_equal(BACKUP_DESC, backup.description)
assert_not_equal(0.0, backup.size)
assert_equal(instance_info.id, backup.instance_id)
assert_equal('COMPLETED', backup.status)
@test
def test_backup_list_filter_different_datastore(self):
"""Test list backups and filter by datastore."""
result = instance_info.dbaas.backups.list(
datastore=CONFIG.dbaas_datastore_name_no_versions)
# There should not be any backups for this datastore
assert_equal(0, len(result))
@test
def test_backup_list_filter_datastore_not_found(self):
"""Test list backups and filter by datastore."""
assert_raises(exceptions.NotFound, instance_info.dbaas.backups.list,
datastore='NOT_FOUND')
@test
def test_backup_list_for_instance(self):
"""Test backup list for instance."""
result = instance_info.dbaas.instances.backups(instance_info.id)
assert_equal(backup_count_for_instance_prior_to_create + 1,
len(result))
backup = result[0]
assert_equal(BACKUP_NAME, backup.name)
assert_equal(BACKUP_DESC, backup.description)
assert_not_equal(0.0, backup.size)
assert_equal(instance_info.id, backup.instance_id)
assert_equal('COMPLETED', backup.status)
@test
def test_backup_get(self):
"""Test get backup."""
backup = instance_info.dbaas.backups.get(backup_info.id)
assert_equal(backup_info.id, backup.id)
assert_equal(backup_info.name, backup.name)
assert_equal(backup_info.description, backup.description)
assert_equal(instance_info.id, backup.instance_id)
assert_not_equal(0.0, backup.size)
assert_equal('COMPLETED', backup.status)
assert_equal(instance_info.dbaas_datastore,
backup.datastore['type'])
assert_equal(instance_info.dbaas_datastore_version,
backup.datastore['version'])
datastore_version = instance_info.dbaas.datastore_versions.get(
instance_info.dbaas_datastore,
instance_info.dbaas_datastore_version)
assert_equal(datastore_version.id, backup.datastore['version_id'])
# Test to make sure that user in other tenant is not able
# to GET this backup
reqs = Requirements(is_admin=False)
other_user = CONFIG.users.find_user(
reqs,
black_list=[instance_info.user.auth_user])
other_client = create_dbaas_client(other_user)
assert_raises(exceptions.NotFound, other_client.backups.get,
backup_info.id)
@test(runs_after=[ListBackups],
depends_on=[WaitForBackupCreateToFinish],
groups=[tests.DBAAS_API_BACKUPS],
enabled=CONFIG.swift_enabled)
class IncrementalBackups(BackupRestoreMixin):
@test
def test_create_db(self):
global total_num_dbs
total_num_dbs = len(instance_info.dbaas.databases.list(
instance_info.id))
databases = [{'name': incremental_db}]
instance_info.dbaas.databases.create(instance_info.id, databases)
assert_equal(202, instance_info.dbaas.last_http_code)
total_num_dbs += 1
@test(runs_after=['test_create_db'])
def test_create_incremental_backup(self):
result = instance_info.dbaas.backups.create("incremental-backup",
backup_info.instance_id,
parent_id=backup_info.id)
global incremental_info
incremental_info = result
assert_equal(202, instance_info.dbaas.last_http_code)
# Wait for the backup to finish
self.verify_backup(incremental_info.id)
assert_equal(backup_info.id, incremental_info.parent_id)
@test(groups=[tests.DBAAS_API_BACKUPS],
depends_on_classes=[IncrementalBackups],
enabled=CONFIG.swift_enabled)
class RestoreUsingBackup(object):
@classmethod
def _restore(cls, backup_ref):
restorePoint = {"backupRef": backup_ref}
result = instance_info.dbaas.instances.create(
instance_info.name + "_restore",
instance_info.dbaas_flavor_href,
instance_info.volume,
datastore=instance_info.dbaas_datastore,
datastore_version=instance_info.dbaas_datastore_version,
nics=instance_info.nics,
restorePoint=restorePoint)
assert_equal(200, instance_info.dbaas.last_http_code)
assert_equal("BUILD", result.status)
return result.id
@test(depends_on=[IncrementalBackups])
def test_restore_incremental(self):
"""Restore from incremental backup."""
global incremental_restore_instance_id
incremental_restore_instance_id = self._restore(incremental_info.id)
@test(depends_on_classes=[RestoreUsingBackup],
groups=[tests.DBAAS_API_BACKUPS],
enabled=CONFIG.swift_enabled)
class WaitForRestoreToFinish(object):
@classmethod
def _poll(cls, instance_id_to_poll):
"""Shared "instance restored" test logic."""
# This version just checks the REST API status.
def result_is_active():
instance = instance_info.dbaas.instances.get(instance_id_to_poll)
if instance.status in CONFIG.running_status:
return True
else:
# If its not ACTIVE, anything but BUILD must be
# an error.
assert_equal("BUILD", instance.status)
if instance_info.volume is not None:
assert_equal(instance.volume.get('used', None), None)
return False
poll_until(result_is_active, time_out=TIMEOUT_INSTANCE_RESTORE,
sleep_time=10)
@test
def test_instance_restored_incremental(self):
try:
self._poll(incremental_restore_instance_id)
except exception.PollTimeOut:
fail('Timed out')
@test(enabled=(not CONFIG.fake_mode and CONFIG.swift_enabled),
depends_on_classes=[WaitForRestoreToFinish],
groups=[tests.DBAAS_API_BACKUPS])
class VerifyRestore(object):
@classmethod
def _poll(cls, instance_id, db):
def db_is_found():
databases = instance_info.dbaas.databases.list(instance_id)
if db in [d.name for d in databases]:
return True
else:
return False
poll_until(db_is_found, time_out=60 * 10, sleep_time=10)
@test
def test_database_restored_incremental(self):
try:
self._poll(incremental_restore_instance_id, incremental_db)
assert_equal(total_num_dbs, len(instance_info.dbaas.databases.list(
incremental_restore_instance_id)))
except exception.PollTimeOut:
fail('Timed out')
@test(groups=[tests.DBAAS_API_BACKUPS], enabled=CONFIG.swift_enabled,
depends_on_classes=[VerifyRestore])
class DeleteRestoreInstance(object):
@classmethod
def _delete(cls, instance_id):
"""Test delete restored instance."""
instance_info.dbaas.instances.delete(instance_id)
assert_equal(202, instance_info.dbaas.last_http_code)
def instance_is_gone():
try:
instance_info.dbaas.instances.get(instance_id)
return False
except exceptions.NotFound:
return True
poll_until(instance_is_gone, time_out=TIMEOUT_INSTANCE_DELETE)
assert_raises(exceptions.NotFound, instance_info.dbaas.instances.get,
instance_id)
@test
def test_delete_restored_instance_incremental(self):
try:
self._delete(incremental_restore_instance_id)
except exception.PollTimeOut:
fail('Timed out')
@test(depends_on_classes=[DeleteRestoreInstance],
groups=[tests.DBAAS_API_BACKUPS],
enabled=CONFIG.swift_enabled)
class DeleteBackups(object):
@test
def test_backup_delete_not_found(self):
"""Test delete unknown backup."""
assert_raises(exceptions.NotFound, instance_info.dbaas.backups.delete,
'nonexistent_backup')
@test
def test_backup_delete_other(self):
"""Test another user cannot delete backup."""
# Test to make sure that user in other tenant is not able
# to DELETE this backup
reqs = Requirements(is_admin=False)
other_user = CONFIG.users.find_user(
reqs,
black_list=[instance_info.user.auth_user])
other_client = create_dbaas_client(other_user)
assert_raises(exceptions.NotFound, other_client.backups.delete,
backup_info.id)
@test(runs_after=[test_backup_delete_other])
def test_backup_delete(self):
"""Test backup deletion."""
instance_info.dbaas.backups.delete(backup_info.id)
assert_equal(202, instance_info.dbaas.last_http_code)
def backup_is_gone():
try:
instance_info.dbaas.backups.get(backup_info.id)
return False
except exceptions.NotFound:
return True
poll_until(backup_is_gone, time_out=TIMEOUT_BACKUP_DELETE)
@test(runs_after=[test_backup_delete])
def test_incremental_deleted(self):
"""Test backup children are deleted."""
if incremental_info is None:
raise SkipTest("Incremental Backup not created")
assert_raises(exceptions.NotFound, instance_info.dbaas.backups.get,
incremental_info.id)
@test(depends_on=[WaitForGuestInstallationToFinish],
runs_after=[DeleteBackups],
enabled=CONFIG.swift_enabled)
class FakeTestHugeBackupOnSmallInstance(BackupRestoreMixin):
report = CONFIG.get_report()
def tweak_fake_guest(self, size):
from trove.tests.fakes import guestagent
guestagent.BACKUP_SIZE = size
@test
def test_load_mysql_with_data(self):
if not CONFIG.fake_mode:
raise SkipTest("Must run in fake mode.")
self.tweak_fake_guest(1.9)
@test(depends_on=[test_load_mysql_with_data])
def test_create_huge_backup(self):
if not CONFIG.fake_mode:
raise SkipTest("Must run in fake mode.")
self.new_backup = instance_info.dbaas.backups.create(
BACKUP_NAME,
instance_info.id,
BACKUP_DESC)
assert_equal(202, instance_info.dbaas.last_http_code)
@test(depends_on=[test_create_huge_backup])
def test_verify_huge_backup_completed(self):
if not CONFIG.fake_mode:
raise SkipTest("Must run in fake mode.")
self.verify_backup(self.new_backup.id)
@test(depends_on=[test_verify_huge_backup_completed])
def test_try_to_restore_on_small_instance_with_volume(self):
if not CONFIG.fake_mode:
raise SkipTest("Must run in fake mode.")
assert_raises(exceptions.Forbidden,
instance_info.dbaas.instances.create,
instance_info.name + "_restore",
instance_info.dbaas_flavor_href,
{'size': 1},
datastore=instance_info.dbaas_datastore,
datastore_version=(instance_info.
dbaas_datastore_version),
nics=instance_info.nics,
restorePoint={"backupRef": self.new_backup.id})
assert_equal(403, instance_info.dbaas.last_http_code)
@test(depends_on=[test_verify_huge_backup_completed])
def test_try_to_restore_on_small_instance_with_flavor_only(self):
if not CONFIG.fake_mode:
raise SkipTest("Must run in fake mode.")
self.orig_conf_value = cfg.CONF.get(
instance_info.dbaas_datastore).volume_support
cfg.CONF.get(instance_info.dbaas_datastore).volume_support = False
assert_raises(exceptions.Forbidden,
instance_info.dbaas.instances.create,
instance_info.name + "_restore", 11,
datastore=instance_info.dbaas_datastore,
datastore_version=(instance_info.
dbaas_datastore_version),
nics=instance_info.nics,
restorePoint={"backupRef": self.new_backup.id})
assert_equal(403, instance_info.dbaas.last_http_code)
cfg.CONF.get(
instance_info.dbaas_datastore
).volume_support = self.orig_conf_value