176bfa6ccb
Before this change we used to loose any progress details set by task when it was updating its progress when task state was changed from RUNNING to SUCCESS (and thus progress forced to 1.0). This commit fixes this, so that when progress is updated from the engine latest progress details are preserved. Breaking change: to allow details to be associated with progress value they were set for we save progress and then return progress value with details. Change-Id: Ic90e61ee3dcf62731696a0f10134bc448e7d6384
146 lines
5.0 KiB
Python
146 lines
5.0 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.
|
|
|
|
import contextlib
|
|
|
|
from taskflow import task
|
|
from taskflow import test
|
|
|
|
import taskflow.engines
|
|
from taskflow.patterns import linear_flow as lf
|
|
from taskflow.persistence.backends import impl_memory
|
|
from taskflow.utils import persistence_utils as p_utils
|
|
|
|
|
|
class ProgressTask(task.Task):
|
|
def __init__(self, name, segments):
|
|
super(ProgressTask, self).__init__(name=name)
|
|
self._segments = segments
|
|
|
|
def execute(self):
|
|
if self._segments <= 0:
|
|
return
|
|
for i in range(1, self._segments):
|
|
progress = float(i) / self._segments
|
|
self.update_progress(progress)
|
|
|
|
|
|
class ProgressTaskWithDetails(task.Task):
|
|
def execute(self):
|
|
self.update_progress(0.5, test='test data', foo='bar')
|
|
|
|
|
|
class TestProgress(test.TestCase):
|
|
def _make_engine(self, flow, flow_detail=None, backend=None):
|
|
e = taskflow.engines.load(flow,
|
|
flow_detail=flow_detail,
|
|
backend=backend)
|
|
e.compile()
|
|
return e
|
|
|
|
def tearDown(self):
|
|
super(TestProgress, self).tearDown()
|
|
with contextlib.closing(impl_memory.MemoryBackend({})) as be:
|
|
with contextlib.closing(be.get_connection()) as conn:
|
|
conn.clear_all()
|
|
|
|
def test_sanity_progress(self):
|
|
fired_events = []
|
|
|
|
def notify_me(task, event_data, progress):
|
|
fired_events.append(progress)
|
|
|
|
ev_count = 5
|
|
t = ProgressTask("test", ev_count)
|
|
t.bind('update_progress', notify_me)
|
|
flo = lf.Flow("test")
|
|
flo.add(t)
|
|
e = self._make_engine(flo)
|
|
e.run()
|
|
self.assertEquals(ev_count + 1, len(fired_events))
|
|
self.assertEquals(1.0, fired_events[-1])
|
|
self.assertEquals(0.0, fired_events[0])
|
|
|
|
def test_no_segments_progress(self):
|
|
fired_events = []
|
|
|
|
def notify_me(task, event_data, progress):
|
|
fired_events.append(progress)
|
|
|
|
t = ProgressTask("test", 0)
|
|
t.bind('update_progress', notify_me)
|
|
flo = lf.Flow("test")
|
|
flo.add(t)
|
|
e = self._make_engine(flo)
|
|
e.run()
|
|
# 0.0 and 1.0 should be automatically fired
|
|
self.assertEquals(2, len(fired_events))
|
|
self.assertEquals(1.0, fired_events[-1])
|
|
self.assertEquals(0.0, fired_events[0])
|
|
|
|
def test_storage_progress(self):
|
|
with contextlib.closing(impl_memory.MemoryBackend({})) as be:
|
|
flo = lf.Flow("test")
|
|
flo.add(ProgressTask("test", 3))
|
|
b, fd = p_utils.temporary_flow_detail(be)
|
|
e = self._make_engine(flo, flow_detail=fd, backend=be)
|
|
e.run()
|
|
t_uuid = e.storage.get_uuid_by_name("test")
|
|
end_progress = e.storage.get_task_progress(t_uuid)
|
|
self.assertEquals(1.0, end_progress)
|
|
td = fd.find(t_uuid)
|
|
self.assertEquals(1.0, td.meta['progress'])
|
|
self.assertFalse(td.meta['progress_details'])
|
|
|
|
def test_storage_progress_detail(self):
|
|
flo = ProgressTaskWithDetails("test")
|
|
e = self._make_engine(flo)
|
|
e.run()
|
|
t_uuid = e.storage.get_uuid_by_name("test")
|
|
end_progress = e.storage.get_task_progress(t_uuid)
|
|
self.assertEquals(1.0, end_progress)
|
|
end_details = e.storage.get_task_progress_details(t_uuid)
|
|
self.assertEquals(end_details.get('at_progress'), 0.5)
|
|
self.assertEquals(end_details.get('details'), {
|
|
'test': 'test data',
|
|
'foo': 'bar'
|
|
})
|
|
|
|
def test_dual_storage_progress(self):
|
|
fired_events = []
|
|
|
|
def notify_me(task, event_data, progress):
|
|
fired_events.append(progress)
|
|
|
|
with contextlib.closing(impl_memory.MemoryBackend({})) as be:
|
|
t = ProgressTask("test", 5)
|
|
t.bind('update_progress', notify_me)
|
|
flo = lf.Flow("test")
|
|
flo.add(t)
|
|
b, fd = p_utils.temporary_flow_detail(be)
|
|
e = self._make_engine(flo, flow_detail=fd, backend=be)
|
|
e.run()
|
|
|
|
t_uuid = e.storage.get_uuid_by_name("test")
|
|
end_progress = e.storage.get_task_progress(t_uuid)
|
|
self.assertEquals(1.0, end_progress)
|
|
td = fd.find(t_uuid)
|
|
self.assertEquals(1.0, td.meta['progress'])
|
|
self.assertFalse(td.meta['progress_details'])
|
|
self.assertEquals(6, len(fired_events))
|