Added ReplaceAssertBooleanWithAssertEqualityInspection

JetBrains · Aug 4, 2018 · 65f3f3d · 65f3f3d
1 parent e4bf20a
commit 65f3f3d
Show file tree

Hide file tree

Showing 24 changed files with 324 additions and 0 deletions.
diff --git a/idea/resources/inspectionDescriptions/ReplaceAssertBooleanWithAssertEquality.html b/idea/resources/inspectionDescriptions/ReplaceAssertBooleanWithAssertEquality.html
@@ -0,0 +1,6 @@
+<html>
+<body>
+This inspection reports assert boolean function calls replaceable with assert equality function.
+Example: <b>assertTrue(a == b)</b> can be replaced by <b>assertEquals(a, b)</b>.
+</body>
+</html>
diff --git a/idea/src/META-INF/plugin.xml b/idea/src/META-INF/plugin.xml
@@ -2967,6 +2967,15 @@ The Kotlin plugin provides language support in IntelliJ IDEA and Android Studio.
                      language="kotlin"
     />
 
+    <localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.ReplaceAssertBooleanWithAssertEqualityInspection"
+                     displayName="Replace assert boolean with assert equality"
+                     groupPath="Kotlin"
+                     groupName="Style issues"
+                     enabledByDefault="true"
+                     level="INFORMATION"
+                     language="kotlin"
+    />
+
     <referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
 
     <fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>

diff --git a/idea/src/META-INF/plugin.xml.173 b/idea/src/META-INF/plugin.xml.173
@@ -2966,6 +2966,15 @@ The Kotlin plugin provides language support in IntelliJ IDEA and Android Studio.
                      language="kotlin"
     />
 
+    <localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.ReplaceAssertBooleanWithAssertEqualityInspection"
+                     displayName="Replace assert boolean with assert equality"
+                     groupPath="Kotlin"
+                     groupName="Style issues"
+                     enabledByDefault="true"
+                     level="INFORMATION"
+                     language="kotlin"
+    />
+
     <referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
 
     <fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>

diff --git a/idea/src/META-INF/plugin.xml.181 b/idea/src/META-INF/plugin.xml.181
@@ -2966,6 +2966,15 @@ The Kotlin plugin provides language support in IntelliJ IDEA and Android Studio.
                      language="kotlin"
     />
 
+    <localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.ReplaceAssertBooleanWithAssertEqualityInspection"
+                     displayName="Replace assert boolean with assert equality"
+                     groupPath="Kotlin"
+                     groupName="Style issues"
+                     enabledByDefault="true"
+                     level="INFORMATION"
+                     language="kotlin"
+    />
+
     <referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
 
     <fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>

diff --git a/idea/src/META-INF/plugin.xml.183 b/idea/src/META-INF/plugin.xml.183
@@ -2967,6 +2967,15 @@ The Kotlin plugin provides language support in IntelliJ IDEA and Android Studio.
                      language="kotlin"
     />
 
+    <localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.ReplaceAssertBooleanWithAssertEqualityInspection"
+                     displayName="Replace assert boolean with assert equality"
+                     groupPath="Kotlin"
+                     groupName="Style issues"
+                     enabledByDefault="true"
+                     level="INFORMATION"
+                     language="kotlin"
+    />
+
     <referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
 
     <fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>

diff --git a/idea/src/META-INF/plugin.xml.as31 b/idea/src/META-INF/plugin.xml.as31
@@ -2966,6 +2966,15 @@ The Kotlin plugin provides language support in IntelliJ IDEA and Android Studio.
                      language="kotlin"
     />
 
+    <localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.ReplaceAssertBooleanWithAssertEqualityInspection"
+                     displayName="Replace assert boolean with assert equality"
+                     groupPath="Kotlin"
+                     groupName="Style issues"
+                     enabledByDefault="true"
+                     level="INFORMATION"
+                     language="kotlin"
+    />
+
     <referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
 
     <fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>

diff --git a/idea/src/META-INF/plugin.xml.as32 b/idea/src/META-INF/plugin.xml.as32
@@ -2966,6 +2966,15 @@ The Kotlin plugin provides language support in IntelliJ IDEA and Android Studio.
                      language="kotlin"
     />
 
+    <localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.ReplaceAssertBooleanWithAssertEqualityInspection"
+                     displayName="Replace assert boolean with assert equality"
+                     groupPath="Kotlin"
+                     groupName="Style issues"
+                     enabledByDefault="true"
+                     level="INFORMATION"
+                     language="kotlin"
+    />
+
     <referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
 
     <fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>

