Clean up implementation of GitLabCILog

Author: ap0llo

src/Cake.GitLabCI.Module/AnsiEscapeCodes.cs

@@ -0,0 +1,15 @@
+namespace Cake.AzurePipelines.Module
+{
+    internal static class AnsiEscapeCodes
+    {
+        public static readonly string Reset = string.Format(FORMAT, 0);
+        public static readonly string ForegroundWhite = string.Format(FORMAT, 97);
+        public static readonly string ForegroundYellow = string.Format(FORMAT, 33);
+        public static readonly string ForegroundLightGray = string.Format(FORMAT, 37);
+        public static readonly string ForegroundDarkGray = string.Format(FORMAT, 90);
+        public static readonly string BackgroundMagenta = string.Format(FORMAT, 45);
+        public static readonly string BackgroundRed = string.Format(FORMAT, 41);
+
+        private const string FORMAT = "\u001B[{0}m";
+    }
+}

src/Cake.GitLabCI.Module/GitLabCILog.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 
 using Cake.Core;
 using Cake.Core.Diagnostics;
@@ -13,22 +14,21 @@ namespace Cake.AzurePipelines.Module
     [UsedImplicitly]
     public class GitLabCILog : ICakeLog
     {
-        private static class AnsiEscapeCodes
-        {
-            public static readonly string Reset = string.Format(FORMAT, 0);
-            public static readonly string ForegroundWhite = string.Format(FORMAT, 97);
-            public static readonly string ForegroundYellow = string.Format(FORMAT, 33);
-            public static readonly string ForegroundLightGray = string.Format(FORMAT, 37);
-            public static readonly string ForegroundDarkGray = string.Format(FORMAT, 90);
-            public static readonly string BackgroundMagenta = string.Format(FORMAT, 45);
-            public static readonly string BackgroundRed = string.Format(FORMAT, 41);
-
-            private const string FORMAT = "\u001B[{0}m";
-        }
-
         private readonly ICakeLog _cakeLogImplementation;
         private readonly IConsole _console;
 
+        // Define the escape sequenes to make GitLab show colored messages
+        // For reference, see https://docs.gitlab.com/ee/ci/yaml/script.html#add-color-codes-to-script-output
+        // For the colors, match the colors used by Cake, see https://github.com/cake-build/cake/blob/ed612029b92f5da2b6cbdfe295c62e6b99a2963d/src/Cake.Core/Diagnostics/Console/ConsolePalette.cs#L34C17-L34C17
+        private readonly Dictionary<LogLevel, string> _escapeSequences = new Dictionary<LogLevel, string>()
+        {
+            { LogLevel.Fatal, $"{AnsiEscapeCodes.BackgroundMagenta}{AnsiEscapeCodes.ForegroundWhite}" },
+            { LogLevel.Error, $"{AnsiEscapeCodes.BackgroundRed}{AnsiEscapeCodes.ForegroundWhite}" },
+            { LogLevel.Warning, AnsiEscapeCodes.ForegroundYellow },
+            { LogLevel.Verbose, AnsiEscapeCodes.ForegroundLightGray },
+            { LogLevel.Debug, AnsiEscapeCodes.ForegroundDarkGray },
+        };
+
         /// <summary>
         /// Initializes a new instance of the <see cref="GitLabCILog"/> class.
         /// </summary>
@@ -40,6 +40,13 @@ public GitLabCILog(IConsole console, Verbosity verbosity = Verbosity.Normal)
             _console = console;
         }
 
+        /// <inheritdoc />
+        public Verbosity Verbosity
+        {
+            get { return _cakeLogImplementation.Verbosity; }
+            set { _cakeLogImplementation.Verbosity = value; }
+        }
+
         /// <inheritdoc />
         public void Write(Verbosity verbosity, LogLevel level, string format, params object[] args)
         {
@@ -53,40 +60,24 @@ public void Write(Verbosity verbosity, LogLevel level, string format, params obj
                 return;
             }
 
-            // Use colored output for log messages on GitLab CI
-            // For reference, see https://docs.gitlab.com/ee/ci/yaml/script.html#add-color-codes-to-script-output
-            // For the colors, mostly match the colors used by Cake, see https://github.com/cake-build/cake/blob/ed612029b92f5da2b6cbdfe295c62e6b99a2963d/src/Cake.Core/Diagnostics/Console/ConsolePalette.cs#L34C17-L34C17
-            // Not however, that the GitLab Web UI seems to render some colors the same (e.g. white and dark gray
-            switch (level)
+            string message;
+            if (_escapeSequences.TryGetValue(level, out var sequence))
             {
-                case LogLevel.Fatal:
-                    _console.WriteErrorLine($"{AnsiEscapeCodes.BackgroundMagenta}{AnsiEscapeCodes.ForegroundWhite}{level}: {string.Format(format, args)}{AnsiEscapeCodes.Reset}");
-                    break;
-                case LogLevel.Error:
-                    _console.WriteErrorLine($"{AnsiEscapeCodes.BackgroundRed}{AnsiEscapeCodes.ForegroundWhite}{level}: {string.Format(format, args)}{AnsiEscapeCodes.Reset}");
-                    break;
-                case LogLevel.Warning:
-                    _console.WriteLine($"{AnsiEscapeCodes.ForegroundYellow}{level}: {string.Format(format, args)}{AnsiEscapeCodes.Reset}");
-                    break;
-                case LogLevel.Information:
-                    _console.WriteLine($"{level}: {string.Format(format, args)}");
-                    break;
-                case LogLevel.Verbose:
-                    _console.WriteLine($"{AnsiEscapeCodes.ForegroundLightGray}{level}: {string.Format(format, args)}{AnsiEscapeCodes.Reset}");
-                    break;
-                case LogLevel.Debug:
-                    _console.WriteLine($"{AnsiEscapeCodes.ForegroundDarkGray}{level}: {string.Format(format, args)}{AnsiEscapeCodes.Reset}");
-                    break;
-                default:
-                    throw new ArgumentOutOfRangeException(nameof(level), level, null);
+                message = $"{sequence}{level}: {string.Format(format, args)}{AnsiEscapeCodes.Reset}";
+            }
+            else
+            {
+                message = $"{level}: {string.Format(format, args)}";
             }
-        }
 
-        /// <inheritdoc />
-        public Verbosity Verbosity
-        {
-            get { return _cakeLogImplementation.Verbosity; }
-            set { _cakeLogImplementation.Verbosity = value; }
+            if (level > LogLevel.Error)
+            {
+                _console.WriteLine(message);
+            }
+            else
+            {
+                _console.WriteErrorLine(message);
+            }
         }
     }
 }