Skip to content

Commit ef92a8a

Browse files
dsplaisteddsplaisted
authored
Add workload config command (#39888)
2 parents 3f731f2 + 7ecfc8a commit ef92a8a

File tree

60 files changed

+868
-299
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+868
-299
lines changed

‎src/Cli/dotnet/commands/InstallingWorkloadCommand.cs

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -244,12 +244,6 @@ protected IEnumerable<WorkloadId> GetInstalledWorkloads(bool fromPreviousSdk)
244244

245245
internal static class InstallingWorkloadCommandParser
246246
{
247-
public static readonly CliOption<string> WorkloadSetMode = new("--mode")
248-
{
249-
Description = Strings.WorkloadSetMode,
250-
Hidden = true
251-
};
252-
253247
public static readonly CliOption<string> WorkloadSetVersionOption = new("--version")
254248
{
255249
Description = Strings.WorkloadSetVersionOptionDescription

‎src/Cli/dotnet/commands/dotnet-workload/WorkloadCommandParser.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ private static CliCommand ConstructCommand()
124124
command.Subcommands.Add(WorkloadRestoreCommandParser.GetCommand());
125125
command.Subcommands.Add(WorkloadCleanCommandParser.GetCommand());
126126
command.Subcommands.Add(WorkloadElevateCommandParser.GetCommand());
127+
command.Subcommands.Add(WorkloadConfigCommandParser.GetCommand());
127128

128129
command.Validators.Add(commandResult =>
129130
{

‎src/Cli/dotnet/commands/dotnet-workload/config/LocalizableStrings.resx

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="CommandDescription" xml:space="preserve">
121+
<value>Modify or display workload configuration values.
122+
To display a value, specify the corresponding command-line option without providing a value. For example: "dotnet workload config --update-mode"</value>
123+
</data>
124+
<data name="UpdateModeDescription" xml:space="preserve">
125+
<value>Controls whether updates should look for workload sets or the latest version of each individual manifest.</value>
126+
</data>
127+
</root>

‎src/Cli/dotnet/commands/dotnet-workload/config/WorkloadConfigCommand.cs

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
// Licensed to the .NET Foundation under one or more agreements.
2+
// The .NET Foundation licenses this file to you under the MIT license.
3+
4+
using System;
5+
using System.Collections.Generic;
6+
using System.CommandLine;
7+
using System.Linq;
8+
using System.Text;
9+
using System.Threading.Tasks;
10+
using Microsoft.Deployment.DotNet.Releases;
11+
using Microsoft.DotNet.Cli;
12+
using Microsoft.DotNet.Cli.Utils;
13+
using Microsoft.DotNet.Workloads.Workload;
14+
using Microsoft.DotNet.Workloads.Workload.Install;
15+
using Microsoft.NET.Sdk.WorkloadManifestReader;
16+
17+
#nullable enable
18+
19+
namespace Microsoft.DotNet.Workloads.Workload.Config
20+
{
21+
internal class WorkloadConfigCommand : WorkloadCommandBase
22+
{
23+
private bool _hasUpdateMode;
24+
private string? _updateMode;
25+
private readonly IWorkloadResolverFactory _workloadResolverFactory;
26+
27+
private string? _dotnetPath;
28+
private string _userProfileDir;
29+
private readonly IWorkloadResolver _workloadResolver;
30+
private readonly ReleaseVersion _sdkVersion;
31+
private readonly SdkFeatureBand _sdkFeatureBand;
32+
33+
readonly IInstaller _workloadInstaller;
34+
35+
public WorkloadConfigCommand(
36+
ParseResult parseResult,
37+
IReporter? reporter = null,
38+
IWorkloadResolverFactory? workloadResolverFactory = null
39+
) : base(parseResult, CommonOptions.HiddenVerbosityOption, reporter)
40+
{
41+
_hasUpdateMode = parseResult.HasOption(WorkloadConfigCommandParser.UpdateMode);
42+
_updateMode = parseResult.GetValue(WorkloadConfigCommandParser.UpdateMode);
43+
44+
_workloadResolverFactory = workloadResolverFactory ?? new WorkloadResolverFactory();
45+
46+
var creationResult = _workloadResolverFactory.Create();
47+
48+
_dotnetPath = creationResult.DotnetPath;
49+
_userProfileDir = creationResult.UserProfileDir;
50+
_workloadResolver = creationResult.WorkloadResolver;
51+
_sdkVersion = creationResult.SdkVersion;
52+
53+
_sdkFeatureBand = new SdkFeatureBand(_sdkVersion);
54+
_workloadInstaller = WorkloadInstallerFactory.GetWorkloadInstaller(Reporter, _sdkFeatureBand, creationResult.WorkloadResolver, Verbosity, creationResult.UserProfileDir, VerifySignatures, PackageDownloader, creationResult.DotnetPath);
55+
}
56+
57+
public override int Execute()
58+
{
59+
// When we support multiple configuration values, it would be nice if we could process and display them in the order they are passed.
60+
// It seems that the parser doesn't give us a good way to do that, however
61+
if (_hasUpdateMode)
62+
{
63+
if (WorkloadConfigCommandParser.UpdateMode_WorkloadSet.Equals(_updateMode, StringComparison.InvariantCultureIgnoreCase))
64+
{
65+
_workloadInstaller.UpdateInstallMode(_sdkFeatureBand, true);
66+
}
67+
else if (WorkloadConfigCommandParser.UpdateMode_Manifests.Equals(_updateMode, StringComparison.InvariantCultureIgnoreCase))
68+
{
69+
_workloadInstaller.UpdateInstallMode(_sdkFeatureBand, false);
70+
}
71+
else if (string.IsNullOrEmpty(_updateMode))
72+
{
73+
if (InstallingWorkloadCommand.ShouldUseWorkloadSetMode(_sdkFeatureBand, _dotnetPath))
74+
{
75+
Reporter.WriteLine(WorkloadConfigCommandParser.UpdateMode_WorkloadSet);
76+
}
77+
else
78+
{
79+
Reporter.WriteLine(WorkloadConfigCommandParser.UpdateMode_Manifests);
80+
}
81+
}
82+
else
83+
{
84+
// This should not be hit, as parser sets the accepted values and should error before getting here if the value is not valid
85+
throw new InvalidOperationException($"Invalid update mode: {_updateMode}");
86+
}
87+
}
88+
else
89+
{
90+
_parseResult.ShowHelp();
91+
}
92+
93+
return 0;
94+
}
95+
}
96+
97+
}

‎src/Cli/dotnet/commands/dotnet-workload/config/WorkloadConfigCommandParser.cs

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
// Licensed to the .NET Foundation under one or more agreements.
2+
// The .NET Foundation licenses this file to you under the MIT license.
3+
4+
using System.CommandLine;
5+
using Microsoft.DotNet.Workloads.Workload.Config;
6+
7+
namespace Microsoft.DotNet.Cli
8+
{
9+
internal static class WorkloadConfigCommandParser
10+
{
11+
// dotnet workload config --update-mode workload-set
12+
13+
public static readonly string UpdateMode_WorkloadSet = "workload-set";
14+
public static readonly string UpdateMode_Manifests = "manifests";
15+
16+
public static readonly CliOption<string> UpdateMode = new("--update-mode")
17+
{
18+
Description = LocalizableStrings.UpdateModeDescription,
19+
Arity = ArgumentArity.ZeroOrOne
20+
};
21+
22+
private static readonly CliCommand Command = ConstructCommand();
23+
24+
public static CliCommand GetCommand()
25+
{
26+
return Command;
27+
}
28+
29+
private static CliCommand ConstructCommand()
30+
{
31+
UpdateMode.AcceptOnlyFromAmong(UpdateMode_WorkloadSet, UpdateMode_Manifests);
32+
33+
CliCommand command = new("config", LocalizableStrings.CommandDescription);
34+
command.Options.Add(UpdateMode);
35+
36+
command.SetAction(parseResult =>
37+
{
38+
new WorkloadConfigCommand(parseResult).Execute();
39+
});
40+
41+
return command;
42+
}
43+
}
44+
}

‎src/Cli/dotnet/commands/dotnet-workload/config/xlf/LocalizableStrings.cs.xlf

Lines changed: 19 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Cli/dotnet/commands/dotnet-workload/config/xlf/LocalizableStrings.de.xlf

Lines changed: 19 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Cli/dotnet/commands/dotnet-workload/config/xlf/LocalizableStrings.es.xlf

Lines changed: 19 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Cli/dotnet/commands/dotnet-workload/config/xlf/LocalizableStrings.fr.xlf

Lines changed: 19 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Cli/dotnet/commands/dotnet-workload/config/xlf/LocalizableStrings.it.xlf

Lines changed: 19 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)