[Fixes #40] SplitPackages needs to fail with a summary of all failures

Author: javiercn

src/SplitPackages/Program.cs

@@ -25,8 +25,8 @@ class Program
         private CommandOption _csvOption;
         private CommandOption _destinationOption;
         private CommandOption _whatIf;
-        private CommandOption _warningsOnly;
-        private CommandOption _warningsAsErrors;
+        private CommandOption _quiet;
+        private CommandOption _ignoreErrors;
 
         public ILogger Logger
         {
@@ -47,16 +47,16 @@ public Program(
             CommandOption csvOption,
             CommandOption destinationOption,
             CommandOption whatIfOption,
-            CommandOption warningsOnly,
-            CommandOption warningsAsErrors)
+            CommandOption quiet,
+            CommandOption ignoreErrors)
         {
             _app = app;
             _sourceOption = sourceOption;
             _csvOption = csvOption;
             _destinationOption = destinationOption;
             _whatIf = whatIfOption;
-            _warningsOnly = warningsOnly;
-            _warningsAsErrors = warningsAsErrors;
+            _quiet = quiet;
+            _ignoreErrors = ignoreErrors;
         }
 
         static int Main(string[] args)
@@ -86,14 +86,14 @@ static int Main(string[] args)
                 "Performs a dry run of the command with the given arguments without copying the packages",
                 CommandOptionType.NoValue);
 
-            var warningsOnly = app.Option(
+            var quiet = app.Option(
                 "--quiet",
                 "Avoids printing to the output anything other than warnings or errors",
                 CommandOptionType.NoValue);
 
-            var warningsAsErrors = app.Option(
-                "--warningsaserrors",
-                "Treats warnigns and errors and stops the execution of the command",
+            var ignoreErrors = app.Option(
+                "--ignore-errors",
+                "Treats errors as warnings and allows the command to continue executing",
                 CommandOptionType.NoValue);
 
             var program = new Program(
@@ -102,8 +102,8 @@ static int Main(string[] args)
                 csvOption,
                 destinationOption,
                 whatIfOption,
-                warningsOnly,
-                warningsAsErrors);
+                quiet,
+                ignoreErrors);
 
             app.OnExecute(new Func<int>(program.Execute));
 
@@ -128,7 +128,17 @@ private int Execute()
 
                 EnsureNoExtraSourcePackagesFound(packagesFromSource, expandedPackages);
 
-                EmitWarningsForMissingPackages(packagesFromSource, packagesFromCsv);
+                var errors = new List<string>();
+                EmitWarningsForMissingPackages(packagesFromSource, packagesFromCsv, errors);
+
+                if (errors.Count > 0)
+                {
+                    WriteErrorMessage(errors);
+                    if (!_ignoreErrors.HasValue())
+                    {
+                        return Error;
+                    }
+                }
 
                 EnsureDestinationDirectories(
                     arguments.DestinationFolder,
@@ -150,6 +160,24 @@ private int Execute()
             }
         }
 
+        private void WriteErrorMessage(List<string> errors)
+        {
+            var header = new [] {
+                "The list of packages in the source folder is inconsistent with the list of packages in the CSV file:"
+            };
+
+            var message = string.Join($"{Environment.NewLine}    ", header.Concat(errors));
+
+            if(_ignoreErrors.HasValue())
+            {
+                Logger.LogWarning(message);
+            }
+            else
+            {
+                Logger.LogError(message);
+            }
+        }
+
         private void CreateProjectJsonFiles(IEnumerable<PackageItem> packages)
         {
             var packagesByFolder = packages.GroupBy(p => Path.GetDirectoryName(p.DestinationPath));
@@ -161,7 +189,7 @@ private void CreateProjectJsonFiles(IEnumerable<PackageItem> packages)
                 var jsonFileBuilder = new ProjectJsonFileBuilder(
                     Path.Combine(path.Key, "project.json"),
                     _whatIf.HasValue(),
-                    _warningsAsErrors.HasValue(),
+                    _ignoreErrors.HasValue(),
                     Logger);
 
                 jsonFileBuilder.AddDependencies(dependenciesList);
@@ -173,7 +201,7 @@ private void CreateProjectJsonFiles(IEnumerable<PackageItem> packages)
         private ILogger CreateLogger()
         {
             var loggerFactory = new LoggerFactory();
-            var logLevel = _warningsOnly.HasValue() ? LogLevel.Warning : LogLevel.Information;
+            var logLevel = _quiet.HasValue() ? LogLevel.Warning : LogLevel.Information;
 
             loggerFactory.AddConsole(logLevel, includeScopes: false);
 
@@ -385,15 +413,15 @@ private void EnsureNoExtraSourcePackagesFound(IList<PackageItem> source, IList<P
             }
         }
 
-        private void EmitWarningsForMissingPackages(IList<PackageItem> source, IList<PackageItem> csv)
+        private void EmitWarningsForMissingPackages(IList<PackageItem> source, IList<PackageItem> csv, IList<string> errors)
         {
             for (int i = 0; i < source.Count; i++)
             {
                 if (!source[i].FoundInCsv)
                 {
                     var msg = $@"No entry in the csv file matched the following package:
     {source[i].Name}";
-                    LogWarning(msg);
+                    LogWarning(msg, errors);
                 }
             }
 
@@ -403,7 +431,7 @@ private void EmitWarningsForMissingPackages(IList<PackageItem> source, IList<Pac
                 {
                     var msg = $@"No package found in the source folder for the following csv entry:
     {csv[i].Name}";
-                    LogWarning(msg);
+                    LogWarning(msg, errors);
                 }
             }
         }
@@ -465,14 +493,14 @@ private void CopyPackages(IList<PackageItem> expandedPackages)
             }
         }
 
