1f4dd72e6e
Instead of having code that is some what like the notifier
code we already have, but is duplicated and is slightly different
in the task class just move the code that was in the task class (and
doing similar actions) to instead now use a notifier that is directly
contained in the task base class for internal task triggering of
internal task events.
Breaking change: alters the capabilities of the task to process
notifications itself, most actions now must go through the task
notifier property and instead use that (update_progress still exists
as a common utility method, since it's likely the most common type
of notification that will be used).
Removes the following methods from task base class (as they are
no longer needed with a notifier attribute):
- trigger (replaced with notifier.notify)
- autobind (removed, not replaced, can be created by the user
of taskflow in a simple manner, without requiring
functionality in taskflow)
- bind (replaced with notifier.register)
- unbind (replaced with notifier.unregister)
- listeners_iter (replaced with notifier.listeners_iter)
Due to this change we can now also correctly proxy back events from
remote tasks to the engine for correct proxying back to the original
task.
Fixes bug 1370766
Change-Id: Ic9dfef516d72e6e32e71dda30a1cb3522c9e0be6
199 lines
7.3 KiB
Python
199 lines
7.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright (C) 2013 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.
|
|
|
|
import collections
|
|
import functools
|
|
|
|
from taskflow import states
|
|
from taskflow import test
|
|
from taskflow.types import notifier as nt
|
|
|
|
|
|
class NotifierTest(test.TestCase):
|
|
|
|
def test_notify_called(self):
|
|
call_collector = []
|
|
|
|
def call_me(state, details):
|
|
call_collector.append((state, details))
|
|
|
|
notifier = nt.Notifier()
|
|
notifier.register(nt.Notifier.ANY, call_me)
|
|
notifier.notify(states.SUCCESS, {})
|
|
notifier.notify(states.SUCCESS, {})
|
|
|
|
self.assertEqual(2, len(call_collector))
|
|
self.assertEqual(1, len(notifier))
|
|
|
|
def test_notify_register_deregister(self):
|
|
|
|
def call_me(state, details):
|
|
pass
|
|
|
|
class A(object):
|
|
def call_me_too(self, state, details):
|
|
pass
|
|
|
|
notifier = nt.Notifier()
|
|
notifier.register(nt.Notifier.ANY, call_me)
|
|
a = A()
|
|
notifier.register(nt.Notifier.ANY, a.call_me_too)
|
|
|
|
self.assertEqual(2, len(notifier))
|
|
notifier.deregister(nt.Notifier.ANY, call_me)
|
|
notifier.deregister(nt.Notifier.ANY, a.call_me_too)
|
|
self.assertEqual(0, len(notifier))
|
|
|
|
def test_notify_reset(self):
|
|
|
|
def call_me(state, details):
|
|
pass
|
|
|
|
notifier = nt.Notifier()
|
|
notifier.register(nt.Notifier.ANY, call_me)
|
|
self.assertEqual(1, len(notifier))
|
|
|
|
notifier.reset()
|
|
self.assertEqual(0, len(notifier))
|
|
|
|
def test_bad_notify(self):
|
|
|
|
def call_me(state, details):
|
|
pass
|
|
|
|
notifier = nt.Notifier()
|
|
self.assertRaises(KeyError, notifier.register,
|
|
nt.Notifier.ANY, call_me,
|
|
kwargs={'details': 5})
|
|
|
|
def test_not_callable(self):
|
|
notifier = nt.Notifier()
|
|
self.assertRaises(ValueError, notifier.register,
|
|
nt.Notifier.ANY, 2)
|
|
|
|
def test_restricted_notifier(self):
|
|
notifier = nt.RestrictedNotifier(['a', 'b'])
|
|
self.assertRaises(ValueError, notifier.register,
|
|
'c', lambda *args, **kargs: None)
|
|
notifier.register('b', lambda *args, **kargs: None)
|
|
self.assertEqual(1, len(notifier))
|
|
|
|
def test_restricted_notifier_any(self):
|
|
notifier = nt.RestrictedNotifier(['a', 'b'])
|
|
self.assertRaises(ValueError, notifier.register,
|
|
'c', lambda *args, **kargs: None)
|
|
notifier.register('b', lambda *args, **kargs: None)
|
|
self.assertEqual(1, len(notifier))
|
|
notifier.register(nt.RestrictedNotifier.ANY,
|
|
lambda *args, **kargs: None)
|
|
self.assertEqual(2, len(notifier))
|
|
|
|
def test_restricted_notifier_no_any(self):
|
|
notifier = nt.RestrictedNotifier(['a', 'b'], allow_any=False)
|
|
self.assertRaises(ValueError, notifier.register,
|
|
nt.RestrictedNotifier.ANY,
|
|
lambda *args, **kargs: None)
|
|
notifier.register('b', lambda *args, **kargs: None)
|
|
self.assertEqual(1, len(notifier))
|
|
|
|
def test_selective_notify(self):
|
|
call_counts = collections.defaultdict(list)
|
|
|
|
def call_me_on(registered_state, state, details):
|
|
call_counts[registered_state].append((state, details))
|
|
|
|
notifier = nt.Notifier()
|
|
|
|
call_me_on_success = functools.partial(call_me_on, states.SUCCESS)
|
|
notifier.register(states.SUCCESS, call_me_on_success)
|
|
self.assertTrue(notifier.is_registered(states.SUCCESS,
|
|
call_me_on_success))
|
|
|
|
call_me_on_any = functools.partial(call_me_on, nt.Notifier.ANY)
|
|
notifier.register(nt.Notifier.ANY, call_me_on_any)
|
|
self.assertTrue(notifier.is_registered(nt.Notifier.ANY,
|
|
call_me_on_any))
|
|
|
|
self.assertEqual(2, len(notifier))
|
|
notifier.notify(states.SUCCESS, {})
|
|
|
|
self.assertEqual(1, len(call_counts[nt.Notifier.ANY]))
|
|
self.assertEqual(1, len(call_counts[states.SUCCESS]))
|
|
|
|
notifier.notify(states.FAILURE, {})
|
|
self.assertEqual(2, len(call_counts[nt.Notifier.ANY]))
|
|
self.assertEqual(1, len(call_counts[states.SUCCESS]))
|
|
self.assertEqual(2, len(call_counts))
|
|
|
|
def test_details_filter(self):
|
|
call_counts = collections.defaultdict(list)
|
|
|
|
def call_me_on(registered_state, state, details):
|
|
call_counts[registered_state].append((state, details))
|
|
|
|
def when_red(details):
|
|
return details.get('color') == 'red'
|
|
|
|
notifier = nt.Notifier()
|
|
|
|
call_me_on_success = functools.partial(call_me_on, states.SUCCESS)
|
|
notifier.register(states.SUCCESS, call_me_on_success,
|
|
details_filter=when_red)
|
|
self.assertEqual(1, len(notifier))
|
|
self.assertTrue(notifier.is_registered(
|
|
states.SUCCESS, call_me_on_success, details_filter=when_red))
|
|
|
|
notifier.notify(states.SUCCESS, {})
|
|
self.assertEqual(0, len(call_counts[states.SUCCESS]))
|
|
notifier.notify(states.SUCCESS, {'color': 'red'})
|
|
self.assertEqual(1, len(call_counts[states.SUCCESS]))
|
|
notifier.notify(states.SUCCESS, {'color': 'green'})
|
|
self.assertEqual(1, len(call_counts[states.SUCCESS]))
|
|
|
|
def test_different_details_filter(self):
|
|
call_counts = collections.defaultdict(list)
|
|
|
|
def call_me_on(registered_state, state, details):
|
|
call_counts[registered_state].append((state, details))
|
|
|
|
def when_red(details):
|
|
return details.get('color') == 'red'
|
|
|
|
def when_blue(details):
|
|
return details.get('color') == 'blue'
|
|
|
|
notifier = nt.Notifier()
|
|
|
|
call_me_on_success = functools.partial(call_me_on, states.SUCCESS)
|
|
notifier.register(states.SUCCESS, call_me_on_success,
|
|
details_filter=when_red)
|
|
notifier.register(states.SUCCESS, call_me_on_success,
|
|
details_filter=when_blue)
|
|
self.assertEqual(2, len(notifier))
|
|
self.assertTrue(notifier.is_registered(
|
|
states.SUCCESS, call_me_on_success, details_filter=when_blue))
|
|
self.assertTrue(notifier.is_registered(
|
|
states.SUCCESS, call_me_on_success, details_filter=when_red))
|
|
|
|
notifier.notify(states.SUCCESS, {})
|
|
self.assertEqual(0, len(call_counts[states.SUCCESS]))
|
|
notifier.notify(states.SUCCESS, {'color': 'red'})
|
|
self.assertEqual(1, len(call_counts[states.SUCCESS]))
|
|
notifier.notify(states.SUCCESS, {'color': 'blue'})
|
|
self.assertEqual(2, len(call_counts[states.SUCCESS]))
|
|
notifier.notify(states.SUCCESS, {'color': 'green'})
|
|
self.assertEqual(2, len(call_counts[states.SUCCESS]))
|