def describe_policy():
"""
Return a dictionary/json description of the set of gates available and triggers.
:param gate_filter: a list of gate names to filter by, if None, then all are returned
:return: dict/json description of the gates and triggers
"""
try:
doc = []
for name in Gate.registered_gate_names():
v = Gate.get_gate_by_name(name)
g = GateSpec()
g.name = name
g.description = v.__description__ if v.__description__ else ''
g.triggers = []
for t in v.__triggers__:
tr = TriggerSpec()
tr.name = t.__trigger_name__
tr.description = t.__description__ if t.__description__ else ''
tr.parameters = []
params = t._parameters()
if params:
for param in params.values():
tps = TriggerParamSpec()
tps.name = param.name
tps.description = param.description
tps.validator = param.validator.json()
tps.required = param.required
tr.parameters.append(tps)
g.triggers.append(tr)
doc.append(g.to_dict())
return doc, 200
except Exception as e:
log.exception('Error describing gate system')
abort(500, 'Internal error describing gate configuration')
def describe_policy():
"""
Return a dictionary/json description of the set of gates available and triggers.
:param gate_filter: a list of gate names to filter by, if None, then all are returned
:return: dict/json description of the gates and triggers
"""
try:
doc = []
for name in Gate.registered_gate_names():
v = Gate.get_gate_by_name(name)
g = GateSpec()
g.name = name
g.description = v.__description__ if v.__description__ else ""
g.triggers = []
if hasattr(v, "__superceded_by__"):
g.superceded_by = v.__superceded_by__
else:
g.superceded_by = None
if hasattr(v, "__lifecycle_state__"):
g.state = v.__lifecycle_state__.name
else:
g.state = "active"
for t in v.__triggers__:
tr = TriggerSpec()
tr.name = t.__trigger_name__
tr.description = t.__description__ if t.__description__ else ""
tr.parameters = []
if hasattr(t, "__superceded_by__"):
tr.superceded_by = t.__superceded_by__
else:
tr.superceded_by = None
if hasattr(t, "__lifecycle_state__"):
tr.state = t.__lifecycle_state__.name
else:
tr.state = "active"
params = t._parameters()
if params:
param_list = sorted(list(params.values()),
key=lambda x: x.sort_order)
for param in param_list:
tps = TriggerParamSpec()
tps.name = param.name
tps.description = param.description
tps.example = param.example
tps.validator = param.validator.json()
tps.required = param.required
if hasattr(param, "__superceded_by__"):
tps.superceded_by = param.__superceded_by__
else:
tps.superceded_by = None
if hasattr(param, "__lifecycle_state__"):
tps.state = param.__lifecycle_state__.name
else:
tps.state = "active"
tr.parameters.append(tps)
g.triggers.append(tr)
doc.append(g.to_json())
doc = sorted(doc, key=lambda x: x["state"])
return doc, 200
except Exception as e:
log.exception("Error describing gate system")
return make_response_error(e, in_httpcode=500), 500
def describe_policy():
"""
Return a dictionary/json description of the set of gates available and triggers.
:param gate_filter: a list of gate names to filter by, if None, then all are returned
:return: dict/json description of the gates and triggers
"""
try:
doc = []
for name in Gate.registered_gate_names():
v = Gate.get_gate_by_name(name)
g = GateSpec()
g.name = name
g.description = v.__description__ if v.__description__ else ''
g.triggers = []
if hasattr(v, '__superceded_by__'):
g.superceded_by = v.__superceded_by__
else:
g.superceded_by = None
if hasattr(v, '__lifecycle_state__'):
g.state = v.__lifecycle_state__.name
else:
g.state = 'active'
for t in v.__triggers__:
tr = TriggerSpec()
tr.name = t.__trigger_name__
tr.description = t.__description__ if t.__description__ else ''
tr.parameters = []
if hasattr(t, '__superceded_by__'):
tr.superceded_by = t.__superceded_by__
else:
tr.superceded_by = None
if hasattr(t, '__lifecycle_state__'):
tr.state = t.__lifecycle_state__.name
else:
tr.state = 'active'
params = t._parameters()
if params:
param_list = sorted(list(params.values()),
key=lambda x: x.sort_order)
for param in param_list:
tps = TriggerParamSpec()
tps.name = param.name
tps.description = param.description
tps.example = param.example
tps.validator = param.validator.json()
tps.required = param.required
if hasattr(param, '__superceded_by__'):
tps.superceded_by = param.__superceded_by__
else:
tps.superceded_by = None
if hasattr(param, '__lifecycle_state__'):
tps.state = param.__lifecycle_state__.name
else:
tps.state = 'active'
tr.parameters.append(tps)
g.triggers.append(tr)
doc.append(g.to_dict())
doc = sorted(doc, key=lambda x: x['state'])
return doc, 200
except Exception as e:
log.exception('Error describing gate system')
abort(500, 'Internal error describing gate configuration')