deb-mistral/mistral/workflow/states.py
Winson Chan 82ab51b0c1 Add cancelled state to executions
Allow workflow executions to be cancelled and propagate state up for
subworkflows and with-items task. Cancelled workflow executions are
subject to expiration.

Change-Id: I74925105420e84c0b164f83b76edaa9b1612b5d5
Implements: blueprint mistral-cancel-state
2016-07-29 18:05:30 +00:00

94 lines
2.0 KiB
Python

# Copyright 2013 - Mirantis, Inc.
# Copyright 2016 - Brocade Communications Systems, Inc.
#
# 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.
"""Valid task and workflow states."""
IDLE = 'IDLE'
WAITING = 'WAITING'
RUNNING = 'RUNNING'
RUNNING_DELAYED = 'DELAYED'
PAUSED = 'PAUSED'
SUCCESS = 'SUCCESS'
CANCELLED = 'CANCELLED'
ERROR = 'ERROR'
_ALL = [
IDLE,
WAITING,
RUNNING,
RUNNING_DELAYED,
PAUSED,
SUCCESS,
CANCELLED,
ERROR
]
_VALID_TRANSITIONS = {
IDLE: [RUNNING, ERROR, CANCELLED],
WAITING: [RUNNING],
RUNNING: [PAUSED, RUNNING_DELAYED, SUCCESS, ERROR, CANCELLED],
RUNNING_DELAYED: [RUNNING, ERROR, CANCELLED],
PAUSED: [RUNNING, ERROR, CANCELLED],
SUCCESS: [],
CANCELLED: [],
ERROR: [RUNNING]
}
def is_valid(state):
return state in _ALL
def is_invalid(state):
return not is_valid(state)
def is_completed(state):
return state in [SUCCESS, ERROR, CANCELLED]
def is_running(state):
return state in [RUNNING, RUNNING_DELAYED]
def is_waiting(state):
return state == WAITING
def is_idle(state):
return state == IDLE
def is_paused(state):
return state == PAUSED
def is_paused_or_completed(state):
return is_paused(state) or is_completed(state)
def is_paused_or_idle(state):
return is_paused(state) or is_idle(state)
def is_valid_transition(from_state, to_state):
if is_invalid(from_state) or is_invalid(to_state):
return False
if from_state == to_state:
return True
return to_state in _VALID_TRANSITIONS[from_state]