nunit#94 Allow users to pass arguments via file(s) instead parameters…

… of a command line - implementation allowing to parse argument with spaces and multiple elements per line

src/NUnitConsole/nunit3-console.tests/ArgumentsFileParserTests.cs

@@ -0,0 +1,63 @@
+// ***********************************************************************
+// Copyright (c) 2011 Charlie Poole
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+// 
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+// 
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+// ***********************************************************************
+
+using System;
+using NUnit.Framework;
+
+namespace NUnit.ConsoleRunner.Tests
+{
+    [TestFixture]
+    public class ArgumentsFileParserTests
+    {
+        [Test]
+        [TestCase("--arg", "--arg")]
+        [TestCase("--arg1 --arg2", "--arg1\n--arg2")]
+        [TestCase("--arg1\n--arg2", "--arg1\n--arg2")]
+        [TestCase("", "")]
+        [TestCase("   ", "")]
+        [TestCase("--arg1 --arg2", "--arg1\n--arg2")]
+        [TestCase("\"--arg 1\" --arg2", "--arg 1\n--arg2")]
+        [TestCase("\"--arg 1\"\n--arg2", "--arg 1\n--arg2")]
+        [TestCase("--arg1 \"--arg 2\"", "--arg1\n--arg 2")]
+        [TestCase("\"--arg 1\" \"--arg 2\"", "--arg 1\n--arg 2")]
+        [TestCase("\"--arg 1\" \"--arg 2\" arg3 \"arg 4\"", "--arg 1\n--arg 2\narg3\narg 4")]
+        [TestCase("--arg1 \"--arg 2\" arg3 \"arg 4\"", "--arg1\n--arg 2\narg3\narg 4")]
+        [TestCase("\"--arg 1\" \"--arg 2\" arg3 \"arg 4\"\n\"--arg 1\" \"--arg 2\" arg3 \"arg 4\"", "--arg 1\n--arg 2\narg3\narg 4\n--arg 1\n--arg 2\narg3\narg 4")]
+        [TestCase("\"--arg\"", "--arg")]
+        [TestCase("\"--arg 1\"", "--arg 1")]
+        [TestCase("\"--arg\"1\"", "--arg\n1")]
+        public void ShouldParseArgumentsFromLines(string linesStr, string expecdetArgsStr)
+        {
+            // Given
+            var parser = new ArgumentsFileParser();
+            var lines = linesStr.Split(new[] { '\n' }, StringSplitOptions.RemoveEmptyEntries);
+            var expectedArgs = expecdetArgsStr.Split(new[] { '\n' }, StringSplitOptions.RemoveEmptyEntries);
+
+            // When
+            var actualArgs = parser.Convert(lines);
+
+            // Then
+            Assert.AreEqual(expectedArgs, actualArgs);
+        }
+    }
+}

src/NUnitConsole/nunit3-console.tests/CommandLineTests.cs

@@ -26,12 +26,11 @@
 using System.Reflection;
 using NUnit.Common;
 using NUnit.Options;
