-
Notifications
You must be signed in to change notification settings - Fork 229
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: expose method to manually obtain ADC from gcloud CLI well-known… (
#1188) * feat: expose method to manually obtain ADC from gcloud CLI well-known file * chore: expose well-known file instead of credentials * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * chore: expose path to well-known creds file only * chore: better test name * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * chore: revert changes in favor of util class * chore: move gcloud CLI path logic to new utils class * chore: add GoogleAuthUtils test * chore: use default instance of DCP * chore: revert initial changes of utils class * chore: restore static modifier * chore: use test-friendly method signatures of auth utils * chore: fix utils test to compute path assuming env not set * chore: correct comments for the auth util class * chore: license header for utils test --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
- Loading branch information
1 parent
1a6d02f
commit 2fa9d52
Showing
4 changed files
with
144 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
81 changes: 81 additions & 0 deletions
81
oauth2_http/java/com/google/auth/oauth2/GoogleAuthUtils.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
/* | ||
* Copyright 2023, Google Inc. All rights reserved. | ||
* | ||
* Redistribution and use in source and binary forms, with or without | ||
* modification, are permitted provided that the following conditions are | ||
* met: | ||
* | ||
* * Redistributions of source code must retain the above copyright | ||
* notice, this list of conditions and the following disclaimer. | ||
* * Redistributions in binary form must reproduce the above | ||
* copyright notice, this list of conditions and the following disclaimer | ||
* in the documentation and/or other materials provided with the | ||
* distribution. | ||
* | ||
* * Neither the name of Google Inc. nor the names of its | ||
* contributors may be used to endorse or promote products derived from | ||
* this software without specific prior written permission. | ||
* | ||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
*/ | ||
|
||
package com.google.auth.oauth2; | ||
|
||
import java.io.File; | ||
|
||
/** | ||
* This public class provides shared utilities for common OAuth2 utils or ADC. It also exposes | ||
* convenience methods such as a getter for well-known Application Default Credentials file path | ||
*/ | ||
public class GoogleAuthUtils { | ||
|
||
/** | ||
* Gets the path to the well-known Application Default Credentials file location | ||
* | ||
* @return the path to the well-known Application Default Credentials file location | ||
*/ | ||
public static final String getWellKnownCredentialsPath() { | ||
return getWellKnownCredentialsFile(DefaultCredentialsProvider.DEFAULT).getAbsolutePath(); | ||
} | ||
|
||
/** | ||
* Testing version of getWellKnownCredentialsPath() that uses a custom provider | ||
* | ||
* @return the path to the well-known Application Default Credentials file location | ||
*/ | ||
static final String getWellKnownCredentialsPath(DefaultCredentialsProvider provider) { | ||
return getWellKnownCredentialsFile(provider).getAbsolutePath(); | ||
} | ||
|
||
/** | ||
* Platform-independent logic to obtain the well-known Application Default Credentials file | ||
* | ||
* @param provider the provider used to resolve env and system properties (exposed for testing | ||
* purposes) | ||
* @return the well-known Application Default Credentials file | ||
*/ | ||
static final File getWellKnownCredentialsFile(DefaultCredentialsProvider provider) { | ||
File cloudConfigPath; | ||
String envPath = provider.getEnv("CLOUDSDK_CONFIG"); | ||
if (envPath != null) { | ||
cloudConfigPath = new File(envPath); | ||
} else if (provider.getOsName().indexOf("windows") >= 0) { | ||
File appDataPath = new File(provider.getEnv("APPDATA")); | ||
cloudConfigPath = new File(appDataPath, provider.CLOUDSDK_CONFIG_DIRECTORY); | ||
} else { | ||
File configPath = new File(provider.getProperty("user.home", ""), ".config"); | ||
cloudConfigPath = new File(configPath, provider.CLOUDSDK_CONFIG_DIRECTORY); | ||
} | ||
return new File(cloudConfigPath, provider.WELL_KNOWN_CREDENTIALS_FILE); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
58 changes: 58 additions & 0 deletions
58
oauth2_http/javatests/com/google/auth/oauth2/GoogleAuthUtilsTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
/* | ||
* Copyright 2023, Google Inc. All rights reserved. | ||
* | ||
* Redistribution and use in source and binary forms, with or without | ||
* modification, are permitted provided that the following conditions are | ||
* met: | ||
* | ||
* * Redistributions of source code must retain the above copyright | ||
* notice, this list of conditions and the following disclaimer. | ||
* * Redistributions in binary form must reproduce the above | ||
* copyright notice, this list of conditions and the following disclaimer | ||
* in the documentation and/or other materials provided with the | ||
* distribution. | ||
* | ||
* * Neither the name of Google Inc. nor the names of its | ||
* contributors may be used to endorse or promote products derived from | ||
* this software without specific prior written permission. | ||
* | ||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
*/ | ||
|
||
package com.google.auth.oauth2; | ||
|
||
import static org.junit.Assert.assertEquals; | ||
import static org.junit.Assert.assertNotNull; | ||
|
||
import java.io.File; | ||
import org.junit.Test; | ||
|
||
public class GoogleAuthUtilsTest { | ||
|
||
@Test | ||
public void getWellKnownCredentialsPath_correct() { | ||
DefaultCredentialsProvider provider = | ||
new DefaultCredentialsProviderTest.TestDefaultCredentialsProvider(); | ||
// since the TestDefaultCredentialsProvider properties and envs are not set, | ||
// the base folder will be an empty string using. | ||
File homeDir = new File(""); | ||
File configDir = new File(homeDir, ".config"); | ||
File cloudConfigDir = new File(configDir, provider.CLOUDSDK_CONFIG_DIRECTORY); | ||
File wellKnownFile = new File(cloudConfigDir, provider.WELL_KNOWN_CREDENTIALS_FILE); | ||
|
||
String obtainedPath = GoogleAuthUtils.getWellKnownCredentialsPath(provider); | ||
|
||
assertNotNull(obtainedPath); | ||
assertEquals(obtainedPath, wellKnownFile.getAbsolutePath()); | ||
} | ||
} |