/usr/lib/python3/dist-packages/oslo_service/tests/test_periodic.py is in python3-oslo.service 1.29.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 | # Copyright 2010 United States Government as represented by the
# Administrator of the National Aeronautics and Space Administration.
# 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.
"""
Unit Tests for periodic_task decorator and PeriodicTasks class.
"""
import mock
from testtools import matchers
from oslo_service import periodic_task
from oslo_service.tests import base
class AnException(Exception):
pass
class PeriodicTasksTestCase(base.ServiceBaseTestCase):
"""Test cases for PeriodicTasks."""
@mock.patch('oslo_service.periodic_task.now')
def test_called_thrice(self, mock_now):
time = 340
mock_now.return_value = time
# Class inside test def to mock 'now' in
# the periodic task decorator
class AService(periodic_task.PeriodicTasks):
def __init__(self, conf):
super(AService, self).__init__(conf)
self.called = {'doit': 0, 'urg': 0, 'ticks': 0, 'tocks': 0}
@periodic_task.periodic_task
def doit(self, context):
self.called['doit'] += 1
@periodic_task.periodic_task
def crashit(self, context):
self.called['urg'] += 1
raise AnException('urg')
@periodic_task.periodic_task(
spacing=10 + periodic_task.DEFAULT_INTERVAL,
run_immediately=True)
def doit_with_ticks(self, context):
self.called['ticks'] += 1
@periodic_task.periodic_task(
spacing=10 + periodic_task.DEFAULT_INTERVAL)
def doit_with_tocks(self, context):
self.called['tocks'] += 1
external_called = {'ext1': 0, 'ext2': 0}
@periodic_task.periodic_task
def ext1(self, context):
external_called['ext1'] += 1
@periodic_task.periodic_task(
spacing=10 + periodic_task.DEFAULT_INTERVAL)
def ext2(self, context):
external_called['ext2'] += 1
serv = AService(self.conf)
serv.add_periodic_task(ext1)
serv.add_periodic_task(ext2)
serv.run_periodic_tasks(None)
# Time: 340
self.assertEqual(0, serv.called['doit'])
self.assertEqual(0, serv.called['urg'])
# New last run will be 350
self.assertEqual(1, serv.called['ticks'])
self.assertEqual(0, serv.called['tocks'])
self.assertEqual(0, external_called['ext1'])
self.assertEqual(0, external_called['ext2'])
time = time + periodic_task.DEFAULT_INTERVAL
mock_now.return_value = time
serv.run_periodic_tasks(None)
# Time:400
# New Last run: 420
self.assertEqual(1, serv.called['doit'])
self.assertEqual(1, serv.called['urg'])
# Closest multiple of 70 is 420
self.assertEqual(1, serv.called['ticks'])
self.assertEqual(0, serv.called['tocks'])
self.assertEqual(1, external_called['ext1'])
self.assertEqual(0, external_called['ext2'])
time = time + periodic_task.DEFAULT_INTERVAL / 2
mock_now.return_value = time
serv.run_periodic_tasks(None)
self.assertEqual(1, serv.called['doit'])
self.assertEqual(1, serv.called['urg'])
self.assertEqual(2, serv.called['ticks'])
self.assertEqual(1, serv.called['tocks'])
self.assertEqual(1, external_called['ext1'])
self.assertEqual(1, external_called['ext2'])
time = time + periodic_task.DEFAULT_INTERVAL
mock_now.return_value = time
serv.run_periodic_tasks(None)
self.assertEqual(2, serv.called['doit'])
self.assertEqual(2, serv.called['urg'])
self.assertEqual(3, serv.called['ticks'])
self.assertEqual(2, serv.called['tocks'])
self.assertEqual(2, external_called['ext1'])
self.assertEqual(2, external_called['ext2'])
@mock.patch('oslo_service.periodic_task.now')
def test_called_correct(self, mock_now):
time = 360444
mock_now.return_value = time
test_spacing = 9
# Class inside test def to mock 'now' in
# the periodic task decorator
class AService(periodic_task.PeriodicTasks):
def __init__(self, conf):
super(AService, self).__init__(conf)
self.called = {'ticks': 0}
@periodic_task.periodic_task(spacing=test_spacing)
def tick(self, context):
self.called['ticks'] += 1
serv = AService(self.conf)
for i in range(200):
serv.run_periodic_tasks(None)
self.assertEqual(int(i / test_spacing), serv.called['ticks'])
time += 1
mock_now.return_value = time
@mock.patch('oslo_service.periodic_task.now')
def test_raises(self, mock_now):
time = 230000
mock_now.return_value = time
class AService(periodic_task.PeriodicTasks):
def __init__(self, conf):
super(AService, self).__init__(conf)
self.called = {'urg': 0, }
@periodic_task.periodic_task
def crashit(self, context):
self.called['urg'] += 1
raise AnException('urg')
serv = AService(self.conf)
now = serv._periodic_last_run['crashit']
mock_now.return_value = now + periodic_task.DEFAULT_INTERVAL
self.assertRaises(AnException,
serv.run_periodic_tasks,
None, raise_on_error=True)
def test_name(self):
class AService(periodic_task.PeriodicTasks):
def __init__(self, conf):
super(AService, self).__init__(conf)
@periodic_task.periodic_task(name='better-name')
def tick(self, context):
pass
@periodic_task.periodic_task
def tack(self, context):
pass
@periodic_task.periodic_task(name='another-name')
def foo(self, context):
pass
serv = AService(self.conf)
serv.add_periodic_task(foo)
self.assertIn('better-name', serv._periodic_last_run)
self.assertIn('another-name', serv._periodic_last_run)
self.assertIn('tack', serv._periodic_last_run)
class ManagerMetaTestCase(base.ServiceBaseTestCase):
"""Tests for the meta class which manages creation of periodic tasks."""
def test_meta(self):
class Manager(periodic_task.PeriodicTasks):
@periodic_task.periodic_task
def foo(self):
return 'foo'
@periodic_task.periodic_task(spacing=4)
def bar(self):
return 'bar'
@periodic_task.periodic_task(enabled=False)
def baz(self):
return 'baz'
m = Manager(self.conf)
self.assertThat(m._periodic_tasks, matchers.HasLength(2))
self.assertEqual(periodic_task.DEFAULT_INTERVAL,
m._periodic_spacing['foo'])
self.assertEqual(4, m._periodic_spacing['bar'])
self.assertThat(
m._periodic_spacing, matchers.Not(matchers.Contains('baz')))
@periodic_task.periodic_task
def external():
return 42
m.add_periodic_task(external)
self.assertThat(m._periodic_tasks, matchers.HasLength(3))
self.assertEqual(periodic_task.DEFAULT_INTERVAL,
m._periodic_spacing['external'])
class ManagerTestCase(base.ServiceBaseTestCase):
"""Tests the periodic tasks portion of the manager class."""
def setUp(self):
super(ManagerTestCase, self).setUp()
def test_periodic_tasks_with_idle(self):
class Manager(periodic_task.PeriodicTasks):
@periodic_task.periodic_task(spacing=200)
def bar(self):
return 'bar'
m = Manager(self.conf)
self.assertThat(m._periodic_tasks, matchers.HasLength(1))
self.assertEqual(200, m._periodic_spacing['bar'])
# Now a single pass of the periodic tasks
idle = m.run_periodic_tasks(None)
self.assertAlmostEqual(60, idle, 1)
def test_periodic_tasks_constant(self):
class Manager(periodic_task.PeriodicTasks):
@periodic_task.periodic_task(spacing=0)
def bar(self):
return 'bar'
m = Manager(self.conf)
idle = m.run_periodic_tasks(None)
self.assertAlmostEqual(60, idle, 1)
@mock.patch('oslo_service.periodic_task.now')
def test_periodic_tasks_idle_calculation(self, mock_now):
fake_time = 32503680000.0
mock_now.return_value = fake_time
class Manager(periodic_task.PeriodicTasks):
@periodic_task.periodic_task(spacing=10)
def bar(self, context):
return 'bar'
m = Manager(self.conf)
# Ensure initial values are correct
self.assertEqual(1, len(m._periodic_tasks))
task_name, task = m._periodic_tasks[0]
# Test task values
self.assertEqual('bar', task_name)
self.assertEqual(10, task._periodic_spacing)
self.assertTrue(task._periodic_enabled)
self.assertFalse(task._periodic_external_ok)
self.assertFalse(task._periodic_immediate)
self.assertAlmostEqual(32503680000.0,
task._periodic_last_run)
# Test the manager's representation of those values
self.assertEqual(10, m._periodic_spacing[task_name])
self.assertAlmostEqual(32503680000.0,
m._periodic_last_run[task_name])
mock_now.return_value = fake_time + 5
idle = m.run_periodic_tasks(None)
self.assertAlmostEqual(5, idle, 1)
self.assertAlmostEqual(32503680000.0,
m._periodic_last_run[task_name])
mock_now.return_value = fake_time + 10
idle = m.run_periodic_tasks(None)
self.assertAlmostEqual(10, idle, 1)
self.assertAlmostEqual(32503680010.0,
m._periodic_last_run[task_name])
@mock.patch('oslo_service.periodic_task.now')
def test_periodic_tasks_immediate_runs_now(self, mock_now):
fake_time = 32503680000.0
mock_now.return_value = fake_time
class Manager(periodic_task.PeriodicTasks):
@periodic_task.periodic_task(spacing=10, run_immediately=True)
def bar(self, context):
return 'bar'
m = Manager(self.conf)
# Ensure initial values are correct
self.assertEqual(1, len(m._periodic_tasks))
task_name, task = m._periodic_tasks[0]
# Test task values
self.assertEqual('bar', task_name)
self.assertEqual(10, task._periodic_spacing)
self.assertTrue(task._periodic_enabled)
self.assertFalse(task._periodic_external_ok)
self.assertTrue(task._periodic_immediate)
self.assertIsNone(task._periodic_last_run)
# Test the manager's representation of those values
self.assertEqual(10, m._periodic_spacing[task_name])
self.assertIsNone(m._periodic_last_run[task_name])
idle = m.run_periodic_tasks(None)
self.assertAlmostEqual(32503680000.0,
m._periodic_last_run[task_name])
self.assertAlmostEqual(10, idle, 1)
mock_now.return_value = fake_time + 5
idle = m.run_periodic_tasks(None)
self.assertAlmostEqual(5, idle, 1)
def test_periodic_tasks_disabled(self):
class Manager(periodic_task.PeriodicTasks):
@periodic_task.periodic_task(spacing=-1)
def bar(self):
return 'bar'
m = Manager(self.conf)
idle = m.run_periodic_tasks(None)
self.assertAlmostEqual(60, idle, 1)
def test_external_running_here(self):
self.config(run_external_periodic_tasks=True)
class Manager(periodic_task.PeriodicTasks):
@periodic_task.periodic_task(spacing=200, external_process_ok=True)
def bar(self):
return 'bar'
m = Manager(self.conf)
self.assertThat(m._periodic_tasks, matchers.HasLength(1))
@mock.patch('oslo_service.periodic_task.now')
@mock.patch('random.random')
def test_nearest_boundary(self, mock_random, mock_now):
mock_now.return_value = 19
mock_random.return_value = 0
self.assertEqual(17, periodic_task._nearest_boundary(10, 7))
mock_now.return_value = 28
self.assertEqual(27, periodic_task._nearest_boundary(13, 7))
mock_now.return_value = 1841
self.assertEqual(1837, periodic_task._nearest_boundary(781, 88))
mock_now.return_value = 1835
self.assertEqual(mock_now.return_value,
periodic_task._nearest_boundary(None, 88))
# Add 5% jitter
mock_random.return_value = 1.0
mock_now.return_value = 1300
self.assertEqual(1200 + 10, periodic_task._nearest_boundary(1000, 200))
# Add 2.5% jitter
mock_random.return_value = 0.5
mock_now.return_value = 1300
self.assertEqual(1200 + 5, periodic_task._nearest_boundary(1000, 200))
|