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 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
|
# 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 django.conf import settings
from django.utils.translation import gettext_lazy as _
from openstack_dashboard.api import base
from watcherclient import client as wc
from watcher_dashboard.utils import errors as errors_utils
LOG = logging.getLogger(__name__)
WATCHER_SERVICE = 'infra-optim'
def watcherclient(request, password=None):
api_version = "1"
insecure = getattr(settings, 'OPENSTACK_SSL_NO_VERIFY', False)
ca_file = getattr(settings, 'OPENSTACK_SSL_CACERT', None)
insert_watcher_policy_file()
endpoint = base.url_for(request, WATCHER_SERVICE)
LOG.debug('watcherclient connection created using token "%s" and url "%s"'
% (request.user.token.id, endpoint))
client = wc.get_client(
api_version,
watcher_url=endpoint,
insecure=insecure,
ca_file=ca_file,
username=request.user.username,
password=password,
os_auth_token=request.user.token.id
)
return client
def insert_watcher_policy_file():
policy_files = getattr(settings, 'POLICY_FILES', {})
policy_files['infra-optim'] = 'watcher_policy.json'
setattr(settings, 'POLICY_FILES', policy_files)
class Audit(base.APIDictWrapper):
_attrs = ('uuid', 'name', 'created_at', 'modified_at', 'deleted_at',
'state', 'audit_type', 'audit_template_uuid',
'audit_template_name', 'interval')
def __init__(self, apiresource, request=None):
super(Audit, self).__init__(apiresource)
self._request = request
@classmethod
def create(cls, request, audit_template_uuid, audit_type, name=None,
auto_trigger=False, interval=None):
"""Create an audit in Watcher
:param request: request object
:type request: django.http.HttpRequest
:param audit_template_uuid: related audit template UUID
:type audit_template_uuid: string
:param audit_type: audit type
:type audit_type: string
:param interval: Audit interval (default: None)
:type interval: int
:param name: Name for this audit
:type name: string
:return: the created Audit object
:rtype: :py:class:`~.Audit`
"""
if interval:
return watcherclient(request).audit.create(
audit_template_uuid=audit_template_uuid, audit_type=audit_type,
auto_trigger=auto_trigger, interval=interval, name=name)
else:
return watcherclient(request).audit.create(
audit_template_uuid=audit_template_uuid, audit_type=audit_type,
auto_trigger=auto_trigger, name=name)
@classmethod
def list(cls, request, **filters):
"""Return a list of audits in Watcher
:param request: request object
:type request: django.http.HttpRequest
:param filters: key/value kwargs used as filters
:type filters: dict
:return: list of audits, or an empty list if there are none
:rtype: list of :py:class:`~.Audit`
"""
return watcherclient(request).audit.list(detail=True, **filters)
@classmethod
@errors_utils.handle_errors(_("Unable to retrieve audit"))
def get(cls, request, audit_id):
"""Return the audit that matches the ID
:param request: request object
:type request: django.http.HttpRequest
:param audit_id: id of audit to be retrieved
:type audit_id: int
:return: matching audit, or None if no audit matches
the ID
:rtype: :py:class:`~.Audit`
"""
return watcherclient(request).audit.get(audit=audit_id)
@classmethod
def delete(cls, request, audit_id):
"""Delete an audit
:param request: request object
:type request: django.http.HttpRequest
:param audit_id: audit id
:type audit_id: int
"""
return watcherclient(request).audit.delete(audit=audit_id)
@classmethod
def cancel(cls, request, audit_id):
"""Cancel an audit
:param request: request object
:type request: django.http.HttpRequest
:param audit_id: audit id
:type audit_id: int
"""
cancel_patch = [{'op': 'replace', 'path': '/state',
'value': 'CANCELLED'}]
return watcherclient(request).audit.update(audit=audit_id,
patch=cancel_patch)
@property
def id(self):
return self.uuid
class AuditTemplate(base.APIDictWrapper):
_attrs = ('uuid', 'description', 'scope', 'name', 'goal_uuid', 'goal_name',
'strategy_uuid', 'strategy_name', 'created_at', 'updated_at',
'deleted_at')
def __init__(self, apiresource, request=None):
super(AuditTemplate, self).__init__(apiresource)
self._request = request
@classmethod
def create(cls, request, name, goal, strategy,
description, scope):
"""Create an audit template in Watcher
:param request: request object
:type request: django.http.HttpRequest
:param name: Name for this audit template
:type name: string
:param goal: Goal UUID or name associated to this audit template
:type goal: string
:param strategy: Strategy UUID or name associated to this audit
template
:type strategy: string
:param description: Descrition of the audit template
:type description: string
:param scope: Audit scope
:type scope: list of list of dict
:param audit_template: audit template
:type audit_template: string
:return: the created Audit Template object
:rtype: :py:class:`~.AuditTemplate`
"""
audit_template = watcherclient(request).audit_template.create(
name=name,
goal=goal,
strategy=strategy,
description=description,
scope=scope,
)
return audit_template
@classmethod
def patch(cls, request, audit_template_id, parameters):
"""Update an audit in Watcher
:param request: request object
:type request: django.http.HttpRequest
:param audit_template_id: id of the audit template we want to update
:type audit_template_id: string
:param parameters: new values for the audit template's parameters
:type parameters: dict
:return: the updated Audit Template object
:rtype: :py:class:`~.AuditTemplate`
"""
parameter_list = [{
'name': str(name),
'value': str(value),
} for (name, value) in parameters.items()]
audit_template = watcherclient(request).audit_template.patch(
audit_template_id, parameter_list)
return audit_template
@classmethod
def list(cls, request, **filters):
"""Return a list of audit templates in Watcher
:param request: request object
:type request: django.http.HttpRequest
:param filters: key/value kwargs used as filters
:type filters: dict
:return: list of audit templates, or an empty list if there are none
:rtype: list of :py:class:`~.AuditTemplate`
"""
return watcherclient(request).audit_template.list(
detail=True, **filters)
@classmethod
@errors_utils.handle_errors(_("Unable to retrieve audit template"))
def get(cls, request, audit_template_id):
"""Return the audit template that matches the ID
:param request: request object
:type request: django.http.HttpRequest
:param audit_template_id: id of audit template to be retrieved
:type audit_template_id: int
:return: matching audit template, or None if no audit template matches
the ID
:rtype: :py:class:`~.AuditTemplate`
"""
return watcherclient(request).audit_template.get(
audit_template_id=audit_template_id)
@classmethod
def delete(cls, request, audit_template_id):
"""Delete an audit_template
:param request: request object
:type request: django.http.HttpRequest
:param audit_template_id: audit id
:type audit_template_id: int
"""
watcherclient(request).audit_template.delete(
audit_template_id=audit_template_id)
@property
def id(self):
return self.uuid
class ActionPlan(base.APIDictWrapper):
_attrs = ('uuid', 'created_at', 'updated_at', 'deleted_at',
'audit_uuid', 'state')
def __init__(self, apiresource, request=None):
super(ActionPlan, self).__init__(apiresource)
self._request = request
@classmethod
def list(cls, request, **filters):
"""Return a list of action plans in Watcher
:param request: request object
:type request: django.http.HttpRequest
:param filters: key/value kwargs used as filters
:type filters: dict
:return: list of action plans, or an empty list if there are none
:rtype: list of :py:class:`~.ActionPlan`
"""
return watcherclient(request).action_plan.list(detail=True, **filters)
@classmethod
@errors_utils.handle_errors(_("Unable to retrieve action plan"))
def get(cls, request, action_plan_id):
"""Return the action plan that matches the ID
:param request: request object
:type request: django.http.HttpRequest
:param action_plan_id: id of action plan to be retrieved
:type action_plan_id: int
:return: matching action plan, or None if no action plan matches
the ID
:rtype: :py:class:`~.ActionPlan`
"""
return watcherclient(request).action_plan.get(
action_plan_id=action_plan_id)
@classmethod
def delete(cls, request, action_plan_id):
"""Delete an action plan
:param request: request object
:type request: django.http.HttpRequest
:param action_plan_id: audit id
:type action_plan_id: int
"""
watcherclient(request).action_plan.delete(
action_plan_id=action_plan_id)
@classmethod
def start(cls, request, action_plan_id):
"""Start an Action Plan
:param request: request object
:type request: django.http.HttpRequest
:param action_plan_id: audit id
:type action_plan_id: int
"""
watcherclient(request).action_plan.start(action_plan_id)
@property
def id(self):
return self.uuid
class Action(base.APIDictWrapper):
_attrs = ('uuid', 'created_at', 'updated_at', 'deleted_at', 'next_uuid',
'description', 'state', 'action_plan_uuid',
'action_type', 'applies_to', 'src', 'dst', 'parameter')
def __init__(self, apiresource, request=None):
super(Action, self).__init__(apiresource)
self._request = request
@classmethod
def list(cls, request, **filters):
"""Return a list of actions in Watcher
:param request: request object
:type request: django.http.HttpRequest
:param filters: key/value kwargs used as filters
:type filters: dict
:return: list of actions, or an empty list if there are none
:rtype: list of :py:class:`~.Action`
"""
return watcherclient(request).action.list(detail=True, **filters)
@classmethod
@errors_utils.handle_errors(_("Unable to retrieve action"))
def get(cls, request, action_id):
"""Return the action that matches the ID
:param request: request object
:type request: django.http.HttpRequest
:param action_id: id of action to be retrieved
:type action_id: int
:return: matching action, or None if no action matches
the ID
:rtype: :py:class:`~.Action`
"""
return watcherclient(request).action.get(action_id=action_id)
@classmethod
def delete(cls, request, action_id):
"""Delete an action
:param request: request object
:type request: django.http.HttpRequest
:param action_id: action_plan id
:type action_id: int
"""
watcherclient(request).action.delete(
action_id=action_id)
@classmethod
def start(cls, request, action_id):
"""Start an Action Plan
:param request: request object
:type request: django.http.HttpRequest
:param action_id: action_plan id
:type action_id: int
"""
patch = []
patch.append({'op': 'replace', 'path': '/state', 'value': 'PENDING'})
watcherclient(request).action.update(action_id, patch)
@property
def id(self):
return self.uuid
class Goal(base.APIDictWrapper):
"""Goal resource."""
_attrs = ('uuid', 'name', 'display_name', 'created_at',
'updated_at', 'deleted_at', 'efficacy_specifications')
def __init__(self, apiresource, request=None):
super(Goal, self).__init__(apiresource)
self._request = request
@classmethod
def list(cls, request, **filters):
"""Return a list of goals in Watcher
:param request: request object
:type request: django.http.HttpRequest
:param filters: key/value kwargs used as filters
:type filters: dict
:return: list of goals, or an empty list if there are none
:rtype: list of :py:class:`~.Goal` instance
"""
return watcherclient(request).goal.list(detail=True, **filters)
@classmethod
@errors_utils.handle_errors(_("Unable to retrieve goal"))
def get(cls, request, goal):
"""Return the goal that matches the ID
:param request: request object
:type request: django.http.HttpRequest
:param goal: uuid of goal to be retrieved
:type goal: int
:return: matching goal, or None if no goal matches the UUID
:rtype: :py:class:`~.Goal` instance
"""
return watcherclient(request).goal.get(goal)
@property
def id(self):
return self.uuid
class Strategy(base.APIDictWrapper):
"""Strategy resource."""
_attrs = ('uuid', 'name', 'display_name', 'goal_uuid', 'goal_name',
'created_at', 'updated_at', 'deleted_at')
def __init__(self, apiresource, request=None):
super(Strategy, self).__init__(apiresource)
self._request = request
@classmethod
def list(cls, request, **filters):
"""Return a list of strategies in Watcher
:param request: request object
:type request: django.http.HttpRequest
:param filters: key/value kwargs used as filters
:type filters: dict
:return: list of strategies, or an empty list if there are none
:rtype: list of :py:class:`~.Strategy` instances
"""
return watcherclient(request).strategy.list(detail=True, **filters)
@classmethod
@errors_utils.handle_errors(_("Unable to retrieve strategy"))
def get(cls, request, strategy):
"""Return the strategy that matches the UUID
:param request: request object
:type request: django.http.HttpRequest
:param strategy: uuid of strategy to be retrieved
:type strategy: str
:return: matching strategy, or None if no strategy matches the UUID
:rtype: :py:class:`~.Strategy` instance
"""
return watcherclient(request).strategy.get(strategy)
@property
def id(self):
return self.uuid
class EfficacyIndicatorSpec(base.APIDictWrapper):
attrs = ('name', 'description', 'unit', 'schema')
class EfficacyIndicator(base.APIDictWrapper):
def __init__(self, indicator):
super(EfficacyIndicator, self).__init__(indicator)
self.value = indicator.get('value', None)
self.name = indicator.get('name', None)
self.description = indicator.get('description', None)
self.unit = indicator.get('unit', None)
|