c6845c0136
New audit state SUSPENDED is added in this patch set. If audit state with continuous mode is changed from ONGOING to SUSPENDED, audit's job is removed and the audit is not executed. If audit state changed from SUSPENDED to ONGOING in reverse, audit is executed again periodically. Change-Id: I32257f56a40c0352a7c24f3fb80ad95ec28dc614 Implements: blueprint suspended-audit-state
611 lines
22 KiB
Python
611 lines
22 KiB
Python
# -*- encoding: utf-8 -*-
|
|
# Copyright 2013 Red Hat, Inc.
|
|
# All Rights Reserved.
|
|
#
|
|
# 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.
|
|
|
|
"""
|
|
In the Watcher system, an :ref:`Audit <audit_definition>` is a request for
|
|
optimizing a :ref:`Cluster <cluster_definition>`.
|
|
|
|
The optimization is done in order to satisfy one :ref:`Goal <goal_definition>`
|
|
on a given :ref:`Cluster <cluster_definition>`.
|
|
|
|
For each :ref:`Audit <audit_definition>`, the Watcher system generates an
|
|
:ref:`Action Plan <action_plan_definition>`.
|
|
|
|
To see the life-cycle and description of an :ref:`Audit <audit_definition>`
|
|
states, visit :ref:`the Audit State machine <audit_state_machine>`.
|
|
"""
|
|
|
|
import datetime
|
|
|
|
import pecan
|
|
from pecan import rest
|
|
import wsme
|
|
from wsme import types as wtypes
|
|
import wsmeext.pecan as wsme_pecan
|
|
|
|
from watcher._i18n import _
|
|
from watcher.api.controllers import base
|
|
from watcher.api.controllers import link
|
|
from watcher.api.controllers.v1 import collection
|
|
from watcher.api.controllers.v1 import types
|
|
from watcher.api.controllers.v1 import utils as api_utils
|
|
from watcher.common import exception
|
|
from watcher.common import policy
|
|
from watcher.common import utils
|
|
from watcher.decision_engine import rpcapi
|
|
from watcher import objects
|
|
|
|
|
|
class AuditPostType(wtypes.Base):
|
|
|
|
audit_template_uuid = wtypes.wsattr(types.uuid, mandatory=False)
|
|
|
|
goal = wtypes.wsattr(wtypes.text, mandatory=False)
|
|
|
|
strategy = wtypes.wsattr(wtypes.text, mandatory=False)
|
|
|
|
audit_type = wtypes.wsattr(wtypes.text, mandatory=True)
|
|
|
|
state = wsme.wsattr(wtypes.text, readonly=True,
|
|
default=objects.audit.State.PENDING)
|
|
|
|
parameters = wtypes.wsattr({wtypes.text: types.jsontype}, mandatory=False,
|
|
default={})
|
|
interval = wsme.wsattr(int, mandatory=False)
|
|
|
|
scope = wtypes.wsattr(types.jsontype, readonly=True)
|
|
|
|
auto_trigger = wtypes.wsattr(bool, mandatory=False)
|
|
|
|
def as_audit(self, context):
|
|
audit_type_values = [val.value for val in objects.audit.AuditType]
|
|
if self.audit_type not in audit_type_values:
|
|
raise exception.AuditTypeNotFound(audit_type=self.audit_type)
|
|
|
|
if (self.audit_type == objects.audit.AuditType.ONESHOT.value and
|
|
self.interval not in (wtypes.Unset, None)):
|
|
raise exception.AuditIntervalNotAllowed(audit_type=self.audit_type)
|
|
|
|
if (self.audit_type == objects.audit.AuditType.CONTINUOUS.value and
|
|
self.interval in (wtypes.Unset, None)):
|
|
raise exception.AuditIntervalNotSpecified(
|
|
audit_type=self.audit_type)
|
|
|
|
# If audit_template_uuid was provided, we will provide any
|
|
# variables not included in the request, but not override
|
|
# those variables that were included.
|
|
if self.audit_template_uuid:
|
|
try:
|
|
audit_template = objects.AuditTemplate.get(
|
|
context, self.audit_template_uuid)
|
|
except exception.AuditTemplateNotFound:
|
|
raise exception.Invalid(
|
|
message=_('The audit template UUID or name specified is '
|
|
'invalid'))
|
|
at2a = {
|
|
'goal': 'goal_id',
|
|
'strategy': 'strategy_id',
|
|
'scope': 'scope',
|
|
}
|
|
to_string_fields = set(['goal', 'strategy'])
|
|
for k in at2a:
|
|
if not getattr(self, k):
|
|
try:
|
|
at_attr = getattr(audit_template, at2a[k])
|
|
if at_attr and (k in to_string_fields):
|
|
at_attr = str(at_attr)
|
|
setattr(self, k, at_attr)
|
|
except AttributeError:
|
|
pass
|
|
return Audit(
|
|
audit_type=self.audit_type,
|
|
parameters=self.parameters,
|
|
goal_id=self.goal,
|
|
strategy_id=self.strategy,
|
|
interval=self.interval,
|
|
scope=self.scope,
|
|
auto_trigger=self.auto_trigger)
|
|
|
|
|
|
class AuditPatchType(types.JsonPatchType):
|
|
|
|
@staticmethod
|
|
def mandatory_attrs():
|
|
return ['/audit_template_uuid', '/type']
|
|
|
|
@staticmethod
|
|
def validate(patch):
|
|
|
|
def is_new_state_none(p):
|
|
return p.path == '/state' and p.op == 'replace' and p.value is None
|
|
|
|
serialized_patch = {'path': patch.path,
|
|
'op': patch.op,
|
|
'value': patch.value}
|
|
if (patch.path in AuditPatchType.mandatory_attrs() or
|
|
is_new_state_none(patch)):
|
|
msg = _("%(field)s can't be updated.")
|
|
raise exception.PatchError(
|
|
patch=serialized_patch,
|
|
reason=msg % dict(field=patch.path))
|
|
return types.JsonPatchType.validate(patch)
|
|
|
|
|
|
class Audit(base.APIBase):
|
|
"""API representation of a audit.
|
|
|
|
This class enforces type checking and value constraints, and converts
|
|
between the internal object model and the API representation of a audit.
|
|
"""
|
|
_goal_uuid = None
|
|
_goal_name = None
|
|
_strategy_uuid = None
|
|
_strategy_name = None
|
|
|
|
def _get_goal(self, value):
|
|
if value == wtypes.Unset:
|
|
return None
|
|
goal = None
|
|
try:
|
|
if utils.is_uuid_like(value) or utils.is_int_like(value):
|
|
goal = objects.Goal.get(
|
|
pecan.request.context, value)
|
|
else:
|
|
goal = objects.Goal.get_by_name(
|
|
pecan.request.context, value)
|
|
except exception.GoalNotFound:
|
|
pass
|
|
if goal:
|
|
self.goal_id = goal.id
|
|
return goal
|
|
|
|
def _get_goal_uuid(self):
|
|
return self._goal_uuid
|
|
|
|
def _set_goal_uuid(self, value):
|
|
if value and self._goal_uuid != value:
|
|
self._goal_uuid = None
|
|
goal = self._get_goal(value)
|
|
if goal:
|
|
self._goal_uuid = goal.uuid
|
|
|
|
def _get_goal_name(self):
|
|
return self._goal_name
|
|
|
|
def _set_goal_name(self, value):
|
|
if value and self._goal_name != value:
|
|
self._goal_name = None
|
|
goal = self._get_goal(value)
|
|
if goal:
|
|
self._goal_name = goal.name
|
|
|
|
def _get_strategy(self, value):
|
|
if value == wtypes.Unset:
|
|
return None
|
|
strategy = None
|
|
try:
|
|
if utils.is_uuid_like(value) or utils.is_int_like(value):
|
|
strategy = objects.Strategy.get(
|
|
pecan.request.context, value)
|
|
else:
|
|
strategy = objects.Strategy.get_by_name(
|
|
pecan.request.context, value)
|
|
except exception.StrategyNotFound:
|
|
pass
|
|
if strategy:
|
|
self.strategy_id = strategy.id
|
|
return strategy
|
|
|
|
def _get_strategy_uuid(self):
|
|
return self._strategy_uuid
|
|
|
|
def _set_strategy_uuid(self, value):
|
|
if value and self._strategy_uuid != value:
|
|
self._strategy_uuid = None
|
|
strategy = self._get_strategy(value)
|
|
if strategy:
|
|
self._strategy_uuid = strategy.uuid
|
|
|
|
def _get_strategy_name(self):
|
|
return self._strategy_name
|
|
|
|
def _set_strategy_name(self, value):
|
|
if value and self._strategy_name != value:
|
|
self._strategy_name = None
|
|
strategy = self._get_strategy(value)
|
|
if strategy:
|
|
self._strategy_name = strategy.name
|
|
|
|
uuid = types.uuid
|
|
"""Unique UUID for this audit"""
|
|
|
|
audit_type = wtypes.text
|
|
"""Type of this audit"""
|
|
|
|
state = wtypes.text
|
|
"""This audit state"""
|
|
|
|
goal_uuid = wsme.wsproperty(
|
|
wtypes.text, _get_goal_uuid, _set_goal_uuid, mandatory=True)
|
|
"""Goal UUID the audit template refers to"""
|
|
|
|
goal_name = wsme.wsproperty(
|
|
wtypes.text, _get_goal_name, _set_goal_name, mandatory=False)
|
|
"""The name of the goal this audit template refers to"""
|
|
|
|
strategy_uuid = wsme.wsproperty(
|
|
wtypes.text, _get_strategy_uuid, _set_strategy_uuid, mandatory=False)
|
|
"""Strategy UUID the audit template refers to"""
|
|
|
|
strategy_name = wsme.wsproperty(
|
|
wtypes.text, _get_strategy_name, _set_strategy_name, mandatory=False)
|
|
"""The name of the strategy this audit template refers to"""
|
|
|
|
parameters = {wtypes.text: types.jsontype}
|
|
"""The strategy parameters for this audit"""
|
|
|
|
links = wsme.wsattr([link.Link], readonly=True)
|
|
"""A list containing a self link and associated audit links"""
|
|
|
|
interval = wsme.wsattr(int, mandatory=False)
|
|
"""Launch audit periodically (in seconds)"""
|
|
|
|
scope = wsme.wsattr(types.jsontype, mandatory=False)
|
|
"""Audit Scope"""
|
|
|
|
auto_trigger = wsme.wsattr(bool, mandatory=False, default=False)
|
|
"""Autoexecute action plan once audit is succeeded"""
|
|
|
|
def __init__(self, **kwargs):
|
|
self.fields = []
|
|
fields = list(objects.Audit.fields)
|
|
for k in fields:
|
|
# Skip fields we do not expose.
|
|
if not hasattr(self, k):
|
|
continue
|
|
self.fields.append(k)
|
|
setattr(self, k, kwargs.get(k, wtypes.Unset))
|
|
|
|
self.fields.append('goal_id')
|
|
self.fields.append('strategy_id')
|
|
fields.append('goal_uuid')
|
|
setattr(self, 'goal_uuid', kwargs.get('goal_id',
|
|
wtypes.Unset))
|
|
fields.append('goal_name')
|
|
setattr(self, 'goal_name', kwargs.get('goal_id',
|
|
wtypes.Unset))
|
|
fields.append('strategy_uuid')
|
|
setattr(self, 'strategy_uuid', kwargs.get('strategy_id',
|
|
wtypes.Unset))
|
|
fields.append('strategy_name')
|
|
setattr(self, 'strategy_name', kwargs.get('strategy_id',
|
|
wtypes.Unset))
|
|
|
|
@staticmethod
|
|
def _convert_with_links(audit, url, expand=True):
|
|
if not expand:
|
|
audit.unset_fields_except(['uuid', 'audit_type', 'state',
|
|
'goal_uuid', 'interval', 'scope',
|
|
'strategy_uuid', 'goal_name',
|
|
'strategy_name', 'auto_trigger'])
|
|
|
|
audit.links = [link.Link.make_link('self', url,
|
|
'audits', audit.uuid),
|
|
link.Link.make_link('bookmark', url,
|
|
'audits', audit.uuid,
|
|
bookmark=True)
|
|
]
|
|
|
|
return audit
|
|
|
|
@classmethod
|
|
def convert_with_links(cls, rpc_audit, expand=True):
|
|
audit = Audit(**rpc_audit.as_dict())
|
|
return cls._convert_with_links(audit, pecan.request.host_url, expand)
|
|
|
|
@classmethod
|
|
def sample(cls, expand=True):
|
|
sample = cls(uuid='27e3153e-d5bf-4b7e-b517-fb518e17f34c',
|
|
audit_type='ONESHOT',
|
|
state='PENDING',
|
|
created_at=datetime.datetime.utcnow(),
|
|
deleted_at=None,
|
|
updated_at=datetime.datetime.utcnow(),
|
|
interval=7200,
|
|
scope=[],
|
|
auto_trigger=False)
|
|
|
|
sample.goal_id = '7ae81bb3-dec3-4289-8d6c-da80bd8001ae'
|
|
sample.strategy_id = '7ae81bb3-dec3-4289-8d6c-da80bd8001ff'
|
|
|
|
return cls._convert_with_links(sample, 'http://localhost:9322', expand)
|
|
|
|
|
|
class AuditCollection(collection.Collection):
|
|
"""API representation of a collection of audits."""
|
|
|
|
audits = [Audit]
|
|
"""A list containing audits objects"""
|
|
|
|
def __init__(self, **kwargs):
|
|
super(AuditCollection, self).__init__()
|
|
self._type = 'audits'
|
|
|
|
@staticmethod
|
|
def convert_with_links(rpc_audits, limit, url=None, expand=False,
|
|
**kwargs):
|
|
collection = AuditCollection()
|
|
collection.audits = [Audit.convert_with_links(p, expand)
|
|
for p in rpc_audits]
|
|
|
|
if 'sort_key' in kwargs:
|
|
reverse = False
|
|
if kwargs['sort_key'] == 'goal_uuid':
|
|
if 'sort_dir' in kwargs:
|
|
reverse = True if kwargs['sort_dir'] == 'desc' else False
|
|
collection.audits = sorted(
|
|
collection.audits,
|
|
key=lambda audit: audit.goal_uuid,
|
|
reverse=reverse)
|
|
|
|
collection.next = collection.get_next(limit, url=url, **kwargs)
|
|
return collection
|
|
|
|
@classmethod
|
|
def sample(cls):
|
|
sample = cls()
|
|
sample.audits = [Audit.sample(expand=False)]
|
|
return sample
|
|
|
|
|
|
class AuditsController(rest.RestController):
|
|
"""REST controller for Audits."""
|
|
def __init__(self):
|
|
super(AuditsController, self).__init__()
|
|
|
|
from_audits = False
|
|
"""A flag to indicate if the requests to this controller are coming
|
|
from the top-level resource Audits."""
|
|
|
|
_custom_actions = {
|
|
'detail': ['GET'],
|
|
}
|
|
|
|
def _get_audits_collection(self, marker, limit,
|
|
sort_key, sort_dir, expand=False,
|
|
resource_url=None, goal=None,
|
|
strategy=None):
|
|
limit = api_utils.validate_limit(limit)
|
|
api_utils.validate_sort_dir(sort_dir)
|
|
marker_obj = None
|
|
if marker:
|
|
marker_obj = objects.Audit.get_by_uuid(pecan.request.context,
|
|
marker)
|
|
|
|
filters = {}
|
|
if goal:
|
|
if utils.is_uuid_like(goal):
|
|
filters['goal_uuid'] = goal
|
|
else:
|
|
# TODO(michaelgugino): add method to get goal by name.
|
|
filters['goal_name'] = goal
|
|
|
|
if strategy:
|
|
if utils.is_uuid_like(strategy):
|
|
filters['strategy_uuid'] = strategy
|
|
else:
|
|
# TODO(michaelgugino): add method to get goal by name.
|
|
filters['strategy_name'] = strategy
|
|
|
|
if sort_key == 'goal_uuid':
|
|
sort_db_key = 'goal_id'
|
|
elif sort_key == 'strategy_uuid':
|
|
sort_db_key = 'strategy_id'
|
|
else:
|
|
sort_db_key = sort_key
|
|
|
|
audits = objects.Audit.list(pecan.request.context,
|
|
limit,
|
|
marker_obj, sort_key=sort_db_key,
|
|
sort_dir=sort_dir, filters=filters)
|
|
|
|
return AuditCollection.convert_with_links(audits, limit,
|
|
url=resource_url,
|
|
expand=expand,
|
|
sort_key=sort_key,
|
|
sort_dir=sort_dir)
|
|
|
|
@wsme_pecan.wsexpose(AuditCollection, types.uuid, int, wtypes.text,
|
|
wtypes.text, wtypes.text, wtypes.text, int)
|
|
def get_all(self, marker=None, limit=None, sort_key='id', sort_dir='asc',
|
|
goal=None, strategy=None):
|
|
"""Retrieve a list of audits.
|
|
|
|
:param marker: pagination marker for large data sets.
|
|
:param limit: maximum number of resources to return in a single result.
|
|
:param sort_key: column to sort results by. Default: id.
|
|
:param sort_dir: direction to sort. "asc" or "desc". Default: asc.
|
|
:param goal: goal UUID or name to filter by
|
|
:param strategy: strategy UUID or name to filter by
|
|
"""
|
|
|
|
context = pecan.request.context
|
|
policy.enforce(context, 'audit:get_all',
|
|
action='audit:get_all')
|
|
|
|
return self._get_audits_collection(marker, limit, sort_key,
|
|
sort_dir, goal=goal,
|
|
strategy=strategy)
|
|
|
|
@wsme_pecan.wsexpose(AuditCollection, wtypes.text, types.uuid, int,
|
|
wtypes.text, wtypes.text)
|
|
def detail(self, goal=None, marker=None, limit=None,
|
|
sort_key='id', sort_dir='asc'):
|
|
"""Retrieve a list of audits with detail.
|
|
|
|
:param goal: goal UUID or name to filter by
|
|
:param marker: pagination marker for large data sets.
|
|
:param limit: maximum number of resources to return in a single result.
|
|
:param sort_key: column to sort results by. Default: id.
|
|
:param sort_dir: direction to sort. "asc" or "desc". Default: asc.
|
|
"""
|
|
context = pecan.request.context
|
|
policy.enforce(context, 'audit:detail',
|
|
action='audit:detail')
|
|
# NOTE(lucasagomes): /detail should only work agaist collections
|
|
parent = pecan.request.path.split('/')[:-1][-1]
|
|
if parent != "audits":
|
|
raise exception.HTTPNotFound
|
|
|
|
expand = True
|
|
resource_url = '/'.join(['audits', 'detail'])
|
|
return self._get_audits_collection(marker, limit,
|
|
sort_key, sort_dir, expand,
|
|
resource_url,
|
|
goal=goal)
|
|
|
|
@wsme_pecan.wsexpose(Audit, types.uuid)
|
|
def get_one(self, audit_uuid):
|
|
"""Retrieve information about the given audit.
|
|
|
|
:param audit_uuid: UUID of a audit.
|
|
"""
|
|
if self.from_audits:
|
|
raise exception.OperationNotPermitted
|
|
|
|
context = pecan.request.context
|
|
rpc_audit = api_utils.get_resource('Audit', audit_uuid)
|
|
policy.enforce(context, 'audit:get', rpc_audit, action='audit:get')
|
|
|
|
return Audit.convert_with_links(rpc_audit)
|
|
|
|
@wsme_pecan.wsexpose(Audit, body=AuditPostType, status_code=201)
|
|
def post(self, audit_p):
|
|
"""Create a new audit.
|
|
|
|
:param audit_p: a audit within the request body.
|
|
"""
|
|
context = pecan.request.context
|
|
policy.enforce(context, 'audit:create',
|
|
action='audit:create')
|
|
audit = audit_p.as_audit(context)
|
|
|
|
if self.from_audits:
|
|
raise exception.OperationNotPermitted
|
|
|
|
if not audit._goal_uuid:
|
|
raise exception.Invalid(
|
|
message=_('A valid goal_id or audit_template_id '
|
|
'must be provided'))
|
|
|
|
strategy_uuid = audit.strategy_uuid
|
|
no_schema = True
|
|
if strategy_uuid is not None:
|
|
# validate parameter when predefined strategy in audit template
|
|
strategy = objects.Strategy.get(pecan.request.context,
|
|
strategy_uuid)
|
|
schema = strategy.parameters_spec
|
|
if schema:
|
|
# validate input parameter with default value feedback
|
|
no_schema = False
|
|
utils.StrictDefaultValidatingDraft4Validator(schema).validate(
|
|
audit.parameters)
|
|
|
|
if no_schema and audit.parameters:
|
|
raise exception.Invalid(_('Specify parameters but no predefined '
|
|
'strategy for audit template, or no '
|
|
'parameter spec in predefined strategy'))
|
|
|
|
audit_dict = audit.as_dict()
|
|
|
|
new_audit = objects.Audit(context, **audit_dict)
|
|
new_audit.create()
|
|
|
|
# Set the HTTP Location Header
|
|
pecan.response.location = link.build_url('audits', new_audit.uuid)
|
|
|
|
# trigger decision-engine to run the audit
|
|
if new_audit.audit_type == objects.audit.AuditType.ONESHOT.value:
|
|
dc_client = rpcapi.DecisionEngineAPI()
|
|
dc_client.trigger_audit(context, new_audit.uuid)
|
|
|
|
return Audit.convert_with_links(new_audit)
|
|
|
|
@wsme.validate(types.uuid, [AuditPatchType])
|
|
@wsme_pecan.wsexpose(Audit, types.uuid, body=[AuditPatchType])
|
|
def patch(self, audit_uuid, patch):
|
|
"""Update an existing audit.
|
|
|
|
:param audit_uuid: UUID of a audit.
|
|
:param patch: a json PATCH document to apply to this audit.
|
|
"""
|
|
if self.from_audits:
|
|
raise exception.OperationNotPermitted
|
|
|
|
context = pecan.request.context
|
|
audit_to_update = api_utils.get_resource(
|
|
'Audit', audit_uuid, eager=True)
|
|
policy.enforce(context, 'audit:update', audit_to_update,
|
|
action='audit:update')
|
|
|
|
try:
|
|
audit_dict = audit_to_update.as_dict()
|
|
|
|
initial_state = audit_dict['state']
|
|
new_state = api_utils.get_patch_value(patch, 'state')
|
|
if not api_utils.check_audit_state_transition(
|
|
patch, initial_state):
|
|
error_message = _("State transition not allowed: "
|
|
"(%(initial_state)s -> %(new_state)s)")
|
|
raise exception.PatchError(
|
|
patch=patch,
|
|
reason=error_message % dict(
|
|
initial_state=initial_state, new_state=new_state))
|
|
|
|
audit = Audit(**api_utils.apply_jsonpatch(audit_dict, patch))
|
|
except api_utils.JSONPATCH_EXCEPTIONS as e:
|
|
raise exception.PatchError(patch=patch, reason=e)
|
|
|
|
# Update only the fields that have changed
|
|
for field in objects.Audit.fields:
|
|
try:
|
|
patch_val = getattr(audit, field)
|
|
except AttributeError:
|
|
# Ignore fields that aren't exposed in the API
|
|
continue
|
|
if patch_val == wtypes.Unset:
|
|
patch_val = None
|
|
if audit_to_update[field] != patch_val:
|
|
audit_to_update[field] = patch_val
|
|
|
|
audit_to_update.save()
|
|
return Audit.convert_with_links(audit_to_update)
|
|
|
|
@wsme_pecan.wsexpose(None, types.uuid, status_code=204)
|
|
def delete(self, audit_uuid):
|
|
"""Delete a audit.
|
|
|
|
:param audit_uuid: UUID of a audit.
|
|
"""
|
|
context = pecan.request.context
|
|
audit_to_delete = api_utils.get_resource(
|
|
'Audit', audit_uuid, eager=True)
|
|
policy.enforce(context, 'audit:update', audit_to_delete,
|
|
action='audit:update')
|
|
|
|
audit_to_delete.soft_delete()
|