Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Clean up local server socket on error #339

Merged
merged 2 commits into from
Apr 23, 2024
Merged

fix: Clean up local server socket on error #339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54da71f
fix: Clean up local server socket on error
clundin25 Mar 21, 2024
1af10ba
Merge branch 'main' into fix-socket-cleanup
clundin25 Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 27 additions & 25 deletions google_auth_oauthlib/flow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,31 +433,33 @@ def run_local_server(
bind_addr or host, port, wsgi_app, handler_class=_WSGIRequestHandler
)

redirect_uri_format = (
"http://{}:{}/" if redirect_uri_trailing_slash else "http://{}:{}"
)
self.redirect_uri = redirect_uri_format.format(host, local_server.server_port)
auth_url, _ = self.authorization_url(**kwargs)

if open_browser:
# if browser is None it defaults to default browser
webbrowser.get(browser).open(auth_url, new=1, autoraise=True)

if authorization_prompt_message:
print(authorization_prompt_message.format(url=auth_url))

local_server.timeout = timeout_seconds
local_server.handle_request()

# Note: using https here because oauthlib is very picky that
# OAuth 2.0 should only occur over https.
authorization_response = wsgi_app.last_request_uri.replace("http", "https")
self.fetch_token(
authorization_response=authorization_response, audience=token_audience
)

# This closes the socket
local_server.server_close()
try:
redirect_uri_format = (
"http://{}:{}/" if redirect_uri_trailing_slash else "http://{}:{}"
)
self.redirect_uri = redirect_uri_format.format(
host, local_server.server_port
)
auth_url, _ = self.authorization_url(**kwargs)

if open_browser:
# if browser is None it defaults to default browser
webbrowser.get(browser).open(auth_url, new=1, autoraise=True)

if authorization_prompt_message:
print(authorization_prompt_message.format(url=auth_url))

local_server.timeout = timeout_seconds
local_server.handle_request()

# Note: using https here because oauthlib is very picky that
# OAuth 2.0 should only occur over https.
authorization_response = wsgi_app.last_request_uri.replace("http", "https")
self.fetch_token(
authorization_response=authorization_response, audience=token_audience
)
finally:
local_server.server_close()

return self.credentials

Expand Down
15 changes: 15 additions & 0 deletions tests/unit/test_flow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import pytest
import requests
import urllib
import webbrowser

from google_auth_oauthlib import flow

Expand Down Expand Up @@ -440,3 +441,17 @@ def test_run_local_server_occupied_port(
with pytest.raises(OSError) as exc:
instance.run_local_server(port=port)
assert "address already in use" in exc.strerror.lower()

@mock.patch("google_auth_oauthlib.flow.webbrowser.get", autospec=True)
@mock.patch("wsgiref.simple_server.make_server", autospec=True)
def test_local_server_socket_cleanup(
self, make_server_mock, webbrowser_mock, instance
):
server_mock = mock.MagicMock()
make_server_mock.return_value = server_mock
webbrowser_mock.side_effect = webbrowser.Error("Browser not found")

with pytest.raises(webbrowser.Error):
instance.run_local_server()

server_mock.server_close.assert_called_once()
Loading