improved logging

Author: genusP

src/ApiCodeGenerator.Core/GenerationTask.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.Diagnostics.CodeAnalysis;
@@ -91,8 +91,9 @@ public async Task<bool> ExecuteAsync(string nswagFilePath,
             vars["OutFile"] = outFilePath;
             var roVariables = new ReadOnlyDictionary<string, string>(vars);
 
-            LogMessage("Values of nswag variables");
-            LogMessage(string.Join(Environment.NewLine, vars.Select(_ => $"\t[{_.Key}] = {_.Value}")));
+            LogMessage("Values of nswag variables: {0}{1}",
+                Environment.NewLine,
+                string.Join(Environment.NewLine, vars.Select(_ => $"\t[{_.Key}] = {_.Value}")));
 
             JObject? baseNswagDocument = LoadBaseNswag(baseNswagFilePath);
             var nswagDocument = _documentFactory.LoadNswagDocument(nswagFilePath, roVariables, baseNswagDocument);
@@ -110,18 +111,18 @@ public async Task<bool> ExecuteAsync(string nswagFilePath,
                 return false;
             }
 
-            var context = await CreateGenerationContext(nswagDocument, nswagFilePath, roVariables);
-
-            if (context is not null)
+            try
             {
-                if (context.DocumentReader is null)
-                {
-                    Log?.LogWarning(NotSetInput, nswagFilePath, "Source not set. Skip generation.");
-                    return true;
-                }
+                var context = await CreateGenerationContext(nswagDocument, nswagFilePath, roVariables);
 
-                try
+                if (context is not null)
                 {
+                    if (context.DocumentReader is null)
+                    {
+                        Log?.LogWarning(NotSetInput, nswagFilePath, "Source not set. Skip generation.");
+                        return true;
+                    }
+
                     LogMessage($"Use settings: {generatorSettings.Key}");
                     var contentGenerator = await contentGeneratorFactory.Invoke(context);
 
@@ -137,14 +138,14 @@ public async Task<bool> ExecuteAsync(string nswagFilePath,
                     {
                         Log?.LogError(WriteFileErr, outFilePath, "Unable write file. Error: {0}", ex.Message);
                     }
-                }
-                catch (InvalidOperationException ex)
-                {
-                    Log?.LogError(GenerationErr, nswagFilePath, ex.Message);
-                    return false;
-                }
 
-                return true;
+                    return true;
+                }
+            }
+            catch (InvalidOperationException ex)
+            {
+                Log?.LogError(GenerationErr, nswagFilePath, ex.Message);
+                return false;
             }
 
             return false;

src/ApiCodeGenerator.MSBuild/ApiCodeGenerator.MSBuild.csproj

@@ -30,9 +30,6 @@
 
   <ItemGroup>
     <ProjectReference Include="..\ApiCodeGenerator.Abstraction\ApiCodeGenerator.Abstraction.csproj" />
-    <ProjectReference Include="..\ApiCodeGenerator.Core\ApiCodeGenerator.Core.csproj" ReferenceOutputAssembly="false" />
-    <ProjectReference Include="..\ApiCodeGenerator.OpenApi\ApiCodeGenerator.OpenApi.csproj" ReferenceOutputAssembly="false" />
-    <ProjectReference Include="..\ApiCodeGenerator.AsyncApi\ApiCodeGenerator.AsyncApi.csproj" ReferenceOutputAssembly="false" />
   </ItemGroup>
 
   <ItemGroup Label="Nswag prerequiries">

src/ApiCodeGenerator.MSBuild/Console/ConsoleLogAdapter.cs

@@ -1,21 +1,43 @@
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
+using System.IO;
 using ApiCodeGenerator.Abstraction;
 
 namespace ApiCodeGenerator.MSBuild
 {
     internal class ConsoleLogAdapter : ILogger
     {
         public void LogError(string? code, string? sourceFile, string message, params object[] messageArgs)
-            => Console.Error.WriteLine($"{sourceFile}: {string.Format(message, messageArgs)}");
+            => Log(Console.Error, "error", code, sourceFile, string.Format(message, messageArgs));
 
         public void LogMessage(string? code, string? sourceFile, string message, params object[] messageArgs)
-            => Console.WriteLine($"INFO: {string.Format(message, messageArgs)}");
+            => Log(Console.Out, code is null ? null : "info", code, sourceFile, string.Format(message, messageArgs));
 
         public void LogWarning(string? code, string? sourceFile, string message, params object[] messageArgs)
-            => Console.WriteLine($"WARNING {sourceFile}: {string.Format(message, messageArgs)}");
+            => Log(Console.Out, "warning", code, sourceFile, string.Format(message, messageArgs));
+
+        private static void Log(TextWriter writer, string? type, string? code, string? file, string message)
+        {
+            if (file is not null)
+            {
+                writer.Write(Path.IsPathFullyQualified(file)
+                    ? file
+                    : Path.GetFullPath(file));
+                writer.Write("(1,1): ");
+            }
+
+            if (type is not null)
+            {
+                writer.Write(type);
+                if (code is not null)
+                {
+                    writer.Write(" ");
+                    writer.Write(code);
+                }
+
+                writer.Write(": ");
+            }
+
+            writer.WriteLine(message);
+        }
     }
 }

src/ApiCodeGenerator.MSBuild/Console/GenerateCommand.cs

@@ -50,7 +50,7 @@ public GenerateCommand()
             this.SetHandler(ExecuteAsync);
         }
 