diff --git a/...org/jetbrains/kotlin/idea/inspections/ReplaceAssertBooleanWithAssertEqualityInspection.kt b/...org/jetbrains/kotlin/idea/inspections/ReplaceAssertBooleanWithAssertEqualityInspection.kt
@@ -0,0 +1,84 @@
+/*
+ * Copyright 2010-2018 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.openapi.editor.Editor
+import com.intellij.openapi.project.Project
+import com.intellij.psi.PsiElement
+import org.jetbrains.kotlin.idea.intentions.getCallableDescriptor
+import org.jetbrains.kotlin.lexer.KtTokens
+import org.jetbrains.kotlin.name.FqName
+import org.jetbrains.kotlin.psi.*
+import org.jetbrains.kotlin.resolve.descriptorUtil.fqNameSafe
+
+class ReplaceAssertBooleanWithAssertEqualityInspection : AbstractApplicabilityBasedInspection<KtCallExpression>(KtCallExpression::class.java) {
+
+    override fun inspectionText(element: KtCallExpression) = "Replace assert boolean with assert equality"
+
+    override val defaultFixText = "Replace assert boolean with assert equality"
+
+    override fun fixText(element: KtCallExpression): String {
+        val assertion = element.replaceableAssertion() ?: return defaultFixText
+        return "Replace with '$assertion'"
+    }
+
+    override fun isApplicable(element: KtCallExpression): Boolean {
+        return (element.replaceableAssertion() != null)
+    }
+
+    override fun applyTo(element: PsiElement, project: Project, editor: Editor?) {
+        val expression = element as? KtCallExpression ?: return
+        val condition = expression.valueArguments.first().getArgumentExpression() as? KtBinaryExpression ?: return
+        val left = condition.left ?: return
+        val right = condition.right ?: return
+        val assertion = expression.replaceableAssertion() ?: return
+        val factory = KtPsiFactory(project)
+
+        if (expression.valueArguments.size == 1) {
+            expression.replace(factory.createExpressionByPattern("$assertion($0, $1)", left, right))
+        } else if (expression.valueArguments.size == 2) {
+            val message = expression.valueArguments[1].getArgumentExpression() ?: return
+            expression.replace(factory.createExpressionByPattern("$assertion($0, $1, $2)", left, right, message))
+        }
+    }
+
+    private fun KtCallExpression.replaceableAssertion(): String? {
+        var result: String? = null
+        val referencedName = (calleeExpression as? KtNameReferenceExpression)?.getReferencedName() ?: return null
+        if (!assertions.contains(referencedName)) {
+            return result
+        }
+
+        if (getCallableDescriptor()?.containingDeclaration?.fqNameSafe != FqName("kotlin.test")) {
+            return result
+        }
+
+        if (valueArguments.size != 1 && valueArguments.size != 2) return null
+        val binaryExpression = valueArguments.first().getArgumentExpression() as? KtBinaryExpression ?: return null
+        val operationToken = binaryExpression.operationToken
+
+        assertionMap.entries.forEach {
+            val (assertion, token) = it.key
+            if (referencedName == assertion && operationToken == token) {
+                result = it.value
+                return@forEach
+            }
+        }
+
+        return result
+    }
+
+    companion object {
+        private val assertions = setOf("assertTrue", "assertFalse")
+
+        private val assertionMap = mapOf(
+            Pair("assertTrue", KtTokens.EQEQ) to "assertEquals",
+            Pair("assertTrue", KtTokens.EQEQEQ) to "assertSame",
+            Pair("assertFalse", KtTokens.EQEQ) to "assertNotEquals",
+            Pair("assertFalse", KtTokens.EQEQEQ) to "assertNotSame"
+        )
+    }
+}
diff --git a/idea/testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/.inspection b/idea/testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/.inspection
@@ -0,0 +1 @@
+org.jetbrains.kotlin.idea.inspections.ReplaceAssertBooleanWithAssertEqualityInspection
diff --git a/idea/testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertFalse.kt b/idea/testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertFalse.kt
@@ -0,0 +1,9 @@
+// RUNTIME_WITH_KOTLIN_TEST
+// PROBLEM: none
+
+import kotlin.test.*
+
+fun foo() {
+    val isA = false
+    assertFalse<caret>(isA)
+}
diff --git a/idea/testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertFalseEQEQ.kt b/idea/testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertFalseEQEQ.kt
@@ -0,0 +1,9 @@
+// RUNTIME_WITH_KOTLIN_TEST
+
+import kotlin.test.*
+
+fun foo() {
+    val a = "a"
+    val b = "b"
+    assertFalse<caret>(a == b)
+}
diff --git a/...testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertFalseEQEQ.kt.after b/...testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertFalseEQEQ.kt.after
@@ -0,0 +1,9 @@
+// RUNTIME_WITH_KOTLIN_TEST
+
+import kotlin.test.*
+
+fun foo() {
+    val a = "a"
+    val b = "b"
+    assertNotEquals(a, b)
+}
diff --git a/idea/testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertFalseEQEQEQ.kt b/idea/testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertFalseEQEQEQ.kt
@@ -0,0 +1,9 @@
+// RUNTIME_WITH_KOTLIN_TEST
+
+import kotlin.test.*
+
+fun foo() {
+    val a = "a"
+    val b = "b"
+    assertFalse<caret>(a === b)
+}
diff --git a/...stData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertFalseEQEQEQ.kt.after b/...stData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertFalseEQEQEQ.kt.after
@@ -0,0 +1,9 @@
+// RUNTIME_WITH_KOTLIN_TEST
+
+import kotlin.test.*
+
+fun foo() {
+    val a = "a"
+    val b = "b"
+    assertNotSame(a, b)
+}
diff --git a/...estData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertFalseWithMessage.kt b/...estData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertFalseWithMessage.kt
@@ -0,0 +1,9 @@
+// RUNTIME_WITH_KOTLIN_TEST
+
+import kotlin.test.*
+
+fun foo() {
+    val a = "a"
+    val b = "b"
+    assertFalse(<caret>a == b, "message")
+}
diff --git a/...a/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertFalseWithMessage.kt.after b/...a/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertFalseWithMessage.kt.after
@@ -0,0 +1,9 @@
+// RUNTIME_WITH_KOTLIN_TEST
+
+import kotlin.test.*
+
+fun foo() {
+    val a = "a"
+    val b = "b"
+    assertNotEquals(a, b, "message")
+}
diff --git a/idea/testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertTrue.kt b/idea/testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertTrue.kt
@@ -0,0 +1,9 @@
+// RUNTIME_WITH_KOTLIN_TEST
+// PROBLEM: none
+
+import kotlin.test.*
+
+fun foo() {
+    val isA = true
+    assertTrue<caret>(isA)
+}
diff --git a/idea/testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertTrueEQEQ.kt b/idea/testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertTrueEQEQ.kt
@@ -0,0 +1,9 @@
+// RUNTIME_WITH_KOTLIN_TEST
+
+import kotlin.test.*
+
+fun foo() {
+    val a = "a"
+    val b = "a"
+    assertTrue<caret>(a == b)
+}
diff --git a/.../testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertTrueEQEQ.kt.after b/.../testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertTrueEQEQ.kt.after
@@ -0,0 +1,9 @@
+// RUNTIME_WITH_KOTLIN_TEST
+
+import kotlin.test.*
+
+fun foo() {
+    val a = "a"
+    val b = "a"
+    assertEquals(a, b)
+}
diff --git a/idea/testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertTrueEQEQEQ.kt b/idea/testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertTrueEQEQEQ.kt
@@ -0,0 +1,9 @@
+// RUNTIME_WITH_KOTLIN_TEST
+
+import kotlin.test.*
+
+fun foo() {
+    val a = "a"
+    val b = "a"
+    assertTrue(<caret>a === b)
+}
diff --git a/...estData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertTrueEQEQEQ.kt.after b/...estData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertTrueEQEQEQ.kt.after
@@ -0,0 +1,9 @@
+// RUNTIME_WITH_KOTLIN_TEST
+
+import kotlin.test.*
+
+fun foo() {
+    val a = "a"
+    val b = "a"
+    assertSame(a, b)
+}
diff --git a/...testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertTrueWithMessage.kt b/...testData/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertTrueWithMessage.kt
@@ -0,0 +1,9 @@
+// RUNTIME_WITH_KOTLIN_TEST
+
+import kotlin.test.*
+
+fun foo() {
+    val a = "a"
+    val b = "a"
+    assertTrue(<caret>a == b, "message")
+}
diff --git a/...ta/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertTrueWithMessage.kt.after b/...ta/inspectionsLocal/replaceAssertBooleanWithAssertEquality/assertTrueWithMessage.kt.after
@@ -0,0 +1,9 @@
+// RUNTIME_WITH_KOTLIN_TEST
+
+import kotlin.test.*
+
+fun foo() {
+    val a = "a"
+    val b = "a"
+    assertEquals(a, b, "message")
+}