def test_init(self): config = dict(endpoint='https://test.com/path/', token=str(uuid.uuid4()), timeout=1, retry=dict(total=3), headers={'Custom': 'Field 123'}, verify=False, proxies={'https': 'http://proxy.com'}) with DWaveAPIClient(**config) as client: session = client.session self.assertIsInstance(session, requests.Session) self.assertEqual(session.base_url, config['endpoint']) self.assertEqual(session.cert, None) self.assertEqual(session.headers['X-Auth-Token'], config['token']) self.assertEqual(session.headers['Custom'], config['headers']['Custom']) self.assertIn(__packagename__, session.headers['User-Agent']) self.assertIn(__version__, session.headers['User-Agent']) self.assertEqual(session.verify, config['verify']) self.assertEqual(session.proxies, config['proxies']) # verify Retry object config retry = session.get_adapter('https://').max_retries self.assertEqual(retry.total, config['retry']['total'])
def test_non_json(self, m): """Non-JSON OK response is unexpected.""" m.get(requests_mock.ANY, text='text', status_code=200) with DWaveAPIClient(endpoint='https://mock') as client: with self.assertRaises(exceptions.ResourceBadResponseError) as exc: client.session.get('test')
def test_defaults(self): with self.assertRaises(ValueError): DWaveAPIClient() endpoint = constants.DEFAULT_METADATA_API_ENDPOINT client = DWaveAPIClient(endpoint=endpoint) defaults = DWaveAPIClient.DEFAULTS.copy() defaults.update(endpoint=endpoint) self.assertEqual(client.config, defaults) self.assertIsInstance(client.session, requests.Session) # verify Retry object config retry = client.session.get_adapter('https://').max_retries conf = DWaveAPIClient.DEFAULTS['retry'] client.close() self.assertEqual(retry.total, conf['total'])
class ResourceBase: """A class for interacting with a SAPI resource.""" resource_path = None def _patch_session(self): # anchor all session requests at the new base path if self.resource_path and self.session: self.session.base_url = self.session.create_url(self.resource_path) def __init__(self, **config): self.client = DWaveAPIClient(**config) self.session = self.client.session self._patch_session() def close(self): self.client.close() def __enter__(self): return self def __exit__(self, exc_type, exc_value, traceback): self.close() @classmethod def from_client_config(cls, client: Union[DWaveAPIClient, 'dwave.cloud.client.base.Client']): """Create Resource instance configured from a :class:`~dwave.cloud.client.base.Client' instance. """ # TODO: also accept configuration dict/dataclass when config/client refactored if isinstance(client, DWaveAPIClient): return cls(**client.config) else: # assume isinstance(client, dwave.cloud.Client), without importing sapiclient = SolverAPIClient.from_client_config(client) return cls(**sapiclient.config)
def test_request(self, m): """Config options are respected when making requests.""" config = dict(endpoint='https://test.com/path/', token=str(uuid.uuid4()), headers={'Custom': 'Field 123'}) auth_headers = {'X-Auth-Token': config['token']} data = dict(answer=123) m.get(requests_mock.ANY, status_code=401) m.get(requests_mock.ANY, status_code=404, request_headers=auth_headers) m.get(config['endpoint'], json=data, request_headers=config['headers']) with DWaveAPIClient(**config) as client: self.assertEqual(client.session.get('').json(), data)
def test_unknown_errors(self, m): """Unknown status code with plain text msg raised as general req exc.""" error_msg = "I'm a teapot" error_code = 418 m.get(requests_mock.ANY, text=error_msg, status_code=error_code) with DWaveAPIClient(endpoint='https://mock') as client: with self.assertRaisesRegex(exceptions.RequestError, error_msg) as exc: client.session.get('test') self.assertEqual(exc.error_msg, error_msg) self.assertEqual(exc.error_code, error_code)
def test_plain_text_error(self, m): """Error messages in plain text/body correctly initialize exc.""" error_msg = "I looked, but couldn't find." error_code = 404 m.get(requests_mock.ANY, text=error_msg, status_code=error_code) with DWaveAPIClient(endpoint='https://mock') as client: with self.assertRaisesRegex(exceptions.ResourceNotFoundError, error_msg) as exc: client.session.get('test') self.assertEqual(exc.error_msg, error_msg) self.assertEqual(exc.error_code, error_code)
def test_paths(self, m): """Path translation works.""" baseurl = 'https://test.com' config = dict(endpoint=baseurl) path_a, path_b = 'a', 'b' data_a, data_b = dict(answer='a'), dict(answer='b') m.get(requests_mock.ANY, status_code=404) m.get(f"{baseurl}/{path_a}", json=data_a) m.get(f"{baseurl}/{path_b}", json=data_b) with DWaveAPIClient(**config) as client: self.assertEqual(client.session.get(path_a).json(), data_a) self.assertEqual(client.session.get(path_b).json(), data_b)
def test_structured_error_response(self, m): """Error response dict correctly initializes exc.""" error_msg = "I looked, but couldn't find." error_code = 404 error = dict(error_msg=error_msg, error_code=error_code) m.get(requests_mock.ANY, json=error, status_code=error_code) with DWaveAPIClient(endpoint='https://mock') as client: with self.assertRaisesRegex(exceptions.ResourceNotFoundError, error_msg) as exc: client.session.get('test') self.assertEqual(exc.error_msg, error_msg) self.assertEqual(exc.error_code, error_code)
def test_session_history(self, m): """Session history is available.""" baseurl = 'https://test.com' config = dict(endpoint=baseurl, history_size=1) m.get(requests_mock.ANY, status_code=404) m.get(f"{baseurl}/path", json=dict(data=True)) with DWaveAPIClient(**config) as client: client.session.get('path') self.assertEqual(client.session.history[-1].request.path_url, '/path') with self.assertRaises(exceptions.ResourceNotFoundError): client.session.get('unknown') self.assertEqual( client.session.history[-1].exception.error_code, 404) client.session.get('/path') self.assertEqual(client.session.history[-1].request.path_url, '/path')
def __init__(self, **config): self.client = DWaveAPIClient(**config) self.session = self.client.session self._patch_session()