Skip to content

Fix Spotbugs in azure-core #16500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
g2vinay merged 3 commits into from
Oct 24, 2020
Merged

Fix Spotbugs in azure-core #16500

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fabf2bb
fix spotbugs in azure-core
g2vinay Oct 19, 2020
f350619
update pom
g2vinay Oct 19, 2020
a1b3263
add unit test + add descriptions to spotbugs suppressions.
g2vinay Oct 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions eng/code-quality-reports/src/main/resources/spotbugs/spotbugs-exclude.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2433,4 +2433,18 @@
<Field name="detectionConfiguration" />
<Bug pattern="UWF_UNWRITTEN_FIELD" />
</Match>

<!-- Disabling false positives in azure-core -->
<Match>
<Class name="com.azure.core.util.logging.ClientLogger" />
<Bug pattern="CRLF_INJECTION_LOGS" />
</Match>
<Match>
<Class name="com.azure.core.http.policy.ExponentialBackoff" />
<Bug pattern="PREDICTABLE_RANDOM" />
</Match>
<Match>
<Class name="com.azure.core.implementation.logging.DefaultLogger" />
<Bug pattern="INFORMATION_EXPOSURE_THROUGH_AN_ERROR_MESSAGE" />
</Match>
</FindBugsFilter>
17 changes: 17 additions & 0 deletions sdk/core/azure-core/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,23 @@
</rules>
</configuration>
</plugin>

<!-- This plugin scans reports spotbugs in the code -->
<plugin>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-maven-plugin</artifactId>
<version>3.1.12.2</version> <!-- {x-version-update;com.github.spotbugs:spotbugs-maven-plugin;external_dependency} -->
<configuration>
<plugins>
<plugin>
<groupId>com.h3xstream.findsecbugs</groupId>
<artifactId>findsecbugs-plugin</artifactId>
<version>1.9.0</version> <!-- {x-version-update;com.h3xstream.findsecbugs:findsecbugs-plugin;external_dependency} -->
</plugin>
</plugins>
</configuration>
</plugin>

</plugins>
</build>

Expand Down
21 changes: 17 additions & 4 deletions sdk/core/azure-core/src/main/java/com/azure/core/util/logging/ClientLogger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

import java.util.Arrays;
import java.util.Objects;
import java.util.regex.Pattern;

/**
* This is a fluent logger helper class that wraps a pluggable {@link Logger}.
Expand All @@ -35,6 +36,7 @@
* @see Configuration
*/
public class ClientLogger {
private static final Pattern CRLF_PATTERN = Pattern.compile("[\r\n]");
private final Logger logger;

/**
Expand Down Expand Up @@ -70,7 +72,7 @@ public ClientLogger(String className) {
*/
public void verbose(String message) {
if (logger.isDebugEnabled()) {
logger.debug(message);
logger.debug(sanitizeLogMessageInput(message));
}
}

Expand Down Expand Up @@ -106,7 +108,7 @@ public void verbose(String format, Object... args) {
*/
public void info(String message) {
if (logger.isInfoEnabled()) {
logger.info(message);
logger.info(sanitizeLogMessageInput(message));
}
}

Expand Down Expand Up @@ -142,7 +144,7 @@ public void info(String format, Object... args) {
*/
public void warning(String message) {
if (logger.isWarnEnabled()) {
logger.warn(message);
logger.warn(sanitizeLogMessageInput(message));
}
}

Expand Down Expand Up @@ -178,7 +180,7 @@ public void warning(String format, Object... args) {
*/
public void error(String message) {
if (logger.isErrorEnabled()) {
logger.error(message);
logger.error(sanitizeLogMessageInput(message));
}
}

Expand Down Expand Up @@ -327,6 +329,7 @@ private void performLogging(LogLevel logLevel, boolean isExceptionLogging, Strin
}
}

sanitizeLogMessageInput(format);
switch (logLevel) {
case VERBOSE:
logger.debug(format, args);
Expand Down Expand Up @@ -401,4 +404,14 @@ private boolean doesArgsHaveThrowable(Object... args) {
private Object[] removeThrowable(Object... args) {
return Arrays.copyOf(args, args.length - 1);
}

/**
* Removes CRLF pattern in the {@code logMessage}.
*
* @param logMessage The log message to sanitize.
* @return The updated logMessage.
*/
private static String sanitizeLogMessageInput(String logMessage) {
return CRLF_PATTERN.matcher(logMessage).replaceAll("");
}
}