Files
@ 2c7d6c16e14f
Branch filter:
Location: rattail-project/rattail/tests/filemon/test_actions.py
2c7d6c16e14f
6.3 KiB
text/x-python
File Monitor overhaul!
* New configuration syntax (old syntax still supported but deprecated).
* Class-based actions.
* Configure keyword arguments to action callables.
* Configure retry for actions.
* Add (some) tests, docs.
* New configuration syntax (old syntax still supported but deprecated).
* Class-based actions.
* Configure keyword arguments to action callables.
* Configure retry for actions.
* Add (some) tests, docs.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 | # -*- coding: utf-8 -*-
import os
import time
import Queue
from unittest import TestCase
from mock import Mock, patch, call
from fixture import TempIO
from edbob.configuration import AppConfigParser
from rattail.filemon import actions
from rattail.filemon.config import Profile, ProfileAction
class TestAction(TestCase):
def test_callable_must_be_implemented_in_subclass(self):
config = AppConfigParser(u'rattail')
action = actions.Action(config)
self.assertRaises(NotImplementedError, action)
@patch(u'rattail.filemon.actions.noop')
class TestPerformActions(TestCase):
def setUp(self):
self.tmp = TempIO()
self.config = AppConfigParser(u'rattail')
self.config.set(u'rattail.filemon', u'monitor', u'foo')
self.config.set(u'rattail.filemon', u'foo.dirs', self.tmp)
self.config.set(u'rattail.filemon', u'foo.actions', u'noop')
self.config.set(u'rattail.filemon', u'foo.action.noop.func', u'rattail.filemon.actions:noop')
# Must delay creating the profile since doing it here would bypass our mock of noop.
def get_profile(self, stop_on_error=False):
profile = Profile(self.config, u'foo')
profile.stop_on_error = stop_on_error
profile.queue = Mock()
profile.queue.get_nowait.side_effect = [
Queue.Empty, # for coverage sake; will be effectively skipped
self.tmp.putfile(u'file1', u''),
self.tmp.putfile(u'file2', u''),
self.tmp.putfile(u'file3', u''),
actions.StopProcessing,
]
return profile
def test_action_is_invoked_for_each_file_in_queue(self, noop):
profile = self.get_profile()
actions.perform_actions(profile)
self.assertEqual(noop.call_count, 3)
noop.assert_has_calls([
call(self.tmp.join(u'file1')),
call(self.tmp.join(u'file2')),
call(self.tmp.join(u'file3')),
])
def test_action_is_skipped_for_nonexistent_file(self, noop):
profile = self.get_profile()
os.remove(self.tmp.join(u'file2'))
actions.perform_actions(profile)
self.assertEqual(noop.call_count, 2)
# no call for file2
noop.assert_has_calls([
call(self.tmp.join(u'file1')),
call(self.tmp.join(u'file3')),
])
def test_action_which_raises_error_causes_subsequent_actions_to_be_skipped_for_same_file(self, noop):
self.config.set(u'rattail.filemon', u'foo.actions', u'noop, delete')
self.config.set(u'rattail.filemon', u'foo.action.delete.func', u'os:remove')
profile = self.get_profile()
# processing second file fails, so it shouldn't be deleted
noop.side_effect = [None, RuntimeError, None]
actions.perform_actions(profile)
self.assertFalse(os.path.exists(self.tmp.join(u'file1')))
self.assertTrue(os.path.exists(self.tmp.join(u'file2')))
self.assertFalse(os.path.exists(self.tmp.join(u'file3')))
def test_action_which_raises_error_causes_all_processing_to_stop_if_so_configured(self, noop):
self.config.set(u'rattail.filemon', u'foo.actions', u'noop, delete')
self.config.set(u'rattail.filemon', u'foo.action.delete.func', u'os:remove')
profile = self.get_profile(stop_on_error=True)
# processing second file fails; third file shouldn't be processed at all
noop.side_effect = [None, RuntimeError, None]
actions.perform_actions(profile)
self.assertEqual(noop.call_count, 2)
noop.assert_has_calls([
call(self.tmp.join(u'file1')),
call(self.tmp.join(u'file2')),
])
self.assertFalse(os.path.exists(self.tmp.join(u'file1')))
self.assertTrue(os.path.exists(self.tmp.join(u'file2')))
self.assertTrue(os.path.exists(self.tmp.join(u'file3')))
class TestInvokeAction(TestCase):
def setUp(self):
self.action = ProfileAction()
self.action.action = Mock(return_value=None)
self.action.retry_attempts = 6
self.tmp = TempIO()
self.file = self.tmp.putfile(u'file', u'')
def test_action_which_succeeds_is_only_called_once(self):
actions.invoke_action(self.action, self.file)
self.assertEqual(self.action.action.call_count, 1)
def test_action_with_no_delay_does_not_pause_between_attempts(self):
self.action.retry_attempts = 3
self.action.action.side_effect = [RuntimeError, RuntimeError, None]
start = time.time()
actions.invoke_action(self.action, self.file)
self.assertEqual(self.action.action.call_count, 3)
self.assertTrue(time.time() - start < 1.0)
def test_action_with_delay_pauses_between_attempts(self):
self.action.retry_attempts = 3
self.action.retry_delay = 1
self.action.action.side_effect = [RuntimeError, RuntimeError, None]
start = time.time()
actions.invoke_action(self.action, self.file)
self.assertEqual(self.action.action.call_count, 3)
self.assertTrue(time.time() - start >= 2.0)
def test_action_which_fails_is_only_attempted_the_specified_number_of_times(self):
self.action.action.side_effect = RuntimeError
# Last attempt will not handle the exception; assert that as well.
self.assertRaises(RuntimeError, actions.invoke_action, self.action, self.file)
self.assertEqual(self.action.action.call_count, 6)
def test_action_which_fails_then_succeeds_stops_retrying(self):
# First 2 attempts fail, third succeeds.
self.action.action.side_effect = [RuntimeError, RuntimeError, None]
actions.invoke_action(self.action, self.file)
self.assertEqual(self.action.action.call_count, 3)
def test_action_which_fails_with_different_errors_stops_retrying(self):
self.action.action.side_effect = [ValueError, TypeError, None]
# Second attempt will not handle the exception; assert that as well.
self.assertRaises(TypeError, actions.invoke_action, self.action, self.file)
self.assertEqual(self.action.action.call_count, 2)
class TestRaiseException(TestCase):
def test_exception_is_raised(self):
# this hardly deserves a test, but what the hell
self.assertRaises(Exception, actions.raise_exception, '/dev/null')
|