From 0b9b8b402cc2f8f39ed342c59d52bee31861d3f7 Mon Sep 17 00:00:00 2001 From: Roman Marusyk Date: Wed, 24 Aug 2022 21:37:30 +0300 Subject: [PATCH] Add alias for dotnet workload repair command --- .../Repair/DotNetWorkloadRepairerFixture.cs | 17 +++ .../Repair/DotNetWorkloadRepairTests.cs | 85 ++++++++++++++ src/Cake.Common/Tools/DotNet/DotNetAliases.cs | 53 +++++++++ .../Repair/DotNetWorkloadRepairSettings.cs | 57 +++++++++ .../Workload/Repair/DotNetWorkloadRepairer.cs | 110 ++++++++++++++++++ .../Tools/DotNet/DotNetAliases.cake | 9 ++ 6 files changed, 331 insertions(+) create mode 100644 src/Cake.Common.Tests/Fixtures/Tools/DotNet/Workload/Repair/DotNetWorkloadRepairerFixture.cs create mode 100644 src/Cake.Common.Tests/Unit/Tools/DotNet/Workload/Repair/DotNetWorkloadRepairTests.cs create mode 100644 src/Cake.Common/Tools/DotNet/Workload/Repair/DotNetWorkloadRepairSettings.cs create mode 100644 src/Cake.Common/Tools/DotNet/Workload/Repair/DotNetWorkloadRepairer.cs diff --git a/src/Cake.Common.Tests/Fixtures/Tools/DotNet/Workload/Repair/DotNetWorkloadRepairerFixture.cs b/src/Cake.Common.Tests/Fixtures/Tools/DotNet/Workload/Repair/DotNetWorkloadRepairerFixture.cs new file mode 100644 index 0000000000..86d25af11c --- /dev/null +++ b/src/Cake.Common.Tests/Fixtures/Tools/DotNet/Workload/Repair/DotNetWorkloadRepairerFixture.cs @@ -0,0 +1,17 @@ +// 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.Repair; + +namespace Cake.Common.Tests.Fixtures.Tools.DotNet.Workload.Repair +{ + internal sealed class DotNetWorkloadRepairerFixture : DotNetFixture + { + protected override void RunTool() + { + var tool = new DotNetWorkloadRepairer(FileSystem, Environment, ProcessRunner, Tools); + tool.Repair(Settings); + } + } +} diff --git a/src/Cake.Common.Tests/Unit/Tools/DotNet/Workload/Repair/DotNetWorkloadRepairTests.cs b/src/Cake.Common.Tests/Unit/Tools/DotNet/Workload/Repair/DotNetWorkloadRepairTests.cs new file mode 100644 index 0000000000..bbd4efda00 --- /dev/null +++ b/src/Cake.Common.Tests/Unit/Tools/DotNet/Workload/Repair/DotNetWorkloadRepairTests.cs @@ -0,0 +1,85 @@ +// 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.Repair; +using Cake.Common.Tools.DotNet; +using Cake.Testing; +using Xunit; + +namespace Cake.Common.Tests.Unit.Tools.DotNet.Workload.Repair +{ + public sealed class DotNetWorkloadRepairTests + { + public sealed class TheWorkloadRepairMethod + { + [Fact] + public void Should_Throw_If_Process_Was_Not_Started() + { + // Given + var fixture = new DotNetWorkloadRepairerFixture(); + 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 DotNetWorkloadRepairerFixture(); + 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 DotNetWorkloadRepairerFixture(); + fixture.Settings = null; + fixture.GivenDefaultToolDoNotExist(); + + // When + var result = Record.Exception(() => fixture.Run()); + + // Then + AssertEx.IsArgumentNullException(result, "settings"); + } + + [Fact] + public void Should_Add_Additional_Arguments() + { + // Given + var fixture = new DotNetWorkloadRepairerFixture(); + 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.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 repair --configfile \"/Working/nuget.config\" --disable-parallel --ignore-failed-sources --include-previews --interactive --no-cache"; + expected += " --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); + } + } + } +} diff --git a/src/Cake.Common/Tools/DotNet/DotNetAliases.cs b/src/Cake.Common/Tools/DotNet/DotNetAliases.cs index 6f945837a8..f01c821d3e 100644 --- a/src/Cake.Common/Tools/DotNet/DotNetAliases.cs +++ b/src/Cake.Common/Tools/DotNet/DotNetAliases.cs @@ -24,6 +24,7 @@ using Cake.Common.Tools.DotNet.VSTest; 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.Search; using Cake.Common.Tools.DotNet.Workload.Uninstall; using Cake.Common.Tools.DotNetCore.Build; @@ -2139,5 +2140,57 @@ public static IEnumerable DotNetWorkloadList(this ICakeC var lister = new DotNetWorkloadLister(context.FileSystem, context.Environment, context.ProcessRunner, context.Tools); return lister.List(settings); } + + /// + /// Repairs all workloads installations. + /// + /// The context. + /// + /// + /// DotNetWorkloadRepair(); + /// + /// + [CakeMethodAlias] + [CakeAliasCategory("Workload")] + [CakeNamespaceImport("Cake.Common.Tools.DotNet.Workload.Repair")] + public static void DotNetWorkloadRepair(this ICakeContext context) + { + context.DotNetWorkloadRepair(null); + } + + /// + /// Repairs all workloads installations. + /// + /// The context. + /// The settings. + /// + /// + /// var settings = new DotNetWorkloadRepairSettings + /// { + /// IncludePreviews = true, + /// NoCache = true + /// }; + /// + /// DotNetWorkloadRepair(settings); + /// + /// + [CakeMethodAlias] + [CakeAliasCategory("Workload")] + [CakeNamespaceImport("Cake.Common.Tools.DotNet.Workload.Repair")] + public static void DotNetWorkloadRepair(this ICakeContext context, DotNetWorkloadRepairSettings settings) + { + if (context is null) + { + throw new ArgumentNullException(nameof(context)); + } + + if (settings == null) + { + settings = new DotNetWorkloadRepairSettings(); + } + + var repairer = new DotNetWorkloadRepairer(context.FileSystem, context.Environment, context.ProcessRunner, context.Tools); + repairer.Repair(settings); + } } } diff --git a/src/Cake.Common/Tools/DotNet/Workload/Repair/DotNetWorkloadRepairSettings.cs b/src/Cake.Common/Tools/DotNet/Workload/Repair/DotNetWorkloadRepairSettings.cs new file mode 100644 index 0000000000..f78a0ed532 --- /dev/null +++ b/src/Cake.Common/Tools/DotNet/Workload/Repair/DotNetWorkloadRepairSettings.cs @@ -0,0 +1,57 @@ +// 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.Repair +{ + /// + /// Contains settings used by . + /// + public sealed class DotNetWorkloadRepairSettings : 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 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/Repair/DotNetWorkloadRepairer.cs b/src/Cake.Common/Tools/DotNet/Workload/Repair/DotNetWorkloadRepairer.cs new file mode 100644 index 0000000000..0d8de40e4c --- /dev/null +++ b/src/Cake.Common/Tools/DotNet/Workload/Repair/DotNetWorkloadRepairer.cs @@ -0,0 +1,110 @@ +// 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.Repair +{ + /// + /// .NET workloads installations repairer. + /// + public sealed class DotNetWorkloadRepairer : DotNetTool + { + private readonly ICakeEnvironment _environment; + + /// + /// Initializes a new instance of the class. + /// + /// The file system. + /// The environment. + /// The process runner. + /// The tool locator. + public DotNetWorkloadRepairer( + IFileSystem fileSystem, + ICakeEnvironment environment, + IProcessRunner processRunner, + IToolLocator tools) : base(fileSystem, environment, processRunner, tools) + { + _environment = environment; + } + + /// + /// Repairs all workloads installations. + /// + /// The settings. + public void Repair(DotNetWorkloadRepairSettings settings) + { + if (settings == null) + { + throw new ArgumentNullException(nameof(settings)); + } + + RunCommand(settings, GetArguments(settings)); + } + + private ProcessArgumentBuilder GetArguments(DotNetWorkloadRepairSettings settings) + { + var builder = CreateArgumentBuilder(settings); + + builder.Append("workload repair"); + + // 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"); + } + + // 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 4afd636041..24a856e2b5 100644 --- a/tests/integration/Cake.Common/Tools/DotNet/DotNetAliases.cake +++ b/tests/integration/Cake.Common/Tools/DotNet/DotNetAliases.cake @@ -280,6 +280,14 @@ Task("Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadSearch") } }); +Task("Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadRepair") + .IsDependentOn("Cake.Common.Tools.DotNet.DotNetAliases.Setup") + .Does(() => +{ + // When + DotNetWorkloadRepair(); +}); + Task("Cake.Common.Tools.DotNet.DotNetAliases.DotNetBuildServerShutdown") .IsDependentOn("Cake.Common.Tools.DotNet.DotNetAliases.DotNetRestore") .IsDependentOn("Cake.Common.Tools.DotNet.DotNetAliases.DotNetBuild") @@ -298,6 +306,7 @@ Task("Cake.Common.Tools.DotNet.DotNetAliases.DotNetBuildServerShutdown") .IsDependentOn("Cake.Common.Tools.DotNet.DotNetAliases.DotNetFormat") .IsDependentOn("Cake.Common.Tools.DotNet.DotNetAliases.DotNetSDKCheck") .IsDependentOn("Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadSearch") + .IsDependentOn("Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadRepair") .Does(() => { // When