Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add workload config command #39888

Merged
merged 9 commits into from
Apr 4, 2024
Merged
6 changes: 0 additions & 6 deletions src/Cli/dotnet/commands/InstallingWorkloadCommand.cs
Original file line number Diff line number Diff line change
Expand Up @@ -244,12 +244,6 @@ protected IEnumerable<WorkloadId> GetInstalledWorkloads(bool fromPreviousSdk)

internal static class InstallingWorkloadCommandParser
{
public static readonly CliOption<string> WorkloadSetMode = new("--mode")
{
Description = Strings.WorkloadSetMode,
Hidden = true
};

public static readonly CliOption<string> WorkloadSetVersionOption = new("--version")
{
Description = Strings.WorkloadSetVersionOptionDescription
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ private static CliCommand ConstructCommand()
command.Subcommands.Add(WorkloadRestoreCommandParser.GetCommand());
command.Subcommands.Add(WorkloadCleanCommandParser.GetCommand());
command.Subcommands.Add(WorkloadElevateCommandParser.GetCommand());
command.Subcommands.Add(WorkloadConfigCommandParser.GetCommand());

command.Validators.Add(commandResult =>
{
Expand Down
127 changes: 127 additions & 0 deletions src/Cli/dotnet/commands/dotnet-workload/config/LocalizableStrings.resx
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<!--
Microsoft ResX Schema

Version 2.0

The primary goals of this format is to allow a simple XML format
that is mostly human readable. The generation and parsing of the
various data types are done through the TypeConverter classes
associated with the data types.

Example:

... ado.net/XML headers & schema ...
<resheader name="resmimetype">text/microsoft-resx</resheader>
<resheader name="version">2.0</resheader>
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
<value>[base64 mime encoded serialized .NET Framework object]</value>
</data>
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
<comment>This is a comment</comment>
</data>

There are any number of "resheader" rows that contain simple
name/value pairs.

Each data row contains a name, and value. The row also contains a
type or mimetype. Type corresponds to a .NET class that support
text/value conversion through the TypeConverter architecture.
Classes that don't support this are serialized and stored with the
mimetype set.

The mimetype is used for serialized objects, and tells the
ResXResourceReader how to depersist the object. This is currently not
extensible. For a given mimetype the value must be set accordingly:

Note - application/x-microsoft.net.object.binary.base64 is the format
that the ResXResourceWriter will generate, however the reader can
read any of the formats listed below.

mimetype: application/x-microsoft.net.object.binary.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
: and then encoded with base64 encoding.

mimetype: application/x-microsoft.net.object.soap.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
: and then encoded with base64 encoding.

mimetype: application/x-microsoft.net.object.bytearray.base64
value : The object must be serialized into a byte array
: using a System.ComponentModel.TypeConverter
: and then encoded with base64 encoding.
-->
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
<xsd:element name="root" msdata:IsDataSet="true">
<xsd:complexType>
<xsd:choice maxOccurs="unbounded">
<xsd:element name="metadata">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" />
</xsd:sequence>
<xsd:attribute name="name" use="required" type="xsd:string" />
<xsd:attribute name="type" type="xsd:string" />
<xsd:attribute name="mimetype" type="xsd:string" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="assembly">
<xsd:complexType>
<xsd:attribute name="alias" type="xsd:string" />
<xsd:attribute name="name" type="xsd:string" />
</xsd:complexType>
</xsd:element>
<xsd:element name="data">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="resheader">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" />
</xsd:complexType>
</xsd:element>
</xsd:choice>
</xsd:complexType>
</xsd:element>
</xsd:schema>
<resheader name="resmimetype">
<value>text/microsoft-resx</value>
</resheader>
<resheader name="version">
<value>2.0</value>
</resheader>
<resheader name="reader">
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<data name="CommandDescription" xml:space="preserve">
<value>Modify or display workload configuration values.
To display a value, specify the corresponding command-line option without providing a value. For example: "dotnet workload config --update-mode"</value>
</data>
<data name="UpdateModeDescription" xml:space="preserve">
<value>Controls whether updates should look for workload sets or the latest version of each individual manifest.</value>
</data>
</root>
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Collections.Generic;
using System.CommandLine;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Microsoft.Deployment.DotNet.Releases;
using Microsoft.DotNet.Cli;
using Microsoft.DotNet.Cli.Utils;
using Microsoft.DotNet.Workloads.Workload;
using Microsoft.DotNet.Workloads.Workload.Install;
using Microsoft.NET.Sdk.WorkloadManifestReader;

#nullable enable

namespace Microsoft.DotNet.Workloads.Workload.Config
{
internal class WorkloadConfigCommand : WorkloadCommandBase
{
private bool _hasUpdateMode;
private string? _updateMode;
private readonly IWorkloadResolverFactory _workloadResolverFactory;

private string? _dotnetPath;
private string _userProfileDir;
private readonly IWorkloadResolver _workloadResolver;
private readonly ReleaseVersion _sdkVersion;
private readonly SdkFeatureBand _sdkFeatureBand;

readonly IInstaller _workloadInstaller;

public WorkloadConfigCommand(
ParseResult parseResult,
IReporter? reporter = null,
IWorkloadResolverFactory? workloadResolverFactory = null
) : base(parseResult, CommonOptions.HiddenVerbosityOption, reporter)
{
_hasUpdateMode = parseResult.HasOption(WorkloadConfigCommandParser.UpdateMode);
_updateMode = parseResult.GetValue(WorkloadConfigCommandParser.UpdateMode);

_workloadResolverFactory = workloadResolverFactory ?? new WorkloadResolverFactory();

var creationResult = _workloadResolverFactory.Create();

_dotnetPath = creationResult.DotnetPath;
_userProfileDir = creationResult.UserProfileDir;
_workloadResolver = creationResult.WorkloadResolver;
_sdkVersion = creationResult.SdkVersion;

_sdkFeatureBand = new SdkFeatureBand(_sdkVersion);
_workloadInstaller = WorkloadInstallerFactory.GetWorkloadInstaller(Reporter, _sdkFeatureBand, creationResult.WorkloadResolver, Verbosity, creationResult.UserProfileDir, VerifySignatures, PackageDownloader, creationResult.DotnetPath);
}

public override int Execute()
{
// When we support multiple configuration values, it would be nice if we could process and display them in the order they are passed.
// It seems that the parser doesn't give us a good way to do that, however
if (_hasUpdateMode)
{
if (WorkloadConfigCommandParser.UpdateMode_WorkloadSet.Equals(_updateMode, StringComparison.InvariantCultureIgnoreCase))
{
_workloadInstaller.UpdateInstallMode(_sdkFeatureBand, true);
}
else if (WorkloadConfigCommandParser.UpdateMode_Manifests.Equals(_updateMode, StringComparison.InvariantCultureIgnoreCase))
{
_workloadInstaller.UpdateInstallMode(_sdkFeatureBand, false);
}
else if (string.IsNullOrEmpty(_updateMode))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The _hasUpdateMode check doesn't eliminate this possibility?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, _hasUpdateMode specifies whether the --update-mode option was specified, but it's possible to specify the option without it's optional argument value, which we use to print the current value.

{
if (InstallingWorkloadCommand.ShouldUseWorkloadSetMode(_sdkFeatureBand, _dotnetPath))
{
Reporter.WriteLine(WorkloadConfigCommandParser.UpdateMode_WorkloadSet);
}
else
{
Reporter.WriteLine(WorkloadConfigCommandParser.UpdateMode_Manifests);
}
}
else
{
// This should not be hit, as parser sets the accepted values and should error before getting here if the value is not valid
throw new InvalidOperationException($"Invalid update mode: {_updateMode}");
}
}
else
{
_parseResult.ShowHelp();
}

return 0;
}
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.CommandLine;
using Microsoft.DotNet.Workloads.Workload.Config;

namespace Microsoft.DotNet.Cli
{
internal static class WorkloadConfigCommandParser
{
// dotnet workload config --update-mode workload-set

public static readonly string UpdateMode_WorkloadSet = "workload-set";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: typing - is hard. workloadset?

Also, I thought we were trying to not include "workload set" terminology? Not that I have a better proposal in this case...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty sure the guidance I got from @baronfel was to use dashes to separate words. I think that's the style we're going with in the CLI.

public static readonly string UpdateMode_Manifests = "manifests";

public static readonly CliOption<string> UpdateMode = new("--update-mode")
{
Description = LocalizableStrings.UpdateModeDescription,
Arity = ArgumentArity.ZeroOrOne
};

private static readonly CliCommand Command = ConstructCommand();

public static CliCommand GetCommand()
{
return Command;
}

private static CliCommand ConstructCommand()
{
UpdateMode.AcceptOnlyFromAmong(UpdateMode_WorkloadSet, UpdateMode_Manifests);

CliCommand command = new("config", LocalizableStrings.CommandDescription);
command.Options.Add(UpdateMode);

command.SetAction(parseResult =>
{
new WorkloadConfigCommand(parseResult).Execute();
});

return command;
}
}
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading