1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
|
"""
Copyright 2015 Rackspace
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 logging
from tempest_lib.cli import base
from designateclient.functionaltests.config import cfg
from designateclient.functionaltests.models import FieldValueModel
from designateclient.functionaltests.models import ListModel
LOG = logging.getLogger(__name__)
def build_option_string(options):
"""Format a string of option flags (--key 'value').
This will quote the values, in case spaces are included.
Any values that are None are excluded entirely.
Usage:
build_option_string({
"--email": "me@example.com",
"--name": "example.com."
"--ttl": None,
})
Returns:
"--email 'me@example.com' --name 'example.com.'
"""
return " ".join("{0} '{1}'".format(flag, value)
for flag, value in options.items()
if value is not None)
def build_flags_string(flags):
"""Format a string of value-less flags.
Pass in a dictionary mapping flags to booleans. Those flags set to true
are included in the returned string.
Usage:
build_flags_string({
'--no-ttl': True,
'--no-name': False,
'--verbose': True,
})
Returns:
'--no-ttl --verbose'
"""
flags = {flag: is_set for flag, is_set in flags.items() if is_set}
return " ".join(flags.keys())
class ZoneCommands(object):
"""This is a mixin that provides zone commands to DesignateCLI"""
def zone_list(self, *args, **kwargs):
return self.parsed_cmd('zone list', ListModel, *args, **kwargs)
def zone_show(self, id, *args, **kwargs):
return self.parsed_cmd('zone show %s' % id, FieldValueModel, *args,
**kwargs)
def zone_delete(self, id, *args, **kwargs):
return self.parsed_cmd('zone delete %s' % id, *args, **kwargs)
def zone_create(self, name, email=None, ttl=None, description=None,
type=None, masters=None, *args, **kwargs):
options_str = build_option_string({
"--email": email,
"--ttl": ttl,
"--description": description,
"--masters": masters,
"--type": type,
})
cmd = 'zone create {0} {1}'.format(name, options_str)
return self.parsed_cmd(cmd, FieldValueModel, *args, **kwargs)
def zone_set(self, id, email=None, ttl=None, description=None,
type=None, masters=None, *args, **kwargs):
options_str = build_option_string({
"--email": email,
"--ttl": ttl,
"--description": description,
"--masters": masters,
"--type": type,
})
cmd = 'zone set {0} {1}'.format(id, options_str)
return self.parsed_cmd(cmd, FieldValueModel, *args, **kwargs)
class ZoneTransferCommands(object):
"""A mixin for DesignateCLI to add zone transfer commands"""
def zone_transfer_request_list(self, *args, **kwargs):
cmd = 'zone transfer request list'
return self.parsed_cmd(cmd, ListModel, *args, **kwargs)
def zone_transfer_request_create(self, zone_id, target_project_id=None,
description=None, *args, **kwargs):
options_str = build_option_string({
"--target-project-id": target_project_id,
"--description": description,
})
cmd = 'zone transfer request create {0} {1}'.format(
zone_id, options_str)
return self.parsed_cmd(cmd, FieldValueModel, *args, **kwargs)
def zone_transfer_request_show(self, id, *args, **kwargs):
cmd = 'zone transfer request show {0}'.format(id)
return self.parsed_cmd(cmd, FieldValueModel, *args, **kwargs)
def zone_transfer_request_set(self, id, description=None, *args, **kwargs):
options_str = build_option_string({"--description": description})
cmd = 'zone transfer request set {0} {1}'.format(options_str, id)
return self.parsed_cmd(cmd, FieldValueModel, *args, **kwargs)
def zone_transfer_request_delete(self, id, *args, **kwargs):
cmd = 'zone transfer request delete {0}'.format(id)
return self.parsed_cmd(cmd, *args, **kwargs)
def zone_transfer_accept_request(self, id, key, *args, **kwargs):
options_str = build_option_string({
"--transfer-id": id,
"--key": key,
})
cmd = 'zone transfer accept request {0}'.format(options_str)
return self.parsed_cmd(cmd, *args, **kwargs)
def zone_transfer_accept_show(self, id, *args, **kwargs):
cmd = 'zone transfer accept show {0}'.format(id)
return self.parsed_cmd(cmd, FieldValueModel, *args, **kwargs)
class RecordsetCommands(object):
def recordset_show(self, zone_id, id, *args, **kwargs):
cmd = 'recordset show {0} {1}'.format(zone_id, id)
return self.parsed_cmd(cmd, FieldValueModel, *args, **kwargs)
def recordset_list(self, zone_id, *args, **kwargs):
cmd = 'recordset list {0}'.format(zone_id)
return self.parsed_cmd(cmd, ListModel, *args, **kwargs)
def recordset_create(self, zone_id, name, records=None, type=None,
description=None, ttl=None, *args, **kwargs):
options_str = build_option_string({
'--records': records,
'--type': type,
'--description': description,
'--ttl': ttl,
})
cmd = 'recordset create {0} {1} {2}'.format(zone_id, name, options_str)
return self.parsed_cmd(cmd, FieldValueModel, *args, **kwargs)
def recordset_set(self, zone_id, id, records=None, type=None,
description=None, ttl=None, no_description=False,
no_ttl=False, *args, **kwargs):
options_str = build_option_string({
'--records': records,
'--type': type,
'--description': description,
'--ttl': ttl,
})
flags_str = build_flags_string({
'--no-description': no_description,
'--no-ttl': no_ttl,
})
cmd = 'recordset set {0} {1} {2} {3}'.format(
zone_id, id, flags_str, options_str)
return self.parsed_cmd(cmd, FieldValueModel, *args, **kwargs)
def recordset_delete(self, zone_id, id, *args, **kwargs):
cmd = 'recordset delete {0} {1}'.format(zone_id, id)
return self.parsed_cmd(cmd, *args, **kwargs)
class TLDCommands(object):
def tld_list(self, *args, **kwargs):
return self.parsed_cmd('tld list', ListModel, *args, **kwargs)
def tld_show(self, id, *args, **kwargs):
return self.parsed_cmd('tld show {0}'.format(id), FieldValueModel,
*args, **kwargs)
def tld_delete(self, id, *args, **kwargs):
return self.parsed_cmd('tld delete {0}'.format(id), *args, **kwargs)
def tld_create(self, name, description=None, *args, **kwargs):
options_str = build_option_string({
'--name': name,
'--description': description,
})
cmd = 'tld create {0}'.format(options_str)
return self.parsed_cmd(cmd, FieldValueModel, *args, **kwargs)
def tld_set(self, id, name=None, description=None, no_description=False,
*args, **kwargs):
options_str = build_option_string({
'--name': name,
'--description': description,
})
flags_str = build_flags_string({'--no-description': no_description})
cmd = 'tld set {0} {1} {2}'.format(id, options_str, flags_str)
return self.parsed_cmd(cmd, FieldValueModel, *args, **kwargs)
class BlacklistCommands(object):
def zone_blacklist_list(self, *args, **kwargs):
cmd = 'zone blacklist list'
return self.parsed_cmd(cmd, ListModel, *args, **kwargs)
def zone_blacklist_create(self, pattern, description=None, *args,
**kwargs):
options_str = build_option_string({
'--pattern': pattern,
'--description': description,
})
cmd = 'zone blacklist create {0}'.format(options_str)
return self.parsed_cmd(cmd, FieldValueModel, *args, **kwargs)
def zone_blacklist_set(self, id, pattern=None, description=None,
no_description=False, *args, **kwargs):
options_str = build_option_string({
'--pattern': pattern,
'--description': description,
})
flags_str = build_flags_string({'--no_description': no_description})
cmd = 'zone blacklist set {0} {1} {2}'.format(id, options_str,
flags_str)
return self.parsed_cmd(cmd, FieldValueModel, *args, **kwargs)
def zone_blacklist_show(self, id, *args, **kwargs):
cmd = 'zone blacklist show {0}'.format(id)
return self.parsed_cmd(cmd, FieldValueModel, *args, **kwargs)
def zone_blacklist_delete(self, id, *args, **kwargs):
cmd = 'zone blacklist delete {0}'.format(id)
return self.parsed_cmd(cmd, FieldValueModel, *args, **kwargs)
class DesignateCLI(base.CLIClient, ZoneCommands, ZoneTransferCommands,
RecordsetCommands, TLDCommands, BlacklistCommands):
# instantiate this once to minimize requests to keystone
_CLIENTS = None
def __init__(self, *args, **kwargs):
super(DesignateCLI, self).__init__(*args, **kwargs)
# grab the project id. this is used for zone transfer requests
resp = FieldValueModel(self.keystone('token-get'))
self.project_id = resp.tenant_id
@classmethod
def get_clients(cls):
if not cls._CLIENTS:
cls._init_clients()
return cls._CLIENTS
@classmethod
def _init_clients(cls):
cls._CLIENTS = {
'default': DesignateCLI(
cli_dir=cfg.CONF.designateclient.directory,
username=cfg.CONF.identity.username,
password=cfg.CONF.identity.password,
tenant_name=cfg.CONF.identity.tenant_name,
uri=cfg.CONF.identity.uri,
),
'alt': DesignateCLI(
cli_dir=cfg.CONF.designateclient.directory,
username=cfg.CONF.identity.alt_username,
password=cfg.CONF.identity.alt_password,
tenant_name=cfg.CONF.identity.alt_tenant_name,
uri=cfg.CONF.identity.uri,
),
'admin': DesignateCLI(
cli_dir=cfg.CONF.designateclient.directory,
username=cfg.CONF.identity.admin_username,
password=cfg.CONF.identity.admin_password,
tenant_name=cfg.CONF.identity.admin_tenant_name,
uri=cfg.CONF.identity.uri,
)
}
@classmethod
def as_user(self, user):
clients = self.get_clients()
if user in clients:
return clients[user]
raise Exception("User '{0}' does not exist".format(user))
def parsed_cmd(self, cmd, model=None, *args, **kwargs):
out = self.openstack(cmd, *args, **kwargs)
LOG.debug(out)
if model is not None:
return model(out)
return out
|