Macro. Test for diagnostic context messages.

Small tweaks to textual format.

Change-Id: Id019d8ca8fc0a6688a1ce3e6c52b00d0a68c3337
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/337120
Commit-Queue: Konstantin Shcheglov <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>

Author: scheglov

pkg/analyzer/test/src/summary/element_text.dart

@@ -734,19 +734,21 @@ class _ElementWriter {
 
   void _writeMacroDiagnostics(Element e) {
     void writeMessage(MacroDiagnosticMessage object) {
-      // Write the text.
+      // Write the message.
       final validator = configuration.macroDiagnosticMessageValidator;
       if (validator != null) {
         validator(object.message);
       } else {
-        var messageToWrite = object.message;
+        final message = object.message;
         const stackTraceText = 'Stack trace:';
-        final stackTraceIndex = messageToWrite.indexOf(stackTraceText);
+        final stackTraceIndex = message.indexOf(stackTraceText);
         if (stackTraceIndex >= 0) {
           final end = stackTraceIndex + stackTraceText.length;
-          messageToWrite = '${messageToWrite.substring(0, end)} <cut>';
+          final withoutStackTrace = message.substring(0, end);
+          _sink.writelnWithIndent('message:\n$withoutStackTrace <cut>');
+        } else {
+          _sink.writelnWithIndent('message: $message');
         }
-        _sink.writeln(messageToWrite);
       }
       // Write the target.
       final target = object.target;
@@ -778,14 +780,19 @@ class _ElementWriter {
             case MacroDiagnostic():
               _sink.writelnWithIndent('MacroDiagnostic');
               _sink.withIndent(() {
-                _sink.writelnWithIndent('message');
+                _sink.writelnWithIndent('message: MacroDiagnosticMessage');
                 _sink.withIndent(() {
                   writeMessage(diagnostic.message);
                 });
                 _sink.writeElements(
                   'contextMessages',
                   diagnostic.contextMessages,
-                  writeMessage,
+                  (message) {
+                    _sink.writelnWithIndent('MacroDiagnosticMessage');
+                    _sink.withIndent(() {
+                      writeMessage(message);
+                    });
+                  },
                 );
                 _sink.writelnWithIndent(
                   'severity: ${diagnostic.severity.name}',

pkg/analyzer/test/src/summary/macro/diagnostic.dart

@@ -45,6 +45,30 @@ import 'package:_fe_analyzer_shared/src/macros/api.dart';
   }
 }
 
+/*macro*/ class ReportWithContextMessages implements ClassDeclarationsMacro {
+  const ReportWithContextMessages();
+
+  @override
+  buildDeclarationsForClass(declaration, builder) async {
+    final methods = await builder.methodsOf(declaration);
+    builder.report(
+      Diagnostic(
+        DiagnosticMessage(
+          'Reported message',
+          target: declaration.asDiagnosticTarget,
+        ),
+        Severity.warning,
+        contextMessages: methods.map((method) {
+          return DiagnosticMessage(
+            'See ${method.identifier.name}',
+            target: method.asDiagnosticTarget,
+          );
+        }).toList(),
+      ),
+    );
+  }
+}
+
 /*macro*/ class ReportWithoutTargetError implements ClassTypesMacro {
   const ReportWithoutTargetError();
 

pkg/analyzer/test/src/summary/macro_test.dart

@@ -2368,7 +2368,7 @@ library
       class A @35
         macroDiagnostics
           MacroDiagnostic
-            message
+            message: MacroDiagnosticMessage
               target: ApplicationMacroDiagnosticTarget
                 annotationIndex: 0
             severity: error
@@ -2400,8 +2400,8 @@ library
       class A @62
         macroDiagnostics
           MacroDiagnostic
-            message
-Reported message
+            message: MacroDiagnosticMessage
+              message: Reported message
               target: ElementMacroDiagnosticTarget
                 element: self::@class::A
             severity: warning
@@ -2435,8 +2435,8 @@ library
           @70
             macroDiagnostics
               MacroDiagnostic
-                message
-Reported message
+                message: MacroDiagnosticMessage
+                  message: Reported message
                   target: ElementMacroDiagnosticTarget
                     element: self::@class::A::@constructor::new
                 severity: warning
@@ -2474,8 +2474,8 @@ library
             shouldUseTypeForInitializerInference: true
             macroDiagnostics
               MacroDiagnostic
-                message
-Reported message
+                message: MacroDiagnosticMessage
+                  message: Reported message
                   target: ElementMacroDiagnosticTarget
                     element: self::@class::A::@field::foo
                 severity: warning
@@ -2515,14 +2515,64 @@ library
             returnType: void
             macroDiagnostics
               MacroDiagnostic
-                message
-Reported message
+                message: MacroDiagnosticMessage
+                  message: Reported message
                   target: ElementMacroDiagnosticTarget
                     element: self::@class::A::@method::foo
                 severity: warning
 ''');
   }
 
+  test_macroDiagnostics_report_contextMessages() async {
+    newFile(
+      '$testPackageLibPath/diagnostic.dart',
+      _getMacroCode('diagnostic.dart'),
+    );
+
+    final library = await buildLibrary(r'''
+import 'diagnostic.dart';
+
+@ReportWithContextMessages()
+class A {
+  void foo() {}
+  void bar() {}
+}
+''');
+
+    configuration
+      ..withConstructors = false
+      ..withMetadata = false;
+    checkElementText(library, r'''
+library
+  imports
+    package:test/diagnostic.dart
+  definingUnit
+    classes
+      class A @62
+        macroDiagnostics
+          MacroDiagnostic
+            message: MacroDiagnosticMessage
+              message: Reported message
+              target: ElementMacroDiagnosticTarget
+                element: self::@class::A
+            contextMessages
+              MacroDiagnosticMessage
+                message: See foo
+                target: ElementMacroDiagnosticTarget
+                  element: self::@class::A::@method::foo
+              MacroDiagnosticMessage
+                message: See bar
+                target: ElementMacroDiagnosticTarget
+                  element: self::@class::A::@method::bar
+            severity: warning
+        methods
+          foo @73
+            returnType: void
+          bar @89
+            returnType: void
+''');
+  }
+
   test_macroDiagnostics_report_withoutTarget_error() async {
     newFile(
       '$testPackageLibPath/diagnostic.dart',
@@ -2548,8 +2598,8 @@ library
       class A @61
         macroDiagnostics
           MacroDiagnostic
-            message
-Reported message
+            message: MacroDiagnosticMessage
+              message: Reported message
               target: ApplicationMacroDiagnosticTarget
                 annotationIndex: 0
             severity: error
@@ -2581,8 +2631,8 @@ library
       class A @60
         macroDiagnostics
           MacroDiagnostic
-            message
-Reported message
+            message: MacroDiagnosticMessage
+              message: Reported message
               target: ApplicationMacroDiagnosticTarget
                 annotationIndex: 0
             severity: info
@@ -2614,8 +2664,8 @@ library
       class A @63
         macroDiagnostics
           MacroDiagnostic
-            message
-Reported message
+            message: MacroDiagnosticMessage
+              message: Reported message
               target: ApplicationMacroDiagnosticTarget
                 annotationIndex: 0
             severity: warning
@@ -2647,7 +2697,8 @@ library
       class A @68
         macroDiagnostics
           MacroDiagnostic
-            message
+            message: MacroDiagnosticMessage
+              message:
 Unhandled error: My declarations phase
 Stack trace: <cut>
               target: ApplicationMacroDiagnosticTarget
@@ -2683,7 +2734,8 @@ library
           @76
             macroDiagnostics
               MacroDiagnostic
-                message
+                message: MacroDiagnosticMessage
+                  message:
 Unhandled error: My declarations phase
 Stack trace: <cut>
                   target: ApplicationMacroDiagnosticTarget
@@ -2723,7 +2775,8 @@ library
             shouldUseTypeForInitializerInference: true
             macroDiagnostics
               MacroDiagnostic
-                message
+                message: MacroDiagnosticMessage
+                  message:
 Unhandled error: My declarations phase
 Stack trace: <cut>
                   target: ApplicationMacroDiagnosticTarget
@@ -2770,7 +2823,8 @@ library
             returnType: void
             macroDiagnostics
               MacroDiagnostic
-                message
+                message: MacroDiagnosticMessage
+                  message:
 Unhandled error: My declarations phase
 Stack trace: <cut>
                   target: ApplicationMacroDiagnosticTarget
@@ -2804,7 +2858,8 @@ library
       class A @67
         macroDiagnostics
           MacroDiagnostic
-            message
+            message: MacroDiagnosticMessage
+              message:
 Unhandled error: My definitions phase
 Stack trace: <cut>
               target: ApplicationMacroDiagnosticTarget
@@ -2838,7 +2893,8 @@ library
       class A @61
         macroDiagnostics
           MacroDiagnostic
-            message
+            message: MacroDiagnosticMessage
+              message:
 Unhandled error: My types phase
 Stack trace: <cut>
               target: ApplicationMacroDiagnosticTarget