-        private Task ExecuteAsync(InvocationContext context)
+        private async Task ExecuteAsync(InvocationContext context)
         {
 #if DEBUG
             System.Diagnostics.Debugger.Launch();
@@ -66,12 +66,13 @@ private Task ExecuteAsync(InvocationContext context)
             var factory = GetGenerationTaskFactory(nswagToolPath);
             AddExtesionsProbingPaths(extPaths);
             var generator = factory.Create(extPaths, new ConsoleLogAdapter());
-            return generator.ExecuteAsync(nswagFile, openApiFile, outFile, variables, baseNswagFile);
+            var result = await generator.ExecuteAsync(nswagFile, openApiFile, outFile, variables, baseNswagFile);
+            context.ExitCode = result ? 0 : 1;
         }
 
         private IGenerationTaskFactory GetGenerationTaskFactory(string? nswagToolsPath)
         {
-            var context = AssemblyLoadContext.GetLoadContext(Assembly.GetCallingAssembly())!;
+            var context = new AssemblyLoadContext("Generator Context");
 
             // регистриуем процесс резолва сборок
             AssemblyResolver.Register(context);

src/ApiCodeGenerator.MSBuild/Console/Program.cs

@@ -2,4 +2,6 @@
 using ApiCodeGenerator.MSBuild;
 
 var cmd = new GenerateCommand();
-await cmd.InvokeAsync(args);
+var exitCode = await cmd.InvokeAsync(args);
+
+return exitCode;

src/ApiCodeGenerator.MSBuild/build/Console.targets

@@ -1,4 +1,4 @@
-<Project>
+<Project>
 
   <UsingTask TaskName="AcgGetTools"
     TaskFactory="RoslynCodeTaskFactory"
@@ -191,8 +191,12 @@
     </ItemGroup>
     <Warning Condition="'@(__acgNotExistsBiExtAssemblies)' != ''" Text="File '%(__acgNotExistsBiExtAssemblies.Identity)' not found." />
     <Exec Command="%(CurrentOpenApiReference.Command)"
-      LogStandardErrorAsError="true"
-      CustomWarningRegularExpression="^WARNING .*"
-      StdErrEncoding="utf-8" />
+      StandardOutputImportance="low"
+      StdErrEncoding="utf-8"
+      IgnoreExitCode="true">
+      <Output TaskParameter="ExitCode" PropertyName="_ResultCode" />
+    </Exec>
+
+    <Error Condition="'$(_ResultCode)' != '0'" Text="Code generation failed!" />
   </Target>
 </Project>