0cad208658
* Set the minimum version of python to be 2.6, since we don't need to support anything older anymore. * As the first of a series of related cleanups, drop our custom json module (since json is in the stdlib since 2.6).
323 lines
9.5 KiB
Python
323 lines
9.5 KiB
Python
#!/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.
|
|
|
|
|
|
"""Oauth2client.file tests
|
|
|
|
Unit tests for oauth2client.file
|
|
"""
|
|
|
|
__author__ = 'jcgregorio@google.com (Joe Gregorio)'
|
|
|
|
import copy
|
|
import datetime
|
|
import httplib2
|
|
import json
|
|
import os
|
|
import pickle
|
|
import stat
|
|
import tempfile
|
|
import unittest
|
|
|
|
from http_mock import HttpMockSequence
|
|
from oauth2client import GOOGLE_TOKEN_URI
|
|
from oauth2client import file
|
|
from oauth2client import locked_file
|
|
from oauth2client import multistore_file
|
|
from oauth2client import util
|
|
from oauth2client.client import AccessTokenCredentials
|
|
from oauth2client.client import AssertionCredentials
|
|
from oauth2client.client import OAuth2Credentials
|
|
|
|
|
|
FILENAME = tempfile.mktemp('oauth2client_test.data')
|
|
|
|
|
|
class OAuth2ClientFileTests(unittest.TestCase):
|
|
|
|
def tearDown(self):
|
|
try:
|
|
os.unlink(FILENAME)
|
|
except OSError:
|
|
pass
|
|
|
|
def setUp(self):
|
|
try:
|
|
os.unlink(FILENAME)
|
|
except OSError:
|
|
pass
|
|
|
|
def create_test_credentials(self, client_id='some_client_id'):
|
|
access_token = 'foo'
|
|
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'
|
|
|
|
credentials = OAuth2Credentials(
|
|
access_token, client_id, client_secret,
|
|
refresh_token, token_expiry, token_uri,
|
|
user_agent)
|
|
return credentials
|
|
|
|
def test_non_existent_file_storage(self):
|
|
s = file.Storage(FILENAME)
|
|
credentials = s.get()
|
|
self.assertEquals(None, credentials)
|
|
|
|
def test_no_sym_link_credentials(self):
|
|
if hasattr(os, 'symlink'):
|
|
SYMFILENAME = FILENAME + '.sym'
|
|
os.symlink(FILENAME, SYMFILENAME)
|
|
s = file.Storage(SYMFILENAME)
|
|
try:
|
|
s.get()
|
|
self.fail('Should have raised an exception.')
|
|
except file.CredentialsFileSymbolicLinkError:
|
|
pass
|
|
finally:
|
|
os.unlink(SYMFILENAME)
|
|
|
|
def test_pickle_and_json_interop(self):
|
|
# Write a file with a pickled OAuth2Credentials.
|
|
credentials = self.create_test_credentials()
|
|
|
|
f = open(FILENAME, 'w')
|
|
pickle.dump(credentials, f)
|
|
f.close()
|
|
|
|
# Storage should be not be able to read that object, as the capability to
|
|
# read and write credentials as pickled objects has been removed.
|
|
s = file.Storage(FILENAME)
|
|
read_credentials = s.get()
|
|
self.assertEquals(None, read_credentials)
|
|
|
|
# Now write it back out and confirm it has been rewritten as JSON
|
|
s.put(credentials)
|
|
with open(FILENAME) as f:
|
|
data = json.load(f)
|
|
|
|
self.assertEquals(data['access_token'], 'foo')
|
|
self.assertEquals(data['_class'], 'OAuth2Credentials')
|
|
self.assertEquals(data['_module'], OAuth2Credentials.__module__)
|
|
|
|
def test_token_refresh(self):
|
|
credentials = self.create_test_credentials()
|
|
|
|
s = file.Storage(FILENAME)
|
|
s.put(credentials)
|
|
credentials = s.get()
|
|
new_cred = copy.copy(credentials)
|
|
new_cred.access_token = 'bar'
|
|
s.put(new_cred)
|
|
|
|
credentials._refresh(lambda x: x)
|
|
self.assertEquals(credentials.access_token, 'bar')
|
|
|
|
def test_credentials_delete(self):
|
|
credentials = self.create_test_credentials()
|
|
|
|
s = file.Storage(FILENAME)
|
|
s.put(credentials)
|
|
credentials = s.get()
|
|
self.assertNotEquals(None, credentials)
|
|
s.delete()
|
|
credentials = s.get()
|
|
self.assertEquals(None, credentials)
|
|
|
|
def test_access_token_credentials(self):
|
|
access_token = 'foo'
|
|
user_agent = 'refresh_checker/1.0'
|
|
|
|
credentials = AccessTokenCredentials(access_token, user_agent)
|
|
|
|
s = file.Storage(FILENAME)
|
|
credentials = s.put(credentials)
|
|
credentials = s.get()
|
|
|
|
self.assertNotEquals(None, credentials)
|
|
self.assertEquals('foo', credentials.access_token)
|
|
mode = os.stat(FILENAME).st_mode
|
|
|
|
if os.name == 'posix':
|
|
self.assertEquals('0600', oct(stat.S_IMODE(os.stat(FILENAME).st_mode)))
|
|
|
|
def test_read_only_file_fail_lock(self):
|
|
credentials = self.create_test_credentials()
|
|
|
|
open(FILENAME, 'a+b').close()
|
|
os.chmod(FILENAME, 0400)
|
|
|
|
store = multistore_file.get_credential_storage(
|
|
FILENAME,
|
|
credentials.client_id,
|
|
credentials.user_agent,
|
|
['some-scope', 'some-other-scope'])
|
|
|
|
store.put(credentials)
|
|
if os.name == 'posix':
|
|
self.assertTrue(store._multistore._read_only)
|
|
os.chmod(FILENAME, 0600)
|
|
|
|
def test_multistore_no_symbolic_link_files(self):
|
|
if hasattr(os, 'symlink'):
|
|
SYMFILENAME = FILENAME + 'sym'
|
|
os.symlink(FILENAME, SYMFILENAME)
|
|
store = multistore_file.get_credential_storage(
|
|
SYMFILENAME,
|
|
'some_client_id',
|
|
'user-agent/1.0',
|
|
['some-scope', 'some-other-scope'])
|
|
try:
|
|
store.get()
|
|
self.fail('Should have raised an exception.')
|
|
except locked_file.CredentialsFileSymbolicLinkError:
|
|
pass
|
|
finally:
|
|
os.unlink(SYMFILENAME)
|
|
|
|
def test_multistore_non_existent_file(self):
|
|
store = multistore_file.get_credential_storage(
|
|
FILENAME,
|
|
'some_client_id',
|
|
'user-agent/1.0',
|
|
['some-scope', 'some-other-scope'])
|
|
|
|
credentials = store.get()
|
|
self.assertEquals(None, credentials)
|
|
|
|
def test_multistore_file(self):
|
|
credentials = self.create_test_credentials()
|
|
|
|
store = multistore_file.get_credential_storage(
|
|
FILENAME,
|
|
credentials.client_id,
|
|
credentials.user_agent,
|
|
['some-scope', 'some-other-scope'])
|
|
|
|
store.put(credentials)
|
|
credentials = store.get()
|
|
|
|
self.assertNotEquals(None, credentials)
|
|
self.assertEquals('foo', credentials.access_token)
|
|
|
|
store.delete()
|
|
credentials = store.get()
|
|
|
|
self.assertEquals(None, credentials)
|
|
|
|
if os.name == 'posix':
|
|
self.assertEquals('0600', oct(stat.S_IMODE(os.stat(FILENAME).st_mode)))
|
|
|
|
def test_multistore_file_custom_key(self):
|
|
credentials = self.create_test_credentials()
|
|
|
|
custom_key = {'myapp': 'testing', 'clientid': 'some client'}
|
|
store = multistore_file.get_credential_storage_custom_key(
|
|
FILENAME, custom_key)
|
|
|
|
store.put(credentials)
|
|
stored_credentials = store.get()
|
|
|
|
self.assertNotEquals(None, stored_credentials)
|
|
self.assertEqual(credentials.access_token, stored_credentials.access_token)
|
|
|
|
store.delete()
|
|
stored_credentials = store.get()
|
|
|
|
self.assertEquals(None, stored_credentials)
|
|
|
|
def test_multistore_file_custom_string_key(self):
|
|
credentials = self.create_test_credentials()
|
|
|
|
# store with string key
|
|
store = multistore_file.get_credential_storage_custom_string_key(
|
|
FILENAME, 'mykey')
|
|
|
|
store.put(credentials)
|
|
stored_credentials = store.get()
|
|
|
|
self.assertNotEquals(None, stored_credentials)
|
|
self.assertEqual(credentials.access_token, stored_credentials.access_token)
|
|
|
|
# try retrieving with a dictionary
|
|
store_dict = multistore_file.get_credential_storage_custom_string_key(
|
|
FILENAME, {'key': 'mykey'})
|
|
stored_credentials = store.get()
|
|
self.assertNotEquals(None, stored_credentials)
|
|
self.assertEqual(credentials.access_token, stored_credentials.access_token)
|
|
|
|
store.delete()
|
|
stored_credentials = store.get()
|
|
|
|
self.assertEquals(None, stored_credentials)
|
|
|
|
def test_multistore_file_backwards_compatibility(self):
|
|
credentials = self.create_test_credentials()
|
|
scopes = ['scope1', 'scope2']
|
|
|
|
# store the credentials using the legacy key method
|
|
store = multistore_file.get_credential_storage(
|
|
FILENAME, 'client_id', 'user_agent', scopes)
|
|
store.put(credentials)
|
|
|
|
# retrieve the credentials using a custom key that matches the legacy key
|
|
key = {'clientId': 'client_id', 'userAgent': 'user_agent',
|
|
'scope': util.scopes_to_string(scopes)}
|
|
store = multistore_file.get_credential_storage_custom_key(FILENAME, key)
|
|
stored_credentials = store.get()
|
|
|
|
self.assertEqual(credentials.access_token, stored_credentials.access_token)
|
|
|
|
|
|
def test_multistore_file_get_all_keys(self):
|
|
# start with no keys
|
|
keys = multistore_file.get_all_credential_keys(FILENAME)
|
|
self.assertEquals([], keys)
|
|
|
|
# store credentials
|
|
credentials = self.create_test_credentials(client_id='client1')
|
|
custom_key = {'myapp': 'testing', 'clientid': 'client1'}
|
|
store1 = multistore_file.get_credential_storage_custom_key(
|
|
FILENAME, custom_key)
|
|
store1.put(credentials)
|
|
|
|
keys = multistore_file.get_all_credential_keys(FILENAME)
|
|
self.assertEquals([custom_key], keys)
|
|
|
|
# store more credentials
|
|
credentials = self.create_test_credentials(client_id='client2')
|
|
string_key = 'string_key'
|
|
store2 = multistore_file.get_credential_storage_custom_string_key(
|
|
FILENAME, string_key)
|
|
store2.put(credentials)
|
|
|
|
keys = multistore_file.get_all_credential_keys(FILENAME)
|
|
self.assertEquals(2, len(keys))
|
|
self.assertTrue(custom_key in keys)
|
|
self.assertTrue({'key': string_key} in keys)
|
|
|
|
# back to no keys
|
|
store1.delete()
|
|
store2.delete()
|
|
keys = multistore_file.get_all_credential_keys(FILENAME)
|
|
self.assertEquals([], keys)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|