MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2025-12-15 02:59:33 +07:00
Code Issues Packages Projects Releases Wiki Activity

Java: teach inspection about existence of Jetbrains and Spring CheckReturnValue annotations (IDEA-374480)

Browse Source 
for "Result of method call ignored" inspection

GitOrigin-RevId: e3face53d7745d416fba8a22f2e02a1954f71442
This commit is contained in:
Bas Leijdekkers
2025-06-16 13:06:56 +02:00
committed by intellij-monorepo-bot
parent 9ce81139e9
commit ae7c9e0075
2 changed files with 98 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
java/java-impl/src/com/siyeh/ig/bugs/IgnoreResultOfCallInspection.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2003-2023 Dave Griffith, Bas Leijdekkers
* Copyright 2003-2025 Dave Griffith, Bas Leijdekkers
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -106,7 +106,11 @@ public final class IgnoreResultOfCallInspection extends BaseInspection {
);
private static final Set<String> CHECK_ANNOTATIONS = Set.of(
"javax.annotation.CheckReturnValue", "org.assertj.core.util.CheckReturnValue", "com.google.errorprone.annotations.CheckReturnValue");
"javax.annotation.CheckReturnValue",
"org.assertj.core.util.CheckReturnValue",
"com.google.errorprone.annotations.CheckReturnValue",
"org.jetbrains.annotations.CheckReturnValue",
"org.springframework.lang.CheckReturnValue");
private final MethodMatcher myMethodMatcher;
/**
* @noinspection PublicField

127
java/java-tests/testSrc/com/siyeh/ig/bugs/IgnoreResultOfCallInspectionTest.java
View File

@@ -1,4 +1,4 @@
// Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
package com.siyeh.ig.bugs;
import com.intellij.codeInspection.LocalInspectionTool;
@@ -9,7 +9,7 @@ import com.intellij.testFramework.LightProjectDescriptor;
import com.siyeh.ig.LightJavaInspectionTestCase;
import org.jetbrains.annotations.NotNull;
@SuppressWarnings({"ResultOfMethodCallIgnored", "UnusedReturnValue"})
@SuppressWarnings("ALL")
public class IgnoreResultOfCallInspectionTest extends LightJavaInspectionTestCase {
@Override
protected LocalInspectionTool getInspection() {
@@ -53,8 +53,7 @@ public class IgnoreResultOfCallInspectionTest extends LightJavaInspectionTestCas
import javax.annotation.meta.When;
@Documented
@Target( { ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.TYPE,
ElementType.PACKAGE })
@Target({ ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.TYPE, ElementType.PACKAGE })
@Retention(RetentionPolicy.RUNTIME)
public @interface CheckReturnValue {
When when() default When.ALWAYS;
@@ -62,22 +61,45 @@ public class IgnoreResultOfCallInspectionTest extends LightJavaInspectionTestCas
""",
"""
package com.google.errorprone.annotations;
import static java.lang.annotation.ElementType.CONSTRUCTOR;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PACKAGE;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Documented
@Target({METHOD,CONSTRUCTOR,TYPE,PACKAGE})
@Retention(value=RUNTIME)
@Target({METHOD,CONSTRUCTOR,TYPE,PACKAGE})
@Retention(value=RUNTIME)
public @interface CheckReturnValue {}
""",
"""
package org.jetbrains.annotations;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
@Documented
@Target({ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.TYPE, ElementType.PACKAGE})
public @interface CheckReturnValue {}
""",
"""
package org.springframework.lang;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
@Documented
@Target({ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.TYPE, ElementType.PACKAGE})
public @interface CheckReturnValue {}
""",
"""
package org.assertj.core.util;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import static java.lang.annotation.ElementType.CONSTRUCTOR;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PACKAGE;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({CONSTRUCTOR,METHOD,PACKAGE,TYPE})
@Retention(value=CLASS)
@@ -166,6 +188,42 @@ public class IgnoreResultOfCallInspectionTest extends LightJavaInspectionTestCas
"""};
}
public void testJetbrainsAnnotationOnClass() {
doTest("""
import org.jetbrains.annotations.CheckReturnValue;
@CheckReturnValue
class Test {
String foo() {
return "foo";
}
public static void main(String[] args){
new Test()./*Result of 'Test.foo()' is ignored*/foo/**/();
}
}
""");
}
public void testSpringAnnotationOnClass() {
doTest("""
import org.springframework.lang.CheckReturnValue;
@CheckReturnValue
class Test {
String foo() {
return "foo";
}
public static void main(String[] args){
new Test()./*Result of 'Test.foo()' is ignored*/foo/**/();
}
}
""");
}
public void testCanIgnoreReturnValue() {
doTest("""
import com.google.errorprone.annotations.CanIgnoreReturnValue;
@@ -277,7 +335,7 @@ public class IgnoreResultOfCallInspectionTest extends LightJavaInspectionTestCas
ignoreMe(); // <- also inspection
}
}
""");
""");
}
public void testCustomCheckReturnValue() {
@@ -716,29 +774,28 @@ public class IgnoreResultOfCallInspectionTest extends LightJavaInspectionTestCas
}
public void testArgumentSideEffects() {
doTest(
"""
import java.nio.channels.FileChannel;
import java.nio.ByteBuffer;
import java.io.IOException;
class X {
public static void withoutSideEffects(FileChannel fch, ByteBuffer[] srcs) throws IOException {
fch./*Result of 'FileChannel.write()' is ignored*/write/**/(srcs);
}
public static long useResult(FileChannel fch, ByteBuffer[] srcs) throws IOException {
return fch.write(srcs);
}
public static void hasSideEffect(FileChannel fch, ByteBuffer[] srcs) throws IOException {
do{
fch.write(srcs);
} while (test(srcs));
}
public static boolean test(ByteBuffer[] srcs){
return srcs[0].hasRemaining();
}
}
""");
doTest("""
import java.nio.channels.FileChannel;
import java.nio.ByteBuffer;
import java.io.IOException;
class X {
public static void withoutSideEffects(FileChannel fch, ByteBuffer[] srcs) throws IOException {
fch./*Result of 'FileChannel.write()' is ignored*/write/**/(srcs);
}
public static long useResult(FileChannel fch, ByteBuffer[] srcs) throws IOException {
return fch.write(srcs);
}
public static void hasSideEffect(FileChannel fch, ByteBuffer[] srcs) throws IOException {
do{
fch.write(srcs);
} while (test(srcs));
}
public static boolean test(ByteBuffer[] srcs){
return srcs[0].hasRemaining();
}
}
""");
}
public void testFragment() {