acd545f9c2
In order to rework some of the persistence layer I would like to move around some of the files first, keeping job specifics in a jobs folder. Having some of the items which are root level taskflow items (flow, task) be at the root of the hiearchy. Also for now until the celery work is commited move that, since it doesn't make sense in backends anyway. Change-Id: If6c149710b40f70d4ec69ee8e523defe8f5e766d
81 lines
2.9 KiB
Python
81 lines
2.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# vim: tabstop=4 shiftwidth=4 softtabstop=4
|
|
|
|
# Copyright (C) 2013 Rackspace Hosting 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.
|
|
|
|
import abc
|
|
|
|
# from taskflow.backends import api as b_api
|
|
from taskflow.openstack.common import uuidutils
|
|
from taskflow import utils
|
|
|
|
|
|
class Task(object):
|
|
"""An abstraction that defines a potential piece of work that can be
|
|
applied and can be reverted to undo the work as a single unit.
|
|
"""
|
|
__metaclass__ = abc.ABCMeta
|
|
|
|
def __init__(self, name, task_id=None):
|
|
if task_id:
|
|
self._uuid = task_id
|
|
else:
|
|
self._uuid = uuidutils.generate_uuid()
|
|
self._name = name
|
|
# An *immutable* input 'resource' name set this task depends
|
|
# on existing before this task can be applied.
|
|
self.requires = set()
|
|
# An *immutable* input 'resource' name set this task would like to
|
|
# depends on existing before this task can be applied (but does not
|
|
# strongly depend on existing).
|
|
self.optional = set()
|
|
# An *immutable* output 'resource' name set this task
|
|
# produces that other tasks may depend on this task providing.
|
|
self.provides = set()
|
|
# This identifies the version of the task to be ran which
|
|
# can be useful in resuming older versions of tasks. Standard
|
|
# major, minor version semantics apply.
|
|
self.version = (1, 0)
|
|
|
|
@property
|
|
def uuid(self):
|
|
return self._uuid
|
|
|
|
@property
|
|
def name(self):
|
|
return self._name
|
|
|
|
def __str__(self):
|
|
return "%s==%s" % (self.name, utils.join(self.version, with_what="."))
|
|
|
|
@abc.abstractmethod
|
|
def __call__(self, context, *args, **kwargs):
|
|
"""Activate a given task which will perform some operation and return.
|
|
|
|
This method can be used to apply some given context and given set
|
|
of args and kwargs to accomplish some goal. Note that the result
|
|
that is returned needs to be serializable so that it can be passed
|
|
back into this task if reverting is triggered.
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def revert(self, context, result, cause):
|
|
"""Revert this task using the given context, result that the apply
|
|
provided as well as any information which may have caused
|
|
said reversion.
|
|
"""
|
|
pass
|