Merge pull request #588 from patriksvensson/f/tool-arguments

Added support for adding custom arguments to tools.
cake-build · Dec 17, 2015 · ce99a1d · ce99a1d
2 parents 87d6a5d + f060aa2
commit ce99a1d
Show file tree

Hide file tree

Showing 48 changed files with 330 additions and 24 deletions.
diff --git a/src/Cake.Common.Tests/Cake.Common.Tests.csproj b/src/Cake.Common.Tests/Cake.Common.Tests.csproj
@@ -60,8 +60,6 @@
     <Compile Include="Fixtures\Build\AppVeyorInfoFixture.cs" />
     <Compile Include="Fixtures\AssemblyInfoFixture.cs" />
     <Compile Include="Fixtures\AssemblyInfoParserFixture.cs" />
-    <Compile Include="Fixtures\ToolFixture.cs" />
-    <Compile Include="Fixtures\ToolFixtureResult.cs" />
     <Compile Include="Fixtures\Tools\CakeRunnerFixture.cs" />
     <Compile Include="Fixtures\IO\FileCopyFixture.cs" />
     <Compile Include="Fixtures\IO\FileDeleteFixture.cs" />
@@ -259,6 +257,10 @@
       <Project>{8074B833-11B8-459F-BB98-BFBA2BC5C698}</Project>
       <Name>Cake.Core</Name>
     </ProjectReference>
+    <ProjectReference Include="..\Cake.Testing.Shared\Cake.Testing.Shared.csproj">
+      <Project>{8e5a518a-eb84-4a1b-a091-d9d66c8ff979}</Project>
+      <Name>Cake.Testing.Shared</Name>
+    </ProjectReference>
     <ProjectReference Include="..\Cake.Testing.Xunit\Cake.Testing.Xunit.csproj">
       <Project>{5AF751D1-BB54-4268-9E42-3A898B034B06}</Project>
       <Name>Cake.Testing.Xunit</Name>

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/CakeRunnerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/CakeRunnerFixture.cs
@@ -2,6 +2,7 @@
 using Cake.Core;
 using Cake.Core.IO;
 using Cake.Testing;
+using Cake.Testing.Shared;
 using NSubstitute;
 
 namespace Cake.Common.Tests.Fixtures.Tools

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/CandleFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/CandleFixture.cs
@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using Cake.Common.Tools.WiX;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/Chocolatey/ChocolateyFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/Chocolatey/ChocolateyFixture.cs
@@ -2,6 +2,7 @@
 using Cake.Core.Diagnostics;
 using Cake.Core.IO;
 using Cake.Core.Tooling;
+using Cake.Testing.Shared;
 using NSubstitute;
 
 namespace Cake.Common.Tests.Fixtures.Tools.Chocolatey

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/Chocolatey/Packer/ChocolateyPackerFixtureResult.cs b/src/Cake.Common.Tests/Fixtures/Tools/Chocolatey/Packer/ChocolateyPackerFixtureResult.cs
@@ -3,6 +3,7 @@
 using Cake.Core;
 using Cake.Core.IO;
 using Cake.Testing;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools.Chocolatey.Packer
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/DNU/DNUFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/DNU/DNUFixture.cs
@@ -1,5 +1,6 @@
 using Cake.Core.IO;
 using Cake.Core.Tooling;
+using Cake.Testing.Shared;
 using NSubstitute;
 
 namespace Cake.Common.Tests.Fixtures.Tools.DNU

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/DupFinder/DupFinderRunnerConfigFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/DupFinder/DupFinderRunnerConfigFixture.cs
@@ -1,6 +1,7 @@
 using Cake.Common.Tools.DupFinder;
 using Cake.Core.Diagnostics;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 using NSubstitute;
 
 namespace Cake.Common.Tests.Fixtures.Tools.DupFinder

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/DupFinder/DupFinderRunnerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/DupFinder/DupFinderRunnerFixture.cs
@@ -5,6 +5,7 @@
 using Cake.Core.Diagnostics;
 using Cake.Core.IO;
 using Cake.Testing;
+using Cake.Testing.Shared;
 using NSubstitute;
 
 namespace Cake.Common.Tests.Fixtures.Tools.DupFinder

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/FixieRunnerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/FixieRunnerFixture.cs
@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using Cake.Common.Tools.Fixie;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/GitReleaseManagerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/GitReleaseManagerFixture.cs
@@ -1,6 +1,7 @@
 using Cake.Common.Tools.GitReleaseManager;
 using Cake.Core.Diagnostics;
 using Cake.Core.Tooling;
+using Cake.Testing.Shared;
 using NSubstitute;
 
 namespace Cake.Common.Tests.Fixtures.Tools

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/GitReleaseNotesRunnerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/GitReleaseNotesRunnerFixture.cs
@@ -1,5 +1,6 @@
 using Cake.Common.Tools.GitReleaseNotes;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/GitVersionRunnerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/GitVersionRunnerFixture.cs
