3 from __future__ import absolute_import, print_function
8 import arvados.errors as arverror
13 import arvnodeman.computenode.dispatch as dispatch
14 from . import testutil
16 class ComputeNodeSetupActorTestCase(testutil.ActorTestMixin, unittest.TestCase):
17 def make_mocks(self, arvados_effect=None):
18 if arvados_effect is None:
19 arvados_effect = [testutil.arvados_node_mock()]
20 self.arvados_effect = arvados_effect
21 self.timer = testutil.MockTimer()
22 self.api_client = mock.MagicMock(name='api_client')
23 self.api_client.nodes().create().execute.side_effect = arvados_effect
24 self.api_client.nodes().update().execute.side_effect = arvados_effect
25 self.cloud_client = mock.MagicMock(name='cloud_client')
26 self.cloud_client.create_node.return_value = testutil.cloud_node_mock(1)
28 def make_actor(self, arv_node=None):
29 if not hasattr(self, 'timer'):
30 self.make_mocks(arvados_effect=[arv_node])
31 self.setup_actor = dispatch.ComputeNodeSetupActor.start(
32 self.timer, self.api_client, self.cloud_client,
33 testutil.MockSize(1), arv_node).proxy()
35 def test_creation_without_arvados_node(self):
37 self.assertEqual(self.arvados_effect[-1],
38 self.setup_actor.arvados_node.get(self.TIMEOUT))
39 self.assertTrue(self.api_client.nodes().create().execute.called)
40 self.assertEqual(self.cloud_client.create_node(),
41 self.setup_actor.cloud_node.get(self.TIMEOUT))
43 def test_creation_with_arvados_node(self):
44 self.make_actor(testutil.arvados_node_mock())
45 self.assertEqual(self.arvados_effect[-1],
46 self.setup_actor.arvados_node.get(self.TIMEOUT))
47 self.assertTrue(self.api_client.nodes().update().execute.called)
48 self.assertEqual(self.cloud_client.create_node(),
49 self.setup_actor.cloud_node.get(self.TIMEOUT))
51 def test_failed_arvados_calls_retried(self):
53 arverror.ApiError(httplib2.Response({'status': '500'}), ""),
54 testutil.arvados_node_mock(),
57 self.wait_for_assignment(self.setup_actor, 'arvados_node')
59 def test_failed_cloud_calls_retried(self):
61 self.cloud_client.create_node.side_effect = [
62 Exception("test cloud creation error"),
63 self.cloud_client.create_node.return_value,
66 self.wait_for_assignment(self.setup_actor, 'cloud_node')
68 def test_failed_post_create_retried(self):
70 self.cloud_client.post_create_node.side_effect = [
71 Exception("test cloud post-create error"), None]
73 done = self.FUTURE_CLASS()
74 self.setup_actor.subscribe(done.set)
75 done.get(self.TIMEOUT)
76 self.assertEqual(2, self.cloud_client.post_create_node.call_count)
78 def test_stop_when_no_cloud_node(self):
80 arverror.ApiError(httplib2.Response({'status': '500'}), ""))
82 self.setup_actor.stop_if_no_cloud_node()
84 self.setup_actor.actor_ref.actor_stopped.wait(self.TIMEOUT))
86 def test_no_stop_when_cloud_node(self):
88 self.wait_for_assignment(self.setup_actor, 'cloud_node')
89 self.setup_actor.stop_if_no_cloud_node().get(self.TIMEOUT)
90 self.assertTrue(self.stop_proxy(self.setup_actor),
91 "actor was stopped by stop_if_no_cloud_node")
93 def test_subscribe(self):
95 arverror.ApiError(httplib2.Response({'status': '500'}), ""))
97 subscriber = mock.Mock(name='subscriber_mock')
98 self.setup_actor.subscribe(subscriber)
99 self.api_client.nodes().create().execute.side_effect = [
100 testutil.arvados_node_mock()]
101 self.wait_for_assignment(self.setup_actor, 'cloud_node')
102 self.assertEqual(self.setup_actor.actor_ref.actor_urn,
103 subscriber.call_args[0][0].actor_ref.actor_urn)
105 def test_late_subscribe(self):
107 subscriber = mock.Mock(name='subscriber_mock')
108 self.wait_for_assignment(self.setup_actor, 'cloud_node')
109 self.setup_actor.subscribe(subscriber).get(self.TIMEOUT)
110 self.stop_proxy(self.setup_actor)
111 self.assertEqual(self.setup_actor.actor_ref.actor_urn,
112 subscriber.call_args[0][0].actor_ref.actor_urn)
115 class ComputeNodeShutdownActorMixin(testutil.ActorTestMixin):
116 def make_mocks(self, cloud_node=None, arvados_node=None,
118 self.timer = testutil.MockTimer()
119 self.shutdowns = testutil.MockShutdownTimer()
120 self.shutdowns._set_state(shutdown_open, 300)
121 self.cloud_client = mock.MagicMock(name='cloud_client')
122 self.updates = mock.MagicMock(name='update_mock')
123 if cloud_node is None:
124 cloud_node = testutil.cloud_node_mock()
125 self.cloud_node = cloud_node
126 self.arvados_node = arvados_node
128 def make_actor(self, cancellable=True):
129 if not hasattr(self, 'timer'):
131 monitor_actor = dispatch.ComputeNodeMonitorActor.start(
132 self.cloud_node, time.time(), self.shutdowns,
133 testutil.cloud_node_fqdn, self.timer, self.updates,
135 self.shutdown_actor = self.ACTOR_CLASS.start(
136 self.timer, self.cloud_client, monitor_actor, cancellable).proxy()
137 self.monitor_actor = monitor_actor.proxy()
139 def check_success_flag(self, expected, allow_msg_count=1):
140 # allow_msg_count is the number of internal messages that may
141 # need to be handled for shutdown to finish.
142 for try_num in range(1 + allow_msg_count):
143 last_flag = self.shutdown_actor.success.get(self.TIMEOUT)
144 if last_flag is expected:
147 self.fail("success flag {} is not {}".format(last_flag, expected))
149 def test_uncancellable_shutdown(self, *mocks):
150 self.make_mocks(shutdown_open=False)
151 self.cloud_client.destroy_node.return_value = False
152 self.make_actor(cancellable=False)
153 self.check_success_flag(None, 0)
154 self.shutdowns._set_state(True, 600)
155 self.cloud_client.destroy_node.return_value = True
156 self.check_success_flag(True)
159 class ComputeNodeShutdownActorTestCase(ComputeNodeShutdownActorMixin,
161 ACTOR_CLASS = dispatch.ComputeNodeShutdownActor
163 def test_easy_shutdown(self):
165 self.check_success_flag(True)
166 self.assertTrue(self.cloud_client.destroy_node.called)
168 def test_shutdown_cancelled_when_window_closes(self):
169 self.make_mocks(shutdown_open=False)
171 self.check_success_flag(False, 2)
172 self.assertFalse(self.cloud_client.destroy_node.called)
174 def test_shutdown_retries_when_cloud_fails(self):
176 self.cloud_client.destroy_node.return_value = False
178 self.assertIsNone(self.shutdown_actor.success.get(self.TIMEOUT))
179 self.cloud_client.destroy_node.return_value = True
180 self.check_success_flag(True)
182 def test_late_subscribe(self):
184 subscriber = mock.Mock(name='subscriber_mock')
185 self.shutdown_actor.subscribe(subscriber).get(self.TIMEOUT)
186 self.stop_proxy(self.shutdown_actor)
187 self.assertTrue(subscriber.called)
188 self.assertEqual(self.shutdown_actor.actor_ref.actor_urn,
189 subscriber.call_args[0][0].actor_ref.actor_urn)
192 class ComputeNodeUpdateActorTestCase(testutil.ActorTestMixin,
194 def make_actor(self):
195 self.driver = mock.MagicMock(name='driver_mock')
196 self.updater = dispatch.ComputeNodeUpdateActor.start(self.driver).proxy()
198 def test_node_sync(self):
200 cloud_node = testutil.cloud_node_mock()
201 arv_node = testutil.arvados_node_mock()
202 self.updater.sync_node(cloud_node, arv_node).get(self.TIMEOUT)
203 self.driver().sync_node.assert_called_with(cloud_node, arv_node)
206 class ComputeNodeMonitorActorTestCase(testutil.ActorTestMixin,
208 def make_mocks(self, node_num):
209 self.shutdowns = testutil.MockShutdownTimer()
210 self.shutdowns._set_state(False, 300)
211 self.timer = mock.MagicMock(name='timer_mock')
212 self.updates = mock.MagicMock(name='update_mock')
213 self.cloud_mock = testutil.cloud_node_mock(node_num)
214 self.subscriber = mock.Mock(name='subscriber_mock')
216 def make_actor(self, node_num=1, arv_node=None, start_time=None):
217 if not hasattr(self, 'cloud_mock'):
218 self.make_mocks(node_num)
219 if start_time is None:
220 start_time = time.time()
221 self.node_actor = dispatch.ComputeNodeMonitorActor.start(
222 self.cloud_mock, start_time, self.shutdowns,
223 testutil.cloud_node_fqdn, self.timer, self.updates,
225 self.node_actor.subscribe(self.subscriber).get(self.TIMEOUT)
227 def node_state(self, *states):
228 return self.node_actor.in_state(*states).get(self.TIMEOUT)
230 def test_in_state_when_unpaired(self):
232 self.assertIsNone(self.node_state('idle', 'busy'))
234 def test_in_state_when_pairing_stale(self):
235 self.make_actor(arv_node=testutil.arvados_node_mock(
236 job_uuid=None, age=90000))
237 self.assertIsNone(self.node_state('idle', 'busy'))
239 def test_in_state_when_no_state_available(self):
240 self.make_actor(arv_node=testutil.arvados_node_mock(
241 crunch_worker_state=None))
242 self.assertIsNone(self.node_state('idle', 'busy'))
244 def test_in_idle_state(self):
245 self.make_actor(2, arv_node=testutil.arvados_node_mock(job_uuid=None))
246 self.assertTrue(self.node_state('idle'))
247 self.assertFalse(self.node_state('busy'))
248 self.assertTrue(self.node_state('idle', 'busy'))
250 def test_in_busy_state(self):
251 self.make_actor(3, arv_node=testutil.arvados_node_mock(job_uuid=True))
252 self.assertFalse(self.node_state('idle'))
253 self.assertTrue(self.node_state('busy'))
254 self.assertTrue(self.node_state('idle', 'busy'))
256 def test_init_shutdown_scheduling(self):
258 self.assertTrue(self.timer.schedule.called)
259 self.assertEqual(300, self.timer.schedule.call_args[0][0])
261 def test_shutdown_window_close_scheduling(self):
263 self.shutdowns._set_state(False, 600)
264 self.timer.schedule.reset_mock()
265 self.node_actor.consider_shutdown().get(self.TIMEOUT)
266 self.stop_proxy(self.node_actor)
267 self.assertTrue(self.timer.schedule.called)
268 self.assertEqual(600, self.timer.schedule.call_args[0][0])
269 self.assertFalse(self.subscriber.called)
271 def test_shutdown_subscription(self):
273 self.shutdowns._set_state(True, 600)
274 self.node_actor.consider_shutdown().get(self.TIMEOUT)
275 self.assertTrue(self.subscriber.called)
276 self.assertEqual(self.node_actor.actor_ref.actor_urn,
277 self.subscriber.call_args[0][0].actor_ref.actor_urn)
279 def test_shutdown_without_arvados_node(self):
281 self.shutdowns._set_state(True, 600)
282 self.assertTrue(self.node_actor.shutdown_eligible().get(self.TIMEOUT))
284 def test_no_shutdown_without_arvados_node_and_old_cloud_node(self):
285 self.make_actor(start_time=0)
286 self.shutdowns._set_state(True, 600)
287 self.assertFalse(self.node_actor.shutdown_eligible().get(self.TIMEOUT))
289 def test_no_shutdown_when_window_closed(self):
290 self.make_actor(3, testutil.arvados_node_mock(3, job_uuid=None))
291 self.assertFalse(self.node_actor.shutdown_eligible().get(self.TIMEOUT))
293 def test_no_shutdown_when_node_running_job(self):
294 self.make_actor(4, testutil.arvados_node_mock(4, job_uuid=True))
295 self.shutdowns._set_state(True, 600)
296 self.assertFalse(self.node_actor.shutdown_eligible().get(self.TIMEOUT))
298 def test_no_shutdown_when_node_state_unknown(self):
299 self.make_actor(5, testutil.arvados_node_mock(
300 5, crunch_worker_state=None))
301 self.shutdowns._set_state(True, 600)
302 self.assertFalse(self.node_actor.shutdown_eligible().get(self.TIMEOUT))
304 def test_no_shutdown_when_node_state_stale(self):
305 self.make_actor(6, testutil.arvados_node_mock(6, age=90000))
306 self.shutdowns._set_state(True, 600)
307 self.assertFalse(self.node_actor.shutdown_eligible().get(self.TIMEOUT))
309 def test_arvados_node_match(self):
311 arv_node = testutil.arvados_node_mock(
312 2, hostname='compute-two.zzzzz.arvadosapi.com')
313 pair_id = self.node_actor.offer_arvados_pair(arv_node).get(self.TIMEOUT)
314 self.assertEqual(self.cloud_mock.id, pair_id)
315 self.stop_proxy(self.node_actor)
316 self.updates.sync_node.assert_called_with(self.cloud_mock, arv_node)
318 def test_arvados_node_mismatch(self):
320 arv_node = testutil.arvados_node_mock(1)
322 self.node_actor.offer_arvados_pair(arv_node).get(self.TIMEOUT))
324 def test_arvados_node_mismatch_first_ping_too_early(self):
326 arv_node = testutil.arvados_node_mock(
327 4, first_ping_at='1971-03-02T14:15:16.1717282Z')
329 self.node_actor.offer_arvados_pair(arv_node).get(self.TIMEOUT))
331 def test_update_cloud_node(self):
334 self.cloud_mock.id = '1'
335 self.node_actor.update_cloud_node(self.cloud_mock)
336 current_cloud = self.node_actor.cloud_node.get(self.TIMEOUT)
337 self.assertEqual([testutil.ip_address_mock(2)],
338 current_cloud.private_ips)
340 def test_missing_cloud_node_update(self):
342 self.node_actor.update_cloud_node(None)
343 current_cloud = self.node_actor.cloud_node.get(self.TIMEOUT)
344 self.assertEqual([testutil.ip_address_mock(1)],
345 current_cloud.private_ips)
347 def test_update_arvados_node(self):
349 job_uuid = 'zzzzz-jjjjj-updatejobnode00'
350 new_arvados = testutil.arvados_node_mock(3, job_uuid)
351 self.node_actor.update_arvados_node(new_arvados)
352 current_arvados = self.node_actor.arvados_node.get(self.TIMEOUT)
353 self.assertEqual(job_uuid, current_arvados['job_uuid'])
355 def test_missing_arvados_node_update(self):
356 self.make_actor(4, testutil.arvados_node_mock(4))
357 self.node_actor.update_arvados_node(None)
358 current_arvados = self.node_actor.arvados_node.get(self.TIMEOUT)
359 self.assertEqual(testutil.ip_address_mock(4),
360 current_arvados['ip_address'])
362 def test_update_arvados_node_syncs_when_fqdn_mismatch(self):
364 self.cloud_mock.extra['testname'] = 'cloudfqdn.zzzzz.arvadosapi.com'
366 arv_node = testutil.arvados_node_mock(5)
367 self.node_actor.update_arvados_node(arv_node).get(self.TIMEOUT)
368 self.assertEqual(1, self.updates.sync_node.call_count)
370 def test_update_arvados_node_skips_sync_when_fqdn_match(self):
372 arv_node = testutil.arvados_node_mock(6)
373 self.cloud_mock.extra['testname'] ='{n[hostname]}.{n[domain]}'.format(
376 self.node_actor.update_arvados_node(arv_node).get(self.TIMEOUT)
377 self.assertEqual(0, self.updates.sync_node.call_count)