[DSC] Implement Microsoft.PowerToys.Configure DSCResource & winget support #30918
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1029,6 +1029,7 @@ NOSIZE | |
| NOTIFICATIONSDLL | ||
| NOTIFYICONDATAW | ||
| NOTIMPL | ||
| notlike | ||
| NOTOPMOST | ||
| NOTRACK | ||
| NOTSRCCOPY | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| { | ||
| "Version": "1.0.0", | ||
| "UseMinimatch": false, | ||
| "SignBatches": [ | ||
| { | ||
| "MatchedPath": [ | ||
| "Microsoft.PowerToys.Configure.psm1", | ||
| "Microsoft.PowerToys.Configure.psd1" | ||
| ], | ||
| "SigningInfo": { | ||
| "Operations": [ | ||
| { | ||
| "KeyCode": "CP-230012", | ||
| "OperationSetCode": "SigntoolSign", | ||
| "Parameters": [ | ||
| { | ||
| "parameterName": "OpusName", | ||
| "parameterValue": "Microsoft" | ||
| }, | ||
| { | ||
| "parameterName": "OpusInfo", | ||
| "parameterValue": "http://www.microsoft.com" | ||
| }, | ||
| { | ||
| "parameterName": "FileDigest", | ||
| "parameterValue": "/fd \"SHA256\"" | ||
| }, | ||
| { | ||
| "parameterName": "PageHash", | ||
| "parameterValue": "/NPH" | ||
| }, | ||
| { | ||
| "parameterName": "TimeStamp", | ||
| "parameterValue": "/tr \"http://rfc3161.gtm.corp.microsoft.com/TSS/HttpTspServer\" /td sha256" | ||
| } | ||
| ], | ||
| "ToolName": "sign", | ||
| "ToolVersion": "1.0" | ||
| }, | ||
| { | ||
| "KeyCode": "CP-230012", | ||
| "OperationSetCode": "SigntoolVerify", | ||
| "Parameters": [], | ||
| "ToolName": "sign", | ||
| "ToolVersion": "1.0" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| # What is it | ||
|
|
||
| We would like to enable our users to use [`winget configure`](https://learn.microsoft.com/en-us/windows/package-manager/winget/configure) command to install PowerToys and configure its settings with a [Winget configuration file](https://learn.microsoft.com/en-us/windows/package-manager/configuration/create). For example: | ||
|
|
||
| ```yaml | ||
| properties: | ||
| resources: | ||
| - resource: Microsoft.WinGet.DSC/WinGetPackage | ||
| directives: | ||
| description: Install PowerToys | ||
| allowPrerelease: true | ||
| settings: | ||
| id: PowerToys (Preview) | ||
| source: winget | ||
|
|
||
| - resource: PowerToysConfigure | ||
| directives: | ||
| description: Configure PowerToys | ||
| settings: | ||
| ShortcutGuide: | ||
| Enabled: false | ||
| OverlayOpacity: 1 | ||
| FancyZones: | ||
| Enabled: true | ||
| FancyzonesEditorHotkey: "Shift+Ctrl+Alt+F" | ||
| configurationVersion: 0.2.0 | ||
| ``` | ||
|
|
||
| This should install PowerToys and make `PowerToysConfigure` resource available. We can use it in the same file. | ||
|
|
||
| # How it works | ||
|
|
||
| `PowerToysConfigure` is a [class-based DSC resource](https://learn.microsoft.com/en-us/powershell/dsc/concepts/class-based-resources?view=dsc-2.0). It looks up whether each setting was specified or not by checking whether it's `$null` or `0` for `enum`s and invokes `PowerToys.Settings.exe` with the updated value like so: | ||
| ``` | ||
| PowerToys.Settings.exe set <ModuleName>.<SettingName> <SettingValue> | ||
| ``` | ||
|
|
||
| So for the example the config above should perform 3 following invocations: | ||
| ``` | ||
| PowerToys.Settings.exe set ShortcutGuide.Enabled false | ||
| PowerToys.Settings.exe set FancyZones.Enabled true | ||
| PowerToys.Settings.exe set FancyZones.FancyzonesEditorHotkey "Shift+Ctrl+Alt+F" | ||
| ``` | ||
|
|
||
| `PowerToys.Settings` uses dotnet reflection capabilities to determine `SettingName` type and tries to convert the supplied `SettingValue` string accordingly. We use `ICmdReprParsable` for custom setting types. | ||
|
|
||
|
|
||
| # How DSC is implemented | ||
|
|
||
| We use `PowerToys.Settings.DSC.Schema.Generator` to generate the bulk of `PowerToysConfigure.psm1` file. It also uses dotnet reflection capabilities to inspect `PowerToys.Settings.UI.Lib.dll` assembly and generate properties for the modules we have. The actual generation is done as a `PowerToys.Settings.DSC.Schema.Generator.csproj` post-build action. | ||
|
|
||
| # Debugging DSC resources | ||
|
|
||
| First, make sure that PowerShell 7.4+ is installed. Then make sure that you have DSC installed: | ||
|
|
||
| ```ps | ||
| Install-Module -Name PSDesiredStateConfiguration -RequiredVersion 2.0.7 | ||
| ``` | ||
|
|
||
| After that, start a new `pwsh` session and `cd` to `src\dsc\Microsoft.PowerToys.Configure\Generated` directory. From there, you should execute: | ||
| ```ps | ||
| $env:PSModulePath += ";$pwd" | ||
| ``` | ||
|
|
||
| Now build `PowerToys.sln` and **move** `src\dsc\Microsoft.PowerToys.Configure\Microsoft.PowerToys.Configure.psd1` temporarily to `src\dsc\Microsoft.PowerToys.Configure\Generated\Microsoft.PowerToys.Configure\0.0.1\` folder, so it's located alongside with the generated `Microsoft.PowerToys.Configure.psm1`. | ||
|
|
||
| This will allow DSC to discover our DSC Resource module. See [PSModulePath](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_psmodulepath?view=powershell-7.4#long-description) for more info. | ||
|
|
||
| If everything works, you should see that your module is discovered by executing the following command: | ||
|
|
||
| ```ps | ||
| Get-Module -ListAvailable | grep PowerToys | ||
| ``` | ||
|
|
||
| The resource itself should also be available: | ||
| ```ps | ||
| Get-DSCResource | grep PowerToys | ||
| ``` | ||
|
|
||
| Otherwise, you can force-import the module to diagnose issues: | ||
|
|
||
| ``` | ||
| Import-Module .\Microsoft.PowerToys.Configure.psd1 | ||
| ``` | ||
|
|
||
| If it's imported successfully, you could also try to invoke it directly: | ||
|
|
||
| ```ps | ||
| Invoke-DscResource -Name PowerToysConfigure -Method Set -ModuleName Microsoft.PowerToys.Configure -Property @{ Debug = $true; Awake = @{ Enabled = $false; Mode = "TIMED"; IntervalMinutes = "10" } } | ||
| ``` | ||
|
|
||
| Note that we've supplied `Debug` option, so a `%TEMP\PowerToys.DSC.TestConfigure.txt` is created with the supplied properties, a current timestamp, and other debug output. | ||
|
|
||
| Finally, you can test it with winget by invoking it as such: | ||
|
|
||
| ```ps | ||
| winget configure .\configuration.dsc.yaml --accept-configuration-agreements --disable-interactivity | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.