Skip to content

Commit 9e9af89

Browse files
zhumin8zhumin8
committed
cleanups and test setups. test ci groups not complete yet
1 parent 7f882d8 commit 9e9af89

21 files changed

+676
-275
lines changed

‎oauth2_http/java/com/google/auth/oauth2/ComputeEngineCredentials.java‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -470,9 +470,9 @@ private HttpResponse getMetadataResponse(
470470
requestMessage = "Sending request for universe domain/default service account";
471471
responseMessage = "Received response for universe domain/default service account";
472472
}
473-
Slf4jUtils.logRequest(request, LOGGER_PROVIDER, requestMessage);
473+
LoggingUtils.logRequest(request, LOGGER_PROVIDER, requestMessage);
474474
response = request.execute();
475-
Slf4jUtils.logResponse(response, LOGGER_PROVIDER, responseMessage);
475+
LoggingUtils.logResponse(response, LOGGER_PROVIDER, responseMessage);
476476
} catch (UnknownHostException exception) {
477477
throw new IOException(
478478
"ComputeEngineCredentials cannot find the metadata server. This is"
@@ -573,9 +573,10 @@ private static boolean pingComputeEngineMetadata(
573573
MetricsUtils.getGoogleCredentialsMetricsHeader(
574574
RequestType.METADATA_SERVER_PING, CredentialTypeForMetrics.DO_NOT_SEND));
575575

576-
Slf4jUtils.logRequest(request, LOGGER_PROVIDER, "Pinging Metadata Server");
576+
LoggingUtils.logRequest(request, LOGGER_PROVIDER, "Pinging Metadata Server");
577577
HttpResponse response = request.execute();
578-
Slf4jUtils.logResponse(response, LOGGER_PROVIDER, "Received response from Metadata Server");
578+
LoggingUtils.logResponse(
579+
response, LOGGER_PROVIDER, "Received response from Metadata Server");
579580
try {
580581
// Internet providers can return a generic response to all requests, so it is necessary
581582
// to check that metadata header is present also.
@@ -754,7 +755,7 @@ private String getDefaultServiceAccount() throws IOException {
754755
throw new IOException(METADATA_RESPONSE_EMPTY_CONTENT_ERROR_MESSAGE);
755756
}
756757
GenericData responseData = response.parseAs(GenericData.class);
757-
Slf4jUtils.logGenericData(
758+
LoggingUtils.logGenericData(
758759
responseData, LOGGER_PROVIDER, "Received default service account payload");
759760
Map<String, Object> defaultAccount =
760761
OAuth2Utils.validateMap(responseData, "default", PARSE_ERROR_ACCOUNT);

‎oauth2_http/java/com/google/auth/oauth2/IamUtils.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -155,10 +155,10 @@ private static String getSignature(
155155
IamUtils.IAM_RETRYABLE_STATUS_CODES.contains(response.getStatusCode())));
156156
request.setIOExceptionHandler(new HttpBackOffIOExceptionHandler(backoff));
157157

158-
Slf4jUtils.logRequest(
158+
LoggingUtils.logRequest(
159159
request, LOGGER_PROVIDER, "Sending request to get signature to sign the blob");
160160
HttpResponse response = request.execute();
161-
Slf4jUtils.logResponse(
161+
LoggingUtils.logResponse(
162162
response, LOGGER_PROVIDER, "Received response for signature to sign the blob");
163163
int statusCode = response.getStatusCode();
164164
if (statusCode >= 400 && statusCode < HttpStatusCodes.STATUS_CODE_SERVER_ERROR) {
@@ -186,7 +186,7 @@ private static String getSignature(
186186
}
187187

188188
GenericData responseData = response.parseAs(GenericData.class);
189-
Slf4jUtils.logGenericData(responseData, LOGGER_PROVIDER, "Response payload for sign blob");
189+
LoggingUtils.logGenericData(responseData, LOGGER_PROVIDER, "Response payload for sign blob");
190190
return OAuth2Utils.validateString(responseData, "signedBlob", PARSE_ERROR_SIGNATURE);
191191
}
192192

@@ -240,10 +240,10 @@ static IdToken getIdToken(
240240
MetricsUtils.getGoogleCredentialsMetricsHeader(
241241
RequestType.ID_TOKEN_REQUEST, credentialTypeForMetrics));
242242

243-
Slf4jUtils.logRequest(request, LOGGER_PROVIDER, "Sending request to get ID token");
243+
LoggingUtils.logRequest(request, LOGGER_PROVIDER, "Sending request to get ID token");
244244
HttpResponse response = request.execute();
245245

246-
Slf4jUtils.logResponse(response, LOGGER_PROVIDER, "Received response for ID token request");
246+
LoggingUtils.logResponse(response, LOGGER_PROVIDER, "Received response for ID token request");
247247
int statusCode = response.getStatusCode();
248248
if (statusCode >= 400 && statusCode < HttpStatusCodes.STATUS_CODE_SERVER_ERROR) {
249249
GenericData responseError = response.parseAs(GenericData.class);
@@ -268,7 +268,7 @@ static IdToken getIdToken(
268268
}
269269

270270
GenericJson responseData = response.parseAs(GenericJson.class);
271-
Slf4jUtils.logGenericData(
271+
LoggingUtils.logGenericData(
272272
responseData, LOGGER_PROVIDER, "Response payload for ID token request");
273273
String rawToken = OAuth2Utils.validateString(responseData, "token", PARSE_ERROR_MESSAGE);
274274
return IdToken.create(rawToken);

‎oauth2_http/java/com/google/auth/oauth2/ImpersonatedCredentials.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -555,16 +555,16 @@ public AccessToken refreshAccessToken() throws IOException {
555555

556556
HttpResponse response = null;
557557
try {
558-
Slf4jUtils.logRequest(request, LOGGER_PROVIDER, "Sending request to refresh access token");
558+
LoggingUtils.logRequest(request, LOGGER_PROVIDER, "Sending request to refresh access token");
559559
response = request.execute();
560-
Slf4jUtils.logResponse(
560+
LoggingUtils.logResponse(
561561
response, LOGGER_PROVIDER, "Received response for refresh access token");
562562
} catch (IOException e) {
563563
throw new IOException("Error requesting access token", e);
564564
}
565565

566566
GenericData responseData = response.parseAs(GenericData.class);
567-
Slf4jUtils.logGenericData(responseData, LOGGER_PROVIDER, "Response payload for access token");
567+
LoggingUtils.logGenericData(responseData, LOGGER_PROVIDER, "Response payload for access token");
568568
response.disconnect();
569569

570570
String accessToken =

‎oauth2_http/java/com/google/auth/oauth2/LoggerProvider.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ private LoggerProvider(Class<?> clazz) {
1111
this.clazz = clazz;
1212
}
1313

14-
public static LoggerProvider forClazz(Class<?> clazz) {
14+
static LoggerProvider forClazz(Class<?> clazz) {
1515
return new LoggerProvider(clazz);
1616
}
1717

18-
public Logger getLogger() {
18+
Logger getLogger() {
1919
if (logger == null) {
2020
this.logger = Slf4jUtils.getLogger(clazz);
2121
}

‎oauth2_http/java/com/google/auth/oauth2/LoggingConfigs.java‎

Lines changed: 0 additions & 83 deletions
This file was deleted.

‎oauth2_http/java/com/google/auth/oauth2/LoggingUtils.java‎

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,22 @@
44
import com.google.api.client.http.HttpResponse;
55
import com.google.api.client.util.GenericData;
66

7-
public class LoggingUtils {
7+
class LoggingUtils {
88

9-
private static boolean loggingEnabled = isLoggingEnabled();
109
static final String GOOGLE_SDK_JAVA_LOGGING = "GOOGLE_SDK_JAVA_LOGGING";
10+
private static EnvironmentProvider environmentProvider =
11+
SystemEnvironmentProvider.getInstance(); // this may be reset for testing purpose
12+
13+
private static boolean loggingEnabled = isLoggingEnabled();
14+
// expose this setter only for testing purposes
15+
static void setEnvironmentProvider(EnvironmentProvider provider) {
16+
environmentProvider = provider;
17+
// Recalculate LOGGING_ENABLED after setting the new provider
18+
loggingEnabled = isLoggingEnabled();
19+
}
1120

1221
static boolean isLoggingEnabled() {
13-
String enableLogging = System.getenv(GOOGLE_SDK_JAVA_LOGGING);
22+
String enableLogging = environmentProvider.getEnv(GOOGLE_SDK_JAVA_LOGGING);
1423
return "true".equalsIgnoreCase(enableLogging);
1524
}
1625

@@ -32,18 +41,4 @@ static void logGenericData(
3241
Slf4jUtils.logGenericData(genericData, loggerProvider, message);
3342
}
3443
}
35-
36-
//
37-
// public static void executeWithTryCatch(ThrowingRunnable action) {
38-
// try {
39-
// action.run();
40-
// } catch (Throwable t) {
41-
// // let logging exceptions fail silently
42-
// }
43-
// }
44-
//
45-
// @FunctionalInterface
46-
// public interface ThrowingRunnable {
47-
// void run() throws Throwable;
48-
// }
4944
}

‎oauth2_http/java/com/google/auth/oauth2/ServiceAccountCredentials.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,7 @@ boolean isConfiguredForDomainWideDelegation() {
507507

508508
private GenericData parseResponseAs(HttpResponse response) throws IOException {
509509
GenericData genericData = response.parseAs(GenericData.class);
510-
Slf4jUtils.logGenericData(genericData, LOGGER_PROVIDER, "Response payload");
510+
LoggingUtils.logGenericData(genericData, LOGGER_PROVIDER, "Response payload");
511511
return genericData;
512512
}
513513
/**
@@ -538,7 +538,7 @@ public AccessToken refreshAccessToken() throws IOException {
538538
}
539539
request.setParser(new JsonObjectParser(jsonFactory));
540540

541-
Slf4jUtils.logRequest(request, LOGGER_PROVIDER, "Sending request to refresh access token");
541+
LoggingUtils.logRequest(request, LOGGER_PROVIDER, "Sending request to refresh access token");
542542
ExponentialBackOff backoff =
543543
new ExponentialBackOff.Builder()
544544
.setInitialIntervalMillis(OAuth2Utils.INITIAL_RETRY_INTERVAL_MILLIS)
@@ -561,7 +561,7 @@ public AccessToken refreshAccessToken() throws IOException {
561561

562562
try {
563563
response = request.execute();
564-
Slf4jUtils.logResponse(
564+
LoggingUtils.logResponse(
565565
response, LOGGER_PROVIDER, "Received response for refresh access token");
566566
} catch (HttpResponseException re) {
567567
String message = String.format(errorTemplate, re.getMessage(), getIssuer());
@@ -621,11 +621,11 @@ private IdToken getIdTokenOauthEndpoint(String targetAudience) throws IOExceptio
621621
MetricsUtils.getGoogleCredentialsMetricsHeader(
622622
RequestType.ID_TOKEN_REQUEST, getMetricsCredentialType()));
623623

624-
Slf4jUtils.logRequest(
624+
LoggingUtils.logRequest(
625625
request, LOGGER_PROVIDER, "Sending request to get ID token via Oauth endpoint");
626626
HttpResponse httpResponse = executeRequest(request);
627627

628-
Slf4jUtils.logResponse(
628+
LoggingUtils.logResponse(
629629
httpResponse, LOGGER_PROVIDER, "Received response for ID token request via Oauth endpoint");
630630
GenericData responseData = parseResponseAs(httpResponse);
631631
String rawToken = OAuth2Utils.validateString(responseData, "id_token", PARSE_ERROR_PREFIX);
@@ -669,10 +669,10 @@ private IdToken getIdTokenIamEndpoint(String targetAudience) throws IOException
669669
// Use the Access Token from the SSJWT to request the ID Token from IAM Endpoint
670670
request.setHeaders(new HttpHeaders().set(AuthHttpConstants.AUTHORIZATION, accessToken));
671671

672-
Slf4jUtils.logRequest(
672+
LoggingUtils.logRequest(
673673
request, LOGGER_PROVIDER, "Sending request to get ID token via Iam Endpoint");
674674
HttpResponse httpResponse = executeRequest(request);
675-
Slf4jUtils.logResponse(
675+
LoggingUtils.logResponse(
676676
httpResponse, LOGGER_PROVIDER, "Received response for ID token request via Iam endpoint");
677677

678678
GenericData responseData = parseResponseAs(httpResponse);

‎oauth2_http/java/com/google/auth/oauth2/Slf4jUtils.java‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
class Slf4jUtils {
5858

5959
private static final Logger NO_OP_LOGGER = org.slf4j.helpers.NOPLogger.NOP_LOGGER;
60-
private static boolean loggingEnabled = LoggingUtils.isLoggingEnabled();
6160
private static final Gson gson = new Gson();
6261
private static final Set<String> SENSITIVE_KEYS = new TreeSet<>(String.CASE_INSENSITIVE_ORDER);
6362
private static boolean hasAddKeyValue;
@@ -95,7 +94,7 @@ static Logger getLogger(Class<?> clazz) {
9594

9695
// constructor with LoggerFactoryProvider to make testing easier
9796
static Logger getLogger(Class<?> clazz, LoggerFactoryProvider factoryProvider) {
98-
if (loggingEnabled) {
97+
if (LoggingUtils.isLoggingEnabled()) {
9998
ILoggerFactory loggerFactory = factoryProvider.getLoggerFactory();
10099
return loggerFactory.getLogger(clazz.getName());
101100
} else {
@@ -122,7 +121,6 @@ static void logWithMDC(
122121
Object value = entry.getValue();
123122

124123
MDC.put(key, value instanceof String ? (String) value : gson.toJson(value));
125-
// MDC.put(key, value.toString()); // different from gax, to not bring in gson (that logic is not used in auth)
126124
}
127125
}
128126
switch (level) {

‎oauth2_http/java/com/google/auth/oauth2/UserCredentials.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -285,9 +285,9 @@ private GenericData doRefreshAccessToken() throws IOException {
285285
HttpResponse response;
286286

287287
try {
288-
Slf4jUtils.logRequest(request, LOGGER_PROVIDER, "Sending request to refresh access token");
288+
LoggingUtils.logRequest(request, LOGGER_PROVIDER, "Sending request to refresh access token");
289289
response = request.execute();
290-
Slf4jUtils.logResponse(
290+
LoggingUtils.logResponse(
291291
response, LOGGER_PROVIDER, "Received response for refresh access token");
292292
} catch (HttpResponseException re) {
293293
throw GoogleAuthException.createWithTokenEndpointResponseException(re);
@@ -297,7 +297,7 @@ private GenericData doRefreshAccessToken() throws IOException {
297297

298298
GenericData data = response.parseAs(GenericData.class);
299299

300-
Slf4jUtils.logGenericData(data, LOGGER_PROVIDER, "Response payload for access token");
300+
LoggingUtils.logGenericData(data, LOGGER_PROVIDER, "Response payload for access token");
301301
return data;
302302
}
303303

0 commit comments

Comments
 (0)