-        private void LogWarning(string message)
+        private void LogWarning(string message, IList<string> errors)
         {
-            if (_warningsAsErrors.HasValue())
+            if (_ignoreErrors.HasValue())
             {
-                throw new InvalidOperationException(message);
+                Logger.LogWarning(message);
             }
 
-            Logger.LogWarning(message);
+            errors.Add(message);
         }
 
         private class PackageItem : IEquatable<PackageItem>
@@ -513,18 +541,18 @@ private class ProjectJsonFileBuilder
         {
             private readonly string _path;
             private readonly bool _whatIf;
-            private readonly bool _warningsAsErrors;
+            private readonly bool _ignoreErrors;
             private readonly ILogger _logger;
 
             public ProjectJsonFileBuilder(
                 string path,
                 bool whatIf,
-                bool warningsAsErrors,
+                bool ignoreErrors,
                 ILogger logger)
             {
                 _path = path;
                 _whatIf = whatIf;
-                _warningsAsErrors = warningsAsErrors;
+                _ignoreErrors = ignoreErrors;
                 _logger = logger;
             }
 
@@ -580,7 +608,7 @@ private IDictionary<string, string> CreateDependenciesDictionary()
                     if (dictionary.ContainsKey(dependency.Identity))
                     {
                         var message = $"A duplicate dependency exists in {_path}, name = {dependency.Identity}";
-                        if (_warningsAsErrors)
+                        if (_ignoreErrors)
                         {
                             throw new InvalidOperationException(message);
                         }

src/SplitPackages/project.json

@@ -1,34 +1,43 @@
-{
-    "version": "1.0.1-*",
-    "description": "Copies Nuget packages form a given source folder into a specific set of folders based on a CSV file.",
-    "authors": [ "Microsoft" ],
-    "tags": [ "" ],
-    "projectUrl": "",
-    "licenseUrl": "",
-    "compilationOptions": {
-        "emitEntryPoint": true
-    },
-    "dependencies": {
-        "Microsoft.Extensions.CommandLineUtils": "1.0.0-*",
-        "Microsoft.Extensions.Logging": "1.0.0-*",
-        "Microsoft.Extensions.Logging.Console": "1.0.0-*",
-        "Newtonsoft.Json": "8.0.2",
-        "NuGet.Client": "3.4.0-*"
-    },
-    "frameworks": {
-        "dnxcore50": {
-            "dependencies": {
-                "NETStandard.Library": "1.0.0-*"
-            }
-        },
-        "net451": {
-            "frameworkAssemblies": {
-                "Microsoft.CSharp": "",
-                "System.Collections": "",
-                "System.Xml.Linq": "",
-                "System.Threading": "",
-                "System.IO.Compression.FileSystem": ""
-            }
+{
+  "version": "1.0.1-*",
+  "description": "Copies Nuget packages form a given source folder into a specific set of folders based on a CSV file.",
+  "authors": [ "Microsoft" ],
+  "tags": [ "" ],
+  "projectUrl": "",
+  "licenseUrl": "",
+  "compilationOptions": {
+    "emitEntryPoint": true
+  },
+  "dependencies": {
+    "Microsoft.Extensions.CommandLineUtils": "1.0.0-*",
+    "Microsoft.Extensions.Logging": "1.0.0-*",
+    "Microsoft.Extensions.Logging.Console": "1.0.0-*",
+    "Newtonsoft.Json": "8.0.2",
+    "NuGet.Client": "3.4.0-*"
+  },
+  "frameworks": {
+    "netcoreapp1.0": {
+      "imports": [
+        "dnxcore50",
+        "portable-net451+win8"
+      ],
+      "dependencies": {
+        "System.Runtime.Serialization.Primitives": "4.1.1-*",
+        "Microsoft.NETCore.App": {
+          "version": "1.0.0-*",
+          "type": "platform"
         }
+      }
+    },
+    "net451": {
+      "frameworkAssemblies": {
+        "Microsoft.CSharp": "",
+        "System.Collections": "",
+        "System.Xml.Linq": "",
+        "System.Threading": "",
+        "System.IO.Compression.FileSystem": "",
+        "System.Runtime.Serialization.Primitives": ""
+      }
     }
+  }
 }