@@ -4,6 +4,7 @@
 using Cake.Core.Diagnostics;
 using NSubstitute;
 using System.Runtime.Serialization.Json;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/ILMergeRunnerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/ILMergeRunnerFixture.cs
@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using Cake.Common.Tools.ILMerge;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/InspectCode/InspectCodeFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/InspectCode/InspectCodeFixture.cs
@@ -1,5 +1,6 @@
 using Cake.Common.Tools.InspectCode;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools.InspectCode
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/MSBuildRunnerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/MSBuildRunnerFixture.cs
@@ -2,6 +2,7 @@
 using Cake.Common.Tools.MSBuild;
 using Cake.Core.IO;
 using Cake.Testing;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/MSTestRunnerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/MSTestRunnerFixture.cs
@@ -1,5 +1,6 @@
 using Cake.Common.Tools.MSTest;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/NSISFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/NSISFixture.cs
@@ -1,5 +1,6 @@
 using Cake.Common.Tools.NSIS;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/NUnit3RunnerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/NUnit3RunnerFixture.cs
@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using Cake.Common.Tools.NUnit;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/NUnitRunnerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/NUnitRunnerFixture.cs
@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using Cake.Common.Tools.NUnit;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/NuGet/NuGetFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/NuGet/NuGetFixture.cs
@@ -2,6 +2,7 @@
 using Cake.Core.IO;
 using Cake.Core.IO.NuGet;
 using Cake.Core.Tooling;
+using Cake.Testing.Shared;
 using NSubstitute;
 
 namespace Cake.Common.Tests.Fixtures.Tools.NuGet

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/NuGet/Packer/NugetPackerFixtureResult.cs b/src/Cake.Common.Tests/Fixtures/Tools/NuGet/Packer/NugetPackerFixtureResult.cs
@@ -3,6 +3,7 @@
 using Cake.Core;
 using Cake.Core.IO;
 using Cake.Testing;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools.NuGet.Packer
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/OctopusDeployReleaseCreatorFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/OctopusDeployReleaseCreatorFixture.cs
@@ -1,4 +1,5 @@
 using Cake.Common.Tools.OctopusDeploy;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/OpenCoverFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/OpenCoverFixture.cs
@@ -3,6 +3,7 @@
 using Cake.Core;
 using Cake.Core.Diagnostics;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 using NSubstitute;
 
 namespace Cake.Common.Tests.Fixtures.Tools

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/ReportGeneratorRunnerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/ReportGeneratorRunnerFixture.cs
@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using Cake.Common.Tools.ReportGenerator;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/ReportUnit/ReportUnitDirectoryFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/ReportUnit/ReportUnitDirectoryFixture.cs
@@ -1,5 +1,6 @@
 using Cake.Common.Tools.ReportUnit;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools.ReportUnit
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/ReportUnit/ReportUnitFileFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/ReportUnit/ReportUnitFileFixture.cs
@@ -1,5 +1,6 @@
 using Cake.Common.Tools.ReportUnit;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools.ReportUnit
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/RoundhouseRunnerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/RoundhouseRunnerFixture.cs
@@ -1,4 +1,5 @@
 using Cake.Common.Tools.Roundhouse;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/SignToolSignRunnerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/SignToolSignRunnerFixture.cs
@@ -2,6 +2,7 @@
 using Cake.Common.Tools.SignTool;
 using Cake.Core.IO;
 using Cake.Testing;
+using Cake.Testing.Shared;
 using NSubstitute;
 
 namespace Cake.Common.Tests.Fixtures.Tools

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/WiXFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/WiXFixture.cs
@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using Cake.Common.Tools.WiX;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/XUnit2RunnerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/XUnit2RunnerFixture.cs
@@ -1,5 +1,6 @@
 using Cake.Common.Tools.XUnit;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Common.Tests/Fixtures/Tools/XUnitRunnerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/XUnitRunnerFixture.cs
@@ -1,5 +1,6 @@
 using Cake.Common.Tools.XUnit;
 using Cake.Core.IO;
