Analysis API: add test for KtDiagnosticsProvider

2021-11-16 04:26:45 +01:00
parent cd3827ca2e
commit f197fc93db
18 changed files with 351 additions and 3 deletions
@@ -0,0 +1,81 @@
+/*
+ * Copyright 2010-2021 JetBrains s.r.o. and Kotlin Programming Language contributors.
+ * 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.analysis.api.impl.base.test.components.diagnosticProvider
+
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiElement
+import org.jetbrains.kotlin.analysis.api.components.KtDiagnosticCheckerFilter
+import org.jetbrains.kotlin.analysis.api.diagnostics.KtDiagnosticWithPsi
+import org.jetbrains.kotlin.analysis.api.impl.barebone.test.FrontendApiTestConfiguratorService
+import org.jetbrains.kotlin.analysis.api.impl.base.test.test.framework.AbstractHLApiSingleFileTest
+import org.jetbrains.kotlin.diagnostics.DiagnosticUtils.getLineAndColumnRangeInPsiFile
+import org.jetbrains.kotlin.diagnostics.PsiDiagnosticUtils.offsetToLineAndColumn
+import org.jetbrains.kotlin.psi.KtElement
+import org.jetbrains.kotlin.psi.KtFile
+import org.jetbrains.kotlin.psi.KtTreeVisitorVoid
+import org.jetbrains.kotlin.psi.psiUtil.startOffset
+import org.jetbrains.kotlin.test.model.TestModule
+import org.jetbrains.kotlin.test.services.TestServices
+import org.jetbrains.kotlin.test.services.assertions
+import kotlin.test.assertEquals
+
+abstract class AbstractCollectDiagnosticsTest(
+    configurator: FrontendApiTestConfiguratorService
+) : AbstractHLApiSingleFileTest(configurator) {
+    override fun doTestByFileStructure(ktFile: KtFile, module: TestModule, testServices: TestServices) {
+        fun TextRange.asLineColumnRange(): String {
+            return getLineAndColumnRangeInPsiFile(ktFile, this).toString()
+        }
+
+        analyseForTest(ktFile) {
+            val diagnosticsInFile =
+                ktFile.collectDiagnosticsForFile(KtDiagnosticCheckerFilter.EXTENDED_AND_COMMON_CHECKERS).map { it.getKey() }.sorted()
+            val diagnosticsFromElements = buildList {
+                ktFile.accept(object : KtTreeVisitorVoid() {
+                    override fun visitKtElement(element: KtElement) {
+                        for (diagnostic in element.getDiagnostics(KtDiagnosticCheckerFilter.EXTENDED_AND_COMMON_CHECKERS)) {
+                            add(element to diagnostic.getKey())
+                        }
+                        super.visitKtElement(element)
+                    }
+                })
+            }.sortedBy { (_, diagnostic) -> diagnostic }
+
+            val actual = buildString {
+                fun DiagnosticKey.print(indent: Int) {
+                    val indentString = " ".repeat(indent)
+                    append(indentString + factoryName)
+                    appendLine("$indentString  text ranges: $textRanges")
+                    appendLine("$indentString  PSI: ${psi::class.simpleName} at ${psi.textRange.asLineColumnRange()}")
+                }
+                appendLine("Diagnostics from elements:")
+                for ((element, diagnostic) in diagnosticsFromElements) {
+                    appendLine("  for PSI element of type ${element::class.simpleName} at ${element.textRange.asLineColumnRange()}")
+                    diagnostic.print(4)
+                }
+            }
+            testServices.assertions.assertEqualsToTestDataFileSibling(actual)
+
+            assertEquals(
+                diagnosticsInFile,
+                diagnosticsFromElements.map { (_, v) -> v },
+                "diagnostics collected from file should be the same as those collected from individual PSI elements."
+            )
+        }
+    }
+
+    private data class DiagnosticKey(val factoryName: String?, val psi: PsiElement, val textRanges: Collection<TextRange>) :
+        Comparable<DiagnosticKey> {
+        override fun toString(): String {
+            val document = psi.containingFile.viewProvider.document
+            return "$factoryName on ${psi::class.simpleName} at ${offsetToLineAndColumn(document, psi.startOffset)})"
+        }
+
+        override fun compareTo(other: DiagnosticKey): Int = this.toString().compareTo(other.toString())
+    }
+
+    private fun KtDiagnosticWithPsi<*>.getKey() = DiagnosticKey(factoryName, psi, textRanges)
+}