mirror of
https://github.com/status-im/PyGithub.git
synced 2026-08-31 19:01:15 +00:00
Liuyang Wan
af6cab5520
* Use pre-commit checks in CI * Fix all issues flagged by mypy * Update travis.yml to reflect testenv changes * Update docs to use tox lint
116 lines
4.9 KiB
Python
116 lines
4.9 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/>. #
|
|
# #
|
|
################################################################################
|
|
|
|
|
|
import itertools
|
|
from io import StringIO
|
|
from unittest.mock import Mock
|
|
|
|
import httpretty # type: ignore
|
|
import pytest # type: ignore
|
|
|
|
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
|
|
super().__init__(file, protocol, host, port)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("replaying_connection_class", "protocol", "response_body", "expected_recording"),
|
|
list(tuple(itertools.chain(*p)) for p in PARAMETERS),
|
|
)
|
|
def testRecordAndReplay(
|
|
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")
|
|
assert file_value_lines[:5] == expected_recording_lines[:5]
|
|
assert eval(file_value_lines[5]) == eval(expected_recording_lines[5])
|
|
# dict literal, so keys not in guaranteed order
|
|
assert 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(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()
|