119 lines
4.6 KiB
Python
119 lines
4.6 KiB
Python
# 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 json
|
|
import keystoneauth1
|
|
import logging
|
|
|
|
from tripleoclient import exceptions
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
def start_workflow(workflow_client, identifier, workflow_input):
|
|
|
|
execution = workflow_client.executions.create(
|
|
identifier,
|
|
workflow_input=workflow_input
|
|
)
|
|
|
|
LOG.debug("Started Mistral Workflow {}. Execution ID: {}".format(
|
|
identifier, execution.id))
|
|
|
|
return execution
|
|
|
|
|
|
def wait_for_messages(mistral, websocket, execution, timeout=None):
|
|
"""Wait for messages on a websocket.
|
|
|
|
Given an instance of mistral client, a websocket and a Mistral execution
|
|
wait for messages on that websocket queue that match the execution ID until
|
|
the timeout is reached.
|
|
|
|
If no timeout is provided, this method will block forever.
|
|
|
|
If a timeout is reached, called check_execution_status which will look up
|
|
the execution on Mistral and log information about it.
|
|
"""
|
|
try:
|
|
for payload in websocket.wait_for_messages(timeout=timeout):
|
|
# Ignore messages whose root_execution_id does not match the
|
|
# id of the execution for which we are waiting
|
|
|
|
# New versions of tripleo-common don't sent the execution anymore
|
|
# but keeping the old way ot getting it is important to keep
|
|
# backwards compatibility.
|
|
|
|
# TODO(apetrich) payload.execution is deprecated and will be
|
|
# removed from stein. We should keep this until payload.execution
|
|
# is removed from the LTS
|
|
payload_exec_id = payload.get('execution_id') or \
|
|
payload.get('execution', {}).get('id')
|
|
|
|
payload_root_exec_id = payload.get('root_execution_id', '') or \
|
|
payload.get('execution', {}).get('root_execution_id', '')
|
|
|
|
if payload_exec_id != execution.id and \
|
|
payload_root_exec_id != execution.id:
|
|
|
|
LOG.debug("Ignoring message from execution %s"
|
|
% payload_exec_id)
|
|
else:
|
|
yield payload
|
|
# If the message is from a sub-workflow, we just need to pass it
|
|
# on to be displayed. This should never be the last message - so
|
|
# continue and wait for the next.
|
|
if payload_exec_id != execution.id:
|
|
continue
|
|
# Check the status of the payload, if we are not given one
|
|
# default to running and assume it is just an "in progress"
|
|
# message from the workflow.
|
|
# Workflows should end with SUCCESS or ERROR statuses.
|
|
if payload.get('status', 'RUNNING') != "RUNNING":
|
|
return
|
|
try:
|
|
execution = mistral.executions.get(execution.id)
|
|
except keystoneauth1.exceptions.connection.ConnectFailure as e:
|
|
LOG.warning("Connection failure while fetching execution ID."
|
|
"Retrying: %s" % e)
|
|
continue
|
|
|
|
if execution.state != "RUNNING":
|
|
# yield the output as the last payload which was missed
|
|
yield json.loads(execution.output)
|
|
return
|
|
except (exceptions.WebSocketTimeout, exceptions.WebSocketConnectionClosed):
|
|
check_execution_status(mistral, execution.id)
|
|
raise
|
|
|
|
|
|
def check_execution_status(workflow_client, execution_id):
|
|
"""Check the status of a workflow that timeout when waiting for messages
|
|
|
|
The status will be logged.
|
|
"""
|
|
|
|
execution = workflow_client.executions.get(execution_id)
|
|
state = execution.state
|
|
|
|
if state == 'RUNNING':
|
|
message = "The WebSocket timed out before the Workflow completed."
|
|
elif state == 'SUCCESS':
|
|
message = ("The Workflow finished successfully but no messages were "
|
|
"received before the WebSocket timed out.")
|
|
elif state == 'ERROR':
|
|
message = "The Workflow errored and no messages were received."
|
|
else:
|
|
message = "Unknown Execution state."
|
|
|
|
LOG.error(("Timed out waiting for messages from Execution "
|
|
"(ID: {}, State: {}). {}").format(execution_id, state, message))
|