From 68d7e51d3270433b69bd4ef05ddf3e13f03780d9 Mon Sep 17 00:00:00 2001
From: Dmitriy Novozhilov <novodmit.2x@yandex.ru>
Date: Mon, 24 Sep 2018 13:51:36 +0300
Subject: [PATCH] Support test directive for rendering full diagnostic messages

New `RENDER_DIAGNOSTICS_MESSAGES` directive forces test system render
full messages for all diagnostics that found in test file
---
 .../kotlin/checkers/CheckerTestUtil.java      | 27 ++++++++++++++++---
 compiler/testData/diagnostics/ReadMe.md       |  8 ++++++
 .../kotlin/checkers/BaseDiagnosticsTest.kt    |  7 ++++-
 3 files changed, 38 insertions(+), 4 deletions(-)

diff --git a/compiler/frontend/src/org/jetbrains/kotlin/checkers/CheckerTestUtil.java b/compiler/frontend/src/org/jetbrains/kotlin/checkers/CheckerTestUtil.java
index b36c737fb1d..eb6916add7f 100644
--- a/compiler/frontend/src/org/jetbrains/kotlin/checkers/CheckerTestUtil.java
+++ b/compiler/frontend/src/org/jetbrains/kotlin/checkers/CheckerTestUtil.java
@@ -411,6 +411,18 @@ public class CheckerTestUtil {
             @NotNull Function<PsiFile, String> getFileText,
             @NotNull Collection<PositionalTextDiagnostic> uncheckedDiagnostics,
             boolean withNewInferenceDirective
+    ) {
+        return addDiagnosticMarkersToText(psiFile, diagnostics, diagnosticToExpectedDiagnostic, getFileText, uncheckedDiagnostics, withNewInferenceDirective, false);
+    }
+
+    public static StringBuffer addDiagnosticMarkersToText(
+            @NotNull PsiFile psiFile,
+            @NotNull Collection<ActualDiagnostic> diagnostics,
+            @NotNull Map<AbstractTestDiagnostic, TextDiagnostic> diagnosticToExpectedDiagnostic,
+            @NotNull Function<PsiFile, String> getFileText,
+            @NotNull Collection<PositionalTextDiagnostic> uncheckedDiagnostics,
+            boolean withNewInferenceDirective,
+            boolean renderDiagnosticMessages
     ) {
         String text = getFileText.fun(psiFile);
         StringBuffer result = new StringBuffer();
@@ -433,7 +445,7 @@ public class CheckerTestUtil {
                 opened.pop();
             }
             while (currentDescriptor != null && i == currentDescriptor.start) {
-                openDiagnosticsString(result, currentDescriptor, diagnosticToExpectedDiagnostic, withNewInferenceDirective);
+                openDiagnosticsString(result, currentDescriptor, diagnosticToExpectedDiagnostic, withNewInferenceDirective, renderDiagnosticMessages);
                 if (currentDescriptor.getEnd() == i) {
                     closeDiagnosticString(result);
                 }
@@ -453,7 +465,7 @@ public class CheckerTestUtil {
         if (currentDescriptor != null) {
             assert currentDescriptor.start == text.length();
             assert currentDescriptor.end == text.length();
-            openDiagnosticsString(result, currentDescriptor, diagnosticToExpectedDiagnostic, withNewInferenceDirective);
+            openDiagnosticsString(result, currentDescriptor, diagnosticToExpectedDiagnostic, withNewInferenceDirective, renderDiagnosticMessages);
             opened.push(currentDescriptor);
         }
 
@@ -471,7 +483,8 @@ public class CheckerTestUtil {
             StringBuffer result,
             AbstractDiagnosticDescriptor currentDescriptor,
             Map<AbstractTestDiagnostic, TextDiagnostic> diagnosticToExpectedDiagnostic,
-            boolean withNewInferenceDirective
+            boolean withNewInferenceDirective,
+            boolean renderDiagnosticMessages
     ) {
         result.append("<!");
         if (currentDescriptor instanceof TextDiagnosticDescriptor) {
@@ -502,6 +515,14 @@ public class CheckerTestUtil {
                         result.append(":");
                     }
                     result.append(diagnostic.getName());
+                    if (renderDiagnosticMessages) {
+                        TextDiagnostic textDiagnostic = TextDiagnostic.asTextDiagnostic(diagnostic);
+                        if (textDiagnostic.getParameters() != null) {
+                            result.append("(")
+                                    .append(String.join(", ", textDiagnostic.getParameters()))
+                                    .append(")");
+                        }
+                    }
                 }
                 if (iterator.hasNext()) {
                     result.append(", ");
diff --git a/compiler/testData/diagnostics/ReadMe.md b/compiler/testData/diagnostics/ReadMe.md
index 7ea7569eec1..1e1e0428b43 100644
--- a/compiler/testData/diagnostics/ReadMe.md
+++ b/compiler/testData/diagnostics/ReadMe.md
@@ -97,3 +97,11 @@ Note that if this directive is present, the NEWER_VERSION_IN_SINCE_KOTLIN diagno
 #### Usage:
 
     // !API_VERSION: 1.0
+    
+### 6. RENDER_DIAGNOSTICS_MESSAGES
+
+This directive forces *Diagnostic printer* prints parametrized diagnostics with all parameters.
+
+#### Usage:
+
+    // !RENDER_DIAGNOSTICS_MESSAGES
diff --git a/compiler/tests-common/tests/org/jetbrains/kotlin/checkers/BaseDiagnosticsTest.kt b/compiler/tests-common/tests/org/jetbrains/kotlin/checkers/BaseDiagnosticsTest.kt
index 4cadfd146ad..3a82fab0568 100644
--- a/compiler/tests-common/tests/org/jetbrains/kotlin/checkers/BaseDiagnosticsTest.kt
+++ b/compiler/tests-common/tests/org/jetbrains/kotlin/checkers/BaseDiagnosticsTest.kt
@@ -140,6 +140,7 @@ abstract class BaseDiagnosticsTest : KotlinMultiFileTestWithJava<TestModule, Tes
         val dynamicCallDescriptors: List<DeclarationDescriptor> = ArrayList()
         val withNewInferenceDirective: Boolean
         val newInferenceEnabled: Boolean
+        val renderDiagnosticMessages: Boolean
 
         init {
             this.declareCheckType = CHECK_TYPE_DIRECTIVE in directives
@@ -162,6 +163,7 @@ abstract class BaseDiagnosticsTest : KotlinMultiFileTestWithJava<TestModule, Tes
                 this.clearText = CheckerTestUtil.parseDiagnosedRanges(addExtras(expectedText), diagnosedRanges)
                 this.createKtFile = lazy { TestCheckerUtil.createCheckAndReturnPsiFile(fileName, clearText, project) }
             }
+            this.renderDiagnosticMessages = RENDER_DIAGNOSTICS_MESSAGES in directives
         }
 
         val ktFile: KtFile? by createKtFile
@@ -302,7 +304,8 @@ abstract class BaseDiagnosticsTest : KotlinMultiFileTestWithJava<TestModule, Tes
                     diagnosticToExpectedDiagnostic,
                     { file -> file.text },
                     uncheckedDiagnostics,
-                    withNewInferenceDirective
+                    withNewInferenceDirective,
+                    renderDiagnosticMessages
                 )
             )
 
@@ -375,6 +378,8 @@ abstract class BaseDiagnosticsTest : KotlinMultiFileTestWithJava<TestModule, Tes
         // Change it to "true" to load diagnostics for old inference to test new inference (ignore diagnostics with <NI; prefix)
         val USE_OLD_INFERENCE_DIAGNOSTICS_FOR_NI = false
 
+        val RENDER_DIAGNOSTICS_MESSAGES = "RENDER_DIAGNOSTICS_MESSAGES"
+
         private fun parseDiagnosticFilterDirective(
             directiveMap: Map<String, String>,
             allowUnderscoreUsage: Boolean