871 lines
40 KiB
Python
871 lines
40 KiB
Python
# Copyright 2017 Red Hat, Inc.
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from http import client as http_client
|
|
import json
|
|
from unittest import mock
|
|
|
|
import requests
|
|
|
|
from sushy import auth as sushy_auth
|
|
from sushy import connector
|
|
from sushy import exceptions
|
|
from sushy.tests.unit import base
|
|
|
|
|
|
class ConnectorMethodsTestCase(base.TestCase):
|
|
|
|
@mock.patch.object(sushy_auth, 'SessionOrBasicAuth', autospec=True)
|
|
def setUp(self, mock_auth):
|
|
mock_auth.get_session_key.return_value = None
|
|
super(ConnectorMethodsTestCase, self).setUp()
|
|
self.conn = connector.Connector(
|
|
'http://foo.bar:1234', verify=True)
|
|
self.conn._auth = mock_auth
|
|
self.data = {'fake': 'data'}
|
|
self.headers = {'X-Fake': 'header'}
|
|
|
|
def test_init_with_credentials(self):
|
|
conn = connector.Connector('http://foo.bar:1234',
|
|
username='admin',
|
|
password='password')
|
|
self.assertEqual(conn._session.auth, ('admin', 'password'))
|
|
|
|
def test_init_with_callback(self):
|
|
def response_callback(response):
|
|
return
|
|
|
|
conn = connector.Connector('http://foo.bar:1234',
|
|
username='admin',
|
|
password='password',
|
|
response_callback=response_callback)
|
|
self.assertIs(conn._response_callback, response_callback)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_get(self, mock__op):
|
|
self.conn.get(path='fake/path', data=self.data.copy(),
|
|
headers=self.headers.copy())
|
|
mock__op.assert_called_once_with(mock.ANY, 'GET', 'fake/path',
|
|
data=self.data, headers=self.headers,
|
|
blocking=False, timeout=60)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_get_blocking(self, mock__op):
|
|
self.conn.get(path='fake/path', data=self.data.copy(),
|
|
headers=self.headers.copy(), blocking=True)
|
|
mock__op.assert_called_once_with(mock.ANY, 'GET', 'fake/path',
|
|
data=self.data, headers=self.headers,
|
|
blocking=True, timeout=60)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_post(self, mock__op):
|
|
self.conn.post(path='fake/path', data=self.data.copy(),
|
|
headers=self.headers.copy())
|
|
mock__op.assert_called_once_with(mock.ANY, 'POST', 'fake/path',
|
|
data=self.data, headers=self.headers,
|
|
blocking=False, timeout=60)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_post_blocking(self, mock__op):
|
|
self.conn.post(path='fake/path', data=self.data.copy(),
|
|
headers=self.headers.copy(), blocking=True, timeout=120)
|
|
mock__op.assert_called_once_with(mock.ANY, 'POST', 'fake/path',
|
|
data=self.data, headers=self.headers,
|
|
blocking=True, timeout=120)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_patch(self, mock__op):
|
|
self.conn.patch(path='fake/path', data=self.data.copy(),
|
|
headers=self.headers.copy())
|
|
mock__op.assert_called_once_with(mock.ANY, 'PATCH', 'fake/path',
|
|
data=self.data, headers=self.headers,
|
|
blocking=False, timeout=60)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_patch_blocking(self, mock__op):
|
|
self.conn.patch(path='fake/path', data=self.data.copy(),
|
|
headers=self.headers.copy(), blocking=True)
|
|
mock__op.assert_called_once_with(mock.ANY, 'PATCH', 'fake/path',
|
|
data=self.data, headers=self.headers,
|
|
blocking=True, timeout=60)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_put(self, mock__op):
|
|
self.conn.put(path='fake/path', data=self.data.copy(),
|
|
headers=self.headers.copy())
|
|
mock__op.assert_called_once_with(mock.ANY, 'PUT', 'fake/path',
|
|
data=self.data, headers=self.headers,
|
|
blocking=False, timeout=60)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_put_blocking(self, mock__op):
|
|
self.conn.put(path='fake/path', data=self.data.copy(),
|
|
headers=self.headers.copy(), blocking=True)
|
|
mock__op.assert_called_once_with(mock.ANY, 'PUT', 'fake/path',
|
|
data=self.data, headers=self.headers,
|
|
blocking=True, timeout=60)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_delete(self, mock__op):
|
|
self.conn.delete(path='fake/path', data=self.data.copy(),
|
|
headers=self.headers.copy())
|
|
mock__op.assert_called_once_with(mock.ANY, 'DELETE', 'fake/path',
|
|
data=self.data, headers=self.headers,
|
|
blocking=False, timeout=60)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_delete_blocking(self, mock__op):
|
|
self.conn.delete(path='fake/path', data=self.data.copy(),
|
|
headers=self.headers.copy(), blocking=True)
|
|
mock__op.assert_called_once_with(mock.ANY, 'DELETE', 'fake/path',
|
|
data=self.data, headers=self.headers,
|
|
blocking=True, timeout=60)
|
|
|
|
def test_set_auth(self):
|
|
mock_auth = mock.MagicMock()
|
|
self.conn.set_auth(mock_auth)
|
|
self.assertEqual(mock_auth, self.conn._auth)
|
|
|
|
def test_set_http_basic_auth(self):
|
|
self.conn.set_http_basic_auth('foo', 'secret')
|
|
self.assertEqual(('foo', 'secret'), self.conn._session.auth)
|
|
|
|
def test_set_http_session_auth(self):
|
|
self.conn.set_http_session_auth('hash-token')
|
|
self.assertIn('X-Auth-Token', self.conn._session.headers)
|
|
self.assertEqual(
|
|
'hash-token', self.conn._session.headers['X-Auth-Token'])
|
|
|
|
def test_close(self):
|
|
session = mock.Mock(spec=requests.Session)
|
|
self.conn._session = session
|
|
self.conn.close()
|
|
session.close.assert_called_once_with()
|
|
|
|
|
|
class ConnectorOpTestCase(base.TestCase):
|
|
|
|
@mock.patch.object(sushy_auth, 'SessionOrBasicAuth', autospec=True)
|
|
def setUp(self, mock_auth):
|
|
mock_auth.get_session_key.return_value = None
|
|
mock_auth._session_key = None
|
|
self.auth = mock_auth
|
|
super(ConnectorOpTestCase, self).setUp()
|
|
self.conn = connector.Connector(
|
|
'http://foo.bar:1234', verify=True,
|
|
server_side_retries=10, server_side_retries_delay=3)
|
|
self.conn._auth = mock_auth
|
|
self.data = {'fake': 'data'}
|
|
self.headers = {'X-Fake': 'header'}
|
|
self.session = mock.Mock(spec=requests.Session)
|
|
self.conn._session = self.session
|
|
self.request = self.session.request
|
|
self.request.return_value.status_code = http_client.OK
|
|
|
|
def test_ok_get(self):
|
|
self.conn._op('GET', path='fake/path', headers=self.headers)
|
|
self.request.assert_called_once_with(
|
|
'GET', 'http://foo.bar:1234/fake/path',
|
|
headers=self.headers, json=None, verify=True, timeout=60)
|
|
|
|
def test_response_callback(self):
|
|
mock_response_callback = mock.MagicMock()
|
|
self.conn._response_callback = mock_response_callback
|
|
|
|
self.conn._op('GET', path='fake/path', headers=self.headers)
|
|
self.assertEqual(1, mock_response_callback.call_count)
|
|
|
|
def test_ok_get_url_redirect_false(self):
|
|
self.conn._op('GET', path='fake/path', headers=self.headers,
|
|
allow_redirects=False)
|
|
self.request.assert_called_once_with(
|
|
'GET', 'http://foo.bar:1234/fake/path',
|
|
headers=self.headers, json=None, allow_redirects=False,
|
|
verify=True, timeout=60)
|
|
|
|
def test_ok_post(self):
|
|
self.conn._op('POST', path='fake/path', data=self.data.copy(),
|
|
headers=self.headers)
|
|
self.request.assert_called_once_with(
|
|
'POST', 'http://foo.bar:1234/fake/path',
|
|
json=self.data, headers=self.headers, verify=True, timeout=60)
|
|
|
|
def test_ok_put(self):
|
|
self.conn._op('PUT', path='fake/path', data=self.data.copy(),
|
|
headers=self.headers)
|
|
self.request.assert_called_once_with(
|
|
'PUT', 'http://foo.bar:1234/fake/path',
|
|
json=self.data, headers=self.headers, verify=True, timeout=60)
|
|
|
|
def test_ok_delete(self):
|
|
expected_headers = self.headers.copy()
|
|
expected_headers['OData-Version'] = '4.0'
|
|
self.conn._op('DELETE', path='fake/path', headers=self.headers.copy())
|
|
self.request.assert_called_once_with(
|
|
'DELETE', 'http://foo.bar:1234/fake/path',
|
|
headers=expected_headers, json=None, verify=True, timeout=60)
|
|
|
|
def test_ok_post_with_session(self):
|
|
self.conn._session.headers = {}
|
|
self.conn._session.headers['X-Auth-Token'] = 'asdf1234'
|
|
expected_headers = self.headers.copy()
|
|
expected_headers['OData-Version'] = '4.0'
|
|
expected_headers['Content-Type'] = 'application/json'
|
|
self.conn._op('POST', path='fake/path', headers=self.headers,
|
|
data=self.data)
|
|
self.request.assert_called_once_with(
|
|
'POST', 'http://foo.bar:1234/fake/path',
|
|
json=self.data, headers=expected_headers, verify=True, timeout=60)
|
|
self.assertEqual(self.conn._session.headers,
|
|
{'X-Auth-Token': 'asdf1234'})
|
|
|
|
def test_odata_version_header_redfish(self):
|
|
path = '/redfish/v1/path'
|
|
headers = dict(self.headers)
|
|
expected_headers = dict(self.headers)
|
|
expected_headers['OData-Version'] = '4.0'
|
|
self.request.reset_mock()
|
|
self.conn._op('GET', path=path, headers=headers)
|
|
self.request.assert_called_once_with(
|
|
'GET', 'http://foo.bar:1234' + path,
|
|
headers=expected_headers, json=None, verify=True, timeout=60)
|
|
|
|
def test_odata_version_header_redfish_no_headers(self):
|
|
path = '/redfish/v1/bar'
|
|
expected_headers = {'OData-Version': '4.0'}
|
|
self.conn._op('GET', path=path)
|
|
self.request.assert_called_once_with(
|
|
'GET', 'http://foo.bar:1234' + path,
|
|
headers=expected_headers, json=None, verify=True, timeout=60)
|
|
|
|
def test_odata_version_header_redfish_existing_header(self):
|
|
path = '/redfish/v1/foo'
|
|
headers = {'OData-Version': '3.0'}
|
|
expected_headers = dict(headers)
|
|
self.conn._op('GET', path=path, headers=headers)
|
|
self.request.assert_called_once_with(
|
|
'GET', 'http://foo.bar:1234' + path,
|
|
headers=expected_headers, json=None, verify=True, timeout=60)
|
|
|
|
def test_timed_out_session_unable_to_create_session(self):
|
|
self.conn._auth.can_refresh_session.return_value = False
|
|
self.session.auth = None
|
|
self.conn._session = self.session
|
|
self.request = self.session.request
|
|
self.request.return_value.status_code = http_client.FORBIDDEN
|
|
self.request.return_value.json.side_effect = ValueError('no json')
|
|
mock_response = mock.Mock()
|
|
mock_response.json.side_effect = ValueError('no json')
|
|
mock_response.status_code = http_client.FORBIDDEN
|
|
self.conn._auth.authenticate.side_effect = \
|
|
exceptions.AccessError('POST', 'fake/path', mock_response)
|
|
with self.assertRaisesRegex(exceptions.AccessError,
|
|
'unknown error') as ae:
|
|
self.conn._op('POST', path='fake/path', data=self.data,
|
|
headers=self.headers)
|
|
exc = ae.exception
|
|
self.assertEqual(http_client.FORBIDDEN, exc.status_code)
|
|
|
|
def test_timed_out_session_re_established(self):
|
|
self.auth._session_key = 'asdf1234'
|
|
self.auth.get_session_key.return_value = 'asdf1234'
|
|
self.conn._auth = self.auth
|
|
self.session = mock.Mock(spec=requests.Session)
|
|
self.session.auth = None
|
|
self.conn._session = self.session
|
|
self.request = self.session.request
|
|
first_response = mock.MagicMock()
|
|
first_response.status_code = http_client.FORBIDDEN
|
|
second_response = mock.MagicMock()
|
|
second_response.status_code = http_client.OK
|
|
second_response.json = {'Test': 'Testing'}
|
|
self.request.side_effect = [first_response, second_response]
|
|
response = self.conn._op('POST', path='fake/path', data=self.data,
|
|
headers=self.headers)
|
|
self.auth.refresh_session.assert_called_with()
|
|
self.auth.can_refresh_session.assert_called_with()
|
|
self.assertEqual(response.json, second_response.json)
|
|
|
|
def test_timed_out_session_timed_out_refresh(self):
|
|
self.auth._session_key = 'asdf1234'
|
|
self.auth.get_session_key.return_value = 'asdf1234'
|
|
self.conn._auth = self.auth
|
|
self.session = mock.Mock(spec=requests.Session)
|
|
self.session.auth = None
|
|
self.conn._session = self.session
|
|
self.request = self.session.request
|
|
first_response = mock.MagicMock()
|
|
first_response.status_code = http_client.FORBIDDEN
|
|
second_response = first_response
|
|
self.auth.refresh_session.side_effect = \
|
|
exceptions.ConnectionError('meow')
|
|
third_response = mock.MagicMock()
|
|
third_response.status_code = http_client.OK
|
|
third_response.json = {'Test': 'Testing'}
|
|
self.auth.can_refresh_session.return_value = True
|
|
|
|
self.request.side_effect = [first_response, second_response,
|
|
third_response]
|
|
self.assertRaises(exceptions.ConnectionError, self.conn._op, 'POST',
|
|
path='fake/path', data=self.data,
|
|
headers=self.headers)
|
|
self.auth.refresh_session.assert_called_with()
|
|
self.auth.refresh_session.reset_mock()
|
|
# Normally, this would be reset by refresh_session, but given
|
|
# the heavy mocking, we need to do it for this test.
|
|
self.auth._session_key = None
|
|
self.auth.get_session_key.return_value = None
|
|
self.auth.can_refresh_session.return_value = False
|
|
|
|
response = self.conn._op('POST', path='fake/path', data=self.data,
|
|
headers=self.headers)
|
|
self.auth.refresh_session.assert_not_called()
|
|
self.auth.authenticate.assert_called_once()
|
|
self.assertEqual(response.json, third_response.json)
|
|
|
|
def test_timed_out_session_fail_after_reestablish(self):
|
|
self.auth._session_key = 'asdf1234'
|
|
self.auth.get_session_key.return_value = 'asdf1234'
|
|
self.conn._auth = self.auth
|
|
self.session = mock.Mock(spec=requests.Session)
|
|
self.session.auth = None
|
|
self.conn._session = self.session
|
|
self.request = self.session.request
|
|
first_response = mock.MagicMock()
|
|
first_response.status_code = http_client.FORBIDDEN
|
|
second_response = mock.MagicMock()
|
|
second_response.status_code = http_client.BAD_REQUEST
|
|
self.request.side_effect = [first_response, second_response]
|
|
self.assertRaises(exceptions.BadRequestError,
|
|
self.conn._op,
|
|
'POST', path='fake/path', data=self.data,
|
|
headers=self.headers)
|
|
self.auth.refresh_session.assert_called_with()
|
|
self.auth.can_refresh_session.assert_called_with()
|
|
|
|
def test_timed_out_session_fail_after_reestablish_no_recursion(self):
|
|
self.auth._session_key = 'asdf1234'
|
|
self.auth.get_session_key.return_value = 'asdf1234'
|
|
self.conn._auth = self.auth
|
|
self.session = mock.Mock(spec=requests.Session)
|
|
self.session.auth = None
|
|
self.conn._session = self.session
|
|
self.request = self.session.request
|
|
first_response = mock.MagicMock()
|
|
first_response.status_code = http_client.FORBIDDEN
|
|
second_response = mock.MagicMock()
|
|
second_response.status_code = http_client.FORBIDDEN
|
|
self.request.side_effect = [first_response, second_response]
|
|
self.assertRaises(exceptions.AccessError,
|
|
self.conn._op,
|
|
'POST', path='fake/path', data=self.data,
|
|
headers=self.headers)
|
|
self.auth.refresh_session.assert_called_with()
|
|
self.auth.can_refresh_session.assert_called_with()
|
|
|
|
def test_connection_error(self):
|
|
self.request.side_effect = requests.exceptions.ConnectionError
|
|
self.assertRaises(exceptions.ConnectionError, self.conn._op, 'GET')
|
|
|
|
def test_unknown_http_error(self):
|
|
self.request.return_value.status_code = http_client.CONFLICT
|
|
self.request.return_value.json.side_effect = ValueError('no json')
|
|
|
|
with self.assertRaisesRegex(exceptions.HTTPError,
|
|
'unknown error') as cm:
|
|
self.conn._op('GET', 'http://foo.bar')
|
|
exc = cm.exception
|
|
self.assertEqual(http_client.CONFLICT, exc.status_code)
|
|
self.assertIsNone(exc.body)
|
|
self.assertIsNone(exc.detail)
|
|
|
|
def test_known_http_error(self):
|
|
self.request.return_value.status_code = http_client.BAD_REQUEST
|
|
with open('sushy/tests/unit/json_samples/error.json') as f:
|
|
self.request.return_value.json.return_value = json.load(f)
|
|
|
|
with self.assertRaisesRegex(exceptions.BadRequestError,
|
|
'body submitted was malformed JSON') as cm:
|
|
self.conn._op('GET', 'http://foo.bar')
|
|
exc = cm.exception
|
|
self.assertEqual(http_client.BAD_REQUEST, exc.status_code)
|
|
self.assertIsNotNone(exc.body)
|
|
self.assertIn('body submitted was malformed JSON', exc.detail)
|
|
self.assertEqual(len(exc.extended_info), 3, exc.extended_info)
|
|
|
|
def test_known_http_error_nonlist_ext_info(self):
|
|
self.request.return_value.status_code =\
|
|
http_client.UNSUPPORTED_MEDIA_TYPE
|
|
with open('sushy/tests/unit/json_samples/'
|
|
'error_single_ext_info.json') as f:
|
|
self.request.return_value.json.return_value = json.load(f)
|
|
|
|
with self.assertRaisesRegex(exceptions.HTTPError,
|
|
'See Resolution for information') as cm:
|
|
self.conn._op('POST', 'http://foo.bar')
|
|
exc = cm.exception
|
|
self.assertEqual(http_client.UNSUPPORTED_MEDIA_TYPE, exc.status_code)
|
|
self.assertIsNotNone(exc.body)
|
|
self.assertIn('See Resolution for information', exc.detail)
|
|
self.assertIn('unsupported media type',
|
|
exc.extended_info['Resolution'])
|
|
|
|
@mock.patch('time.sleep', autospec=True)
|
|
def test_not_found_error(self, mock_sleep):
|
|
self.request.return_value.status_code = http_client.NOT_FOUND
|
|
self.request.return_value.json.side_effect = ValueError('no json')
|
|
|
|
with self.assertRaisesRegex(exceptions.ResourceNotFoundError,
|
|
'Resource http://foo.bar not found') as cm:
|
|
self.conn._op('GET', 'http://foo.bar')
|
|
exc = cm.exception
|
|
self.assertEqual(http_client.NOT_FOUND, exc.status_code)
|
|
self.assertFalse(mock_sleep.called)
|
|
self.assertEqual(1, self.request.call_count)
|
|
|
|
@mock.patch('time.sleep', autospec=True)
|
|
def test_server_error(self, mock_sleep):
|
|
self.request.return_value.status_code = (
|
|
http_client.INTERNAL_SERVER_ERROR)
|
|
self.request.return_value.json.side_effect = ValueError('no json')
|
|
|
|
with self.assertRaisesRegex(exceptions.ServerSideError,
|
|
'unknown error') as cm:
|
|
self.conn._op('GET', 'http://foo.bar')
|
|
exc = cm.exception
|
|
self.assertEqual(http_client.INTERNAL_SERVER_ERROR, exc.status_code)
|
|
self.assertEqual(10, mock_sleep.call_count)
|
|
self.assertEqual(11, self.request.call_count)
|
|
|
|
@mock.patch('time.sleep', autospec=True)
|
|
def test_op_retry_on_server_500_sys518(self, mock_sleep):
|
|
response_info = {"error": {"@Message.ExtendedInfo": [
|
|
{'MessageId': 'IDRAC.2.7.SYS518'}]}}
|
|
mock_error = mock.Mock()
|
|
mock_error.status_code = 500
|
|
mock_error.json.return_value = response_info
|
|
self.request.return_value.status_code = (
|
|
http_client.INTERNAL_SERVER_ERROR)
|
|
self.request.return_value.json.side_effect =\
|
|
exceptions.ServerSideError(
|
|
method='DELETE', url='http://foo.bar', response=mock_error)
|
|
|
|
self.assertRaises(exceptions.ServerSideError, self.conn._op, 'DELETE',
|
|
'http://foo.bar')
|
|
self.assertEqual(10, mock_sleep.call_count)
|
|
self.assertEqual(11, self.request.call_count)
|
|
|
|
@mock.patch('time.sleep', autospec=True)
|
|
def test_op_retry_on_server_500_other_than_sys518(self, mock_sleep):
|
|
response_info = {"error": {"@Message.ExtendedInfo": [
|
|
{'MessageId': 'IDRAC.2.7.SYS999'}]}}
|
|
mock_error = mock.Mock()
|
|
mock_error.status_code = 500
|
|
mock_error.json.return_value = response_info
|
|
self.request.return_value.status_code = (
|
|
http_client.INTERNAL_SERVER_ERROR)
|
|
self.request.return_value.json.side_effect =\
|
|
exceptions.ServerSideError(
|
|
method='DELETE', url='http://foo.bar', response=mock_error)
|
|
|
|
self.assertRaises(exceptions.ServerSideError, self.conn._op, 'DELETE',
|
|
'http://foo.bar')
|
|
self.assertEqual(0, mock_sleep.call_count)
|
|
self.assertEqual(1, self.request.call_count)
|
|
|
|
@mock.patch('time.sleep', autospec=True)
|
|
def test_op_retry_on_server_400_ilo_not_ready(self, mock_sleep):
|
|
response_info = {"error": {"@Message.ExtendedInfo": [
|
|
{'MessageId': 'iLO.2.15.InvalidOperationForSystemState'}]}}
|
|
mock_error = mock.Mock()
|
|
mock_error.status_code = 400
|
|
mock_error.json.return_value = response_info
|
|
self.request.return_value.status_code = (
|
|
http_client.INTERNAL_SERVER_ERROR)
|
|
self.request.return_value.json.side_effect =\
|
|
exceptions.ServerSideError(
|
|
method='DELETE', url='http://foo.bar', response=mock_error)
|
|
|
|
self.assertRaises(exceptions.ServerSideError, self.conn._op, 'DELETE',
|
|
'http://foo.bar')
|
|
self.assertEqual(10, mock_sleep.call_count)
|
|
self.assertEqual(11, self.request.call_count)
|
|
|
|
@mock.patch('time.sleep', autospec=True)
|
|
def test_op_retry_on_server_400_ilo_not_ready_other_error(self,
|
|
mock_sleep):
|
|
response_info = {"error": {"@Message.ExtendedInfo": [
|
|
{'MessageId': 'iLO.Invalid'}]}}
|
|
mock_error = mock.Mock()
|
|
mock_error.status_code = 400
|
|
mock_error.json.return_value = response_info
|
|
self.request.return_value.status_code = (
|
|
http_client.INTERNAL_SERVER_ERROR)
|
|
self.request.return_value.json.side_effect =\
|
|
exceptions.ServerSideError(
|
|
method='DELETE', url='http://foo.bar', response=mock_error)
|
|
|
|
self.assertRaises(exceptions.ServerSideError, self.conn._op, 'DELETE',
|
|
'http://foo.bar')
|
|
self.assertEqual(0, mock_sleep.call_count)
|
|
self.assertEqual(1, self.request.call_count)
|
|
|
|
def test_access_error(self):
|
|
self.conn._auth = None
|
|
|
|
self.request.return_value.status_code = http_client.FORBIDDEN
|
|
self.request.return_value.json.side_effect = ValueError('no json')
|
|
|
|
with self.assertRaisesRegex(exceptions.AccessError,
|
|
'unknown error') as cm:
|
|
self.conn._op('GET', 'http://foo.bar')
|
|
exc = cm.exception
|
|
self.assertEqual(http_client.FORBIDDEN, exc.status_code)
|
|
|
|
def test_access_error_on_session_post_does_not_retry(self):
|
|
self.request.return_value.status_code = http_client.FORBIDDEN
|
|
self.request.return_value.json.side_effect = ValueError('no json')
|
|
|
|
self.conn._sessions_uri = '/redfish/v1/SessionService/Sessions'
|
|
|
|
with self.assertRaisesRegex(exceptions.AccessError,
|
|
'unknown error') as cm:
|
|
self.conn._op('POST', 'http://foo.bar/redfish/v1/Session'
|
|
'Service/Sessions',
|
|
data={'foo': 'bar'})
|
|
exc = cm.exception
|
|
self.assertEqual(http_client.FORBIDDEN, exc.status_code)
|
|
self.request.assert_called_once()
|
|
|
|
def test_access_error_triggers_auth_attempt(self):
|
|
self.conn._auth.can_refresh_session.return_value = False
|
|
value_error = ValueError('no json')
|
|
mock_response = mock.Mock()
|
|
mock_response.json.side_effect = value_error
|
|
mock_response.status_code = http_client.FORBIDDEN
|
|
self.session.auth = None
|
|
self.conn._session = self.session
|
|
# This doesn't test/wire all way back through auth -> main
|
|
# and ultimately we want to make sure we get an error all
|
|
# the way back.
|
|
self.conn._auth.authenticate.side_effect = \
|
|
exceptions.AccessError('GET', '/', mock_response)
|
|
self.request.return_value.status_code = http_client.FORBIDDEN
|
|
self.request.return_value.json.side_effect = value_error
|
|
|
|
with self.assertRaisesRegex(exceptions.AccessError,
|
|
'unknown error') as cm:
|
|
self.conn._op('GET', 'http://foo.bar')
|
|
exc = cm.exception
|
|
self.assertEqual(http_client.FORBIDDEN, exc.status_code)
|
|
self.conn._auth.authenticate.assert_called_once()
|
|
|
|
def test_access_error_without_auth(self):
|
|
self.conn._auth = None
|
|
|
|
self.request.return_value.status_code = http_client.FORBIDDEN
|
|
self.request.return_value.json.side_effect = ValueError('no json')
|
|
|
|
with self.assertRaisesRegex(exceptions.AccessError,
|
|
'unknown error') as cm:
|
|
self.conn._op('GET', 'http://foo.bar')
|
|
exc = cm.exception
|
|
self.assertEqual(http_client.FORBIDDEN, exc.status_code)
|
|
|
|
@mock.patch.object(connector.LOG, 'debug', autospec=True)
|
|
def test_access_error_service_session_reauth(self, mock_log):
|
|
self.conn._auth.can_refresh_session.return_value = False
|
|
|
|
self.request.return_value.status_code = http_client.FORBIDDEN
|
|
mock_response = mock.Mock()
|
|
mock_response.json.side_effect = ValueError('no json')
|
|
mock_response.status_code = http_client.FORBIDDEN
|
|
self.session.auth = None
|
|
self.conn._session = self.session
|
|
self.conn._auth.authenticate.side_effect = \
|
|
exceptions.AccessError('POST', 'fake/path', mock_response)
|
|
self.request.return_value.json.side_effect = ValueError('no json')
|
|
|
|
with self.assertRaisesRegex(exceptions.AccessError,
|
|
'unknown error') as cm:
|
|
self.conn._op('GET', 'http://redfish/v1/SessionService')
|
|
exc = cm.exception
|
|
self.assertEqual(http_client.FORBIDDEN, exc.status_code)
|
|
self.conn._auth.authenticate.assert_called_once()
|
|
|
|
@mock.patch.object(connector.LOG, 'debug', autospec=True)
|
|
def test_access_error_service_session_no_auth(self, mock_log):
|
|
self.conn._auth = None
|
|
|
|
self.request.return_value.status_code = http_client.FORBIDDEN
|
|
self.request.return_value.json.side_effect = ValueError('no json')
|
|
|
|
with self.assertRaisesRegex(exceptions.AccessError,
|
|
'unknown error') as cm:
|
|
self.conn._op('GET', 'http://redfish/v1/SessionService')
|
|
exc = cm.exception
|
|
mock_log.assert_called_with(
|
|
'HTTP GET of SessionService failed %s, '
|
|
'this is expected prior to authentication', 'HTTP GET '
|
|
'http://redfish/v1/SessionService returned code '
|
|
'%s. unknown error Extended information: '
|
|
'None' % http_client.FORBIDDEN)
|
|
self.assertEqual(http_client.FORBIDDEN, exc.status_code)
|
|
|
|
def test_blocking_no_location_header(self):
|
|
self.request.return_value.status_code = http_client.ACCEPTED
|
|
self.request.return_value.headers = {'retry-after': 5}
|
|
with self.assertRaisesRegex(exceptions.ConnectionError,
|
|
'status 202, but no Location header'):
|
|
self.conn._op('POST', 'http://foo.bar', blocking=True)
|
|
|
|
@mock.patch('sushy.connector.time.sleep', autospec=True)
|
|
def test_blocking_task_fails(self, mock_sleep):
|
|
response1 = mock.MagicMock(spec=requests.Response)
|
|
response1.status_code = http_client.ACCEPTED
|
|
response1.headers = {
|
|
'Retry-After': 5,
|
|
'Location': '/redfish/v1/taskmon/1',
|
|
'Content-Length': 10
|
|
}
|
|
response1.json.return_value = {'Id': 3, 'Name': 'Test'}
|
|
response2 = mock.MagicMock(spec=requests.Response)
|
|
response2.status_code = http_client.BAD_REQUEST
|
|
message = 'Unable to create Volume with given parameters'
|
|
response2.json.return_value = {
|
|
'error': {
|
|
'message': message
|
|
}
|
|
}
|
|
self.request.side_effect = [response1, response1, response2]
|
|
with self.assertRaisesRegex(exceptions.BadRequestError, message):
|
|
self.conn._op('POST', 'http://foo.bar', blocking=True)
|
|
|
|
@mock.patch.object(connector.LOG, 'warning', autospec=True)
|
|
def test_access_error_basic_auth(self, mock_log):
|
|
self.conn._auth.can_refresh_session.return_value = False
|
|
self.conn._session.auth = ('foo', 'bar')
|
|
self.request.return_value.status_code = 403
|
|
mock_response = mock.Mock()
|
|
mock_response.json.side_effect = ValueError('no json')
|
|
mock_response.status_code = 403
|
|
self.request.return_value.json.side_effect = ValueError('no json')
|
|
|
|
with self.assertRaisesRegex(exceptions.AccessError,
|
|
'unknown error') as cm:
|
|
self.conn._op('GET', 'http://redfish/v1/SessionService')
|
|
exc = cm.exception
|
|
self.assertEqual(http_client.FORBIDDEN, exc.status_code)
|
|
self.conn._auth.authenticate.assert_not_called()
|
|
error_msg = (f'HTTP GET http://redfish/v1/SessionService '
|
|
f'returned code {exc.status_code}. unknown error '
|
|
f'Extended information: None')
|
|
mock_log.assert_called_once_with(
|
|
"We have encountered an AccessError when using 'basic' "
|
|
"authentication. %(err)s",
|
|
{'err': error_msg}
|
|
)
|
|
|
|
def test__op_raises_connection_error(self):
|
|
|
|
exception_list = [
|
|
requests.exceptions.ChunkedEncodingError,
|
|
requests.exceptions.ContentDecodingError,
|
|
requests.exceptions.ReadTimeout,
|
|
requests.exceptions.ConnectTimeout,
|
|
requests.exceptions.SSLError,
|
|
requests.exceptions.ConnectionError,
|
|
requests.exceptions.RequestException,
|
|
]
|
|
for exc in exception_list:
|
|
self.request.side_effect = exc
|
|
self.assertRaises(exceptions.ConnectionError,
|
|
self.conn._op,
|
|
'POST',
|
|
'http://foo.bar',
|
|
blocking=True)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_etag_handler_strong_etag_ok(self, mock__op):
|
|
self.headers['If-Match'] = '"3d7b8a7360bf2941d"'
|
|
response = mock.MagicMock(spec=requests.Response)
|
|
response.status_code = http_client.OK
|
|
data = {'Boot': {'BootSourceOverrideTarget': 'Cd',
|
|
'BootSourceOverrideEnabled': 'Once'}}
|
|
mock__op.return_value = response
|
|
self.conn._etag_handler(path='/redfish/v1/Systems/1',
|
|
headers=self.headers, data=data,
|
|
etag=self.headers['If-Match'],
|
|
blocking=False, timeout=60)
|
|
mock__op.assert_called_once_with(
|
|
self.conn,
|
|
"PATCH",
|
|
'/redfish/v1/Systems/1',
|
|
data={'Boot': {'BootSourceOverrideTarget': 'Cd',
|
|
'BootSourceOverrideEnabled': 'Once'}},
|
|
headers={'X-Fake': 'header',
|
|
'If-Match': '"3d7b8a7360bf2941d"'},
|
|
blocking=False,
|
|
timeout=60)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_etag_handler_weak_etag_ok(self, mock__op):
|
|
self.headers['If-Match'] = 'W/"3d7b8a7360bf2941d"'
|
|
response = mock.MagicMock(spec=requests.Response)
|
|
response.status_code = http_client.OK
|
|
data = {'Boot': {'BootSourceOverrideTarget': 'Cd',
|
|
'BootSourceOverrideEnabled': 'Once'}}
|
|
mock__op.return_value = response
|
|
self.conn._etag_handler(path='/redfish/v1/Systems/1',
|
|
headers=self.headers, data=data,
|
|
etag=self.headers['If-Match'],
|
|
blocking=False, timeout=60)
|
|
mock__op.assert_called_once_with(
|
|
self.conn,
|
|
"PATCH",
|
|
'/redfish/v1/Systems/1',
|
|
data={'Boot': {'BootSourceOverrideTarget': 'Cd',
|
|
'BootSourceOverrideEnabled': 'Once'}},
|
|
headers={'X-Fake': 'header',
|
|
'If-Match': 'W/"3d7b8a7360bf2941d"'},
|
|
blocking=False,
|
|
timeout=60)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_etag_handler_no_etag_ok(self, mock__op):
|
|
response = mock.MagicMock(spec=requests.Response)
|
|
response.status_code = http_client.OK
|
|
data = {'Boot': {'BootSourceOverrideTarget': 'Cd',
|
|
'BootSourceOverrideEnabled': 'Once'}}
|
|
mock__op.return_value = response
|
|
self.conn._etag_handler(path='/redfish/v1/Systems/1',
|
|
headers=self.headers, data=data,
|
|
blocking=False, timeout=60)
|
|
mock__op.assert_called_once_with(
|
|
self.conn,
|
|
"PATCH",
|
|
'/redfish/v1/Systems/1',
|
|
data={'Boot': {'BootSourceOverrideTarget': 'Cd',
|
|
'BootSourceOverrideEnabled': 'Once'}},
|
|
headers={'X-Fake': 'header'},
|
|
blocking=False,
|
|
timeout=60)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_etag_handler_weak_etag_fallback_to_strong(self, mock__op):
|
|
self.headers['If-Match'] = 'W/"3d7b8a7360bf2941d"'
|
|
target_uri = '/redfish/v1/Systems/1'
|
|
response_412 = mock.MagicMock(spec=requests.Response)
|
|
response_412.status_code = http_client.PRECONDITION_FAILED
|
|
response_200 = mock.MagicMock(spec=requests.Response)
|
|
response_200.status_code = http_client.OK
|
|
mock__op.side_effect = [
|
|
exceptions.HTTPError(method='PATCH', url=target_uri,
|
|
response=response_412),
|
|
response_200]
|
|
|
|
data = {'Boot': {'BootSourceOverrideTarget': 'Cd',
|
|
'BootSourceOverrideEnabled': 'Once'}}
|
|
self.conn._etag_handler(path=target_uri, headers=self.headers,
|
|
data=data, etag=self.headers['If-Match'],
|
|
blocking=False, timeout=60)
|
|
mock__op.assert_called_with(
|
|
self.conn,
|
|
"PATCH",
|
|
'/redfish/v1/Systems/1',
|
|
data={'Boot': {'BootSourceOverrideTarget': 'Cd',
|
|
'BootSourceOverrideEnabled': 'Once'}},
|
|
headers={'X-Fake': 'header',
|
|
'If-Match': '"3d7b8a7360bf2941d"'},
|
|
blocking=False,
|
|
timeout=60)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_etag_handler_weak_etag_fallback_to_no_etag(self, mock__op):
|
|
self.headers['If-Match'] = 'W/"3d7b8a7360bf2941d"'
|
|
target_uri = '/redfish/v1/Systems/1'
|
|
response_412 = mock.MagicMock(spec=requests.Response)
|
|
response_412.status_code = http_client.PRECONDITION_FAILED
|
|
response_200 = mock.MagicMock(spec=requests.Response)
|
|
response_200.status_code = http_client.OK
|
|
mock__op.side_effect = [
|
|
exceptions.HTTPError(method='PATCH', url=target_uri,
|
|
response=response_412),
|
|
exceptions.HTTPError(method='PATCH', url=target_uri,
|
|
response=response_412),
|
|
response_200]
|
|
|
|
data = {'Boot': {'BootSourceOverrideTarget': 'Cd',
|
|
'BootSourceOverrideEnabled': 'Once'}}
|
|
self.conn._etag_handler(path=target_uri, headers=self.headers,
|
|
data=data, etag=self.headers['If-Match'],
|
|
blocking=False, timeout=60)
|
|
mock__op.assert_called_with(
|
|
self.conn,
|
|
"PATCH",
|
|
'/redfish/v1/Systems/1',
|
|
data={'Boot': {'BootSourceOverrideTarget': 'Cd',
|
|
'BootSourceOverrideEnabled': 'Once'}},
|
|
headers={'X-Fake': 'header'},
|
|
blocking=False,
|
|
timeout=60)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_etag_handler_strong_etag_fallback_to_no_etag(self, mock__op):
|
|
self.headers['If-Match'] = '"3d7b8a7360bf2941d"'
|
|
target_uri = '/redfish/v1/Systems/1'
|
|
response_412 = mock.MagicMock(spec=requests.Response)
|
|
response_412.status_code = http_client.PRECONDITION_FAILED
|
|
response_200 = mock.MagicMock(spec=requests.Response)
|
|
response_200.status_code = http_client.OK
|
|
mock__op.side_effect = [
|
|
exceptions.HTTPError(method='PATCH', url=target_uri,
|
|
response=response_412),
|
|
response_200]
|
|
|
|
data = {'Boot': {'BootSourceOverrideTarget': 'Cd',
|
|
'BootSourceOverrideEnabled': 'Once'}}
|
|
self.conn._etag_handler(path=target_uri, headers=self.headers,
|
|
data=data, etag=self.headers['If-Match'],
|
|
blocking=False, timeout=60)
|
|
mock__op.assert_called_with(
|
|
self.conn,
|
|
"PATCH",
|
|
'/redfish/v1/Systems/1',
|
|
data={'Boot': {'BootSourceOverrideTarget': 'Cd',
|
|
'BootSourceOverrideEnabled': 'Once'}},
|
|
headers={'X-Fake': 'header'},
|
|
blocking=False,
|
|
timeout=60)
|
|
|
|
@mock.patch.object(connector.Connector, '_op', autospec=True)
|
|
def test_etag_handler_fail_other_exception(self, mock__op):
|
|
self.headers['If-Match'] = 'W/"3d7b8a7360bf2941d"'
|
|
target_uri = '/redfish/v1/Systems/1'
|
|
data = {'Boot': {'BootSourceOverrideTarget': 'Cd',
|
|
'BootSourceOverrideEnabled': 'Once'}}
|
|
response = mock.MagicMock(spec=requests.Response)
|
|
response.status_code = http_client.FORBIDDEN
|
|
response.message = "boom"
|
|
mock__op.return_value = response
|
|
mock__op.side_effect = \
|
|
exceptions.HTTPError(method='PATCH',
|
|
url=target_uri,
|
|
response=response)
|
|
self.assertRaises(exceptions.HTTPError, self.conn._etag_handler,
|
|
'PATCH', target_uri, data,
|
|
self.headers,
|
|
blocking=False, timeout=60)
|