openstack/deb-python-oauth2client
Code Issues Proposed changes

Merge pull request #571 from jonparrott/fix-gce-timeout

Browse Source 
Add configurable timeout for metadata server.
This commit is contained in:
Nathaniel Manista
2016-07-27 14:02:05 -07:00
committed by GitHub
parent 86bd966cf2 216c7c9407
commit 323e5fabd4
2 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
oauth2client/client.py
View File

@@ -102,6 +102,14 @@ DEFAULT_ENV_NAME = 'UNKNOWN'
# If set to True _get_environment avoid GCE check (_detect_gce_environment) # If set to True _get_environment avoid GCE check (_detect_gce_environment)
NO_GCE_CHECK = os.environ.setdefault('NO_GCE_CHECK', 'False') NO_GCE_CHECK = os.environ.setdefault('NO_GCE_CHECK', 'False')
# Timeout in seconds to wait for the GCE metadata server when detecting the
# GCE environment.
try:
GCE_METADATA_TIMEOUT = int(
os.environ.setdefault('GCE_METADATA_TIMEOUT', '3'))
except ValueError: # pragma: NO COVER
GCE_METADATA_TIMEOUT = 3
_SERVER_SOFTWARE = 'SERVER_SOFTWARE' _SERVER_SOFTWARE = 'SERVER_SOFTWARE'
_GCE_METADATA_HOST = '169.254.169.254' _GCE_METADATA_HOST = '169.254.169.254'
_METADATA_FLAVOR_HEADER = 'Metadata-Flavor' _METADATA_FLAVOR_HEADER = 'Metadata-Flavor'
@@ -998,7 +1006,7 @@ def _detect_gce_environment():
# the metadata resolution was particularly slow. The latter case is # the metadata resolution was particularly slow. The latter case is
# "unlikely". # "unlikely".
connection = six.moves.http_client.HTTPConnection( connection = six.moves.http_client.HTTPConnection(
_GCE_METADATA_HOST, timeout=1) _GCE_METADATA_HOST, timeout=GCE_METADATA_TIMEOUT)
try: try:
headers = {_METADATA_FLAVOR_HEADER: _DESIRED_METADATA_FLAVOR} headers = {_METADATA_FLAVOR_HEADER: _DESIRED_METADATA_FLAVOR}

3
tests/test_client.py
View File

@@ -400,7 +400,8 @@ class GoogleCredentialsTests(unittest2.TestCase):
if server_software == '': if server_software == '':
http_client_module.HTTPConnection.assert_called_once_with( http_client_module.HTTPConnection.assert_called_once_with(
client._GCE_METADATA_HOST, timeout=1) client._GCE_METADATA_HOST,
timeout=client.GCE_METADATA_TIMEOUT)
connection.getresponse.assert_called_once_with() connection.getresponse.assert_called_once_with()
# Remaining calls are not "getresponse" # Remaining calls are not "getresponse"
headers = { headers = {