Use @ instead of $ for replacement tokens

Tyrrrz · Jun 1, 2023 · 5c40018 · 5c40018
1 parent b60fbcd
commit 5c40018
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 18 deletions.
diff --git a/GitHubActionsTestLogger.Tests/AnnotationSpecs.cs b/GitHubActionsTestLogger.Tests/AnnotationSpecs.cs
@@ -182,8 +182,8 @@ public void I_can_use_the_logger_to_produce_annotations_that_include_the_test_na
             ),
             new TestLoggerOptions
             {
-                AnnotationTitleFormat = "<$test>",
-                AnnotationMessageFormat = "[$test]"
+                AnnotationTitleFormat = "<@test>",
+                AnnotationMessageFormat = "[@test]"
             }
         );
 
@@ -217,8 +217,8 @@ public void I_can_use_the_logger_to_produce_annotations_that_include_test_traits
             ),
             new TestLoggerOptions
             {
-                AnnotationTitleFormat = "<$traits.Category -> $test>",
-                AnnotationMessageFormat = "[$traits.Category -> $test]"
+                AnnotationTitleFormat = "<@traits.Category -> @test>",
+                AnnotationMessageFormat = "[@traits.Category -> @test]"
             }
         );
 
@@ -254,8 +254,8 @@ public void I_can_use_the_logger_to_produce_annotations_that_include_the_error_m
             ),
             new TestLoggerOptions
             {
-                AnnotationTitleFormat = "<$test: $error>",
-                AnnotationMessageFormat = "[$test: $error]"
+                AnnotationTitleFormat = "<@test: @error>",
+                AnnotationMessageFormat = "[@test: @error]"
             }
         );
 
@@ -290,8 +290,8 @@ public void I_can_use_the_logger_to_produce_annotations_that_include_the_error_s
             ),
             new TestLoggerOptions
             {
-                AnnotationTitleFormat = "<$test: $trace>",
-                AnnotationMessageFormat = "[$test: $trace]"
+                AnnotationTitleFormat = "<@test: @trace>",
+                AnnotationMessageFormat = "[@test: @trace]"
             }
         );
 
@@ -326,8 +326,8 @@ public void I_can_use_the_logger_to_produce_annotations_that_include_the_target_
             ),
             new TestLoggerOptions
             {
-                AnnotationTitleFormat = "<$test ($framework)>",
-                AnnotationMessageFormat = "[$test ($framework)]"
+                AnnotationTitleFormat = "<@test (@framework)>",
+                AnnotationMessageFormat = "[@test (@framework)]"
             }
         );
 

diff --git a/GitHubActionsTestLogger/TestLoggerContext.cs b/GitHubActionsTestLogger/TestLoggerContext.cs
@@ -29,24 +29,41 @@ private string FormatAnnotation(string format, TestResult testResult)
     {
         var buffer = new StringBuilder(format);
 
-        // New line token (don't include caret return for consistency across platforms)
+        // Escaped new line token (backwards compat)
         buffer.Replace("\\n", "\n");
 
         // Name token
-        buffer.Replace("$test", testResult.TestCase.DisplayName ?? "");
+        buffer
+            .Replace("@test", testResult.TestCase.DisplayName)
+            // Backwards compat
+            .Replace("$test", testResult.TestCase.DisplayName);
 
         // Trait tokens
         foreach (var trait in testResult.Traits.Union(testResult.TestCase.Traits))
-            buffer.Replace($"$traits.{trait.Name}", trait.Value);
+        {
+            buffer
+                .Replace($"@traits.{trait.Name}", trait.Value)
+                // Backwards compat
+                .Replace($"$traits.{trait.Name}", trait.Value);
+        }
 
         // Error message
-        buffer.Replace("$error", testResult.ErrorMessage ?? "");
+        buffer
+            .Replace("@error", testResult.ErrorMessage ?? "")
+            // Backwards compat
+            .Replace("$error", testResult.ErrorMessage ?? "");
 
         // Error trace
-        buffer.Replace("$trace", testResult.ErrorStackTrace ?? "");
+        buffer
+            .Replace("@trace", testResult.ErrorStackTrace ?? "")
+            // Backwards compat
+            .Replace("$trace", testResult.ErrorStackTrace ?? "");
 
         // Target framework
-        buffer.Replace("$framework", _testRunCriteria?.TryGetTargetFramework() ?? "");
+        buffer
+            .Replace("@framework", _testRunCriteria?.TryGetTargetFramework() ?? "")
+            // Backwards compat
+            .Replace("$framework", _testRunCriteria?.TryGetTargetFramework() ?? "");
 
         return buffer.Trim().ToString();
     }

diff --git a/GitHubActionsTestLogger/TestLoggerOptions.cs b/GitHubActionsTestLogger/TestLoggerOptions.cs
@@ -5,9 +5,9 @@ namespace GitHubActionsTestLogger;
 
 public partial class TestLoggerOptions
 {
-    public string AnnotationTitleFormat { get; init; } = "$test";
+    public string AnnotationTitleFormat { get; init; } = "@test";
 
-    public string AnnotationMessageFormat { get; init; } = "$error";
+    public string AnnotationMessageFormat { get; init; } = "@error";
 
     public bool SummaryIncludePassedTests { get; init; }