Skip to content
Navigation Menu
{{ message }}
forked from sigmavirus24/github3.py
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_github_session.py
More file actions
328 lines (280 loc) · 12.2 KB
/
Copy pathtest_github_session.py
File metadata and controls
328 lines (280 loc) · 12.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
try:
import cPickle as pickle
except ImportError:
import pickle
import pytest
import requests
from github3 import session
from .helper import mock
class TestGitHubSession:
def build_session(self, base_url=None):
s = session.GitHubSession()
if base_url:
s.base_url = base_url
return s
def test_has_default_headers(self):
"""Assert the default headers are there upon initialization"""
s = self.build_session()
assert "Accept" in s.headers
assert s.headers["Accept"] == "application/vnd.github.v3.full+json"
assert "Accept-Charset" in s.headers
assert s.headers["Accept-Charset"] == "utf-8"
assert "Content-Type" in s.headers
assert s.headers["Content-Type"] == "application/json"
assert "User-Agent" in s.headers
assert s.headers["User-Agent"].startswith("github3.py/")
@mock.patch.object(requests.Session, "request")
def test_default_timeout(self, request_mock):
"""Test that default timeout values are used"""
response = mock.Mock()
response.configure_mock(status_code=200, headers={})
request_mock.return_value = response
s = self.build_session()
r = s.get("http://example.com")
assert r is response
request_mock.assert_called_once_with(
"GET", "http://example.com", allow_redirects=True,
timeout=(4, 10)
)
@mock.patch.object(requests.Session, "request")
def test_custom_timeout(self, request_mock):
"""Test that custom timeout values are used"""
response = mock.Mock()
response.configure_mock(status_code=200, headers={})
request_mock.return_value = response
s = session.GitHubSession(
default_connect_timeout=300, default_read_timeout=400
)
r = s.get("http://example.com")
assert r is response
request_mock.assert_called_once_with(
"GET",
"http://example.com",
allow_redirects=True,
timeout=(300, 400),
)
def test_build_url(self):
"""Test that GitHubSessions build basic URLs"""
s = self.build_session()
url = s.build_url("gists", "123456", "history")
assert url == "https://api.github.com/gists/123456/history"
def test_build_url_caches_built_urls(self):
"""Test that building a URL caches it"""
s = self.build_session()
url = s.build_url("gists", "123456", "history")
url_parts = ("https://api.github.com", "gists", "123456", "history")
assert url_parts in session.__url_cache__
assert url in session.__url_cache__.values()
def test_build_url_uses_a_different_base(self):
"""Test that you can pass in a different base URL to build_url"""
s = self.build_session()
url = s.build_url(
"gists", "123456", "history", base_url="https://status.github.com"
)
assert url == "https://status.github.com/gists/123456/history"
def test_build_url_respects_the_session_base_url(self):
"""Test that build_url uses the session's base_url"""
s = self.build_session("https://enterprise.customer.com")
url = s.build_url("gists")
assert url == "https://enterprise.customer.com/gists"
def test_basic_login_does_not_use_falsey_values(self):
"""Test that basic auth will not authenticate with falsey values"""
bad_auths = [
(None, "password"),
("username", None),
("", "password"),
("username", ""),
]
for auth in bad_auths:
# Make sure we have a clean session to test with
s = self.build_session()
s.basic_auth(*auth)
assert s.auth != session.BasicAuth(*auth)
def test_basic_login(self):
"""Test that basic auth will work with a valid combination"""
s = self.build_session()
s.basic_auth("username", "password")
assert s.auth == session.BasicAuth("username", "password")
def test_basic_login_disables_token_auth(self):
"""Test that basic auth will remove the Authorization header.
Token and basic authentication will conflict so remove the token
authentication.
"""
s = self.build_session()
s.token_auth("token goes here")
req = requests.Request("GET", "https://api.github.com/")
pr = s.prepare_request(req)
assert "token token goes here" == pr.headers["Authorization"]
s.basic_auth("username", "password")
pr = s.prepare_request(req)
assert "token token goes here" != pr.headers["Authorization"]
@mock.patch.object(requests.Session, "request")
def test_handle_two_factor_auth(self, request_mock):
"""Test the method that handles getting the 2fa code"""
s = self.build_session()
s.two_factor_auth_callback(lambda: "fake")
args = ("GET", "http://example.com")
s.handle_two_factor_auth(args, {})
request_mock.assert_called_once_with(
*args, headers={"X-GitHub-OTP": "fake"}
)
@mock.patch.object(requests.Session, "request")
def test_request_ignores_responses_that_do_not_require_2fa(
self, request_mock
):
"""Test that request does not try to handle 2fa when it should not"""
response = mock.Mock()
response.configure_mock(status_code=200, headers={})
request_mock.return_value = response
s = self.build_session()
s.two_factor_auth_callback(lambda: "fake")
r = s.get("http://example.com")
assert r is response
request_mock.assert_called_once_with(
"GET", "http://example.com", allow_redirects=True,
timeout=(4, 10)
)
@mock.patch.object(requests.Session, "request")
def test_creates_history_while_handling_2fa(self, request_mock):
"""Test that the overridden request method will create history"""
response = mock.Mock()
response.configure_mock(
status_code=401,
headers={"X-GitHub-OTP": "required;2fa"},
history=[],
)
request_mock.return_value = response
s = self.build_session()
s.two_factor_auth_callback(lambda: "fake")
r = s.get("http://example.com")
assert len(r.history) != 0
assert request_mock.call_count == 2
def test_token_auth(self):
"""Test that token auth will work with a valid token"""
s = self.build_session()
s.token_auth("token goes here")
req = requests.Request("GET", "https://api.github.com/")
pr = s.prepare_request(req)
assert pr.headers["Authorization"] == "token token goes here"
def test_token_auth_disables_basic_auth(self):
"""Test that using token auth removes the value of the auth attribute.
If `GitHubSession.auth` is set then it conflicts with the token value.
"""
s = self.build_session()
s.auth = ("foo", "bar")
s.token_auth("token goes here")
assert s.auth != ("foo", "bar")
assert isinstance(s.auth, session.TokenAuth)
def test_token_auth_does_not_use_falsey_values(self):
"""Test that token auth will not authenticate with falsey values"""
bad_tokens = [None, ""]
req = requests.Request("GET", "https://api.github.com/")
for token in bad_tokens:
s = self.build_session()
s.token_auth(token)
pr = s.prepare_request(req)
assert "Authorization" not in pr.headers
def test_token_auth_with_netrc_works(self, tmpdir):
"""
Test that token auth will be used instead of netrc.
With no auth specified, requests will use any matching auths
in .netrc/_netrc files
"""
token = "my-valid-token"
s = self.build_session()
s.token_auth(token)
netrc_contents = (
"machine api.github.com\n"
"login sigmavirus24\n"
"password invalid_token_for_test_verification\n"
)
# cover testing netrc behaviour on different OSs
dotnetrc = tmpdir.join(".netrc")
dotnetrc.write(netrc_contents)
dashnetrc = tmpdir.join("_netrc")
dashnetrc.write(netrc_contents)
with mock.patch.dict("os.environ", {"HOME": str(tmpdir)}):
# prepare_request triggers reading of .netrc files
pr = s.prepare_request(
requests.Request(
"GET", "https://api.github.com/users/sigmavirus24"
)
)
auth_header = pr.headers["Authorization"]
assert auth_header == "token {0}".format(token)
def test_two_factor_auth_callback_handles_None(self):
s = self.build_session()
assert s.two_factor_auth_cb is None
s.two_factor_auth_callback(None)
assert s.two_factor_auth_cb is None
def test_two_factor_auth_callback_checks_for_Callable(self):
s = self.build_session()
assert s.two_factor_auth_cb is None
with pytest.raises(ValueError):
s.two_factor_auth_callback(1)
def test_two_factor_auth_callback_accepts_a_Callable(self):
s = self.build_session()
assert s.two_factor_auth_cb is None
# You have to have a sense of humor ;)
def _not_so_anonymous(*args):
return "foo"
not_so_anonymous = _not_so_anonymous
s.two_factor_auth_callback(not_so_anonymous)
assert s.two_factor_auth_cb is not_so_anonymous
def test_oauth2_auth(self):
"""Test that oauth2 authentication works
For now though, it doesn't because it isn't implemented.
"""
s = self.build_session()
with pytest.raises(NotImplementedError):
s.oauth2_auth("Foo", "bar")
def test_issubclass_of_requests_Session(self):
"""Test that GitHubSession is a subclass of requests.Session"""
assert issubclass(session.GitHubSession, requests.Session)
def test_can_use_temporary_basic_auth(self):
"""Test that temporary_basic_auth resets old auth."""
s = self.build_session()
s.basic_auth("foo", "bar")
with s.temporary_basic_auth("temp", "pass"):
assert s.auth != session.BasicAuth("foo", "bar")
assert s.auth == session.BasicAuth("foo", "bar")
def test_temporary_basic_auth_replaces_auth(self):
"""Test that temporary_basic_auth sets the proper credentials."""
s = self.build_session()
s.basic_auth("foo", "bar")
with s.temporary_basic_auth("temp", "pass"):
assert s.auth == session.BasicAuth("temp", "pass")
def test_no_auth(self):
"""Verify that no_auth removes existing authentication."""
s = self.build_session()
s.basic_auth("user", "password")
req = requests.Request("GET", "https://api.github.com/")
with s.no_auth():
pr = s.prepare_request(req)
assert "Authorization" not in pr.headers
assert s.auth is None
pr = s.prepare_request(req)
assert "Authorization" in pr.headers
assert s.auth == session.BasicAuth("user", "password")
def test_retrieve_client_credentials_when_set(self):
"""Test that retrieve_client_credentials will return the credentials.
We must assert that when set, this function will return them.
"""
s = self.build_session()
s.params = {"client_id": "id", "client_secret": "secret"}
assert s.retrieve_client_credentials() == ("id", "secret")
def test_retrieve_client_credentials_returns_none(self):
"""Test that retrieve_client_credentials will return (None, None).
Namely, then the necessary parameters are set, it will not raise an
error.
"""
s = self.build_session()
assert s.retrieve_client_credentials() == (None, None)
def test_pickling(self):
s = self.build_session("https://api.github.com")
dumped = pickle.dumps(s, pickle.HIGHEST_PROTOCOL)
loaded = pickle.loads(dumped)
assert hasattr(loaded, "base_url")
assert hasattr(loaded, "two_factor_auth_cb")
assert loaded.base_url == s.base_url
assert loaded.two_factor_auth_cb == s.two_factor_auth_cb
You can’t perform that action at this time.