# Copyright 2017 Google Inc. # # 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. import concurrent.futures import datetime from functools import partial import json import os import re import random import socket import mock import pytest import requests import urllib import webbrowser from google_auth_oauthlib import flow DATA_DIR = os.path.join(os.path.dirname(__file__), "data") CLIENT_SECRETS_FILE = os.path.join(DATA_DIR, "client_secrets.json") with open(CLIENT_SECRETS_FILE, "r") as fh: CLIENT_SECRETS_INFO = json.load(fh) class TestFlow(object): def test_from_client_secrets_file(self): instance = flow.Flow.from_client_secrets_file( CLIENT_SECRETS_FILE, scopes=mock.sentinel.scopes ) assert instance.client_config == CLIENT_SECRETS_INFO["web"] assert ( instance.oauth2session.client_id == CLIENT_SECRETS_INFO["web"]["client_id"] ) assert instance.oauth2session.scope == mock.sentinel.scopes def test_from_client_secrets_file_with_redirect_uri(self): instance = flow.Flow.from_client_secrets_file( CLIENT_SECRETS_FILE, scopes=mock.sentinel.scopes, redirect_uri=mock.sentinel.redirect_uri, ) assert ( instance.redirect_uri == instance.oauth2session.redirect_uri == mock.sentinel.redirect_uri ) def test_from_client_config_installed(self): client_config = {"installed": CLIENT_SECRETS_INFO["web"]} instance = flow.Flow.from_client_config( client_config, scopes=mock.sentinel.scopes ) assert instance.client_config == client_config["installed"] assert ( instance.oauth2session.client_id == client_config["installed"]["client_id"] ) assert instance.oauth2session.scope == mock.sentinel.scopes def test_from_client_config_with_redirect_uri(self): client_config = {"installed": CLIENT_SECRETS_INFO["web"]} instance = flow.Flow.from_client_config( client_config, scopes=mock.sentinel.scopes, redirect_uri=mock.sentinel.redirect_uri, ) assert ( instance.redirect_uri == instance.oauth2session.redirect_uri == mock.sentinel.redirect_uri ) def test_from_client_config_bad_format(self): with pytest.raises(ValueError): flow.Flow.from_client_config({}, scopes=mock.sentinel.scopes) @pytest.fixture def instance(self): yield flow.Flow.from_client_config( CLIENT_SECRETS_INFO, scopes=mock.sentinel.scopes ) def test_redirect_uri(self, instance): instance.redirect_uri = mock.sentinel.redirect_uri assert ( instance.redirect_uri == instance.oauth2session.redirect_uri == mock.sentinel.redirect_uri ) def test_authorization_url(self, instance): scope = "scope_one" instance.oauth2session.scope = [scope] authorization_url_patch = mock.patch.object( instance.oauth2session, "authorization_url", wraps=instance.oauth2session.authorization_url, ) with authorization_url_patch as authorization_url_spy: url, _ = instance.authorization_url(prompt="consent") assert CLIENT_SECRETS_INFO["web"]["auth_uri"] in url assert scope in url authorization_url_spy.assert_called_with( CLIENT_SECRETS_INFO["web"]["auth_uri"], access_type="offline", prompt="consent", ) def test_authorization_url_code_verifier(self, instance): scope = "scope_one" instance.oauth2session.scope = [scope] instance.code_verifier = "amanaplanacanalpanama" authorization_url_patch = mock.patch.object( instance.oauth2session, "authorization_url", wraps=instance.oauth2session.authorization_url, ) with authorization_url_patch as authorization_url_spy: url, _ = instance.authorization_url(prompt="consent") assert CLIENT_SECRETS_INFO["web"]["auth_uri"] in url assert scope in url authorization_url_spy.assert_called_with( CLIENT_SECRETS_INFO["web"]["auth_uri"], access_type="offline", prompt="consent", code_challenge="2yN0TOdl0gkGwFOmtfx3f913tgEaLM2d2S0WlmG1Z6Q", code_challenge_method="S256", ) def test_authorization_url_access_type(self, instance): scope = "scope_one" instance.oauth2session.scope = [scope] instance.code_verifier = "amanaplanacanalpanama" authorization_url_patch = mock.patch.object( instance.oauth2session, "authorization_url", wraps=instance.oauth2session.authorization_url, ) with authorization_url_patch as authorization_url_spy: url, _ = instance.authorization_url(access_type="meep") assert CLIENT_SECRETS_INFO["web"]["auth_uri"] in url assert scope in url authorization_url_spy.assert_called_with( CLIENT_SECRETS_INFO["web"]["auth_uri"], access_type="meep", code_challenge="2yN0TOdl0gkGwFOmtfx3f913tgEaLM2d2S0WlmG1Z6Q", code_challenge_method="S256", ) def test_authorization_url_generated_verifier(self): scope = "scope_one" instance = flow.Flow.from_client_config( CLIENT_SECRETS_INFO, scopes=[scope], autogenerate_code_verifier=True ) authorization_url_path = mock.patch.object( instance.oauth2session, "authorization_url", wraps=instance.oauth2session.authorization_url, ) with authorization_url_path as authorization_url_spy: instance.authorization_url() _, kwargs = authorization_url_spy.call_args_list[0] assert kwargs["code_challenge_method"] == "S256" assert len(instance.code_verifier) == 128 assert len(kwargs["code_challenge"]) == 43 valid_verifier = r"^[A-Za-z0-9-._~]*$" valid_challenge = r"^[A-Za-z0-9-_]*$" assert re.match(valid_verifier, instance.code_verifier) assert re.match(valid_challenge, kwargs["code_challenge"]) def test_fetch_token(self, instance): instance.code_verifier = "amanaplanacanalpanama" fetch_token_patch = mock.patch.object( instance.oauth2session, "fetch_token", autospec=True, return_value=mock.sentinel.token, ) with fetch_token_patch as fetch_token_mock: token = instance.fetch_token(code=mock.sentinel.code) assert token == mock.sentinel.token fetch_token_mock.assert_called_with( CLIENT_SECRETS_INFO["web"]["token_uri"], client_secret=CLIENT_SECRETS_INFO["web"]["client_secret"], code=mock.sentinel.code, code_verifier="amanaplanacanalpanama", ) def test_credentials(self, instance): instance.oauth2session.token = { "access_token": mock.sentinel.access_token, "refresh_token": mock.sentinel.refresh_token, "id_token": mock.sentinel.id_token, "expires_at": 643969200.0, } credentials = instance.credentials assert credentials.token == mock.sentinel.access_token assert credentials.expiry == datetime.datetime(1990, 5, 29, 8, 20, 0) assert credentials._refresh_token == mock.sentinel.refresh_token assert credentials.id_token == mock.sentinel.id_token assert credentials._client_id == CLIENT_SECRETS_INFO["web"]["client_id"] assert credentials._client_secret == CLIENT_SECRETS_INFO["web"]["client_secret"] assert credentials._token_uri == CLIENT_SECRETS_INFO["web"]["token_uri"] def test_authorized_session(self, instance): instance.oauth2session.token = { "access_token": mock.sentinel.access_token, "refresh_token": mock.sentinel.refresh_token, "id_token": mock.sentinel.id_token, "expires_at": 643969200.0, } session = instance.authorized_session() assert session.credentials.token == mock.sentinel.access_token class TestInstalledAppFlow(object): SCOPES = ["email", "profile"] REDIRECT_REQUEST_PATH = "/?code=code&state=state" AUDIENCE = "dummy-audience" @pytest.fixture def instance(self): yield flow.InstalledAppFlow.from_client_config( CLIENT_SECRETS_INFO, scopes=self.SCOPES ) @pytest.fixture def port(self): # Creating a new server at the same port will result in # a 'Address already in use' error for a brief # period of time after the socket has been closed. # Work around this in the tests by choosing a random port. # https://stackoverflow.com/questions/6380057/python-binding-socket-address-already-in-use yield random.randrange(60400, 60900) @pytest.fixture def socket(self, port): s = socket.socket() s.bind(("localhost", port)) yield s s.close() @pytest.fixture def mock_fetch_token(self, instance): def set_token(*args, **kwargs): instance.oauth2session.token = { "access_token": mock.sentinel.access_token, "refresh_token": mock.sentinel.refresh_token, "id_token": mock.sentinel.id_token, "expires_at": 643969200.0, } fetch_token_patch = mock.patch.object( instance.oauth2session, "fetch_token", autospec=True, side_effect=set_token ) with fetch_token_patch as fetch_token_mock: yield fetch_token_mock @pytest.mark.webtest @mock.patch("google_auth_oauthlib.flow.webbrowser", autospec=True) def test_run_local_server(self, webbrowser_mock, instance, mock_fetch_token, port): auth_redirect_url = urllib.parse.urljoin( f"http://localhost:{port}", self.REDIRECT_REQUEST_PATH ) with concurrent.futures.ThreadPoolExecutor(max_workers=1) as pool: future = pool.submit(partial(instance.run_local_server, port=port)) while not future.done(): try: requests.get(auth_redirect_url) except requests.ConnectionError: # pragma: NO COVER pass credentials = future.result() assert credentials.token == mock.sentinel.access_token assert credentials._refresh_token == mock.sentinel.refresh_token assert credentials.id_token == mock.sentinel.id_token assert webbrowser_mock.get().open.called assert instance.redirect_uri == f"http://localhost:{port}/" expected_auth_response = auth_redirect_url.replace("http", "https") mock_fetch_token.assert_called_with( CLIENT_SECRETS_INFO["web"]["token_uri"], client_secret=CLIENT_SECRETS_INFO["web"]["client_secret"], authorization_response=expected_auth_response, code_verifier=None, audience=None, ) @pytest.mark.webtest @mock.patch("google_auth_oauthlib.flow.webbrowser", autospec=True) def test_run_local_server_audience( self, webbrowser_mock, instance, mock_fetch_token, port ): auth_redirect_url = urllib.parse.urljoin( f"http://localhost:{port}", self.REDIRECT_REQUEST_PATH ) with concurrent.futures.ThreadPoolExecutor(max_workers=1) as pool: future = pool.submit( partial( instance.run_local_server, port=port, token_audience=self.AUDIENCE ) ) while not future.done(): try: requests.get(auth_redirect_url) except requests.ConnectionError: # pragma: NO COVER pass credentials = future.result() assert credentials.token == mock.sentinel.access_token assert credentials._refresh_token == mock.sentinel.refresh_token assert credentials.id_token == mock.sentinel.id_token assert webbrowser_mock.get().open.called assert instance.redirect_uri == f"http://localhost:{port}/" expected_auth_response = auth_redirect_url.replace("http", "https") mock_fetch_token.assert_called_with( CLIENT_SECRETS_INFO["web"]["token_uri"], client_secret=CLIENT_SECRETS_INFO["web"]["client_secret"], authorization_response=expected_auth_response, code_verifier=None, audience=self.AUDIENCE, ) @pytest.mark.webtest @mock.patch("google_auth_oauthlib.flow.webbrowser", autospec=True) def test_run_local_server_code_verifier( self, webbrowser_mock, instance, mock_fetch_token, port ): auth_redirect_url = urllib.parse.urljoin( f"http://localhost:{port}", self.REDIRECT_REQUEST_PATH ) instance.code_verifier = "amanaplanacanalpanama" with concurrent.futures.ThreadPoolExecutor(max_workers=1) as pool: future = pool.submit( partial( instance.run_local_server, port=port, redirect_uri_trailing_slash=False, ) ) while not future.done(): try: requests.get(auth_redirect_url) except requests.ConnectionError: # pragma: NO COVER pass credentials = future.result() assert credentials.token == mock.sentinel.access_token assert credentials._refresh_token == mock.sentinel.refresh_token assert credentials.id_token == mock.sentinel.id_token assert webbrowser_mock.get().open.called assert instance.redirect_uri == f"http://localhost:{port}" expected_auth_response = auth_redirect_url.replace("http", "https") mock_fetch_token.assert_called_with( CLIENT_SECRETS_INFO["web"]["token_uri"], client_secret=CLIENT_SECRETS_INFO["web"]["client_secret"], authorization_response=expected_auth_response, code_verifier="amanaplanacanalpanama", audience=None, ) @mock.patch("google_auth_oauthlib.flow.webbrowser", autospec=True) @mock.patch("wsgiref.simple_server.make_server", autospec=True) def test_run_local_server_no_browser( self, make_server_mock, webbrowser_mock, instance, mock_fetch_token ): def assign_last_request_uri(host, port, wsgi_app, **kwargs): wsgi_app.last_request_uri = self.REDIRECT_REQUEST_PATH return mock.Mock() make_server_mock.side_effect = assign_last_request_uri instance.run_local_server(open_browser=False) assert not webbrowser_mock.get().open.called @mock.patch("google_auth_oauthlib.flow.webbrowser", autospec=True) @mock.patch("wsgiref.simple_server.make_server", autospec=True) def test_run_local_server_bind_addr( self, make_server_mock, webbrowser_mock, instance, mock_fetch_token ): def assign_last_request_uri(host, port, wsgi_app, **kwargs): wsgi_app.last_request_uri = self.REDIRECT_REQUEST_PATH return mock.Mock() make_server_mock.side_effect = assign_last_request_uri my_ip = socket.gethostbyname(socket.gethostname()) instance.run_local_server(bind_addr=my_ip, host="localhost") assert webbrowser_mock.get().open.called name, args, kwargs = make_server_mock.mock_calls[0] assert args[0] == my_ip @pytest.mark.webtest @mock.patch("google_auth_oauthlib.flow.webbrowser", autospec=True) def test_run_local_server_occupied_port( self, webbrowser_mock, instance, mock_fetch_token, port, socket ): # socket fixture is already bound to http://localhost:port instance.run_local_server 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()