+using System.Collections.Generic;
+using NUnit.Framework;
 
 namespace NUnit.ConsoleRunner.Tests
 {
-    using System.Collections.Generic;
-    using Framework;
-
     [TestFixture]
     public class CommandLineTests
     {
@@ -52,7 +51,7 @@ public void ArgumentsFromFilesTests(string args, string files, string expectedEx
 
             var expectedErrors = expectedErrorMessages.Split(new [] {'\n'}, StringSplitOptions.RemoveEmptyEntries);
 
-            var options = new ConsoleOptions(new DefaultOptionsProviderStub(false), fileSystem);
+            var options = new ConsoleOptions(new DefaultOptionsProviderStub(false), fileSystem, new SimpleArgumentsFileParser());
 
             // When
             var actualExpectedExpandedArgs = string.Join(" ", new List<string>(options.Expand(args.Split(' '))).ToArray());
@@ -547,7 +546,7 @@ public void ShouldSetTeamCityFlagAccordingToArgsAndDefauls(bool hasTeamcityInCmd
             ConsoleOptions options;
             if (defaultTeamcity.HasValue)
             {
-                options = new ConsoleOptions(new DefaultOptionsProviderStub(defaultTeamcity.Value), new VirtualFileSystem(), args.ToArray());
+                options = new ConsoleOptions(new DefaultOptionsProviderStub(defaultTeamcity.Value), new VirtualFileSystem(), new SimpleArgumentsFileParser(), args.ToArray());
             }
             else
             {

src/NUnitConsole/nunit3-console.tests/SimpleArgumentsFileParser.cs

@@ -0,0 +1,35 @@
+// ***********************************************************************
+// Copyright (c) 2011 Charlie Poole
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+// 
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+// 
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+// ***********************************************************************
+
+using System.Collections.Generic;
+
+namespace NUnit.ConsoleRunner.Tests
+{
+    internal class SimpleArgumentsFileParser: IConverter<IEnumerable<string>, IEnumerable<string>>
+    {
+        public IEnumerable<string> Convert(IEnumerable<string> src)
+        {
+            return src;
+        }
+    }
+}

src/NUnitConsole/nunit3-console.tests/nunit3-console.tests.csproj

@@ -55,6 +55,7 @@
     <Compile Include="..\ConsoleVersion.cs">
       <Link>Properties\ConsoleVersion.cs</Link>
     </Compile>
+    <Compile Include="ArgumentsFileParserTests.cs" />
     <Compile Include="ColorConsoleTests.cs" />
     <Compile Include="ColorStyleTests.cs" />
     <Compile Include="CommandLineTests.cs" />
@@ -65,6 +66,7 @@
     <Compile Include="OutputSpecificationTests.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="ResultReporterTests.cs" />
+    <Compile Include="SimpleArgumentsFileParser.cs" />
     <Compile Include="TestEventHandlerTests.cs" />
     <Compile Include="TestNameParserTests.cs" />
     <Compile Include="VirtualFileSystem.cs" />

src/NUnitConsole/nunit3-console/ArgumentsFileParser.cs

@@ -0,0 +1,53 @@
+// ***********************************************************************
+// Copyright (c) 2011 Charlie Poole
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+// 
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+// 
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+// ***********************************************************************
+
+using System;
+using System.Collections.Generic;
+using System.Text.RegularExpressions;
+
+namespace NUnit.ConsoleRunner
+{
+    internal class ArgumentsFileParser: IConverter<IEnumerable<string>, IEnumerable<string>>
+    {
+        private static readonly Regex ArgsRegex = new Regex("(\\\"(?<arg>.+?)\\\"|(?<arg>[^\\s\"]+))", RegexOptions.Compiled | RegexOptions.CultureInvariant);
+
+        public IEnumerable<string> Convert(IEnumerable<string> src)
+        {
+            if (src == null) throw new ArgumentNullException("src");
+
+            foreach (var line in src)
+            {
+                foreach (Match argMatch in ArgsRegex.Matches(line))
+                {
+                    if (!argMatch.Success && argMatch.Groups.Count != 1)
+                    {
+                        continue;
+                    }
+
+                    yield return argMatch.Groups["arg"].Value;
+                }
+
+            }
+        }
+    }
+}

src/NUnitConsole/nunit3-console/ConsoleOptions.cs

@@ -26,24 +26,30 @@
 
 namespace NUnit.Common
 {
+    using ConsoleRunner;
+
     /// <summary>
     /// ConsoleOptions encapsulates the option settings for
     /// the nunit3-console program.
     /// </summary>
     public class ConsoleOptions : CommandLineOptions
     {
         private readonly IFileSystem _fileSystem;
+        private readonly IConverter<IEnumerable<string>, IEnumerable<string>> _argumentsFileParser;
 
         #region Constructors
 
         internal ConsoleOptions(
             IDefaultOptionsProvider provider,
             IFileSystem fileSystem,
+            IConverter<IEnumerable<string>, IEnumerable<string>> argumentsFileParser,
             params string[] args)
             : base(provider, args)
         {
             if (fileSystem == null) throw new ArgumentNullException("fileSystem");
-            this._fileSystem = fileSystem;
+            if (fileSystem == null) throw new ArgumentNullException("argumentsFileParser");
+            _fileSystem = fileSystem;
+            _argumentsFileParser = argumentsFileParser;
         }
 
         public ConsoleOptions(params string[] args) : base(args) { }
@@ -191,7 +197,7 @@ public IEnumerable<string> Expand(IEnumerable<string> args)
                 }
 
 
-                using(var linesEnumerator = _fileSystem.ReadLines(fileName).GetEnumerator())
+                using (var linesEnumerator = _argumentsFileParser.Convert(_fileSystem.ReadLines(fileName)).GetEnumerator())
                 {
                     while (true)
                     {

src/NUnitConsole/nunit3-console/IConverter.cs

@@ -0,0 +1,30 @@
+// ***********************************************************************
+// Copyright (c) 2011 Charlie Poole
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+// 
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+// 
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+// ***********************************************************************
+
+namespace NUnit.ConsoleRunner
+{
+    public interface IConverter<in TSrc, out TDst>
+    {
+        TDst Convert(TSrc src);
+    }
+}

src/NUnitConsole/nunit3-console/Program.cs

@@ -37,7 +37,7 @@ namespace NUnit.ConsoleRunner
     public class Program
     {
         //static Logger log = InternalTrace.GetLogger(typeof(Runner));
-        static ConsoleOptions Options = new ConsoleOptions(new DefaultOptionsProvider(), new FileSystem());
+        static ConsoleOptions Options = new ConsoleOptions(new DefaultOptionsProvider(), new FileSystem(), new ArgumentsFileParser());
         private static ExtendedTextWriter _outWriter;
 
         // This has to be lazy otherwise NoColor command line option is not applied correctly

src/NUnitConsole/nunit3-console/nunit3-console.csproj

@@ -56,6 +56,7 @@
     <Compile Include="..\ConsoleVersion.cs">
       <Link>Properties\ConsoleVersion.cs</Link>
     </Compile>
+    <Compile Include="ArgumentsFileParser.cs" />
     <Compile Include="ColorConsole.cs" />
     <Compile Include="ColorConsoleWriter.cs" />
     <Compile Include="ColorStyle.cs" />
@@ -68,6 +69,7 @@
     <Compile Include="ExtendedTextWriter.cs" />
     <Compile Include="FileSystem.cs" />
     <Compile Include="FrameworkPackageSettings.cs" />
+    <Compile Include="IConverter.cs" />
     <Compile Include="IDefaultOptionsProvider.cs" />
     <Compile Include="IFileSystem.cs" />
     <Compile Include="Options.cs" />