diff --git a/src/Cake.Common.Tests/Fixtures/Tools/DotNet/Workload/Restore/DotNetWorkloadRestorerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/DotNet/Workload/Restore/DotNetWorkloadRestorerFixture.cs new file mode 100644 index 0000000000..4e8ef88acc --- /dev/null +++ b/src/Cake.Common.Tests/Fixtures/Tools/DotNet/Workload/Restore/DotNetWorkloadRestorerFixture.cs @@ -0,0 +1,19 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. +// See the LICENSE file in the project root for more information. + +using Cake.Common.Tools.DotNet.Workload.Restore; + +namespace Cake.Common.Tests.Fixtures.Tools.DotNet.Workload.Restore +{ + internal sealed class DotNetWorkloadRestorerFixture : DotNetFixture + { + public string Project { get; set; } + + protected override void RunTool() + { + var tool = new DotNetWorkloadRestorer(FileSystem, Environment, ProcessRunner, Tools); + tool.Restore(Project, Settings); + } + } +} diff --git a/src/Cake.Common.Tests/Unit/Tools/DotNet/Workload/Restore/DotNetWorkloadRestoreTests.cs b/src/Cake.Common.Tests/Unit/Tools/DotNet/Workload/Restore/DotNetWorkloadRestoreTests.cs new file mode 100644 index 0000000000..492be031a4 --- /dev/null +++ b/src/Cake.Common.Tests/Unit/Tools/DotNet/Workload/Restore/DotNetWorkloadRestoreTests.cs @@ -0,0 +1,151 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. +// See the LICENSE file in the project root for more information. + +using Cake.Common.Tests.Fixtures.Tools.DotNet.Workload.Restore; +using Cake.Common.Tools.DotNet; +using Cake.Common.Tools.DotNet.Workload.Restore; +using Cake.Testing; +using Xunit; + +namespace Cake.Common.Tests.Unit.Tools.DotNet.Workload.Restore +{ + public sealed class DotNetWorkloadRestoreTests + { + public sealed class TheBuildMethod + { + [Fact] + public void Should_Throw_If_Process_Was_Not_Started() + { + // Given + var fixture = new DotNetWorkloadRestorerFixture(); + fixture.Project = "./src/*"; + fixture.GivenProcessCannotStart(); + + // When + var result = Record.Exception(() => fixture.Run()); + + // Then + AssertEx.IsCakeException(result, ".NET CLI: Process was not started."); + } + + [Fact] + public void Should_Throw_If_Process_Has_A_Non_Zero_Exit_Code() + { + // Given + var fixture = new DotNetWorkloadRestorerFixture(); + fixture.Project = "./src/*"; + fixture.GivenProcessExitsWithCode(1); + + // When + var result = Record.Exception(() => fixture.Run()); + + // Then + AssertEx.IsCakeException(result, ".NET CLI: Process returned an error (exit code 1)."); + } + + [Fact] + public void Should_Throw_If_Settings_Are_Null() + { + // Given + var fixture = new DotNetWorkloadRestorerFixture(); + fixture.Project = "./src/*"; + fixture.Settings = null; + fixture.GivenDefaultToolDoNotExist(); + + // When + var result = Record.Exception(() => fixture.Run()); + + // Then + AssertEx.IsArgumentNullException(result, "settings"); + } + + [Fact] + public void Should_Throw_If_Project_Is_Null() + { + // Given + var fixture = new DotNetWorkloadRestorerFixture(); + fixture.Settings = new DotNetWorkloadRestoreSettings(); + fixture.GivenDefaultToolDoNotExist(); + + // When + var result = Record.Exception(() => fixture.Run()); + + // Then + AssertEx.IsArgumentNullException(result, "project"); + } + + [Fact] + public void Should_Add_Mandatory_Arguments() + { + // Given + var fixture = new DotNetWorkloadRestorerFixture(); + fixture.Project = "./src/*"; + + // When + var result = fixture.Run(); + + // Then + Assert.Equal("workload restore \"./src/*\"", result.Args); + } + + [Fact] + public void Should_Add_Additional_Arguments() + { + // Given + var fixture = new DotNetWorkloadRestorerFixture(); + fixture.Project = "./src/*"; + fixture.Settings.ConfigFile = "./nuget.config"; + fixture.Settings.DisableParallel = true; + fixture.Settings.IgnoreFailedSources = true; + fixture.Settings.IncludePreviews = true; + fixture.Settings.Interactive = true; + fixture.Settings.NoCache = true; + fixture.Settings.SkipManifestUpdate = true; + fixture.Settings.Source.Add("http://www.nuget.org/api/v2/package"); + fixture.Settings.Source.Add("http://www.symbolserver.org/"); + fixture.Settings.TempDir = "./src/project"; + fixture.Settings.Verbosity = DotNetVerbosity.Diagnostic; + + // When + var result = fixture.Run(); + + // Then + var expected = "workload restore \"./src/*\" --configfile \"/Working/nuget.config\" --disable-parallel --ignore-failed-sources --include-previews --interactive --no-cache --skip-manifest-update --source \"http://www.nuget.org/api/v2/package\" --source \"http://www.symbolserver.org/\" --temp-dir \"/Working/src/project\" --verbosity diagnostic"; + Assert.Equal(expected, result.Args); + } + + [Theory] + [InlineData("./src/*", "workload restore \"./src/*\"")] + [InlineData("./src/cake build/", "workload restore \"./src/cake build/\"")] + [InlineData("./src/cake build/cake cli", "workload restore \"./src/cake build/cake cli\"")] + public void Should_Quote_Project_Path(string text, string expected) + { + // Given + var fixture = new DotNetWorkloadRestorerFixture(); + fixture.Project = text; + + // When + var result = fixture.Run(); + + // Then + Assert.Equal(expected, result.Args); + } + + [Fact] + public void Should_Add_Host_Arguments() + { + // Given + var fixture = new DotNetWorkloadRestorerFixture(); + fixture.Project = "./src/*"; + fixture.Settings.DiagnosticOutput = true; + + // When + var result = fixture.Run(); + + // Then + Assert.Equal("--diagnostics workload restore \"./src/*\"", result.Args); + } + } + } +} diff --git a/src/Cake.Common/Tools/DotNet/DotNetAliases.cs b/src/Cake.Common/Tools/DotNet/DotNetAliases.cs index 4508020e7f..d1d06b9f0f 100644 --- a/src/Cake.Common/Tools/DotNet/DotNetAliases.cs +++ b/src/Cake.Common/Tools/DotNet/DotNetAliases.cs @@ -25,6 +25,7 @@ using Cake.Common.Tools.DotNet.Workload.Install; using Cake.Common.Tools.DotNet.Workload.List; using Cake.Common.Tools.DotNet.Workload.Repair; +using Cake.Common.Tools.DotNet.Workload.Restore; using Cake.Common.Tools.DotNet.Workload.Search; using Cake.Common.Tools.DotNet.Workload.Uninstall; using Cake.Common.Tools.DotNet.Workload.Update; @@ -2245,5 +2246,59 @@ public static void DotNetWorkloadUpdate(this ICakeContext context, DotNetWorkloa var updater = new DotNetWorkloadUpdater(context.FileSystem, context.Environment, context.ProcessRunner, context.Tools); updater.Update(settings); } + + /// + /// Installs workloads needed for a project or a solution. + /// + /// The context. + /// The project or solution file to install workloads for. + /// + /// + /// DotNetWorkloadRestore("./src/project"); + /// + /// + [CakeMethodAlias] + [CakeAliasCategory("Workload")] + [CakeNamespaceImport("Cake.Common.Tools.DotNet.Workload.Restore")] + public static void DotNetWorkloadRestore(this ICakeContext context, string project) + { + context.DotNetWorkloadRestore(project, null); + } + + /// + /// Installs workloads needed for a project or a solution. + /// + /// The context. + /// The project or solution file to install workloads for. + /// The settings. + /// + /// + /// var settings = new DotNetWorkloadRestoreSettings + /// { + /// IncludePreviews = true, + /// NoCache = true + /// }; + /// + /// DotNetWorkloadRestore("./src/project", settings); + /// + /// + [CakeMethodAlias] + [CakeAliasCategory("Workload")] + [CakeNamespaceImport("Cake.Common.Tools.DotNet.Workload.Restore")] + public static void DotNetWorkloadRestore(this ICakeContext context, string project, DotNetWorkloadRestoreSettings settings) + { + if (context is null) + { + throw new ArgumentNullException(nameof(context)); + } + + if (settings is null) + { + settings = new DotNetWorkloadRestoreSettings(); + } + + var restorer = new DotNetWorkloadRestorer(context.FileSystem, context.Environment, context.ProcessRunner, context.Tools); + restorer.Restore(project, settings); + } } } diff --git a/src/Cake.Common/Tools/DotNet/Workload/Restore/DotNetWorkloadRestoreSettings.cs b/src/Cake.Common/Tools/DotNet/Workload/Restore/DotNetWorkloadRestoreSettings.cs new file mode 100644 index 0000000000..54aaffdd9a --- /dev/null +++ b/src/Cake.Common/Tools/DotNet/Workload/Restore/DotNetWorkloadRestoreSettings.cs @@ -0,0 +1,63 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. +// See the LICENSE file in the project root for more information. + +using System.Collections.Generic; +using Cake.Core.IO; + +namespace Cake.Common.Tools.DotNet.Workload.Restore +{ + /// + /// Contains settings used by . + /// + public sealed class DotNetWorkloadRestoreSettings : DotNetSettings + { + /// + /// Gets or sets the NuGet configuration file (nuget.config) to use. + /// + public FilePath ConfigFile { get; set; } + + /// + /// Gets or sets a value indicating whether to prevent restoring multiple projects in parallel. + /// + public bool DisableParallel { get; set; } + + /// + /// Gets or sets a value indicating whether to treat package source failures as warnings. + /// + public bool IgnoreFailedSources { get; set; } + + /// + /// Gets or sets a value indicating whether to allow prerelease workload manifests. + /// + public bool IncludePreviews { get; set; } + + /// + /// Gets or sets a value indicating whether to allow the command to stop and wait for user input or action. + /// For example, to complete authentication. + /// + public bool Interactive { get; set; } + + /// + /// Gets or sets a value indicating whether to do not cache packages and http requests. + /// + public bool NoCache { get; set; } + + /// + /// Gets or sets a value indicating whether to skip updating the workload manifests. + /// The workload manifests define what assets and versions need to be installed for each workload. + /// + public bool SkipManifestUpdate { get; set; } + + /// + /// Gets or sets the URI of the NuGet package source to use. + /// This setting overrides all of the sources specified in the nuget.config files. + /// + public ICollection Source { get; set; } = new List(); + + /// + /// Gets or sets the temporary directory used to download and extract NuGet packages (must be secure). + /// + public DirectoryPath TempDir { get; set; } + } +} diff --git a/src/Cake.Common/Tools/DotNet/Workload/Restore/DotNetWorkloadRestorer.cs b/src/Cake.Common/Tools/DotNet/Workload/Restore/DotNetWorkloadRestorer.cs new file mode 100644 index 0000000000..65eda4cb38 --- /dev/null +++ b/src/Cake.Common/Tools/DotNet/Workload/Restore/DotNetWorkloadRestorer.cs @@ -0,0 +1,127 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. +// See the LICENSE file in the project root for more information. + +using System; +using System.Linq; +using Cake.Core; +using Cake.Core.IO; +using Cake.Core.Tooling; + +namespace Cake.Common.Tools.DotNet.Workload.Restore +{ + /// + /// .NET workloads restorer. + /// + public sealed class DotNetWorkloadRestorer : DotNetTool + { + private readonly ICakeEnvironment _environment; + + /// + /// Initializes a new instance of the class. + /// + /// The file system. + /// The environment. + /// The process runner. + /// The tool locator. + public DotNetWorkloadRestorer( + IFileSystem fileSystem, + ICakeEnvironment environment, + IProcessRunner processRunner, + IToolLocator tools) : base(fileSystem, environment, processRunner, tools) + { + _environment = environment; + } + + /// + /// Installs workloads needed for a project or a solution. + /// + /// The target project or solution file path. + /// The settings. + public void Restore(string project, DotNetWorkloadRestoreSettings settings) + { + if (project == null) + { + throw new ArgumentNullException(nameof(project)); + } + if (settings == null) + { + throw new ArgumentNullException(nameof(settings)); + } + + RunCommand(settings, GetArguments(project, settings)); + } + + private ProcessArgumentBuilder GetArguments(string project, DotNetWorkloadRestoreSettings settings) + { + var builder = CreateArgumentBuilder(settings); + + builder.Append("workload restore"); + + // Specific path? + if (project != null) + { + builder.AppendQuoted(project); + } + + // Config File + if (settings.ConfigFile != null) + { + builder.AppendSwitchQuoted("--configfile", settings.ConfigFile.MakeAbsolute(_environment).FullPath); + } + + // Disable Parallel + if (settings.DisableParallel) + { + builder.Append("--disable-parallel"); + } + + // Ignore Failed Sources + if (settings.IgnoreFailedSources) + { + builder.Append("--ignore-failed-sources"); + } + + // Include Previews + if (settings.IncludePreviews) + { + builder.Append("--include-previews"); + } + + // Interactive + if (settings.Interactive) + { + builder.Append("--interactive"); + } + + // No Cache + if (settings.NoCache) + { + builder.Append("--no-cache"); + } + + // Skip Manifest Update + if (settings.SkipManifestUpdate) + { + builder.Append("--skip-manifest-update"); + } + + // Source + if (settings.Source != null && settings.Source.Any()) + { + foreach (var source in settings.Source) + { + builder.AppendSwitchQuoted("--source", source); + } + } + + // Temp Dir + if (settings.TempDir != null) + { + builder.AppendSwitchQuoted("--temp-dir", settings.TempDir.MakeAbsolute(_environment).FullPath); + } + + return builder; + } + } +} diff --git a/tests/integration/Cake.Common/Tools/DotNet/DotNetAliases.cake b/tests/integration/Cake.Common/Tools/DotNet/DotNetAliases.cake index 3a81eb8633..bba4a7b6a0 100644 --- a/tests/integration/Cake.Common/Tools/DotNet/DotNetAliases.cake +++ b/tests/integration/Cake.Common/Tools/DotNet/DotNetAliases.cake @@ -296,6 +296,18 @@ Task("Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadUpdate") DotNetWorkloadUpdate(); }); +Task("Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadRestore") + .IsDependentOn("Cake.Common.Tools.DotNet.DotNetAliases.Setup") + .Does(() => +{ + // Given + var path = Paths.Temp.Combine("./Cake.Common/Tools/DotNet"); + var project = path.CombineWithFilePath("hwapp/hwapp.csproj"); + + // When + DotNetWorkloadRestore(project.FullPath); +}); + Task("Cake.Common.Tools.DotNet.DotNetAliases.DotNetBuildServerShutdown") .IsDependentOn("Cake.Common.Tools.DotNet.DotNetAliases.DotNetRestore") .IsDependentOn("Cake.Common.Tools.DotNet.DotNetAliases.DotNetBuild") @@ -316,6 +328,7 @@ Task("Cake.Common.Tools.DotNet.DotNetAliases.DotNetBuildServerShutdown") .IsDependentOn("Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadSearch") .IsDependentOn("Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadRepair") .IsDependentOn("Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadUpdate") + .IsDependentOn("Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadRestore") .Does(() => { // When