nova/nova/tests/unit/fake_requests.py
Eric Fried 8eb1cfa228 Unit test framework: common FakeResponse
Faking out requests.Response as a mock return value can be awkward,
particularly due to how a real Response responds to a boolean check
(False for status codes >=400).  Attempting to use a real Response is
also awkward when it needs to have a payload, due to indirection and
encoding.

This change set introduces a module, nova.tests.unit.fake_requests,
intended to hold fakes for things found in the requests module.  For
now, it holds FakeResponse, which provides a convenient way to create a
Response-like that can be used as a mock return value, which responds
like a real Response to most operations on it.

We swap this into various test modules that were previously using other
mechanisms to fake Response instances.

Change-Id: Iaeced55c442afdcb277de97829f52fe3c02a380a
2018-03-26 10:28:52 -05:00

40 lines
1.6 KiB
Python

# 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.
"""Fakes relating to the `requests` module."""
import requests
class FakeResponse(requests.Response):
def __init__(self, status_code, content=None, headers=None):
"""A requests.Response that can be used as a mock return_value.
A key feature is that the instance will evaluate to True or False like
a real Response, based on the status_code.
Properties like ok, status_code, text, and content, and methods like
json(), work as expected based on the inputs.
:param status_code: Integer HTTP response code (200, 404, etc.)
:param content: String supplying the payload content of the response.
Using a json-encoded string will make the json() method
behave as expected.
:param headers: Dict of HTTP header values to set.
"""
super(FakeResponse, self).__init__()
self.status_code = status_code
if content:
self._content = content.encode('utf-8')
self.encoding = 'utf-8'
if headers:
self.headers = headers