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 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
|
import errno
import os
import signal
import sys
from unittest.mock import Mock, call, patch
import pytest
import t.skip
from celery.apps.multi import Cluster, MultiParser, NamespacedOptionParser, Node, format_opt
class test_functions:
def test_parse_ns_range(self):
m = MultiParser()
assert m._parse_ns_range('1-3', True), ['1', '2' == '3']
assert m._parse_ns_range('1-3', False) == ['1-3']
assert m._parse_ns_range('1-3,10,11,20', True) == [
'1', '2', '3', '10', '11', '20',
]
def test_format_opt(self):
assert format_opt('--foo', None) == '--foo'
assert format_opt('-c', 1) == '-c 1'
assert format_opt('--log', 'foo') == '--log=foo'
class test_NamespacedOptionParser:
def test_parse(self):
x = NamespacedOptionParser(['-c:1,3', '4'])
x.parse()
assert x.namespaces.get('1,3') == {'-c': '4'}
x = NamespacedOptionParser(['-c:jerry,elaine', '5',
'--loglevel:kramer=DEBUG',
'--flag',
'--logfile=foo', '-Q', 'bar', 'a', 'b',
'--', '.disable_rate_limits=1'])
x.parse()
assert x.options == {
'--logfile': 'foo',
'-Q': 'bar',
'--flag': None,
}
assert x.values, ['a' == 'b']
assert x.namespaces.get('jerry,elaine') == {'-c': '5'}
assert x.namespaces.get('kramer') == {'--loglevel': 'DEBUG'}
assert x.passthrough == '-- .disable_rate_limits=1'
def multi_args(p, *args, **kwargs):
return MultiParser(*args, **kwargs).parse(p)
class test_multi_args:
@patch('celery.apps.multi.os.mkdir')
@patch('celery.apps.multi.gethostname')
def test_parse(self, gethostname, mkdirs_mock):
gethostname.return_value = 'example.com'
p = NamespacedOptionParser([
'-c:jerry,elaine', '5',
'--loglevel:kramer=DEBUG',
'--flag',
'--logfile=/var/log/celery/foo', '-Q', 'bar', 'jerry',
'elaine', 'kramer',
'--', '.disable_rate_limits=1',
])
p.parse()
it = multi_args(p, cmd='celery multi', append='*AP*',
prefix='*P*', suffix='*S*')
nodes = list(it)
def assert_line_in(name, args):
assert name in {n.name for n in nodes}
argv = None
for node in nodes:
if node.name == name:
argv = node.argv
assert argv
for arg in args:
assert arg in argv
assert_line_in(
'*P*jerry@*S*',
['celery multi', '-n *P*jerry@*S*', '-Q bar',
'-c 5', '--flag', '--logfile=/var/log/celery/foo',
'-- .disable_rate_limits=1', '*AP*'],
)
assert_line_in(
'*P*elaine@*S*',
['celery multi', '-n *P*elaine@*S*', '-Q bar',
'-c 5', '--flag', '--logfile=/var/log/celery/foo',
'-- .disable_rate_limits=1', '*AP*'],
)
assert_line_in(
'*P*kramer@*S*',
['celery multi', '--loglevel=DEBUG', '-n *P*kramer@*S*',
'-Q bar', '--flag', '--logfile=/var/log/celery/foo',
'-- .disable_rate_limits=1', '*AP*'],
)
expand = nodes[0].expander
assert expand('%h') == '*P*jerry@*S*'
assert expand('%n') == '*P*jerry'
nodes2 = list(multi_args(p, cmd='celery multi', append='',
prefix='*P*', suffix='*S*'))
assert nodes2[0].argv[-1] == '-- .disable_rate_limits=1'
p2 = NamespacedOptionParser(['10', '-c:1', '5'])
p2.parse()
nodes3 = list(multi_args(p2, cmd='celery multi'))
def _args(name, *args):
return args + (
'--pidfile={}.pid'.format(os.path.join(os.path.normpath('/var/run/celery/'), name)),
'--logfile={}%I.log'.format(os.path.join(os.path.normpath('/var/log/celery/'), name)),
f'--executable={sys.executable}',
'',
)
assert len(nodes3) == 10
assert nodes3[0].name == 'celery1@example.com'
assert nodes3[0].argv == (
'celery multi', '-c 5', '-n celery1@example.com') + _args('celery1')
for i, worker in enumerate(nodes3[1:]):
assert worker.name == 'celery%s@example.com' % (i + 2)
node_i = f'celery{i + 2}'
assert worker.argv == (
'celery multi',
f'-n {node_i}@example.com') + _args(node_i)
nodes4 = list(multi_args(p2, cmd='celery multi', suffix='""'))
assert len(nodes4) == 10
assert nodes4[0].name == 'celery1@'
assert nodes4[0].argv == (
'celery multi', '-c 5', '-n celery1@') + _args('celery1')
p3 = NamespacedOptionParser(['foo@', '-c:foo', '5'])
p3.parse()
nodes5 = list(multi_args(p3, cmd='celery multi', suffix='""'))
assert nodes5[0].name == 'foo@'
assert nodes5[0].argv == (
'celery multi', '-c 5', '-n foo@') + _args('foo')
p4 = NamespacedOptionParser(['foo', '-Q:1', 'test'])
p4.parse()
nodes6 = list(multi_args(p4, cmd='celery multi', suffix='""'))
assert nodes6[0].name == 'foo@'
assert nodes6[0].argv == (
'celery multi', '-Q test', '-n foo@') + _args('foo')
p5 = NamespacedOptionParser(['foo@bar', '-Q:1', 'test'])
p5.parse()
nodes7 = list(multi_args(p5, cmd='celery multi', suffix='""'))
assert nodes7[0].name == 'foo@bar'
assert nodes7[0].argv == (
'celery multi', '-Q test', '-n foo@bar') + _args('foo')
p6 = NamespacedOptionParser(['foo@bar', '-Q:0', 'test'])
p6.parse()
with pytest.raises(KeyError):
list(multi_args(p6))
def test_optmerge(self):
p = NamespacedOptionParser(['foo', 'test'])
p.parse()
p.options = {'x': 'y'}
r = p.optmerge('foo')
assert r['x'] == 'y'
class test_Node:
def setup_method(self):
self.p = Mock(name='p')
self.p.options = {
'--executable': 'python',
'--logfile': '/var/log/celery/foo.log',
}
self.p.namespaces = {}
with patch('celery.apps.multi.os.mkdir'):
self.node = Node('foo@bar.com', options={'-A': 'proj'})
self.expander = self.node.expander = Mock(name='expander')
self.node.pid = 303
def test_from_kwargs(self):
with patch('celery.apps.multi.os.mkdir'):
n = Node.from_kwargs(
'foo@bar.com',
max_tasks_per_child=30, A='foo', Q='q1,q2', O='fair',
)
assert sorted(n.argv) == sorted([
'-m celery -A foo worker --detach',
f'--executable={n.executable}',
'-O fair',
'-n foo@bar.com',
'--logfile={}'.format(os.path.normpath('/var/log/celery/foo%I.log')),
'-Q q1,q2',
'--max-tasks-per-child=30',
'--pidfile={}'.format(os.path.normpath('/var/run/celery/foo.pid')),
'',
])
@patch('os.kill')
def test_send(self, kill):
assert self.node.send(9)
kill.assert_called_with(self.node.pid, 9)
@patch('os.kill')
def test_send__ESRCH(self, kill):
kill.side_effect = OSError()
kill.side_effect.errno = errno.ESRCH
assert not self.node.send(9)
kill.assert_called_with(self.node.pid, 9)
@patch('os.kill')
def test_send__error(self, kill):
kill.side_effect = OSError()
kill.side_effect.errno = errno.ENOENT
with pytest.raises(OSError):
self.node.send(9)
kill.assert_called_with(self.node.pid, 9)
def test_alive(self):
self.node.send = Mock(name='send')
assert self.node.alive() is self.node.send.return_value
self.node.send.assert_called_with(0)
def test_start(self):
self.node._waitexec = Mock(name='_waitexec')
self.node.start(env={'foo': 'bar'}, kw=2)
self.node._waitexec.assert_called_with(
self.node.argv, path=self.node.executable,
env={'foo': 'bar'}, kw=2,
)
@patch('celery.apps.multi.Popen')
def test_waitexec(self, Popen, argv=['A', 'B']):
on_spawn = Mock(name='on_spawn')
on_signalled = Mock(name='on_signalled')
on_failure = Mock(name='on_failure')
env = Mock(name='env')
self.node.handle_process_exit = Mock(name='handle_process_exit')
self.node._waitexec(
argv,
path='python',
env=env,
on_spawn=on_spawn,
on_signalled=on_signalled,
on_failure=on_failure,
)
Popen.assert_called_with(
self.node.prepare_argv(argv, 'python'), env=env)
self.node.handle_process_exit.assert_called_with(
Popen().wait(),
on_signalled=on_signalled,
on_failure=on_failure,
)
def test_handle_process_exit(self):
assert self.node.handle_process_exit(0) == 0
def test_handle_process_exit__failure(self):
on_failure = Mock(name='on_failure')
assert self.node.handle_process_exit(9, on_failure=on_failure) == 9
on_failure.assert_called_with(self.node, 9)
def test_handle_process_exit__signalled(self):
on_signalled = Mock(name='on_signalled')
assert self.node.handle_process_exit(
-9, on_signalled=on_signalled) == 9
on_signalled.assert_called_with(self.node, 9)
def test_logfile(self):
assert self.node.logfile == self.expander.return_value
self.expander.assert_called_with(os.path.normpath('/var/log/celery/%n%I.log'))
@patch('celery.apps.multi.os.path.exists')
def test_pidfile_default(self, mock_exists):
n = Node.from_kwargs(
'foo@bar.com',
)
assert n.options['--pidfile'] == os.path.normpath('/var/run/celery/%n.pid')
mock_exists.assert_any_call(os.path.normpath('/var/run/celery'))
@patch('celery.apps.multi.os.makedirs')
@patch('celery.apps.multi.os.path.exists', return_value=False)
def test_pidfile_custom(self, mock_exists, mock_dirs):
n = Node.from_kwargs(
'foo@bar.com',
pidfile='/var/run/demo/celery/%n.pid'
)
assert n.options['--pidfile'] == '/var/run/demo/celery/%n.pid'
try:
mock_exists.assert_any_call('/var/run/celery')
except AssertionError:
pass
else:
raise AssertionError("Expected exists('/var/run/celery') to not have been called.")
mock_exists.assert_any_call('/var/run/demo/celery')
mock_dirs.assert_any_call('/var/run/demo/celery')
class test_Cluster:
def setup_method(self):
self.Popen = self.patching('celery.apps.multi.Popen')
self.kill = self.patching('os.kill')
self.gethostname = self.patching('celery.apps.multi.gethostname')
self.gethostname.return_value = 'example.com'
self.Pidfile = self.patching('celery.apps.multi.Pidfile')
with patch('celery.apps.multi.os.mkdir'):
self.cluster = Cluster(
[Node('foo@example.com'),
Node('bar@example.com'),
Node('baz@example.com')],
on_stopping_preamble=Mock(name='on_stopping_preamble'),
on_send_signal=Mock(name='on_send_signal'),
on_still_waiting_for=Mock(name='on_still_waiting_for'),
on_still_waiting_progress=Mock(name='on_still_waiting_progress'),
on_still_waiting_end=Mock(name='on_still_waiting_end'),
on_node_start=Mock(name='on_node_start'),
on_node_restart=Mock(name='on_node_restart'),
on_node_shutdown_ok=Mock(name='on_node_shutdown_ok'),
on_node_status=Mock(name='on_node_status'),
on_node_signal=Mock(name='on_node_signal'),
on_node_signal_dead=Mock(name='on_node_signal_dead'),
on_node_down=Mock(name='on_node_down'),
on_child_spawn=Mock(name='on_child_spawn'),
on_child_signalled=Mock(name='on_child_signalled'),
on_child_failure=Mock(name='on_child_failure'),
)
def test_len(self):
assert len(self.cluster) == 3
def test_getitem(self):
assert self.cluster[0].name == 'foo@example.com'
def test_start(self):
self.cluster.start_node = Mock(name='start_node')
self.cluster.start()
self.cluster.start_node.assert_has_calls(
call(node) for node in self.cluster
)
def test_start_node(self):
self.cluster._start_node = Mock(name='_start_node')
node = self.cluster[0]
assert (self.cluster.start_node(node) is
self.cluster._start_node.return_value)
self.cluster.on_node_start.assert_called_with(node)
self.cluster._start_node.assert_called_with(node)
self.cluster.on_node_status.assert_called_with(
node, self.cluster._start_node(),
)
def test__start_node(self):
node = self.cluster[0]
node.start = Mock(name='node.start')
assert self.cluster._start_node(node) is node.start.return_value
node.start.assert_called_with(
self.cluster.env,
on_spawn=self.cluster.on_child_spawn,
on_signalled=self.cluster.on_child_signalled,
on_failure=self.cluster.on_child_failure,
)
def test_send_all(self):
nodes = [Mock(name='n1'), Mock(name='n2')]
self.cluster.getpids = Mock(name='getpids')
self.cluster.getpids.return_value = nodes
self.cluster.send_all(15)
self.cluster.on_node_signal.assert_has_calls(
call(node, 'TERM') for node in nodes
)
for node in nodes:
node.send.assert_called_with(15, self.cluster.on_node_signal_dead)
@t.skip.if_win32
def test_kill(self):
self.cluster.send_all = Mock(name='.send_all')
self.cluster.kill()
self.cluster.send_all.assert_called_with(signal.SIGKILL)
def test_getpids(self):
self.gethostname.return_value = 'e.com'
self.prepare_pidfile_for_getpids(self.Pidfile)
callback = Mock()
with patch('celery.apps.multi.os.mkdir'):
p = Cluster([
Node('foo@e.com'),
Node('bar@e.com'),
Node('baz@e.com'),
])
nodes = p.getpids(on_down=callback)
node_0, node_1 = nodes
assert node_0.name == 'foo@e.com'
assert sorted(node_0.argv) == sorted([
'',
f'--executable={node_0.executable}',
'--logfile={}'.format(os.path.normpath('/var/log/celery/foo%I.log')),
'--pidfile={}'.format(os.path.normpath('/var/run/celery/foo.pid')),
'-m celery worker --detach',
'-n foo@e.com',
])
assert node_0.pid == 10
assert node_1.name == 'bar@e.com'
assert sorted(node_1.argv) == sorted([
'',
f'--executable={node_1.executable}',
'--logfile={}'.format(os.path.normpath('/var/log/celery/bar%I.log')),
'--pidfile={}'.format(os.path.normpath('/var/run/celery/bar.pid')),
'-m celery worker --detach',
'-n bar@e.com',
])
assert node_1.pid == 11
# without callback, should work
nodes = p.getpids('celery worker')
def prepare_pidfile_for_getpids(self, Pidfile):
class pids:
def __init__(self, path):
self.path = path
def read_pid(self):
try:
return {os.path.normpath('/var/run/celery/foo.pid'): 10,
os.path.normpath('/var/run/celery/bar.pid'): 11}[self.path]
except KeyError:
raise ValueError()
self.Pidfile.side_effect = pids
|