5414: Merge branch 'master' into 5414-keep-service-hints
[arvados.git] / sdk / python / tests / arvados_testutil.py
index 369d5618044036c30698bb263a2b1aa188b3621b..a10802ae81b7b2bf439f8452052a0ba1e9643617 100644 (file)
 #!/usr/bin/env python
 
+import arvados
 import errno
+import hashlib
+import httplib
+import httplib2
+import io
+import mock
 import os
+import Queue
+import requests
 import shutil
 import tempfile
 import unittest
 
+# Use this hostname when you want to make sure the traffic will be
+# instantly refused.  100::/64 is a dedicated black hole.
+TEST_HOST = '100::'
+
+skip_sleep = mock.patch('time.sleep', lambda n: None)  # clown'll eat me
+
+def queue_with(items):
+    """Return a thread-safe iterator that yields the given items.
+
+    +items+ can be given as an array or an iterator. If an iterator is
+    given, it will be consumed to fill the queue before queue_with()
+    returns.
+    """
+    queue = Queue.Queue()
+    for val in items:
+        queue.put(val)
+    return lambda *args, **kwargs: queue.get(block=False)
+
+# fake_httplib2_response and mock_responses
+# mock calls to httplib2.Http.request()
+def fake_httplib2_response(code, **headers):
+    headers.update(status=str(code),
+                   reason=httplib.responses.get(code, "Unknown Response"))
+    return httplib2.Response(headers)
+
+def mock_responses(body, *codes, **headers):
+    return mock.patch('httplib2.Http.request', side_effect=queue_with((
+        (fake_httplib2_response(code, **headers), body) for code in codes)))
+
+# fake_requests_response, mock_get_responses and mock_put_responses
+# mock calls to requests.get() and requests.put()
+def fake_requests_response(code, body, **headers):
+    r = requests.Response()
+    r.status_code = code
+    r.reason = httplib.responses.get(code, "Unknown Response")
+    r.headers = headers
+    r.raw = io.BytesIO(body)
+    return r
+
+# The following methods patch requests.Session(), where return_value is a mock
+# Session object.  The put/get attributes are set on mock Session, and the
+# desired put/get behavior is set on the put/get mocks.
+
+def mock_put_responses(body, *codes, **headers):
+    m = mock.MagicMock()
+    if isinstance(body, tuple):
+        codes = list(codes)
+        codes.insert(0, body)
+        m.return_value.put.side_effect = queue_with((fake_requests_response(code, b, **headers) for b, code in codes))
+    else:
+        m.return_value.put.side_effect = queue_with((fake_requests_response(code, body, **headers) for code in codes))
+    return mock.patch('requests.Session', m)
+
+def mock_get_responses(body, *codes, **headers):
+    m = mock.MagicMock()
+    m.return_value.get.side_effect = queue_with((fake_requests_response(code, body, **headers) for code in codes))
+    return mock.patch('requests.Session', m)
+
+def mock_get(side_effect):
+    m = mock.MagicMock()
+    m.return_value.get.side_effect = side_effect
+    return mock.patch('requests.Session', m)
+
+def mock_put(side_effect):
+    m = mock.MagicMock()
+    m.return_value.put.side_effect = side_effect
+    return mock.patch('requests.Session', m)
+
+class MockStreamReader(object):
+    def __init__(self, name='.', *data):
+        self._name = name
+        self._data = ''.join(data)
+        self._data_locators = ['{}+{}'.format(hashlib.md5(d).hexdigest(),
+                                              len(d)) for d in data]
+        self.num_retries = 0
+
+    def name(self):
+        return self._name
+
+    def readfrom(self, start, size, num_retries=None):
+        return self._data[start:start + size]
+
+class ApiClientMock(object):
+    def api_client_mock(self):
+        return mock.MagicMock(name='api_client_mock')
+
+    def mock_keep_services(self, api_mock=None, status=200, count=12,
+                           service_type='disk',
+                           service_host=None,
+                           service_port=None,
+                           service_ssl_flag=False,
+                           additional_services=[]):
+        if api_mock is None:
+            api_mock = self.api_client_mock()
+        body = {
+            'items_available': count,
+            'items': [{
+                'uuid': 'zzzzz-bi6l4-{:015x}'.format(i),
+                'owner_uuid': 'zzzzz-tpzed-000000000000000',
+                'service_host': service_host or 'keep0x{:x}'.format(i),
+                'service_port': service_port or 65535-i,
+                'service_ssl_flag': service_ssl_flag,
+                'service_type': service_type,
+            } for i in range(0, count)] + additional_services
+        }
+        self._mock_api_call(api_mock.keep_services().accessible, status, body)
+        return api_mock
+
+    def _mock_api_call(self, mock_method, code, body):
+        mock_method = mock_method().execute
+        if code == 200:
+            mock_method.return_value = body
+        else:
+            mock_method.side_effect = arvados.errors.ApiError(
+                fake_httplib2_response(code), "{}")
+
+
 class ArvadosBaseTestCase(unittest.TestCase):
     # This class provides common utility functions for our tests.