sdk/python/tests/arvados_testutil.py

   1 #!/usr/bin/env python
   2
   3 import arvados
   4 import errno
   5 import hashlib
   6 import httplib
   7 import httplib2
   8 import io
   9 import mock
  10 import os
  11 import Queue
  12 import requests
  13 import shutil
  14 import tempfile
  15 import unittest
  16
  17 # Use this hostname when you want to make sure the traffic will be
  18 # instantly refused.  100::/64 is a dedicated black hole.
  19 TEST_HOST = '100::'
  20
  21 skip_sleep = mock.patch('time.sleep', lambda n: None)  # clown'll eat me
  22
  23 def queue_with(items):
  24     """Return a thread-safe iterator that yields the given items.
  25
  26     +items+ can be given as an array or an iterator. If an iterator is
  27     given, it will be consumed to fill the queue before queue_with()
  28     returns.
  29     """
  30     queue = Queue.Queue()
  31     for val in items:
  32         queue.put(val)
  33     return lambda *args, **kwargs: queue.get(block=False)
  34
  35 # fake_httplib2_response and mock_responses
  36 # mock calls to httplib2.Http.request()
  37 def fake_httplib2_response(code, **headers):
  38     headers.update(status=str(code),
  39                    reason=httplib.responses.get(code, "Unknown Response"))
  40     return httplib2.Response(headers)
  41
  42 def mock_responses(body, *codes, **headers):
  43     return mock.patch('httplib2.Http.request', side_effect=queue_with((
  44         (fake_httplib2_response(code, **headers), body) for code in codes)))
  45
  46 # fake_requests_response, mock_get_responses and mock_put_responses
  47 # mock calls to requests.get() and requests.put()
  48 def fake_requests_response(code, body, **headers):
  49     r = requests.Response()
  50     r.status_code = code
  51     r.reason = httplib.responses.get(code, "Unknown Response")
  52     r.headers = headers
  53     r.raw = io.BytesIO(body)
  54     return r
  55
  56 def mock_put_responses(body, *codes, **headers):
  57     m = mock.MagicMock()
  58     if isinstance(body, tuple):
  59         codes = list(codes)
  60         codes.insert(0, body)
  61         m.return_value.put.side_effect = queue_with((fake_requests_response(code, b, **headers) for b, code in codes))
  62     else:
  63         m.return_value.put.side_effect = queue_with((fake_requests_response(code, body, **headers) for code in codes))
  64     return mock.patch('requests.Session', m)
  65
  66 def mock_get_responses(body, *codes, **headers):
  67     m = mock.MagicMock()
  68     m.return_value.get.side_effect = queue_with((fake_requests_response(code, body, **headers) for code in codes))
  69     return mock.patch('requests.Session', m)
  70
  71 def mock_get(side_effect):
  72     m = mock.MagicMock()
  73     m.return_value.get.side_effect = side_effect
  74     return mock.patch('requests.Session', m)
  75
  76 def mock_put(side_effect):
  77     m = mock.MagicMock()
  78     m.return_value.put.side_effect = side_effect
  79     return mock.patch('requests.Session', m)
  80
  81 class MockStreamReader(object):
  82     def __init__(self, name='.', *data):
  83         self._name = name
  84         self._data = ''.join(data)
  85         self._data_locators = ['{}+{}'.format(hashlib.md5(d).hexdigest(),
  86                                               len(d)) for d in data]
  87         self.num_retries = 0
  88
  89     def name(self):
  90         return self._name
  91
  92     def readfrom(self, start, size, num_retries=None):
  93         self._readfrom(start, size, num_retries=num_retries)
  94
  95     def _readfrom(self, start, size, num_retries=None):
  96         return self._data[start:start + size]
  97
  98 class ApiClientMock(object):
  99     def api_client_mock(self):
 100         return mock.MagicMock(name='api_client_mock')
 101
 102     def mock_keep_services(self, api_mock=None, status=200, count=12,
 103                            service_type='disk',
 104                            service_host=None,
 105                            service_port=None,
 106                            service_ssl_flag=False):
 107         if api_mock is None:
 108             api_mock = self.api_client_mock()
 109         body = {
 110             'items_available': count,
 111             'items': [{
 112                 'uuid': 'zzzzz-bi6l4-{:015x}'.format(i),
 113                 'owner_uuid': 'zzzzz-tpzed-000000000000000',
 114                 'service_host': service_host or 'keep0x{:x}'.format(i),
 115                 'service_port': service_port or 65535-i,
 116                 'service_ssl_flag': service_ssl_flag,
 117                 'service_type': service_type,
 118             } for i in range(0, count)]
 119         }
 120         self._mock_api_call(api_mock.keep_services().accessible, status, body)
 121         return api_mock
 122
 123     def _mock_api_call(self, mock_method, code, body):
 124         mock_method = mock_method().execute
 125         if code == 200:
 126             mock_method.return_value = body
 127         else:
 128             mock_method.side_effect = arvados.errors.ApiError(
 129                 fake_httplib2_response(code), "{}")
 130
 131
 132 class ArvadosBaseTestCase(unittest.TestCase):
 133     # This class provides common utility functions for our tests.
 134
 135     def setUp(self):
 136         self._tempdirs = []
 137
 138     def tearDown(self):
 139         for workdir in self._tempdirs:
 140             shutil.rmtree(workdir, ignore_errors=True)
 141
 142     def make_tmpdir(self):
 143         self._tempdirs.append(tempfile.mkdtemp())
 144         return self._tempdirs[-1]
 145
 146     def data_file(self, filename):
 147         try:
 148             basedir = os.path.dirname(__file__)
 149         except NameError:
 150             basedir = '.'
 151         return open(os.path.join(basedir, 'data', filename))
 152
 153     def build_directory_tree(self, tree):
 154         tree_root = self.make_tmpdir()
 155         for leaf in tree:
 156             path = os.path.join(tree_root, leaf)
 157             try:
 158                 os.makedirs(os.path.dirname(path))
 159             except OSError as error:
 160                 if error.errno != errno.EEXIST:
 161                     raise
 162             with open(path, 'w') as tmpfile:
 163                 tmpfile.write(leaf)
 164         return tree_root
 165
 166     def make_test_file(self, text="test"):
 167         testfile = tempfile.NamedTemporaryFile()
 168         testfile.write(text)
 169         testfile.flush()
 170         return testfile