feat: honor `NO_GCE_CHECK` environment variable (#1610) · googleapis/google-auth-library-python@383c982

This repository was archived by the owner on Mar 6, 2026. It is now read-only.

File tree

lines changed

lines changed

Original file line number	Diff line number	Diff line change
`@@ -101,6 +101,10 @@ def _get_metadata_ip_root(use_mtls: bool):`
`101`	`101`	`except ValueError: # pragma: NO COVER`
`102`	`102`	`_METADATA_DEFAULT_TIMEOUT = 3`
`103`	`103`
	`104`	`+# This is used to disable checking for the GCE metadata server and directly`
	`105`	`+# assuming it's not available.`
	`106`	`+_NO_GCE_CHECK = os.getenv(environment_vars.NO_GCE_CHECK) == "true"`
	`107`	`+`
`104`	`108`	`# Detect GCE Residency`
`105`	`109`	`_GOOGLE = "Google"`
`106`	`110`	`_GCE_PRODUCT_NAME_FILE = "/sys/class/dmi/id/product_name"`
`@@ -116,6 +120,9 @@ def is_on_gce(request):`
`116`	`120`	`Returns:`
`117`	`121`	`bool: True if the code runs on Google Compute Engine, False otherwise.`
`118`	`122`	`"""`
	`123`	`+if _NO_GCE_CHECK:`
	`124`	`+return False`
	`125`	`+`
`119`	`126`	`if ping(request):`
`120`	`127`	`return True`
`121`	`128`

Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,12 @@`
`60`	`60`	`"""Environment variable providing an alternate ip:port to be used for ip-only`
`61`	`61`	`GCE metadata requests."""`
`62`	`62`
	`63`	`+NO_GCE_CHECK = "NO_GCE_CHECK"`
	`64`	`+"""Environment variable controlling whether to check if running on GCE or not.`
	`65`	`+`
	`66`	`+The default value is false. Users have to explicitly set this value to true`
	`67`	`+in order to disable the GCE check."""`
	`68`	`+`
`63`	`69`	`GCE_METADATA_MTLS_MODE = "GCE_METADATA_MTLS_MODE"`
`64`	`70`	`"""Environment variable controlling the mTLS behavior for GCE metadata requests.`
`65`	`71`

Original file line number	Diff line number	Diff line change
`@@ -108,6 +108,20 @@ def test_is_on_gce_ping_success():`
`108`	`108`	`assert _metadata.is_on_gce(request)`
`109`	`109`
`110`	`110`
	`111`	`+def test_is_on_gce_no_gce_check():`
	`112`	`+request = make_request("", headers=_metadata._METADATA_HEADERS)`
	`113`	`+`
	`114`	`+os.environ[environment_vars.NO_GCE_CHECK] = "true"`
	`115`	`+importlib.reload(_metadata)`
	`116`	`+`
	`117`	`+try:`
	`118`	`+assert not _metadata.is_on_gce(request)`
	`119`	`+assert request.call_count == 0`
	`120`	`+finally:`
	`121`	`+del os.environ[environment_vars.NO_GCE_CHECK]`
	`122`	`+importlib.reload(_metadata)`
	`123`	`+`
	`124`	`+`
`111`	`125`	`@mock.patch("os.name", new="nt")`
`112`	`126`	`def test_is_on_gce_windows_success():`
`113`	`127`	`request = make_request("", headers={_metadata._METADATA_FLAVOR_HEADER: "meep"})`