Add "Redundant 'requireNotNull' or 'checkNotNull' call" inspection
#KT-29113 Fixed
This commit is contained in:
Toshiaki Kameyama
committed by
Mikhail Glukhikh
Mikhail Glukhikh
parent
c234683770
commit
fa1f3871c0
@@ -3248,6 +3248,15 @@
|
|||||||
language="kotlin"
|
language="kotlin"
|
||||||
/>
|
/>
|
||||||
|
|
||||||
|
<localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.RedundantRequireNotNullCallInspection"
|
||||||
|
displayName="Redundant 'requireNotNull' or 'checkNotNull' call"
|
||||||
|
groupPath="Kotlin"
|
||||||
|
groupName="Redundant constructs"
|
||||||
|
enabledByDefault="true"
|
||||||
|
level="WEAK WARNING"
|
||||||
|
language="kotlin"
|
||||||
|
/>
|
||||||
|
|
||||||
<referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
|
<referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
|
||||||
|
|
||||||
<fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>
|
<fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>
|
||||||
|
|||||||
@@ -0,0 +1,11 @@
|
|||||||
|
<html>
|
||||||
|
<body>This inspection reports redundant <b>requireNotNull</b> or <b>checkNotNull</b> call:
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
fun foo(i: Int) {
|
||||||
|
requireNotNull(i) // This 'i' is always not null, so this 'requireNotNull' call is redundant.
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
+74
@@ -0,0 +1,74 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2010-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license
|
||||||
|
* that can be found in the license/LICENSE.txt file.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package org.jetbrains.kotlin.idea.inspections
|
||||||
|
|
||||||
|
import com.intellij.codeInspection.LocalQuickFix
|
||||||
|
import com.intellij.codeInspection.ProblemDescriptor
|
||||||
|
import com.intellij.codeInspection.ProblemHighlightType
|
||||||
|
import com.intellij.codeInspection.ProblemsHolder
|
||||||
|
import com.intellij.openapi.project.Project
|
||||||
|
import org.jetbrains.kotlin.descriptors.CallableDescriptor
|
||||||
|
import org.jetbrains.kotlin.idea.caches.resolve.analyze
|
||||||
|
import org.jetbrains.kotlin.idea.caches.resolve.getResolutionFacade
|
||||||
|
import org.jetbrains.kotlin.idea.inspections.collections.isCalling
|
||||||
|
import org.jetbrains.kotlin.idea.project.languageVersionSettings
|
||||||
|
import org.jetbrains.kotlin.name.FqName
|
||||||
|
import org.jetbrains.kotlin.psi.KtCallExpression
|
||||||
|
import org.jetbrains.kotlin.psi.KtReferenceExpression
|
||||||
|
import org.jetbrains.kotlin.psi.callExpressionVisitor
|
||||||
|
import org.jetbrains.kotlin.psi.psiUtil.getQualifiedExpressionForSelector
|
||||||
|
import org.jetbrains.kotlin.psi.psiUtil.getStrictParentOfType
|
||||||
|
import org.jetbrains.kotlin.psi.psiUtil.referenceExpression
|
||||||
|
import org.jetbrains.kotlin.resolve.BindingContext
|
||||||
|
import org.jetbrains.kotlin.resolve.bindingContextUtil.getDataFlowInfoBefore
|
||||||
|
import org.jetbrains.kotlin.resolve.calls.callUtil.getResolvedCall
|
||||||
|
import org.jetbrains.kotlin.resolve.calls.smartcasts.DataFlowValueFactory
|
||||||
|
import org.jetbrains.kotlin.resolve.lazy.BodyResolveMode
|
||||||
|
import org.jetbrains.kotlin.types.KotlinType
|
||||||
|
import org.jetbrains.kotlin.types.isNullable
|
||||||
|
|
||||||
|
class RedundantRequireNotNullCallInspection : AbstractKotlinInspection() {
|
||||||
|
override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean) = callExpressionVisitor(fun(callExpression) {
|
||||||
|
val callee = callExpression.calleeExpression ?: return
|
||||||
|
val context = callExpression.analyze(BodyResolveMode.PARTIAL)
|
||||||
|
if (!callExpression.isCalling(FqName("kotlin.requireNotNull"), context)
|
||||||
|
&& !callExpression.isCalling(FqName("kotlin.checkNotNull"), context)
|
||||||
|
) return
|
||||||
|
|
||||||
|
val argument = callExpression.valueArguments.firstOrNull()?.getArgumentExpression()?.referenceExpression() ?: return
|
||||||
|
val descriptor = argument.getResolvedCall(context)?.resultingDescriptor ?: return
|
||||||
|
val type = descriptor.returnType ?: return
|
||||||
|
if (argument.isNullable(descriptor, type, context)) return
|
||||||
|
|
||||||
|
val functionName = callee.text
|
||||||
|
holder.registerProblem(
|
||||||
|
callee,
|
||||||
|
"Redundant '$functionName' call",
|
||||||
|
ProblemHighlightType.GENERIC_ERROR_OR_WARNING,
|
||||||
|
RemoveRequireNotNullCallFix(functionName)
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
private fun KtReferenceExpression.isNullable(descriptor: CallableDescriptor, type: KotlinType, context: BindingContext): Boolean {
|
||||||
|
if (!type.isNullable()) return false
|
||||||
|
val dataFlowValueFactory = this.getResolutionFacade().getFrontendService(DataFlowValueFactory::class.java)
|
||||||
|
val dataFlow = dataFlowValueFactory.createDataFlowValue(this, type, context, descriptor)
|
||||||
|
val stableTypes = context.getDataFlowInfoBefore(this).getStableTypes(dataFlow, this.languageVersionSettings)
|
||||||
|
return stableTypes.none { !it.isNullable() }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private class RemoveRequireNotNullCallFix(private val functionName: String) : LocalQuickFix {
|
||||||
|
override fun getName() = "Remove '$functionName' call"
|
||||||
|
|
||||||
|
override fun getFamilyName() = name
|
||||||
|
|
||||||
|
override fun applyFix(project: Project, descriptor: ProblemDescriptor) {
|
||||||
|
val callExpression = descriptor.psiElement.getStrictParentOfType<KtCallExpression>() ?: return
|
||||||
|
val qualifiedExpression = callExpression.getQualifiedExpressionForSelector()
|
||||||
|
(qualifiedExpression ?: callExpression).delete()
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
org.jetbrains.kotlin.idea.inspections.RedundantRequireNotNullCallInspection
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
// WITH_RUNTIME
|
||||||
|
fun test(s: String) {
|
||||||
|
println(1)
|
||||||
|
kotlin.<caret>checkNotNull(s)
|
||||||
|
println(2)
|
||||||
|
}
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
// WITH_RUNTIME
|
||||||
|
fun test(s: String) {
|
||||||
|
println(1)
|
||||||
|
println(2)
|
||||||
|
}
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
// WITH_RUNTIME
|
||||||
|
fun test(s: String) {
|
||||||
|
println(1)
|
||||||
|
<caret>requireNotNull(s)
|
||||||
|
println(2)
|
||||||
|
}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
// WITH_RUNTIME
|
||||||
|
fun test(s: String) {
|
||||||
|
println(1)
|
||||||
|
println(2)
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
// WITH_RUNTIME
|
||||||
|
fun test(s: String?) {
|
||||||
|
if (s != null) {
|
||||||
|
println(1)
|
||||||
|
requireNotNull<caret>(s) { "" }
|
||||||
|
println(2)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
// WITH_RUNTIME
|
||||||
|
fun test(s: String?) {
|
||||||
|
if (s != null) {
|
||||||
|
println(1)
|
||||||
|
println(2)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
// WITH_RUNTIME
|
||||||
|
fun test(s: String?) {
|
||||||
|
requireNotNull(s)
|
||||||
|
<caret>requireNotNull(s)
|
||||||
|
println(1)
|
||||||
|
}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
// WITH_RUNTIME
|
||||||
|
fun test(s: String?) {
|
||||||
|
requireNotNull(s)
|
||||||
|
println(1)
|
||||||
|
}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
// PROBLEM: none
|
||||||
|
// WITH_RUNTIME
|
||||||
|
fun test(s: String?) {
|
||||||
|
<caret>requireNotNull(s)
|
||||||
|
}
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
// PROBLEM: none
|
||||||
|
// WITH_RUNTIME
|
||||||
|
class Test {
|
||||||
|
var s: String? = null
|
||||||
|
|
||||||
|
fun test() {
|
||||||
|
if (s != null) {
|
||||||
|
<caret>requireNotNull(s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
// PROBLEM: none
|
||||||
|
// WITH_RUNTIME
|
||||||
|
fun test(b: Boolean) {
|
||||||
|
<caret>require(b)
|
||||||
|
}
|
||||||
+48
@@ -5206,6 +5206,54 @@ public class LocalInspectionTestGenerated extends AbstractLocalInspectionTest {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@TestMetadata("idea/testData/inspectionsLocal/redundantRequireNotNullCall")
|
||||||
|
@TestDataPath("$PROJECT_ROOT")
|
||||||
|
@RunWith(JUnit3RunnerWithInners.class)
|
||||||
|
public static class RedundantRequireNotNullCall extends AbstractLocalInspectionTest {
|
||||||
|
private void runTest(String testDataFilePath) throws Exception {
|
||||||
|
KotlinTestUtils.runTest(this::doTest, TargetBackend.ANY, testDataFilePath);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void testAllFilesPresentInRedundantRequireNotNullCall() throws Exception {
|
||||||
|
KotlinTestUtils.assertAllTestsPresentByMetadata(this.getClass(), new File("idea/testData/inspectionsLocal/redundantRequireNotNullCall"), Pattern.compile("^([\\w\\-_]+)\\.(kt|kts)$"), TargetBackend.ANY, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
@TestMetadata("checkNotNull.kt")
|
||||||
|
public void testCheckNotNull() throws Exception {
|
||||||
|
runTest("idea/testData/inspectionsLocal/redundantRequireNotNullCall/checkNotNull.kt");
|
||||||
|
}
|
||||||
|
|
||||||
|
@TestMetadata("notNull.kt")
|
||||||
|
public void testNotNull() throws Exception {
|
||||||
|
runTest("idea/testData/inspectionsLocal/redundantRequireNotNullCall/notNull.kt");
|
||||||
|
}
|
||||||
|
|
||||||
|
@TestMetadata("notNull2.kt")
|
||||||
|
public void testNotNull2() throws Exception {
|
||||||
|
runTest("idea/testData/inspectionsLocal/redundantRequireNotNullCall/notNull2.kt");
|
||||||
|
}
|
||||||
|
|
||||||
|
@TestMetadata("notNull3.kt")
|
||||||
|
public void testNotNull3() throws Exception {
|
||||||
|
runTest("idea/testData/inspectionsLocal/redundantRequireNotNullCall/notNull3.kt");
|
||||||
|
}
|
||||||
|
|
||||||
|
@TestMetadata("nullable.kt")
|
||||||
|
public void testNullable() throws Exception {
|
||||||
|
runTest("idea/testData/inspectionsLocal/redundantRequireNotNullCall/nullable.kt");
|
||||||
|
}
|
||||||
|
|
||||||
|
@TestMetadata("nullable2.kt")
|
||||||
|
public void testNullable2() throws Exception {
|
||||||
|
runTest("idea/testData/inspectionsLocal/redundantRequireNotNullCall/nullable2.kt");
|
||||||
|
}
|
||||||
|
|
||||||
|
@TestMetadata("require.kt")
|
||||||
|
public void testRequire() throws Exception {
|
||||||
|
runTest("idea/testData/inspectionsLocal/redundantRequireNotNullCall/require.kt");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
@TestMetadata("idea/testData/inspectionsLocal/redundantReturnLabel")
|
@TestMetadata("idea/testData/inspectionsLocal/redundantReturnLabel")
|
||||||
@TestDataPath("$PROJECT_ROOT")
|
@TestDataPath("$PROJECT_ROOT")
|
||||||
@RunWith(JUnit3RunnerWithInners.class)
|
@RunWith(JUnit3RunnerWithInners.class)
|
||||||
|
|||||||
Reference in New Issue
Block a user