3 from __future__ import absolute_import, print_function
9 import libcloud.common.types as cloud_types
13 from . import pykka_timeout
15 no_sleep = mock.patch('time.sleep', lambda n: None)
17 def arvados_node_mock(node_num=99, job_uuid=None, age=-1, **kwargs):
18 mod_time = datetime.datetime.utcnow() - datetime.timedelta(seconds=age)
19 mod_time_s = mod_time.strftime('%Y-%m-%dT%H:%M:%S.%fZ')
21 job_uuid = 'zzzzz-jjjjj-jobjobjobjobjob'
22 crunch_worker_state = 'idle' if (job_uuid is None) else 'busy'
23 node = {'uuid': 'zzzzz-yyyyy-{:015x}'.format(node_num),
24 'created_at': '2014-01-01T01:02:03.04050607Z',
25 'modified_at': mod_time_s,
26 'first_ping_at': kwargs.pop('first_ping_at', mod_time_s),
27 'last_ping_at': mod_time_s,
28 'slot_number': node_num,
29 'hostname': 'compute{}'.format(node_num),
30 'domain': 'zzzzz.arvadosapi.com',
31 'ip_address': ip_address_mock(node_num),
33 'crunch_worker_state': crunch_worker_state,
35 'info': {'ping_secret': 'defaulttestsecret', 'ec2_instance_id': str(node_num)}}
39 def cloud_object_mock(name_id, **extra):
40 # A very generic mock, useful for stubbing libcloud objects we
41 # only search for and pass around, like locations, subnets, etc.
42 cloud_object = mock.NonCallableMagicMock(['id', 'name'],
44 cloud_object.name = str(name_id)
45 cloud_object.id = 'id_' + cloud_object.name
46 cloud_object.extra = extra
50 def cloud_node_fqdn(node):
51 # We intentionally put the FQDN somewhere goofy to make sure tested code is
52 # using this function for lookups.
53 return node.extra.get('testname', 'NoTestName')
55 def ip_address_mock(last_octet):
56 return '10.20.30.{}'.format(last_octet)
58 class MockShutdownTimer(object):
59 def _set_state(self, is_open, next_opening):
60 self.window_open = lambda: is_open
61 self.next_opening = lambda: next_opening
64 class MockSize(object):
65 def __init__(self, factor):
66 self.id = 'z{}.test'.format(factor)
68 self.ram = 128 * factor
69 self.disk = 100 * factor
70 self.bandwidth = 16 * factor
71 self.price = float(factor)
74 def __eq__(self, other):
75 return self.id == other.id
78 class MockTimer(object):
79 def __init__(self, deliver_immediately=True):
80 self.deliver_immediately = deliver_immediately
82 self.lock = threading.Lock()
86 to_deliver = self.messages
88 for callback, args, kwargs in to_deliver:
90 callback(*args, **kwargs)
91 except pykka.ActorDeadError:
94 def schedule(self, want_time, callback, *args, **kwargs):
96 self.messages.append((callback, args, kwargs))
97 if self.deliver_immediately:
101 class ActorTestMixin(object):
102 FUTURE_CLASS = pykka.ThreadingFuture
103 TIMEOUT = pykka_timeout
106 pykka.ActorRegistry.stop_all()
108 def stop_proxy(self, proxy):
109 return proxy.actor_ref.stop(timeout=self.TIMEOUT)
111 def wait_for_assignment(self, proxy, attr_name, unassigned=None,
113 deadline = time.time() + timeout
115 loop_timeout = deadline - time.time()
116 if loop_timeout <= 0:
117 self.fail("actor did not assign {} in time".format(attr_name))
118 result = getattr(proxy, attr_name).get(loop_timeout)
119 if result is not unassigned:
123 class DriverTestMixin(object):
125 self.driver_mock = mock.MagicMock(name='driver_mock')
126 super(DriverTestMixin, self).setUp()
128 def new_driver(self, auth_kwargs={}, list_kwargs={}, create_kwargs={}):
129 create_kwargs.setdefault('ping_host', '100::')
130 return self.TEST_CLASS(
131 auth_kwargs, list_kwargs, create_kwargs,
132 driver_class=self.driver_mock)
134 def driver_method_args(self, method_name):
135 return getattr(self.driver_mock(), method_name).call_args
137 def test_driver_create_retry(self):
138 with mock.patch('time.sleep'):
139 driver_mock2 = mock.MagicMock(name='driver_mock2')
140 self.driver_mock.side_effect = (Exception("oops"), driver_mock2)
141 kwargs = {'user_id': 'foo'}
142 driver = self.new_driver(auth_kwargs=kwargs)
143 self.assertTrue(self.driver_mock.called)
144 self.assertIs(driver.real, driver_mock2)
146 def test_create_can_find_node_after_timeout(self, create_kwargs={}, node_extra={}):
147 driver = self.new_driver(create_kwargs=create_kwargs)
148 arv_node = arvados_node_mock()
149 cloud_node = cloud_node_mock(**node_extra)
150 cloud_node.name = driver.create_cloud_name(arv_node)
151 create_method = self.driver_mock().create_node
152 create_method.side_effect = cloud_types.LibcloudError("fake timeout")
153 list_method = self.driver_mock().list_nodes
154 list_method.return_value = [cloud_node]
155 actual = driver.create_node(MockSize(1), arv_node)
156 self.assertIs(cloud_node, actual)
158 def test_create_can_raise_exception_after_timeout(self):
159 driver = self.new_driver()
160 arv_node = arvados_node_mock()
161 create_method = self.driver_mock().create_node
162 create_method.side_effect = cloud_types.LibcloudError("fake timeout")
163 list_method = self.driver_mock().list_nodes
164 list_method.return_value = []
165 with self.assertRaises(cloud_types.LibcloudError) as exc_test:
166 driver.create_node(MockSize(1), arv_node)
167 self.assertIs(create_method.side_effect, exc_test.exception)
169 def check_node_found_after_timeout_has_fixed_size(self, size, cloud_node,
171 # This method needs to be called explicitly by driver test suites
173 self.driver_mock().list_sizes.return_value = [size]
174 driver = self.new_driver(create_kwargs=create_kwargs)
175 arv_node = arvados_node_mock()
176 cloud_node.name = driver.create_cloud_name(arv_node)
177 create_method = self.driver_mock().create_node
178 create_method.side_effect = cloud_types.LibcloudError("fake timeout")
179 self.driver_mock().list_nodes.return_value = [cloud_node]
180 actual = driver.create_node(size, arv_node)
181 self.assertIs(size, actual.size)
184 class RemotePollLoopActorTestMixin(ActorTestMixin):
185 def build_monitor(self, *args, **kwargs):
186 self.timer = mock.MagicMock(name='timer_mock')
187 self.client = mock.MagicMock(name='client_mock')
188 self.subscriber = mock.Mock(name='subscriber_mock')
189 self.monitor = self.TEST_CLASS.start(
190 self.client, self.timer, *args, **kwargs).proxy()
192 def cloud_node_mock(node_num=99, size=MockSize(1), **extra):
193 node = mock.NonCallableMagicMock(
194 ['id', 'name', 'state', 'public_ips', 'private_ips', 'driver', 'size',
197 node.id = str(node_num)
201 node.private_ips = [ip_address_mock(node_num)]