Merge branch '4520-arv-copy-project-uuid' closes #4520
[arvados.git] / services / nodemanager / tests / testutil.py
1 #!/usr/bin/env python
2
3 from __future__ import absolute_import, print_function
4
5 import datetime
6 import threading
7 import time
8
9 import mock
10 import pykka
11
12 from . import pykka_timeout
13
14 no_sleep = mock.patch('time.sleep', lambda n: None)
15
16 def arvados_node_mock(node_num=99, job_uuid=None, age=0, **kwargs):
17     mod_time = datetime.datetime.utcnow() - datetime.timedelta(seconds=age)
18     if job_uuid is True:
19         job_uuid = 'zzzzz-jjjjj-jobjobjobjobjob'
20     crunch_worker_state = 'idle' if (job_uuid is None) else 'busy'
21     node = {'uuid': 'zzzzz-yyyyy-{:015x}'.format(node_num),
22             'created_at': '2014-01-01T01:02:03.04050607Z',
23             'modified_at': mod_time.strftime('%Y-%m-%dT%H:%M:%S.%fZ'),
24             'slot_number': node_num,
25             'hostname': 'compute{}'.format(node_num),
26             'domain': 'zzzzz.arvadosapi.com',
27             'ip_address': ip_address_mock(node_num),
28             'job_uuid': job_uuid,
29             'crunch_worker_state': crunch_worker_state,
30             'info': {'ping_secret': 'defaulttestsecret'}}
31     node.update(kwargs)
32     return node
33
34 def cloud_object_mock(name_id):
35     # A very generic mock, useful for stubbing libcloud objects we
36     # only search for and pass around, like locations, subnets, etc.
37     cloud_object = mock.NonCallableMagicMock(['id', 'name'],
38                                              name='cloud_object')
39     cloud_object.id = str(name_id)
40     cloud_object.name = cloud_object.id.upper()
41     return cloud_object
42
43 def cloud_node_mock(node_num=99, **extra):
44     node = mock.NonCallableMagicMock(
45         ['id', 'name', 'state', 'public_ips', 'private_ips', 'driver', 'size',
46          'image', 'extra'],
47         name='cloud_node')
48     node.id = str(node_num)
49     node.name = node.id
50     node.public_ips = []
51     node.private_ips = [ip_address_mock(node_num)]
52     node.extra = extra
53     return node
54
55 def ip_address_mock(last_octet):
56     return '10.20.30.{}'.format(last_octet)
57
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
62
63
64 class MockSize(object):
65     def __init__(self, factor):
66         self.id = 'z{}.test'.format(factor)
67         self.name = self.id
68         self.ram = 128 * factor
69         self.disk = 100 * factor
70         self.bandwidth = 16 * factor
71         self.price = float(factor)
72         self.extra = {}
73
74     def __eq__(self, other):
75         return self.id == other.id
76
77
78 class MockTimer(object):
79     def __init__(self, deliver_immediately=True):
80         self.deliver_immediately = deliver_immediately
81         self.messages = []
82         self.lock = threading.Lock()
83
84     def deliver(self):
85         with self.lock:
86             to_deliver = self.messages
87             self.messages = []
88         for callback, args, kwargs in to_deliver:
89             callback(*args, **kwargs)
90
91     def schedule(self, want_time, callback, *args, **kwargs):
92         with self.lock:
93             self.messages.append((callback, args, kwargs))
94         if self.deliver_immediately:
95             self.deliver()
96
97
98 class ActorTestMixin(object):
99     FUTURE_CLASS = pykka.ThreadingFuture
100     TIMEOUT = pykka_timeout
101
102     def tearDown(self):
103         pykka.ActorRegistry.stop_all()
104
105     def stop_proxy(self, proxy):
106         return proxy.actor_ref.stop(timeout=self.TIMEOUT)
107
108     def wait_for_assignment(self, proxy, attr_name, unassigned=None,
109                             timeout=TIMEOUT):
110         deadline = time.time() + timeout
111         while True:
112             loop_timeout = deadline - time.time()
113             if loop_timeout <= 0:
114                 self.fail("actor did not assign {} in time".format(attr_name))
115             result = getattr(proxy, attr_name).get(loop_timeout)
116             if result is not unassigned:
117                 return result
118
119
120 class DriverTestMixin(object):
121     def setUp(self):
122         self.driver_mock = mock.MagicMock(name='driver_mock')
123         super(DriverTestMixin, self).setUp()
124
125     def new_driver(self, auth_kwargs={}, list_kwargs={}, create_kwargs={}):
126         create_kwargs.setdefault('ping_host', '100::')
127         return self.TEST_CLASS(
128             auth_kwargs, list_kwargs, create_kwargs,
129             driver_class=self.driver_mock)
130
131     def driver_method_args(self, method_name):
132         return getattr(self.driver_mock(), method_name).call_args
133
134
135 class RemotePollLoopActorTestMixin(ActorTestMixin):
136     def build_monitor(self, *args, **kwargs):
137         self.timer = mock.MagicMock(name='timer_mock')
138         self.client = mock.MagicMock(name='client_mock')
139         self.subscriber = mock.Mock(name='subscriber_mock')
140         self.monitor = self.TEST_CLASS.start(
141             self.client, self.timer, *args, **kwargs).proxy()