#    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 oslo_log import log as logging
from tempest import config

from trove_tempest_plugin.tests import base as trove_base

LOG = logging.getLogger(__name__)
CONF = config.CONF


class TestCinderBackupBase(trove_base.BaseTroveTest):
    @classmethod
    def insert_data(cls, *args, **kwargs):
        pass

    @classmethod
    def insert_data_inc(cls, *args, **kwargs):
        pass

    def verify_data(self, *args, **kwargs):
        pass

    @classmethod
    def resource_setup(cls):
        super(TestCinderBackupBase, cls).resource_setup()
        # Insert some data to the current db instance
        LOG.info(f"Inserting data on {cls.instance_ip} before creating"
                 f"backup")
        cls.insert_data(cls.instance_ip)

        # Create a backup that is shared within this test class.
        LOG.info(f"Creating backup for instance {cls.instance_id}")
        name = cls.get_resource_name("backup")
        backup = cls.create_backup(cls.instance_id,
                                   name,
                                   storage_driver="cinder")
        cls.wait_for_backup_status(backup['id'])
        cls.backup = cls.client.get_resource("backups", backup['id'])['backup']

    def backup_test(self):
        # Restore from backup
        LOG.info(f'Creating a new instance using the backup '
                 f'{self.backup["id"]}')
        name = self.get_resource_name("restore")
        restore_instance = self.create_instance(
            name,
            datastore_version=self.backup['datastore']['version'],
            backup_id=self.backup['id'],
            create_user=self.create_user
        )
        self.wait_for_instance_status(
            restore_instance['id'],
            expected_op_status=["HEALTHY"],
            timeout=CONF.database.database_restore_timeout)

        if self.enable_root:
            self.root_password = self.get_root_pass(restore_instance['id'])

        restore_instance = self.client.get_resource(
            "instances", restore_instance['id'])['instance']
        restore_instance_ip = self.get_instance_ip(restore_instance)

        LOG.info(f"Verifying data on restored instance {restore_instance_ip}")
        self.verify_data(restore_instance_ip)

        # Delete the new instance explicitly to avoid too many instances
        # during the test.
        self.wait_for_instance_status(restore_instance['id'],
                                      expected_status="DELETED",
                                      need_delete=True)