| #!/usr/bin/python2.4 |
| # |
| # Copyright 2010 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. |
| |
| |
| """Discovery document tests |
| |
| Unit tests for objects created from discovery documents. |
| """ |
| |
| __author__ = 'jcgregorio@google.com (Joe Gregorio)' |
| |
| import base64 |
| import datetime |
| import httplib2 |
| import mox |
| import os |
| import time |
| import unittest |
| import urlparse |
| |
| try: |
| from urlparse import parse_qs |
| except ImportError: |
| from cgi import parse_qs |
| |
| import dev_appserver |
| dev_appserver.fix_sys_path() |
| import webapp2 |
| |
| from apiclient.http import HttpMockSequence |
| from google.appengine.api import apiproxy_stub |
| from google.appengine.api import apiproxy_stub_map |
| from google.appengine.api import app_identity |
| from google.appengine.api import memcache |
| from google.appengine.api import users |
| from google.appengine.api.memcache import memcache_stub |
| from google.appengine.ext import db |
| from google.appengine.ext import testbed |
| from google.appengine.runtime import apiproxy_errors |
| from oauth2client import appengine |
| from oauth2client.anyjson import simplejson |
| from oauth2client.clientsecrets import _loadfile |
| from oauth2client.clientsecrets import InvalidClientSecretsError |
| from oauth2client.appengine import AppAssertionCredentials |
| from oauth2client.appengine import CredentialsModel |
| from oauth2client.appengine import FlowProperty |
| from oauth2client.appengine import OAuth2Decorator |
| from oauth2client.appengine import StorageByKeyName |
| from oauth2client.appengine import oauth2decorator_from_clientsecrets |
| from oauth2client.client import AccessTokenRefreshError |
| from oauth2client.client import Credentials |
| from oauth2client.client import FlowExchangeError |
| from oauth2client.client import OAuth2Credentials |
| from oauth2client.client import flow_from_clientsecrets |
| from webtest import TestApp |
| |
| |
| DATA_DIR = os.path.join(os.path.dirname(__file__), 'data') |
| |
| |
| def datafile(filename): |
| return os.path.join(DATA_DIR, filename) |
| |
| |
| def load_and_cache(existing_file, fakename, cache_mock): |
| client_type, client_info = _loadfile(datafile(existing_file)) |
| cache_mock.cache[fakename] = {client_type: client_info} |
| |
| |
| class CacheMock(object): |
| def __init__(self): |
| self.cache = {} |
| |
| def get(self, key, namespace=''): |
| # ignoring namespace for easier testing |
| return self.cache.get(key, None) |
| |
| def set(self, key, value, namespace=''): |
| # ignoring namespace for easier testing |
| self.cache[key] = value |
| |
| |
| class UserMock(object): |
| """Mock the app engine user service""" |
| |
| def __call__(self): |
| return self |
| |
| def user_id(self): |
| return 'foo_user' |
| |
| |
| class UserNotLoggedInMock(object): |
| """Mock the app engine user service""" |
| |
| def __call__(self): |
| return None |
| |
| |
| class Http2Mock(object): |
| """Mock httplib2.Http""" |
| status = 200 |
| content = { |
| 'access_token': 'foo_access_token', |
| 'refresh_token': 'foo_refresh_token', |
| 'expires_in': 3600, |
| } |
| |
| def request(self, token_uri, method, body, headers, *args, **kwargs): |
| self.body = body |
| self.headers = headers |
| return (self, simplejson.dumps(self.content)) |
| |
| |
| class TestAppAssertionCredentials(unittest.TestCase): |
| account_name = "service_account_name@appspot.com" |
| signature = "signature" |
| |
| |
| class AppIdentityStubImpl(apiproxy_stub.APIProxyStub): |
| |
| def __init__(self): |
| super(TestAppAssertionCredentials.AppIdentityStubImpl, self).__init__( |
| 'app_identity_service') |
| |
| def _Dynamic_GetAccessToken(self, request, response): |
| response.set_access_token('a_token_123') |
| response.set_expiration_time(time.time() + 1800) |
| |
| |
| class ErroringAppIdentityStubImpl(apiproxy_stub.APIProxyStub): |
| |
| def __init__(self): |
| super(TestAppAssertionCredentials.ErroringAppIdentityStubImpl, self).__init__( |
| 'app_identity_service') |
| |
| def _Dynamic_GetAccessToken(self, request, response): |
| raise app_identity.BackendDeadlineExceeded() |
| |
| def test_raise_correct_type_of_exception(self): |
| app_identity_stub = self.ErroringAppIdentityStubImpl() |
| apiproxy_stub_map.apiproxy = apiproxy_stub_map.APIProxyStubMap() |
| apiproxy_stub_map.apiproxy.RegisterStub("app_identity_service", |
| app_identity_stub) |
| apiproxy_stub_map.apiproxy.RegisterStub( |
| 'memcache', memcache_stub.MemcacheServiceStub()) |
| |
| scope = "http://www.googleapis.com/scope" |
| try: |
| credentials = AppAssertionCredentials(scope) |
| http = httplib2.Http() |
| credentials.refresh(http) |
| self.fail('Should have raised an AccessTokenRefreshError') |
| except AccessTokenRefreshError: |
| pass |
| |
| def test_get_access_token_on_refresh(self): |
| app_identity_stub = self.AppIdentityStubImpl() |
| apiproxy_stub_map.apiproxy = apiproxy_stub_map.APIProxyStubMap() |
| apiproxy_stub_map.apiproxy.RegisterStub("app_identity_service", |
| app_identity_stub) |
| apiproxy_stub_map.apiproxy.RegisterStub( |
| 'memcache', memcache_stub.MemcacheServiceStub()) |
| |
| scope = [ |
| "http://www.googleapis.com/scope", |
| "http://www.googleapis.com/scope2"] |
| credentials = AppAssertionCredentials(scope) |
| http = httplib2.Http() |
| credentials.refresh(http) |
| self.assertEqual('a_token_123', credentials.access_token) |
| |
| json = credentials.to_json() |
| credentials = Credentials.new_from_json(json) |
| self.assertEqual( |
| 'http://www.googleapis.com/scope http://www.googleapis.com/scope2', |
| credentials.scope) |
| |
| scope = "http://www.googleapis.com/scope http://www.googleapis.com/scope2" |
| credentials = AppAssertionCredentials(scope) |
| http = httplib2.Http() |
| credentials.refresh(http) |
| self.assertEqual('a_token_123', credentials.access_token) |
| self.assertEqual( |
| 'http://www.googleapis.com/scope http://www.googleapis.com/scope2', |
| credentials.scope) |
| |
| class TestFlowModel(db.Model): |
| flow = FlowProperty() |
| |
| |
| class FlowPropertyTest(unittest.TestCase): |
| |
| def setUp(self): |
| self.testbed = testbed.Testbed() |
| self.testbed.activate() |
| self.testbed.init_datastore_v3_stub() |
| |
| def tearDown(self): |
| self.testbed.deactivate() |
| |
| def test_flow_get_put(self): |
| instance = TestFlowModel( |
| flow=flow_from_clientsecrets(datafile('client_secrets.json'), 'foo', |
| redirect_uri='oob'), |
| key_name='foo' |
| ) |
| instance.put() |
| retrieved = TestFlowModel.get_by_key_name('foo') |
| |
| self.assertEqual('foo_client_id', retrieved.flow.client_id) |
| |
| |
| def _http_request(*args, **kwargs): |
| resp = httplib2.Response({'status': '200'}) |
| content = simplejson.dumps({'access_token': 'bar'}) |
| |
| return resp, content |
| |
| |
| class StorageByKeyNameTest(unittest.TestCase): |
| |
| def setUp(self): |
| self.testbed = testbed.Testbed() |
| self.testbed.activate() |
| self.testbed.init_datastore_v3_stub() |
| self.testbed.init_memcache_stub() |
| self.testbed.init_user_stub() |
| |
| access_token = "foo" |
| client_id = "some_client_id" |
| client_secret = "cOuDdkfjxxnv+" |
| refresh_token = "1/0/a.df219fjls0" |
| token_expiry = datetime.datetime.utcnow() |
| token_uri = "https://www.google.com/accounts/o8/oauth2/token" |
| user_agent = "refresh_checker/1.0" |
| self.credentials = OAuth2Credentials( |
| access_token, client_id, client_secret, |
| refresh_token, token_expiry, token_uri, |
| user_agent) |
| |
| def tearDown(self): |
| self.testbed.deactivate() |
| |
| def test_get_and_put_simple(self): |
| storage = StorageByKeyName( |
| CredentialsModel, 'foo', 'credentials') |
| |
| self.assertEqual(None, storage.get()) |
| self.credentials.set_store(storage) |
| |
| self.credentials._refresh(_http_request) |
| credmodel = CredentialsModel.get_by_key_name('foo') |
| self.assertEqual('bar', credmodel.credentials.access_token) |
| |
| def test_get_and_put_cached(self): |
| storage = StorageByKeyName( |
| CredentialsModel, 'foo', 'credentials', cache=memcache) |
| |
| self.assertEqual(None, storage.get()) |
| self.credentials.set_store(storage) |
| |
| self.credentials._refresh(_http_request) |
| credmodel = CredentialsModel.get_by_key_name('foo') |
| self.assertEqual('bar', credmodel.credentials.access_token) |
| |
| # Now remove the item from the cache. |
| memcache.delete('foo') |
| |
| # Check that getting refreshes the cache. |
| credentials = storage.get() |
| self.assertEqual('bar', credentials.access_token) |
| self.assertNotEqual(None, memcache.get('foo')) |
| |
| # Deleting should clear the cache. |
| storage.delete() |
| credentials = storage.get() |
| self.assertEqual(None, credentials) |
| self.assertEqual(None, memcache.get('foo')) |
| |
| |
| class MockRequest(object): |
| url = 'https://example.org' |
| |
| def relative_url(self, rel): |
| return self.url + rel |
| |
| |
| class MockRequestHandler(object): |
| request = MockRequest() |
| |
| |
| class DecoratorTests(unittest.TestCase): |
| |
| def setUp(self): |
| self.testbed = testbed.Testbed() |
| self.testbed.activate() |
| self.testbed.init_datastore_v3_stub() |
| self.testbed.init_memcache_stub() |
| self.testbed.init_user_stub() |
| |
| decorator = OAuth2Decorator(client_id='foo_client_id', |
| client_secret='foo_client_secret', |
| scope=['foo_scope', 'bar_scope'], |
| user_agent='foo') |
| |
| self._finish_setup(decorator, user_mock=UserMock) |
| |
| def _finish_setup(self, decorator, user_mock): |
| self.decorator = decorator |
| |
| class TestRequiredHandler(webapp2.RequestHandler): |
| |
| @decorator.oauth_required |
| def get(self): |
| pass |
| |
| class TestAwareHandler(webapp2.RequestHandler): |
| |
| @decorator.oauth_aware |
| def get(self, *args, **kwargs): |
| self.response.out.write('Hello World!') |
| assert(kwargs['year'] == '2012') |
| assert(kwargs['month'] == '01') |
| |
| |
| application = webapp2.WSGIApplication([ |
| ('/oauth2callback', self.decorator.callback_handler()), |
| ('/foo_path', TestRequiredHandler), |
| webapp2.Route(r'/bar_path/<year:\d{4}>/<month:\d{2}>', |
| handler=TestAwareHandler, name='bar')], |
| debug=True) |
| self.app = TestApp(application, extra_environ={ |
| 'wsgi.url_scheme': 'http', |
| 'HTTP_HOST': 'localhost', |
| }) |
| users.get_current_user = user_mock() |
| self.httplib2_orig = httplib2.Http |
| httplib2.Http = Http2Mock |
| |
| def tearDown(self): |
| self.testbed.deactivate() |
| httplib2.Http = self.httplib2_orig |
| |
| def test_required(self): |
| # An initial request to an oauth_required decorated path should be a |
| # redirect to start the OAuth dance. |
| response = self.app.get('http://localhost/foo_path') |
| self.assertTrue(response.status.startswith('302')) |
| q = parse_qs(response.headers['Location'].split('?', 1)[1]) |
| self.assertEqual('http://localhost/oauth2callback', q['redirect_uri'][0]) |
| self.assertEqual('foo_client_id', q['client_id'][0]) |
| self.assertEqual('foo_scope bar_scope', q['scope'][0]) |
| self.assertEqual('http://localhost/foo_path', |
| q['state'][0].rsplit(':', 1)[0]) |
| self.assertEqual('code', q['response_type'][0]) |
| self.assertEqual(False, self.decorator.has_credentials()) |
| |
| m = mox.Mox() |
| m.StubOutWithMock(appengine, "_parse_state_value") |
| appengine._parse_state_value('foo_path:xsrfkey123', |
| mox.IgnoreArg()).AndReturn('foo_path') |
| m.ReplayAll() |
| |
| # Now simulate the callback to /oauth2callback. |
| response = self.app.get('/oauth2callback', { |
| 'code': 'foo_access_code', |
| 'state': 'foo_path:xsrfkey123', |
| }) |
| self.assertEqual('http://localhost/foo_path', response.headers['Location']) |
| self.assertEqual(None, self.decorator.credentials) |
| |
| m.UnsetStubs() |
| m.VerifyAll() |
| |
| # Now requesting the decorated path should work. |
| response = self.app.get('/foo_path') |
| self.assertEqual('200 OK', response.status) |
| self.assertEqual(True, self.decorator.has_credentials()) |
| self.assertEqual('foo_refresh_token', |
| self.decorator.credentials.refresh_token) |
| self.assertEqual('foo_access_token', |
| self.decorator.credentials.access_token) |
| |
| # Invalidate the stored Credentials. |
| self.decorator.credentials.invalid = True |
| self.decorator.credentials.store.put(self.decorator.credentials) |
| |
| # Invalid Credentials should start the OAuth dance again. |
| response = self.app.get('/foo_path') |
| self.assertTrue(response.status.startswith('302')) |
| q = parse_qs(response.headers['Location'].split('?', 1)[1]) |
| self.assertEqual('http://localhost/oauth2callback', q['redirect_uri'][0]) |
| |
| def test_storage_delete(self): |
| # An initial request to an oauth_required decorated path should be a |
| # redirect to start the OAuth dance. |
| response = self.app.get('/foo_path') |
| self.assertTrue(response.status.startswith('302')) |
| |
| m = mox.Mox() |
| m.StubOutWithMock(appengine, "_parse_state_value") |
| appengine._parse_state_value('foo_path:xsrfkey123', |
| mox.IgnoreArg()).AndReturn('foo_path') |
| m.ReplayAll() |
| |
| # Now simulate the callback to /oauth2callback. |
| response = self.app.get('/oauth2callback', { |
| 'code': 'foo_access_code', |
| 'state': 'foo_path:xsrfkey123', |
| }) |
| self.assertEqual('http://localhost/foo_path', response.headers['Location']) |
| self.assertEqual(None, self.decorator.credentials) |
| |
| # Now requesting the decorated path should work. |
| response = self.app.get('/foo_path') |
| |
| # Invalidate the stored Credentials. |
| self.decorator.credentials.store.delete() |
| |
| # Invalid Credentials should start the OAuth dance again. |
| response = self.app.get('/foo_path') |
| self.assertTrue(response.status.startswith('302')) |
| |
| m.UnsetStubs() |
| m.VerifyAll() |
| |
| def test_aware(self): |
| # An initial request to an oauth_aware decorated path should not redirect. |
| response = self.app.get('http://localhost/bar_path/2012/01') |
| self.assertEqual('Hello World!', response.body) |
| self.assertEqual('200 OK', response.status) |
| self.assertEqual(False, self.decorator.has_credentials()) |
| url = self.decorator.authorize_url() |
| q = parse_qs(url.split('?', 1)[1]) |
| self.assertEqual('http://localhost/oauth2callback', q['redirect_uri'][0]) |
| self.assertEqual('foo_client_id', q['client_id'][0]) |
| self.assertEqual('foo_scope bar_scope', q['scope'][0]) |
| self.assertEqual('http://localhost/bar_path/2012/01', |
| q['state'][0].rsplit(':', 1)[0]) |
| self.assertEqual('code', q['response_type'][0]) |
| |
| m = mox.Mox() |
| m.StubOutWithMock(appengine, "_parse_state_value") |
| appengine._parse_state_value('bar_path:xsrfkey456', |
| mox.IgnoreArg()).AndReturn('bar_path') |
| m.ReplayAll() |
| |
| # Now simulate the callback to /oauth2callback. |
| url = self.decorator.authorize_url() |
| response = self.app.get('/oauth2callback', { |
| 'code': 'foo_access_code', |
| 'state': 'bar_path:xsrfkey456', |
| }) |
| self.assertEqual('http://localhost/bar_path', response.headers['Location']) |
| self.assertEqual(False, self.decorator.has_credentials()) |
| |
| m.UnsetStubs() |
| m.VerifyAll() |
| |
| # Now requesting the decorated path will have credentials. |
| response = self.app.get('/bar_path/2012/01') |
| self.assertEqual('200 OK', response.status) |
| self.assertEqual('Hello World!', response.body) |
| self.assertEqual(True, self.decorator.has_credentials()) |
| self.assertEqual('foo_refresh_token', |
| self.decorator.credentials.refresh_token) |
| self.assertEqual('foo_access_token', |
| self.decorator.credentials.access_token) |
| |
| def test_error_in_step2(self): |
| # An initial request to an oauth_aware decorated path should not redirect. |
| response = self.app.get('/bar_path/2012/01') |
| url = self.decorator.authorize_url() |
| response = self.app.get('/oauth2callback', { |
| 'error': 'Bad<Stuff>Happened\'' |
| }) |
| self.assertEqual('200 OK', response.status) |
| self.assertTrue('Bad<Stuff>Happened'' in response.body) |
| |
| def test_kwargs_are_passed_to_underlying_flow(self): |
| decorator = OAuth2Decorator(client_id='foo_client_id', |
| client_secret='foo_client_secret', |
| user_agent='foo_user_agent', |
| scope=['foo_scope', 'bar_scope'], |
| access_type='offline', |
| approval_prompt='force') |
| request_handler = MockRequestHandler() |
| decorator._create_flow(request_handler) |
| |
| self.assertEqual('https://example.org/oauth2callback', |
| decorator.flow.redirect_uri) |
| self.assertEqual('offline', decorator.flow.params['access_type']) |
| self.assertEqual('force', decorator.flow.params['approval_prompt']) |
| self.assertEqual('foo_user_agent', decorator.flow.user_agent) |
| self.assertEqual(None, decorator.flow.params.get('user_agent', None)) |
| |
| def test_decorator_from_client_secrets(self): |
| decorator = oauth2decorator_from_clientsecrets( |
| datafile('client_secrets.json'), |
| scope=['foo_scope', 'bar_scope']) |
| self._finish_setup(decorator, user_mock=UserMock) |
| |
| self.assertFalse(decorator._in_error) |
| self.decorator = decorator |
| self.test_required() |
| http = self.decorator.http() |
| self.assertEquals('foo_access_token', http.request.credentials.access_token) |
| |
| def test_decorator_from_cached_client_secrets(self): |
| cache_mock = CacheMock() |
| load_and_cache('client_secrets.json', 'secret', cache_mock) |
| decorator = oauth2decorator_from_clientsecrets( |
| # filename, scope, message=None, cache=None |
| 'secret', '', cache=cache_mock) |
| self.assertFalse(decorator._in_error) |
| |
| def test_decorator_from_client_secrets_not_logged_in_required(self): |
| decorator = oauth2decorator_from_clientsecrets( |
| datafile('client_secrets.json'), |
| scope=['foo_scope', 'bar_scope'], message='NotLoggedInMessage') |
| self.decorator = decorator |
| self._finish_setup(decorator, user_mock=UserNotLoggedInMock) |
| |
| self.assertFalse(decorator._in_error) |
| |
| # An initial request to an oauth_required decorated path should be a |
| # redirect to login. |
| response = self.app.get('/foo_path') |
| self.assertTrue(response.status.startswith('302')) |
| self.assertTrue('Login' in str(response)) |
| |
| def test_decorator_from_client_secrets_not_logged_in_aware(self): |
| decorator = oauth2decorator_from_clientsecrets( |
| datafile('client_secrets.json'), |
| scope=['foo_scope', 'bar_scope'], message='NotLoggedInMessage') |
| self.decorator = decorator |
| self._finish_setup(decorator, user_mock=UserNotLoggedInMock) |
| |
| # An initial request to an oauth_aware decorated path should be a |
| # redirect to login. |
| response = self.app.get('/bar_path/2012/03') |
| self.assertTrue(response.status.startswith('302')) |
| self.assertTrue('Login' in str(response)) |
| |
| def test_decorator_from_unfilled_client_secrets_required(self): |
| MESSAGE = 'File is missing' |
| try: |
| decorator = oauth2decorator_from_clientsecrets( |
| datafile('unfilled_client_secrets.json'), |
| scope=['foo_scope', 'bar_scope'], message=MESSAGE) |
| except InvalidClientSecretsError: |
| pass |
| |
| def test_decorator_from_unfilled_client_secrets_aware(self): |
| MESSAGE = 'File is missing' |
| try: |
| decorator = oauth2decorator_from_clientsecrets( |
| datafile('unfilled_client_secrets.json'), |
| scope=['foo_scope', 'bar_scope'], message=MESSAGE) |
| except InvalidClientSecretsError: |
| pass |
| |
| |
| class DecoratorXsrfSecretTests(unittest.TestCase): |
| """Test xsrf_secret_key.""" |
| |
| def setUp(self): |
| self.testbed = testbed.Testbed() |
| self.testbed.activate() |
| self.testbed.init_datastore_v3_stub() |
| self.testbed.init_memcache_stub() |
| |
| def tearDown(self): |
| self.testbed.deactivate() |
| |
| def test_build_and_parse_state(self): |
| secret = appengine.xsrf_secret_key() |
| |
| # Secret shouldn't change from call to call. |
| secret2 = appengine.xsrf_secret_key() |
| self.assertEqual(secret, secret2) |
| |
| # Secret shouldn't change if memcache goes away. |
| memcache.delete(appengine.XSRF_MEMCACHE_ID, |
| namespace=appengine.OAUTH2CLIENT_NAMESPACE) |
| secret3 = appengine.xsrf_secret_key() |
| self.assertEqual(secret2, secret3) |
| |
| # Secret should change if both memcache and the model goes away. |
| memcache.delete(appengine.XSRF_MEMCACHE_ID, |
| namespace=appengine.OAUTH2CLIENT_NAMESPACE) |
| model = appengine.SiteXsrfSecretKey.get_or_insert('site') |
| model.delete() |
| |
| secret4 = appengine.xsrf_secret_key() |
| self.assertNotEqual(secret3, secret4) |
| |
| |
| class DecoratorXsrfProtectionTests(unittest.TestCase): |
| """Test _build_state_value and _parse_state_value.""" |
| |
| def setUp(self): |
| self.testbed = testbed.Testbed() |
| self.testbed.activate() |
| self.testbed.init_datastore_v3_stub() |
| self.testbed.init_memcache_stub() |
| |
| def tearDown(self): |
| self.testbed.deactivate() |
| |
| def test_build_and_parse_state(self): |
| state = appengine._build_state_value(MockRequestHandler(), UserMock()) |
| self.assertEqual( |
| 'https://example.org', |
| appengine._parse_state_value(state, UserMock())) |
| self.assertRaises(appengine.InvalidXsrfTokenError, |
| appengine._parse_state_value, state[1:], UserMock()) |
| |
| |
| if __name__ == '__main__': |
| unittest.main() |