Merge pull request #122 from neozwu/use-gce-meta-for-gae8

neozwu · web-flow · commit 60870c90a9ba · 2017-09-01T16:18:17.000-07:00
use metadata server to get credentials for GAE 8 standard environment
diff --git a/oauth2_http/java/com/google/auth/oauth2/DefaultCredentialsProvider.java b/oauth2_http/java/com/google/auth/oauth2/DefaultCredentialsProvider.java
@@ -69,6 +69,9 @@ class DefaultCredentialsProvider {
   static final String CLOUD_SHELL_ENV_VAR = "DEVSHELL_CLIENT_PORT";
 
   static final String SKIP_APP_ENGINE_ENV_VAR = "GOOGLE_APPLICATION_CREDENTIALS_SKIP_APP_ENGINE";
+  static final String SPECIFICATION_VERSION = System.getProperty("java.specification.version");
+  static final String GAE_RUNTIME_VERSION = System.getProperty("com.google.appengine.runtime.version");
+  static final String RUNTIME_JETTY_LOGGER = System.getProperty("org.eclipse.jetty.util.log.class");
 
   static final String NO_GCE_CHECK_ENV_VAR = "NO_GCE_CHECK";
   static final String GCE_METADATA_HOST_ENV_VAR = "GCE_METADATA_HOST";
@@ -175,8 +178,8 @@ private final GoogleCredentials getDefaultCredentialsUnsynchronized(
       }
     }
 
-    // Then try App Engine
-    if (credentials == null && !skipAppEngineCredentialsCheck()) {
+    // Then try GAE 7 standard environment
+    if (credentials == null && isOnGAEStandard7() && !skipAppEngineCredentialsCheck()) {
       credentials = tryGetAppEngineCredential();
     }
 
@@ -186,7 +189,7 @@ private final GoogleCredentials getDefaultCredentialsUnsynchronized(
       credentials = tryGetCloudShellCredentials();
     }
 
-    // Then try Compute Engine
+    // Then try Compute Engine and GAE 8 standard environment
     if (credentials == null) {
       credentials = tryGetComputeCredentials(transportFactory);
     }
@@ -283,6 +286,11 @@ private boolean skipAppEngineCredentialsCheck() {
     return skip;
   }
 
+  protected boolean isOnGAEStandard7() {
+    return GAE_RUNTIME_VERSION != null
+        && (SPECIFICATION_VERSION.equals("1.7") || RUNTIME_JETTY_LOGGER == null);
+  }
+
   /*
    * Start of methods to allow overriding in the test code to isolate from the environment.
    */
diff --git a/oauth2_http/javatests/com/google/auth/oauth2/DefaultCredentialsProviderTest.java b/oauth2_http/javatests/com/google/auth/oauth2/DefaultCredentialsProviderTest.java
@@ -187,6 +187,7 @@ public void getDefaultCredentials_appEngineClassWithoutRuntime_NotFoundError() {
     TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
     testProvider.addType(DefaultCredentialsProvider.APP_ENGINE_SIGNAL_CLASS,
         MockOffAppEngineSystemProperty.class);
+    testProvider.setProperty("isOnGAEStandard7", "true");
 
     try {
       testProvider.getDefaultCredentials(transportFactory);
@@ -203,6 +204,7 @@ public void getDefaultCredentials_appEngineRuntimeWithoutClass_throwsHelpfulLoad
     TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
     testProvider.addType(DefaultCredentialsProvider.APP_ENGINE_SIGNAL_CLASS,
         MockAppEngineSystemProperty.class);
+    testProvider.setProperty("isOnGAEStandard7", "true");
 
     try {
       testProvider.getDefaultCredentials(transportFactory);
@@ -223,6 +225,7 @@ public void getDefaultCredentials_appEngineSkipWorks_retrievesCloudShellCredenti
         MockOffAppEngineSystemProperty.class);
     testProvider.setEnv(DefaultCredentialsProvider.CLOUD_SHELL_ENV_VAR,"9090");
     testProvider.setEnv(DefaultCredentialsProvider.SKIP_APP_ENGINE_ENV_VAR, "true");
+    testProvider.setProperty("isOnGAEStanadard7", "true");
     GoogleCredentials credentials = testProvider.getDefaultCredentials(transportFactory);
     assertNotNull(credentials);
     assertTrue(credentials instanceof CloudShellCredentials);
@@ -578,6 +581,11 @@ Class<?> forName(String className) throws ClassNotFoundException {
       throw new ClassNotFoundException("TestDefaultCredentialProvider: Class not found.");
     }
 
+    @Override
+    protected boolean isOnGAEStandard7() {
+      return getProperty("isOnGAEStandard7", "false").equals("true");
+    }
+
     int getForNameCallCount() {
       return forNameCallCount;
     }

Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,9 @@ class DefaultCredentialsProvider {`
`69`	`69`	`static final String CLOUD_SHELL_ENV_VAR = "DEVSHELL_CLIENT_PORT";`
`70`	`70`
`71`	`71`	`static final String SKIP_APP_ENGINE_ENV_VAR = "GOOGLE_APPLICATION_CREDENTIALS_SKIP_APP_ENGINE";`
	`72`	`+ static final String SPECIFICATION_VERSION = System.getProperty("java.specification.version");`
	`73`	`+ static final String GAE_RUNTIME_VERSION = System.getProperty("com.google.appengine.runtime.version");`
	`74`	`+ static final String RUNTIME_JETTY_LOGGER = System.getProperty("org.eclipse.jetty.util.log.class");`
`72`	`75`
`73`	`76`	`static final String NO_GCE_CHECK_ENV_VAR = "NO_GCE_CHECK";`
`74`	`77`	`static final String GCE_METADATA_HOST_ENV_VAR = "GCE_METADATA_HOST";`
`@@ -175,8 +178,8 @@ private final GoogleCredentials getDefaultCredentialsUnsynchronized(`
`175`	`178`	`}`
`176`	`179`	`}`
`177`	`180`
`178`		`- // Then try App Engine`
`179`		`- if (credentials == null && !skipAppEngineCredentialsCheck()) {`
	`181`	`+ // Then try GAE 7 standard environment`
	`182`	`+ if (credentials == null && isOnGAEStandard7() && !skipAppEngineCredentialsCheck()) {`
`180`	`183`	`credentials = tryGetAppEngineCredential();`
`181`	`184`	`}`
`182`	`185`
`@@ -186,7 +189,7 @@ private final GoogleCredentials getDefaultCredentialsUnsynchronized(`
`186`	`189`	`credentials = tryGetCloudShellCredentials();`
`187`	`190`	`}`
`188`	`191`
`189`		`- // Then try Compute Engine`
	`192`	`+ // Then try Compute Engine and GAE 8 standard environment`
`190`	`193`	`if (credentials == null) {`
`191`	`194`	`credentials = tryGetComputeCredentials(transportFactory);`
`192`	`195`	`}`
`@@ -283,6 +286,11 @@ private boolean skipAppEngineCredentialsCheck() {`
`283`	`286`	`return skip;`
`284`	`287`	`}`
`285`	`288`
	`289`	`+ protected boolean isOnGAEStandard7() {`
	`290`	`+ return GAE_RUNTIME_VERSION != null`
	`291`	`+ && (SPECIFICATION_VERSION.equals("1.7") \|\| RUNTIME_JETTY_LOGGER == null);`
	`292`	`+ }`
	`293`	`+`
`286`	`294`	`/*`
`287`	`295`	`* Start of methods to allow overriding in the test code to isolate from the environment.`
`288`	`296`	`*/`