mirror of
https://github.com/status-im/PyGithub.git
synced 2026-08-31 19:01:15 +00:00
Adam Baratz
faa1bbd61f
* Handle unicode strings when recording responses (#1253) * Add new test requirements * Make requirement conditional * Fix flake8 error * Compare dict values without worrying about key order * Improve readability
115 lines
5.2 KiB
Python
115 lines
5.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
############################ Copyrights and license ############################
|
|
# #
|
|
# Copyright 2019 Adam Baratz <adam.baratz@gmail.com> #
|
|
# #
|
|
# This file is part of PyGithub. #
|
|
# http://pygithub.readthedocs.io/ #
|
|
# #
|
|
# PyGithub is free software: you can redistribute it and/or modify it under #
|
|
# the terms of the GNU Lesser General Public License as published by the Free #
|
|
# Software Foundation, either version 3 of the License, or (at your option) #
|
|
# any later version. #
|
|
# #
|
|
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
|
|
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
|
|
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
|
|
# details. #
|
|
# #
|
|
# You should have received a copy of the GNU Lesser General Public License #
|
|
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
|
|
# #
|
|
################################################################################
|
|
|
|
from __future__ import absolute_import
|
|
|
|
import itertools
|
|
import unittest
|
|
from io import StringIO
|
|
try:
|
|
from unittest.mock import Mock
|
|
except ImportError:
|
|
from mock import Mock
|
|
|
|
import httpretty
|
|
from parameterized import parameterized
|
|
|
|
from . import Framework
|
|
|
|
|
|
PARAMETERS = itertools.product(
|
|
[
|
|
(Framework.ReplayingHttpConnection, "http"),
|
|
(Framework.ReplayingHttpsConnection, "https"),
|
|
],
|
|
[
|
|
(
|
|
"{\"body\":\"BODY TEXT\"}",
|
|
'\nGET\napi.github.com\nNone\n/user\n{\'Authorization\': \'Basic login_and_password_removed\', \'User-Agent\': \'PyGithub/Python\'}\nNone\n200\n[]\n{"body":"BODY TEXT"}\n\n',
|
|
),
|
|
(
|
|
u"{\"body\":\"BODY\xa0TEXT\"}",
|
|
u'\nGET\napi.github.com\nNone\n/user\n{\'Authorization\': \'Basic login_and_password_removed\', \'User-Agent\': \'PyGithub/Python\'}\nNone\n200\n[]\n{"body":"BODY\xa0TEXT"}\n\n',
|
|
),
|
|
(
|
|
"BODY TEXT",
|
|
'\nGET\napi.github.com\nNone\n/user\n{\'Authorization\': \'Basic login_and_password_removed\', \'User-Agent\': \'PyGithub/Python\'}\nNone\n200\n[]\nBODY TEXT\n\n',
|
|
),
|
|
(
|
|
u"BODY\xa0TEXT",
|
|
u'\nGET\napi.github.com\nNone\n/user\n{\'Authorization\': \'Basic login_and_password_removed\', \'User-Agent\': \'PyGithub/Python\'}\nNone\n200\n[]\nBODY\xa0TEXT\n\n',
|
|
),
|
|
],
|
|
)
|
|
|
|
|
|
class RecordingMockConnection(Framework.RecordingConnection):
|
|
def __init__(self, file, protocol, host, port, realConnection):
|
|
self._realConnection = realConnection
|
|
Framework.RecordingConnection.__init__(self, file, protocol, host, port)
|
|
|
|
|
|
class Connection(unittest.TestCase):
|
|
@parameterized.expand(itertools.chain(*p) for p in PARAMETERS)
|
|
def testRecordAndReplay(self, replaying_connection_class, protocol, response_body, expected_recording):
|
|
file = StringIO()
|
|
host = "api.github.com"
|
|
verb = "GET"
|
|
url = "/user"
|
|
headers = {'Authorization': 'Basic p4ssw0rd', 'User-Agent': 'PyGithub/Python'}
|
|
|
|
response = Mock()
|
|
response.status = 200
|
|
response.getheaders.return_value = {}
|
|
response.read.return_value = response_body
|
|
|
|
connection = Mock()
|
|
connection.getresponse.return_value = response
|
|
|
|
# write mock response to buffer
|
|
recording_connection = RecordingMockConnection(file, protocol, host, None, lambda *args, **kwds: connection)
|
|
recording_connection.request(verb, url, None, headers)
|
|
recording_connection.getresponse()
|
|
recording_connection.close()
|
|
|
|
# validate contents of buffer
|
|
file_value_lines = file.getvalue().split("\n")
|
|
expected_recording_lines = (protocol + expected_recording).split("\n")
|
|
self.assertEquals(file_value_lines[:5], expected_recording_lines[:5])
|
|
self.assertEquals(eval(file_value_lines[5]), eval(expected_recording_lines[5])) # dict literal, so keys not in guaranteed order
|
|
self.assertEquals(file_value_lines[6:], expected_recording_lines[6:])
|
|
|
|
# required for replay to work as expected
|
|
httpretty.enable(allow_net_connect=False)
|
|
|
|
# rewind buffer and attempt to replay response from it
|
|
file.seek(0)
|
|
replaying_connection = replaying_connection_class(self, file, host=host, port=None)
|
|
replaying_connection.request(verb, url, None, headers)
|
|
replaying_connection.getresponse()
|
|
|
|
# not necessarily required for subsequent tests
|
|
httpretty.disable()
|
|
httpretty.reset()
|