Add to PS, DSCv2, and GP

Author: JohnMcPMS

src/AppInstallerSharedLib/GroupPolicy.cpp

@@ -219,7 +219,7 @@ namespace AppInstaller::Settings
                 }
             }
 #endif
-            // TrustLevel and Explicit are optional policy fields with default values.
+            // TrustLevel, Explicit, and Priority are optional policy fields with default values.
             const std::string trustLevelName = "TrustLevel";
             if (sourceJson.isMember(trustLevelName) && sourceJson[trustLevelName].isArray())
             {
@@ -236,6 +236,12 @@ namespace AppInstaller::Settings
                 source.Explicit = sourceJson[explicitName].asBool();
             }
 
+            const std::string priorityName = "Priority";
+            if (sourceJson.isMember(priorityName) && sourceJson[priorityName].isInt())
+            {
+                source.Priority = sourceJson[priorityName].asInt();
+            }
+
             return source;
         }
     }

src/PowerShell/Microsoft.WinGet.Client.Cmdlets/Cmdlets/AddSourceCmdlet.cs

@@ -60,13 +60,20 @@ public sealed class AddSourceCmdlet : PSCmdlet
         [Parameter(ValueFromPipelineByPropertyName = true)]
         public SwitchParameter Explicit { get; set; }
 
+        /// <summary>
+        /// Gets or sets a value indicating the priority of the source. Higher values are sorted first.
+        /// </summary>
+        ///
+        [Parameter(ValueFromPipelineByPropertyName = true)]
+        public int Priority { get; set; }
+
         /// <summary>
         /// Adds source.
         /// </summary>
         protected override void ProcessRecord()
         {
             var command = new CliCommand(this);
-            command.AddSource(this.Name, this.Argument, this.Type, this.ConvertPSSourceTrustLevelToString(this.TrustLevel), this.Explicit.ToBool());
+            command.AddSource(this.Name, this.Argument, this.Type, this.ConvertPSSourceTrustLevelToString(this.TrustLevel), this.Explicit.ToBool(), this.Priority);
         }
 
         private string ConvertPSSourceTrustLevelToString(PSSourceTrustLevel trustLevel) => trustLevel switch

src/PowerShell/Microsoft.WinGet.Client.Engine/Commands/CliCommand.cs

@@ -72,7 +72,8 @@ public void GetSettings(bool asPlainText)
         /// <param name="type">Type of source.</param>
         /// <param name="trustLevel">Trust level of source.</param>
         /// <param name="isExplicit">Make source explicit.</param>
-        public void AddSource(string name, string arg, string type, string trustLevel, bool isExplicit)
+        /// <param name="priority">Set the priority if the source.</param>
+        public void AddSource(string name, string arg, string type, string trustLevel, bool isExplicit, int priority)
         {
             Utilities.VerifyAdmin();
             string parameters = $"add --name \"{name}\" --arg \"{arg}\"";
@@ -92,6 +93,11 @@ public void AddSource(string name, string arg, string type, string trustLevel, b
                 parameters += " --explicit";
             }
 
+            if (priority != 0)
+            {
+                parameters += $" --priority \"{priority}\"";
+            }
+
             _ = this.Run("source", parameters, 300000);
         }
 

src/PowerShell/Microsoft.WinGet.Client.Engine/PSObjects/PSSourceResult.cs

@@ -23,6 +23,7 @@ internal PSSourceResult(Management.Deployment.PackageCatalogReference catalogRef
             this.Type = info.Type;
             this.TrustLevel = info.TrustLevel.ToString();
             this.Explicit = info.Explicit;
+            this.Priority = info.Priority;
         }
 
         /// <summary>
@@ -49,5 +50,10 @@ internal PSSourceResult(Management.Deployment.PackageCatalogReference catalogRef
         /// Gets a value indicating whether the source must be explicitly specified for discovery.
         /// </summary>
         public bool Explicit { get; private set; }
+
+        /// <summary>
+        /// Gets a value indicating the priority of the source. Higher values are sorted first.
+        /// </summary>
+        public int Priority { get; private set; }
     }
 }

src/PowerShell/Microsoft.WinGet.DSC/Microsoft.WinGet.DSC.psm1

@@ -203,6 +203,9 @@ class WinGetSource
 
     [DscProperty()]
     [nullable[bool]]$Explicit = $null
+    
+    [DscProperty()]
+    [nullable[int]]$Priority = $null
 
     [DscProperty()]
     [WinGetEnsure]$Ensure = [WinGetEnsure]::Present
@@ -232,6 +235,7 @@ class WinGetSource
             $result.Type = $currentSource.Type
             $result.TrustLevel = $currentSource.TrustLevel
             $result.Explicit = $currentSource.Explicit
+            $result.Priority = $currentSource.Priority
         }
         else
         {
@@ -314,6 +318,11 @@ class WinGetSource
                 $hashArgs.Add("Explicit", $this.Explicit)
             }
 
+            if ($null -ne $this.Priority)
+            {
+                $hashArgs.Add("Priority", $this.Priority)
+            }
+
             Add-WinGetSource @hashArgs
         }
     }
@@ -352,6 +361,12 @@ class WinGetSource
             return $false
         }
 
+        if ($null -ne $this.Priority -and
+            $this.Priority -ne $currentSource.Priority)
+        {
+            return $false
+        }
+
         return $true
     }
 }

src/PowerShell/tests/Microsoft.WinGet.Client.Tests.ps1

@@ -188,7 +188,7 @@ Describe 'Reset-WinGetSource' {
 Describe 'Get|Add|Reset-WinGetSource' {
 
     BeforeAll {
-        Add-WinGetSource -Name 'TestSource' -Arg 'https://localhost:5001/TestKit/' -TrustLevel 'Trusted' -Explicit
+        Add-WinGetSource -Name 'TestSource' -Arg 'https://localhost:5001/TestKit/' -TrustLevel 'Trusted' -Explicit -Priority 42
     }
 
     It 'Get Test source' {
@@ -200,6 +200,7 @@ Describe 'Get|Add|Reset-WinGetSource' {
         $source.Type | Should -Be 'Microsoft.PreIndexed.Package'
         $source.TrustLevel | Should -Be 'Trusted'
         $source.Explicit | Should -Be $true
+        $source.Priority | Should -Be 42
     }
 
     It 'Get fake source' {

src/PowerShell/tests/Microsoft.WinGet.DSC.Tests.ps1

@@ -148,7 +148,7 @@ Describe 'WinGetSource' {
     }
 
     It 'Set WinGet source' {
-        InvokeWinGetDSC -Name WinGetSource -Method Set -Property @{ Name = $testSourceName; Argument = $testSourceArg; Type = $testSourceType; TrustLevel = 'Trusted'; Explicit = $true }
+        InvokeWinGetDSC -Name WinGetSource -Method Set -Property @{ Name = $testSourceName; Argument = $testSourceArg; Type = $testSourceType; TrustLevel = 'Trusted'; Explicit = $true; Priority = 42 }
 
         $result = InvokeWinGetDSC -Name WinGetSource -Method Test -Property @{ Name = $testSourceName; Argument = $testSourceArg; Type = $testSourceType }
         $result.InDesiredState | Should -Be $true
@@ -159,6 +159,7 @@ Describe 'WinGetSource' {
         $result.Argument | Should -Be $testSourceArg
         $result.TrustLevel | Should -Be 'Trusted'
         $result.Explicit | Should -Be $true
+        $result.Priority | Should -Be 42
     }
 }