def test_it_should_not_log_multiple_warnings_when_the_period_has_not_elapsed(
self):
with patch("azurelinuxagent.common.logger.warn") as warn_patcher:
pop = PeriodicOperation("test_operation",
self._operation_with_failure,
period=datetime.timedelta(hours=1))
for _ in range(5):
pop.run()
self.assertEqual(
self._get_number_of_warnings(warn_patcher), 1,
"The error in the operation was should have been reported exactly once"
)
def test_it_should_be_invoked_if_the_period_has_elapsed(self):
def operation():
operation.invoked_count += 1
operation.invoked_count = 0
pop = PeriodicOperation("test_operation",
operation,
period=datetime.timedelta(milliseconds=1))
for _ in range(5):
pop.run()
time.sleep(0.001)
self.assertEqual(
operation.invoked_count, 5,
"The operation was not invoked after the period elapsed")
def test_it_should_not_be_invoked_if_the_period_has_not_elapsed(self):
def operation():
operation.invoked_count += 1
operation.invoked_count = 0
pop = PeriodicOperation("test_operation",
operation,
period=datetime.timedelta(hours=1))
for _ in range(5):
pop.run()
# the first run() invoked the operation, so the count is 1
self.assertEqual(
operation.invoked_count, 1,
"The operation was invoked before the period elapsed")
def test_sleep_until_next_operation_should_wait_for_the_closest_operation(
self):
operations = [
PeriodicOperation("one",
lambda: None,
period=datetime.timedelta(seconds=60)),
PeriodicOperation("one",
lambda: None,
period=datetime.timedelta(hours=1)),
PeriodicOperation(
"one", lambda: None,
period=datetime.timedelta(seconds=10)), # closest operation
PeriodicOperation("one",
lambda: None,
period=datetime.timedelta(minutes=11)),
PeriodicOperation("one",
lambda: None,
period=datetime.timedelta(days=1))
]
for op in operations: # pylint: disable=invalid-name
op.run()
def mock_sleep(seconds):
mock_sleep.seconds = seconds
mock_sleep.seconds = 0
with patch("azurelinuxagent.ga.periodic_operation.time.sleep",
side_effect=mock_sleep):
PeriodicOperation.sleep_until_next_operation(operations)
self.assertAlmostEqual(mock_sleep.seconds, 10, 0,
"did not sleep for the expected time")
def test_it_should_not_multiple_warnings_when_the_period_has_elapsed(self):
with patch("azurelinuxagent.common.logger.warn") as warn_patcher:
with patch(
"azurelinuxagent.ga.periodic_operation.PeriodicOperation._LOG_WARNING_PERIOD",
new_callable=PropertyMock,
return_value=datetime.timedelta(milliseconds=1)):
pop = PeriodicOperation(
"test_operation",
self._operation_with_failure,
period=datetime.timedelta(milliseconds=1))
for _ in range(5):
pop.run()
time.sleep(0.001)
self.assertEqual(
self._get_number_of_warnings(warn_patcher), 5,
"The error in the operation was not reported the expected number of times"
)
def test_it_should_log_a_warning_if_the_operation_fails(self):
with patch("azurelinuxagent.common.logger.warn") as warn_patcher:
PeriodicOperation("test_operation",
self._operation_with_failure,
period=datetime.timedelta(hours=1)).run()
self.assertEqual(
self._get_number_of_warnings(warn_patcher), 1,
"The error in the operation was should have been reported exactly once"
)
def test_it_should_log_warnings_if_they_are_different(self):
with patch("azurelinuxagent.common.logger.warn") as warn_patcher:
for i in range(2):
def operation():
raise Exception("WARNING {0}".format(i))
pop = PeriodicOperation("test_operation",
operation,
period=datetime.timedelta(hours=1))
for _ in range(5):
pop.run()
self.assertEqual(
self._get_number_of_warnings(warn_patcher, "WARNING 0"), 1,
"The first error should have been reported exactly 1 time")
self.assertEqual(
self._get_number_of_warnings(warn_patcher, "WARNING 1"), 1,
"The second error should have been reported exactly 1 time")
def test_it_should_be_invoked_when_run_is_called_first_time(self):
def operation():
operation.invoked = True
operation.invoked = False
PeriodicOperation("test_operation",
operation,
period=datetime.timedelta(hours=1)).run()
self.assertTrue(operation.invoked, "The operation was not invoked")
def test_sleep_until_next_operation_should_wait_for_the_closest_operation(
self):
operations = [
TestPeriodicOperation.NoOp(datetime.timedelta(seconds=60)),
TestPeriodicOperation.NoOp(datetime.timedelta(hours=1)),
TestPeriodicOperation.NoOp(
datetime.timedelta(seconds=10)), # closest operation
TestPeriodicOperation.NoOp(datetime.timedelta(minutes=11)),
TestPeriodicOperation.NoOp(datetime.timedelta(days=1))
]
for op in operations:
op.run()
def mock_sleep(seconds):
mock_sleep.seconds = seconds
mock_sleep.seconds = 0
with patch("azurelinuxagent.ga.periodic_operation.time.sleep",
side_effect=mock_sleep):
PeriodicOperation.sleep_until_next_operation(operations)
self.assertAlmostEqual(mock_sleep.seconds, 10, 0,
"did not sleep for the expected time")
def test_it_should_take_a_number_of_seconds_as_period(self):
def operation():
operation.run_time = datetime.datetime.utcnow()
operation.run_time = None
op = PeriodicOperation("test_operation", operation, period=3600) # pylint: disable=invalid-name
op.run()
expected = operation.run_time + datetime.timedelta(hours=1)
difference = op.next_run_time() - expected
self.assertTrue(
difference < datetime.timedelta(seconds=1),
"The next run time exceeds the expected value by more than 1 second: {0} vs {1}"
.format(op.next_run_time(), expected))
