Files
deb-python-taskflow/taskflow/patterns/linear_flow.py
Ivan A. Melnikov b07ee63f78 Verify provides and requires
When flow is being constructed we ensure that it is actually valid by
checking its invariants:
- for linear flow, no item should depend on items that are executed
  after it;
- for unordered flow, items should be independent.

We also add check that all necessary provides were injected to storage
before actually running flow.

Implements: blueprint flow-verification
Change-Id: I499898f543505b7dd6f82716ae8f4011cb08f601
2013-09-18 09:51:33 +04:00

80 lines
2.6 KiB
Python

# -*- coding: utf-8 -*-
# vim: tabstop=4 shiftwidth=4 softtabstop=4
# Copyright (C) 2012 Yahoo! 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.
from taskflow import exceptions
from taskflow import flow
class Flow(flow.Flow):
""""Linear Flow pattern.
A linear (potentially nested) flow of *tasks/flows* that can be
applied in order as one unit and rolled back as one unit using
the reverse order that the *tasks/flows* have been applied in.
NOTE(imelnikov): Tasks in should not depend on outputs
of tasks that follow it in the flow.
"""
def __init__(self, name, uuid=None):
super(Flow, self).__init__(name, uuid)
self._children = []
def add(self, *items):
"""Adds a given task/tasks/flow/flows to this flow."""
items = [self._extract_item(item) for item in items]
# NOTE(imelnikov): we add item to the end of flow, so it should
# not provide anything previous items of the flow require
requires = self.requires
for item in items:
requires |= item.requires
out_of_order = requires & item.provides
if out_of_order:
raise exceptions.InvariantViolationException(
"%(item)s provides %(oo)s that are required "
"by previous item(s) of linear flow %(flow)s"
% dict(item=item.name, flow=self.name,
oo=sorted(out_of_order)))
self._children.extend(items)
return self
def __len__(self):
return len(self._children)
def __iter__(self):
for child in self._children:
yield child
@property
def provides(self):
provides = set()
for subflow in self._children:
provides.update(subflow.provides)
return provides
@property
def requires(self):
requires = set()
provides = set()
for subflow in self._children:
requires.update(subflow.requires - provides)
provides.update(subflow.provides)
return requires