Skip to content

SONARJAVA-5185 exclude Optional.orElseThrow from S2201 as it has side effects #4946

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
erwan-serandour merged 4 commits into from
Dec 5, 2024
+8 −17
Merged

SONARJAVA-5185 exclude Optional.orElseThrow from S2201 as it has side effects #4946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ff010b1
add new test case : Optional.orElseThrow
erwan-serandour Dec 4, 2024
b4f5fb0
exclude Optional.orElseThrow from the rule
erwan-serandour Dec 4, 2024
e3eddb8
update ruling tests
erwan-serandour Dec 4, 2024
6f88aa2
improve after code review
erwan-serandour Dec 4, 2024
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
15 changes: 0 additions & 15 deletions its/ruling/src/test/resources/sonar-server/java-S2201.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,5 @@
{
"org.sonarsource.sonarqube:sonar-server:src/main/java/org/sonar/server/component/ws/ProjectMeasuresQueryFactory.java": [
129
],
"org.sonarsource.sonarqube:sonar-server:src/main/java/org/sonar/server/issue/ws/AssignAction.java": [
153
],
"org.sonarsource.sonarqube:sonar-server:src/main/java/org/sonar/server/permission/ws/PermissionWsSupport.java": [
110
],
"org.sonarsource.sonarqube:sonar-server:src/main/java/org/sonar/server/qualityprofile/ws/SetDefaultAction.java": [
71
],
"org.sonarsource.sonarqube:sonar-server:src/main/java/org/sonar/server/rule/RuleCreator.java": [
87
],
"org.sonarsource.sonarqube:sonar-server:src/main/java/org/sonar/server/usergroups/ws/AddUserAction.java": [
102
]
}
4 changes: 4 additions & 0 deletions ...checks-test-sources/default/src/main/java/checks/S2201_IgnoredReturnValueCheckSample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,4 +176,8 @@ public Collection<String> get() {
List<String> makeList() {
return new ArrayList<>();
}

void validateValue(Object o){
Optional.ofNullable(o).orElseThrow(); // Compliant: orElseThrow() is used for the side effect
}
}
6 changes: 4 additions & 2 deletions java-checks/src/main/java/org/sonar/java/checks/IgnoredReturnValueCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ public class IgnoredReturnValueCheck extends IssuableSubscriptionVisitor {
private static final String JAVA_LANG_STRING = "java.lang.String";
private static final String JAVA_UTIL_FUNCTION_SUPPLIER = "java.util.function.Supplier";
private static final String JAVA_UTIL_STREAM_STREAM = "java.util.stream.Stream";
private static final String JAVA_UTIL_OPTIONAL = "java.util.Optional";
private static final String COLLECT = "collect";
private static final List<String> CHECKED_TYPES = Arrays.asList(
JAVA_LANG_STRING,
Expand Down Expand Up @@ -67,14 +68,15 @@ public class IgnoredReturnValueCheck extends IssuableSubscriptionVisitor {
"java.time.ZonedDateTime",
"java.math.BigInteger",
"java.math.BigDecimal",
"java.util.Optional",
JAVA_UTIL_OPTIONAL,
"com.google.common.base.Optional");

private static final List<String> EXCLUDED_PREFIX = Arrays.asList("parse", "format", "decode", "valueOf");

private static final MethodMatchers EXCLUDED = MethodMatchers.or(
MethodMatchers.create().ofTypes("java.lang.Character").names("toChars").addParametersMatcher("int", "char[]", "int").build(),
MethodMatchers.create().ofTypes(JAVA_LANG_STRING).names("intern").addWithoutParametersMatcher().build());
MethodMatchers.create().ofTypes(JAVA_LANG_STRING).names("intern").addWithoutParametersMatcher().build(),
MethodMatchers.create().ofTypes(JAVA_UTIL_OPTIONAL).names("orElseThrow").withAnyParameters().build());

private static final MethodMatchers STRING_GET_BYTES = MethodMatchers.create()
.ofTypes(JAVA_LANG_STRING).names("getBytes").addParametersMatcher("java.nio.charset.Charset").build();
Expand Down
Loading