designate/designate/storage/impl_sqlalchemy/__init__.py

724 lines
26 KiB
Python

# Copyright 2012 Managed I.T.
#
# Author: Kiall Mac Innes <kiall@managedit.ie>
#
# 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.
import time
from oslo.config import cfg
from oslo.db.sqlalchemy import utils as oslo_utils
from oslo.db import options
from sqlalchemy.orm import exc
from sqlalchemy import exc as sqlalchemy_exc
from sqlalchemy import distinct, func
from designate.openstack.common import log as logging
from designate import exceptions
from designate import objects
from designate.sqlalchemy import session
from designate.storage import base
from designate.storage.impl_sqlalchemy import models
from designate.sqlalchemy.models import SoftDeleteMixin
LOG = logging.getLogger(__name__)
cfg.CONF.register_group(cfg.OptGroup(
name='storage:sqlalchemy', title="Configuration for SQLAlchemy Storage"
))
cfg.CONF.register_opts(options.database_opts, group='storage:sqlalchemy')
def _set_object_from_model(obj, model):
"""Update a DesignateObject with the values from a SQLA Model"""
for fieldname in obj.FIELDS:
if hasattr(model, fieldname):
obj[fieldname] = getattr(model, fieldname)
obj.obj_reset_changes()
return obj
class SQLAlchemyStorage(base.Storage):
"""SQLAlchemy connection"""
__plugin_name__ = 'sqlalchemy'
def __init__(self):
super(SQLAlchemyStorage, self).__init__()
self.engine = session.get_engine(self.name)
self.session = session.get_session(self.name)
def begin(self):
self.session.begin(subtransactions=True)
def commit(self):
self.session.commit()
def rollback(self):
self.session.rollback()
def setup_schema(self):
"""Semi-Private Method to create the database schema"""
models.Base.metadata.create_all(self.session.bind)
def teardown_schema(self):
"""Semi-Private Method to reset the database schema"""
models.Base.metadata.drop_all(self.session.bind)
def _apply_criterion(self, model, query, criterion):
if criterion is not None:
for name, value in criterion.items():
column = getattr(model, name)
# Wildcard value: '*'
if isinstance(value, basestring) and '*' in value:
queryval = value.replace('*', '%')
query = query.filter(column.like(queryval))
else:
query = query.filter(column == value)
return query
def _apply_tenant_criteria(self, context, model, query):
if hasattr(model, 'tenant_id'):
if context.all_tenants:
LOG.debug('Including all tenants items in query results')
else:
query = query.filter(model.tenant_id == context.tenant)
return query
def _apply_deleted_criteria(self, context, model, query):
if issubclass(model, SoftDeleteMixin):
if context.show_deleted:
LOG.debug('Including deleted items in query results')
else:
query = query.filter(model.deleted == "0")
return query
def _find(self, model, context, criterion, one=False,
marker=None, limit=None, sort_key=None, sort_dir=None):
"""
Base "finder" method
Used to abstract these details from all the _find_*() methods.
"""
# First up, create a query and apply the various filters
query = self.session.query(model)
query = self._apply_criterion(model, query, criterion)
query = self._apply_tenant_criteria(context, model, query)
query = self._apply_deleted_criteria(context, model, query)
if one:
# If we're asked to return exactly one record, but multiple or
# none match, raise a NotFound
try:
return query.one()
except (exc.NoResultFound, exc.MultipleResultsFound):
raise exceptions.NotFound()
else:
# If marker is not none and basestring we query it.
# Otherwise, return all matching records
if marker is not None:
try:
marker = self._find(model, context, {'id': marker},
one=True)
except exceptions.NotFound:
raise exceptions.MarkerNotFound(
'Marker %s could not be found' % marker)
# Malformed UUIDs return StatementError
except sqlalchemy_exc.StatementError as statement_error:
raise exceptions.InvalidMarker(statement_error.message)
sort_key = sort_key or 'created_at'
sort_dir = sort_dir or 'asc'
try:
query = oslo_utils.paginate_query(
query, model, limit,
[sort_key, 'id', 'created_at'], marker=marker,
sort_dir=sort_dir)
return query.all()
except oslo_utils.InvalidSortKey as sort_key_error:
raise exceptions.InvalidSortKey(sort_key_error.message)
# Any ValueErrors are propagated back to the user as is.
# Limits, sort_dir and sort_key are checked at the API layer.
# If however central or storage is called directly, invalid values
# show up as ValueError
except ValueError as value_error:
raise exceptions.ValueError(value_error.message)
# CRUD for our resources (quota, server, tsigkey, tenant, domain & record)
# R - get_*, find_*s
#
# Standard Arguments
# self - python object for the class
# context - a dictionary of details about the request (http etc),
# provided by flask.
# criterion - dictionary of filters to be applied
#
# Quota Methods
def _find_quotas(self, context, criterion, one=False,
marker=None, limit=None, sort_key=None, sort_dir=None):
try:
return self._find(models.Quota, context, criterion, one=one,
marker=marker, limit=limit, sort_key=sort_key,
sort_dir=sort_dir)
except exceptions.NotFound:
raise exceptions.QuotaNotFound()
def create_quota(self, context, values):
quota = models.Quota()
quota.update(values)
try:
quota.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateQuota()
return objects.Quota.from_sqla(quota)
def get_quota(self, context, quota_id):
quota = self._find_quotas(context, {'id': quota_id}, one=True)
return objects.Quota.from_sqla(quota)
def find_quotas(self, context, criterion=None,
marker=None, limit=None, sort_key=None, sort_dir=None):
quotas = self._find_quotas(context, criterion, marker=marker,
limit=limit, sort_key=sort_key,
sort_dir=sort_dir)
return [objects.Quota.from_sqla(q) for q in quotas]
def find_quota(self, context, criterion):
quota = self._find_quotas(context, criterion, one=True)
return objects.Quota.from_sqla(quota)
def update_quota(self, context, quota_id, values):
quota = self._find_quotas(context, {'id': quota_id}, one=True)
quota.update(values)
try:
quota.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateQuota()
return objects.Quota.from_sqla(quota)
def delete_quota(self, context, quota_id):
quota = self._find_quotas(context, {'id': quota_id}, one=True)
quota.delete(self.session)
return objects.Quota.from_sqla(quota)
# Server Methods
def _find_servers(self, context, criterion, one=False,
marker=None, limit=None, sort_key=None, sort_dir=None):
try:
return self._find(models.Server, context, criterion, one,
marker=marker, limit=limit, sort_key=sort_key,
sort_dir=sort_dir)
except exceptions.NotFound:
raise exceptions.ServerNotFound()
def create_server(self, context, server):
storage_server = models.Server()
storage_server.update(server)
try:
storage_server.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateServer()
return _set_object_from_model(server, storage_server)
def find_servers(self, context, criterion=None,
marker=None, limit=None, sort_key=None, sort_dir=None):
servers = self._find_servers(context, criterion, marker=marker,
limit=limit, sort_key=sort_key,
sort_dir=sort_dir)
return [objects.Server.from_sqla(s) for s in servers]
def get_server(self, context, server_id):
server = self._find_servers(context, {'id': server_id}, one=True)
return objects.Server.from_sqla(server)
def update_server(self, context, server_id, values):
server = self._find_servers(context, {'id': server_id}, one=True)
server.update(values)
try:
server.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateServer()
return objects.Server.from_sqla(server)
def delete_server(self, context, server_id):
server = self._find_servers(context, {'id': server_id}, one=True)
server.delete(self.session)
return objects.Server.from_sqla(server)
# TLD Methods
def _find_tlds(self, context, criterion, one=False,
marker=None, limit=None, sort_key=None, sort_dir=None):
try:
return self._find(models.Tld, context, criterion, one=one,
marker=marker, limit=limit, sort_key=sort_key,
sort_dir=sort_dir)
except exceptions.NotFound:
raise exceptions.TLDNotFound()
def create_tld(self, context, tld):
storage_tld = models.Tld()
storage_tld.update(tld)
try:
storage_tld.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateTLD()
return _set_object_from_model(tld, storage_tld)
def find_tlds(self, context, criterion=None,
marker=None, limit=None, sort_key=None, sort_dir=None):
tlds = self._find_tlds(context, criterion, marker=marker, limit=limit,
sort_key=sort_key, sort_dir=sort_dir)
return [objects.Tld.from_sqla(t) for t in tlds]
def find_tld(self, context, criterion):
tld = self._find_tlds(context, criterion, one=True)
return objects.Tld.from_sqla(tld)
def get_tld(self, context, tld_id):
tld = self._find_tlds(context, {'id': tld_id}, one=True)
return objects.Tld.from_sqla(tld)
def update_tld(self, context, tld_id, values):
tld = self._find_tlds(context, {'id': tld_id}, one=True)
tld.update(values)
try:
tld.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateTLD()
return objects.Tld.from_sqla(tld)
def delete_tld(self, context, tld_id):
tld = self._find_tlds(context, {'id': tld_id}, one=True)
tld.delete(self.session)
return objects.Tld.from_sqla(tld)
# TSIG Key Methods
def _find_tsigkeys(self, context, criterion, one=False,
marker=None, limit=None, sort_key=None, sort_dir=None):
try:
return self._find(models.TsigKey, context, criterion, one=one,
marker=marker, limit=limit, sort_key=sort_key,
sort_dir=sort_dir)
except exceptions.NotFound:
raise exceptions.TsigKeyNotFound()
def create_tsigkey(self, context, tsigkey):
storage_tsigkey = models.TsigKey()
storage_tsigkey.update(tsigkey)
try:
storage_tsigkey.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateTsigKey()
return _set_object_from_model(tsigkey, storage_tsigkey)
def find_tsigkeys(self, context, criterion=None,
marker=None, limit=None, sort_key=None, sort_dir=None):
tsigkeys = self._find_tsigkeys(context, criterion, marker=marker,
limit=limit, sort_key=sort_key,
sort_dir=sort_dir)
return [objects.TsigKey.from_sqla(t) for t in tsigkeys]
def get_tsigkey(self, context, tsigkey_id):
tsigkey = self._find_tsigkeys(context, {'id': tsigkey_id}, one=True)
return objects.TsigKey.from_sqla(tsigkey)
def update_tsigkey(self, context, tsigkey_id, values):
tsigkey = self._find_tsigkeys(context, {'id': tsigkey_id}, one=True)
tsigkey.update(values)
try:
tsigkey.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateTsigKey()
return objects.TsigKey.from_sqla(tsigkey)
def delete_tsigkey(self, context, tsigkey_id):
tsigkey = self._find_tsigkeys(context, {'id': tsigkey_id}, one=True)
tsigkey.delete(self.session)
return objects.TsigKey.from_sqla(tsigkey)
##
# Tenant Methods
##
def find_tenants(self, context):
# returns an array of tenant_id & count of their domains
query = self.session.query(models.Domain.tenant_id,
func.count(models.Domain.id))
query = self._apply_tenant_criteria(context, models.Domain, query)
query = self._apply_deleted_criteria(context, models.Domain, query)
query = query.group_by(models.Domain.tenant_id)
return [objects.Tenant(id=t[0], domain_count=t[1])
for t in query.all()]
def get_tenant(self, context, tenant_id):
# get list list & count of all domains owned by given tenant_id
query = self.session.query(models.Domain.name)
query = self._apply_tenant_criteria(context, models.Domain, query)
query = self._apply_deleted_criteria(context, models.Domain, query)
query = query.filter(models.Domain.tenant_id == tenant_id)
result = query.all()
return objects.Tenant(
id=tenant_id,
domain_count=len(result),
domains=[r[0] for r in result])
def count_tenants(self, context):
# tenants are the owner of domains, count the number of unique tenants
# select count(distinct tenant_id) from domains
query = self.session.query(distinct(models.Domain.tenant_id))
query = self._apply_tenant_criteria(context, models.Domain, query)
query = self._apply_deleted_criteria(context, models.Domain, query)
return query.count()
##
# Domain Methods
##
def _find_domains(self, context, criterion, one=False,
marker=None, limit=None, sort_key=None, sort_dir=None):
try:
return self._find(models.Domain, context, criterion, one=one,
marker=marker, limit=limit, sort_key=sort_key,
sort_dir=sort_dir)
except exceptions.NotFound:
raise exceptions.DomainNotFound()
def create_domain(self, context, domain):
storage_domain = models.Domain()
storage_domain.update(domain)
try:
storage_domain.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateDomain()
return _set_object_from_model(domain, storage_domain)
def get_domain(self, context, domain_id):
domain = self._find_domains(context, {'id': domain_id}, one=True)
return objects.Domain.from_sqla(domain)
def find_domains(self, context, criterion=None,
marker=None, limit=None, sort_key=None, sort_dir=None):
domains = self._find_domains(context, criterion, marker=marker,
limit=limit, sort_key=sort_key,
sort_dir=sort_dir)
return [objects.Domain.from_sqla(d) for d in domains]
def find_domain(self, context, criterion):
domain = self._find_domains(context, criterion, one=True)
return objects.Domain.from_sqla(domain)
def update_domain(self, context, domain_id, values):
domain = self._find_domains(context, {'id': domain_id}, one=True)
domain.update(values)
try:
domain.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateDomain()
return objects.Domain.from_sqla(domain)
def delete_domain(self, context, domain_id):
domain = self._find_domains(context, {'id': domain_id}, one=True)
domain.soft_delete(self.session)
return objects.Domain.from_sqla(domain)
def count_domains(self, context, criterion=None):
query = self.session.query(models.Domain)
query = self._apply_criterion(models.Domain, query, criterion)
query = self._apply_tenant_criteria(context, models.Domain, query)
query = self._apply_deleted_criteria(context, models.Domain, query)
return query.count()
# RecordSet Methods
def _find_recordsets(self, context, criterion, one=False,
marker=None, limit=None, sort_key=None,
sort_dir=None):
try:
return self._find(models.RecordSet, context, criterion, one=one,
marker=marker, limit=limit, sort_key=sort_key,
sort_dir=sort_dir)
except exceptions.NotFound:
raise exceptions.RecordSetNotFound()
def create_recordset(self, context, domain_id, recordset):
# Fetch the domain as we need the tenant_id
domain = self._find_domains(context, {'id': domain_id}, one=True)
storage_recordset = models.RecordSet()
storage_recordset.update(recordset)
storage_recordset.tenant_id = domain['tenant_id']
storage_recordset.domain_id = domain_id
try:
storage_recordset.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateRecordSet()
return _set_object_from_model(recordset, storage_recordset)
def get_recordset(self, context, recordset_id):
recordset = self._find_recordsets(context, {'id': recordset_id},
one=True)
return objects.RecordSet.from_sqla(recordset)
def find_recordsets(self, context, criterion=None,
marker=None, limit=None, sort_key=None, sort_dir=None):
recordsets = self._find_recordsets(
context, criterion, marker=marker, limit=limit, sort_key=sort_key,
sort_dir=sort_dir)
return [objects.RecordSet.from_sqla(r) for r in recordsets]
def find_recordset(self, context, criterion):
recordset = self._find_recordsets(context, criterion, one=True)
return objects.RecordSet.from_sqla(recordset)
def update_recordset(self, context, recordset_id, values):
recordset = self._find_recordsets(context, {'id': recordset_id},
one=True)
recordset.update(values)
try:
recordset.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateRecordSet()
return objects.RecordSet.from_sqla(recordset)
def delete_recordset(self, context, recordset_id):
recordset = self._find_recordsets(context, {'id': recordset_id},
one=True)
recordset.delete(self.session)
return objects.RecordSet.from_sqla(recordset)
def count_recordsets(self, context, criterion=None):
query = self.session.query(models.RecordSet)
query = self._apply_criterion(models.RecordSet, query, criterion)
return query.count()
# Record Methods
def _find_records(self, context, criterion, one=False,
marker=None, limit=None, sort_key=None, sort_dir=None):
try:
return self._find(models.Record, context, criterion, one=one,
marker=marker, limit=limit, sort_key=sort_key,
sort_dir=sort_dir)
except exceptions.NotFound:
raise exceptions.RecordNotFound()
def create_record(self, context, domain_id, recordset_id, record):
# Fetch the domain as we need the tenant_id
domain = self._find_domains(context, {'id': domain_id}, one=True)
# Create and populate the new Record model
storage_record = models.Record()
storage_record.update(record)
storage_record.tenant_id = domain['tenant_id']
storage_record.domain_id = domain_id
storage_record.recordset_id = recordset_id
try:
# Save the new Record model
storage_record.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateRecord()
return _set_object_from_model(record, storage_record)
def find_records(self, context, criterion=None,
marker=None, limit=None, sort_key=None, sort_dir=None):
records = self._find_records(
context, criterion, marker=marker, limit=limit, sort_key=sort_key,
sort_dir=sort_dir)
return [objects.Record.from_sqla(r) for r in records]
def get_record(self, context, record_id):
record = self._find_records(context, {'id': record_id}, one=True)
return objects.Record.from_sqla(record)
def find_record(self, context, criterion):
record = self._find_records(context, criterion, one=True)
return objects.Record.from_sqla(record)
def update_record(self, context, record_id, values):
record = self._find_records(context, {'id': record_id}, one=True)
record.update(values)
try:
record.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateRecord()
return objects.Record.from_sqla(record)
def delete_record(self, context, record_id):
record = self._find_records(context, {'id': record_id}, one=True)
record.delete(self.session)
return objects.Record.from_sqla(record)
def count_records(self, context, criterion=None):
query = self.session.query(models.Record)
query = self._apply_tenant_criteria(context, models.Record, query)
query = self._apply_criterion(models.Record, query, criterion)
return query.count()
#
# Blacklist Methods
#
def _find_blacklist(self, context, criterion, one=False,
marker=None, limit=None, sort_key=None, sort_dir=None):
try:
return self._find(models.Blacklists, context, criterion, one=one,
marker=marker, limit=limit, sort_key=sort_key,
sort_dir=sort_dir)
except exceptions.NotFound:
raise exceptions.BlacklistNotFound()
def create_blacklist(self, context, blacklist):
storage_blacklist = models.Blacklists()
storage_blacklist.update(blacklist)
try:
storage_blacklist.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateBlacklist()
return _set_object_from_model(blacklist, storage_blacklist)
def find_blacklists(self, context, criterion=None,
marker=None, limit=None, sort_key=None, sort_dir=None):
blacklists = self._find_blacklist(
context, criterion, marker=marker, limit=limit, sort_key=sort_key,
sort_dir=sort_dir)
return [objects.Blacklist.from_sqla(b) for b in blacklists]
def get_blacklist(self, context, blacklist_id):
blacklist = self._find_blacklist(context,
{'id': blacklist_id}, one=True)
return objects.Blacklist.from_sqla(blacklist)
def find_blacklist(self, context, criterion):
blacklist = self._find_blacklist(context, criterion, one=True)
return objects.Blacklist.from_sqla(blacklist)
def update_blacklist(self, context, blacklist_id, values):
blacklist = self._find_blacklist(context, {'id': blacklist_id},
one=True)
blacklist.update(values)
try:
blacklist.save(self.session)
except exceptions.Duplicate:
raise exceptions.DuplicateBlacklist()
return objects.Blacklist.from_sqla(blacklist)
def delete_blacklist(self, context, blacklist_id):
blacklist = self._find_blacklist(context, {'id': blacklist_id},
one=True)
blacklist.delete(self.session)
return objects.Blacklist.from_sqla(blacklist)
# diagnostics
def ping(self, context):
start_time = time.time()
try:
result = self.engine.execute('SELECT 1').first()
except Exception:
status = False
else:
status = True if result[0] == 1 else False
return {
'status': status,
'rtt': "%f" % (time.time() - start_time)
}