+using Cake.Testing.Shared;
 
 namespace Cake.Common.Tests.Fixtures.Tools
 {

diff --git a/src/Cake.Core.Tests/Cake.Core.Tests.csproj b/src/Cake.Core.Tests/Cake.Core.Tests.csproj
@@ -56,6 +56,7 @@
   <ItemGroup>
     <Compile Include="Extensions\StringExtensions.cs" />
     <Compile Include="Fixtures\CakeContextFixture.cs" />
+    <Compile Include="Fixtures\DummyToolFixture.cs" />
     <Compile Include="Fixtures\PropertyAliasGeneratorFixture.cs" />
     <Compile Include="Fixtures\MethodAliasGeneratorFixture.cs" />
     <Compile Include="Fixtures\ScriptAnalyzerFixture.cs" />
@@ -64,6 +65,8 @@
     <Compile Include="Fixtures\ScriptHostFixture.cs" />
     <Compile Include="Fixtures\ScriptProcessorFixture.cs" />
     <Compile Include="Fixtures\ScriptRunnerFixture.cs" />
+    <Compile Include="Stubs\DummySettings.cs" />
+    <Compile Include="Stubs\DummyTool.cs" />
     <Compile Include="Unit\ActionTaskTests.cs" />
     <Compile Include="Unit\Annotations\CakeAliasCategoryAttributeTests.cs" />
     <Compile Include="Unit\Annotations\CakeNamespaceImportAttributeTests.cs" />
@@ -117,6 +120,7 @@
     <Compile Include="Unit\TaskSetupContextTests.cs" />
     <Compile Include="Unit\TaskTeardownContextTests.cs" />
     <Compile Include="Unit\Text\TextTransformationTemplateTests.cs" />
+    <Compile Include="Unit\Tooling\ToolTests.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="packages.config">
@@ -148,6 +152,10 @@
       <Project>{8074B833-11B8-459F-BB98-BFBA2BC5C698}</Project>
       <Name>Cake.Core</Name>
     </ProjectReference>
+    <ProjectReference Include="..\Cake.Testing.Shared\Cake.Testing.Shared.csproj">
+      <Project>{8e5a518a-eb84-4a1b-a091-d9d66c8ff979}</Project>
+      <Name>Cake.Testing.Shared</Name>
+    </ProjectReference>
     <ProjectReference Include="..\Cake.Testing.Xunit\Cake.Testing.Xunit.csproj">
       <Project>{5AF751D1-BB54-4268-9E42-3A898B034B06}</Project>
       <Name>Cake.Testing.Xunit</Name>

diff --git a/src/Cake.Core.Tests/Fixtures/DummyToolFixture.cs b/src/Cake.Core.Tests/Fixtures/DummyToolFixture.cs
@@ -0,0 +1,20 @@
+using Cake.Core.Tests.Stubs;
+using Cake.Testing.Shared;
+
+namespace Cake.Core.Tests.Fixtures
+{
+    public sealed class DummyToolFixture : ToolFixture<DummySettings>
+    {
+        public DummyToolFixture()
+            : base("dummy.exe")
+        {
+        }
+
+        protected override void RunTool()
+        {
+            var tool = new DummyTool(FileSystem, Environment, ProcessRunner, Globber);
+            tool.Run(Settings);
+        }
+    }
+
+}
diff --git a/src/Cake.Core.Tests/Stubs/DummySettings.cs b/src/Cake.Core.Tests/Stubs/DummySettings.cs
@@ -0,0 +1,8 @@
+using Cake.Core.Tooling;
+
+namespace Cake.Core.Tests.Stubs
+{
+    public sealed class DummySettings : ToolSettings
+    {
+    }
+}
diff --git a/src/Cake.Core.Tests/Stubs/DummyTool.cs b/src/Cake.Core.Tests/Stubs/DummyTool.cs
@@ -0,0 +1,29 @@
+using System.Collections.Generic;
+using Cake.Core.IO;
+using Cake.Core.Tooling;
+
+namespace Cake.Core.Tests.Stubs
+{
+    public sealed class DummyTool : Tool<DummySettings>
+    {
+        public DummyTool(IFileSystem fileSystem, ICakeEnvironment environment, IProcessRunner processRunner, IGlobber globber)
+            : base(fileSystem, environment, processRunner, globber)
+        {
+        }
+
+        public void Run(DummySettings settings)
+        {
+            Run(settings, new ProcessArgumentBuilder().Append("--foo"));
+        }
+
+        protected override string GetToolName()
+        {
+            return "dummy";
+        }
+
+        protected override IEnumerable<string> GetToolExecutableNames()
+        {
+            return new[] { "dummy.exe" };
+        }
+    }
+}
diff --git a/src/Cake.Core.Tests/Unit/IO/ProcessArgumentBuilderTests.cs b/src/Cake.Core.Tests/Unit/IO/ProcessArgumentBuilderTests.cs
@@ -1,10 +1,28 @@
 using Cake.Core.IO;
+using Cake.Core.IO.Arguments;
 using Xunit;
 
 namespace Cake.Core.Tests.Unit.IO
 {
     public sealed class ProcessArgumentBuilderTests
     {
+        public sealed class TheClearMethod
+        {
+            [Fact]
+            public void Should_Remove_All_Arguments()
+            {
+                // Given
+                var builder = new ProcessArgumentBuilder();
+                builder.Append(new TextArgument("Hello World"));
+
+                // When
+                builder.Clear();
+
+                // Then
+                Assert.Empty(builder.Render());
+            }
+        }
+
         public sealed class ImplicitConversion
         {
             public sealed class FromString
@@ -16,9 +34,10 @@ public sealed class FromString
                 [InlineData(null, "")]
                 public void Should_Return_Builder_With_Correct_Content(string value, string expected)
                 {
+                    // Given, When
                     var builder = (ProcessArgumentBuilder)value;
 
-                    // Render
+                    // Then
                     Assert.Equal(expected, builder.Render());
                 }
             }