Source code for glare.db.artifact_api

# Copyright (c) 2016 Mirantis, Inc.
#
# 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.

"""Database API for all artifact types"""

from oslo_db import exception as db_exception
from oslo_log import log as logging
from retrying import retry

from glare.db.sqlalchemy import api
from glare import locking

LOG = logging.getLogger(__name__)


def _retry_on_connection_error(exc):
    """Function to retry a DB API call if connection error was received."""

    if isinstance(exc, db_exception.DBConnectionError):
        LOG.warning("Connection error detected. Retrying...")
        return True
    return False


[docs]class ArtifactAPI(object): def _serialize_values(self, values): new_values = {} if 'tags' in values: new_values['tags'] = values.pop('tags') if values['tags'] else [] for key, value in values.items(): if key in api.BASE_ARTIFACT_PROPERTIES: new_values[key] = value else: new_values.setdefault('properties', {})[key] = value return new_values @retry(retry_on_exception=_retry_on_connection_error, wait_fixed=1000, stop_max_attempt_number=20) def save(self, context, artifact_id, values): """Save artifact values in database :param artifact_id: id of artifact that needs to be updated :param context: user context :param values: values that needs to be updated :return: dict of updated artifact values """ session = api.get_session() return api.create_or_update( context, artifact_id, self._serialize_values(values), session) @retry(retry_on_exception=_retry_on_connection_error, wait_fixed=1000, stop_max_attempt_number=20) def update_blob(self, context, artifact_id, values): """Create and update blob records in db :param artifact_id: id of artifact that needs to be updated :param context: user context :param values: blob values that needs to be updated :return: dict of updated artifact values """ session = api.get_session() return api.create_or_update( context, artifact_id, {'blobs': values}, session) @retry(retry_on_exception=_retry_on_connection_error, wait_fixed=1000, stop_max_attempt_number=20) def delete(self, context, artifact_id): """Delete artifacts from db :param context: user context :param artifact_id: id of artifact that needs to be deleted """ session = api.get_session() api.delete(context, artifact_id, session) @retry(retry_on_exception=_retry_on_connection_error, wait_fixed=1000, stop_max_attempt_number=20) def get(self, context, type_name, artifact_id, get_any_artifact=False): """Return artifact values from database :param context: user context :param type_name: artifact type name or None for metatypes :param artifact_id: id of the artifact :param get_any_artifact: flag that indicate, if we want to enable to get artifact from other realm as well. :return: dict of artifact values """ session = api.get_session() return api.get(context, type_name, artifact_id, session, get_any_artifact) @retry(retry_on_exception=_retry_on_connection_error, wait_fixed=1000, stop_max_attempt_number=20) def list(self, context, filters, marker, limit, sort, latest, list_all_artifacts=False): """List artifacts from db :param context: user request context :param filters: filter conditions from url :param marker: id of first artifact where we need to start artifact lookup :param limit: max number of items in list :param sort: sort conditions :param latest: flag that indicates, that only artifacts with highest versions should be returned in output :param list_all_artifacts: flag that indicate, if the list should return artifact from all realms (True), or from the specific realm (False) :return: list of artifacts. Each artifact is represented as dict of values. """ session = api.get_session() return api.get_all(context=context, session=session, filters=filters, marker=marker, limit=limit, sort=sort, latest=latest, list_all_artifacts=list_all_artifacts) @retry(retry_on_exception=_retry_on_connection_error, wait_fixed=1000, stop_max_attempt_number=20) def count_artifact_number(self, context, type_name=None): """Count the number of artifacts for the tenant. :param context: user context :param type_name: name of specific artifact type to count artifacts. If None count artifacts of all types. :return: number of artifacts for given tenant """ session = api.get_session() return api.count_artifact_number(context, session, type_name) @retry(retry_on_exception=_retry_on_connection_error, wait_fixed=1000, stop_max_attempt_number=20) def calculate_uploaded_data(self, context, type_name=None): """Calculate the amount of uploaded data for tenant. :param context: user context :param type_name: name of specific artifact type to calculate data. If None calculate data of artifacts of all types. :return: amount of uploaded data for given user """ session = api.get_session() return api.calculate_uploaded_data(context, session, type_name)
[docs]class ArtifactLockApi(locking.LockApiBase): @retry(retry_on_exception=_retry_on_connection_error, wait_fixed=1000, stop_max_attempt_number=20) def create_lock(self, context, lock_key): session = api.get_session() return api.create_lock(context, lock_key, session) @retry(retry_on_exception=_retry_on_connection_error, wait_fixed=1000, stop_max_attempt_number=20) def delete_lock(self, context, lock_id): session = api.get_session() api.delete_lock(context, lock_id, session)