Add switch parameter to register MAR

Author: adityapatwardhan

src/code/RegisterPSResourceRepository.cs

@@ -29,6 +29,8 @@ class RegisterPSResourceRepository : PSCmdlet, IDynamicParameters
         #region Members
 
         private readonly string PSGalleryRepoName = "PSGallery";
+        private readonly string MicrosoftArtifactRegistryRepoName = "MicrosoftArtifactRegistry";
+        private readonly string MicrosoftArtifactRegistryRepoUri = "https://artifactregistry.microsoft.com/api/v2";
         private readonly string PSGalleryRepoUri = "https://www.powershellgallery.com/api/v2";
         private const int DefaultPriority = 50;
         private const bool DefaultTrusted = false;
@@ -37,6 +39,7 @@ class RegisterPSResourceRepository : PSCmdlet, IDynamicParameters
         private const string RepositoriesParameterSet = "RepositoriesParameterSet";
         private Uri _uri;
         private CredentialProviderDynamicParameters _credentialProvider;
+        private const string MARParameterSet = "MARParameterSet";
 
         #endregion
 
@@ -62,6 +65,13 @@ class RegisterPSResourceRepository : PSCmdlet, IDynamicParameters
         [Parameter(Mandatory = true, ParameterSetName = PSGalleryParameterSet, HelpMessage = "PSGallery switch used to indicate registering PSGallery repository.")]
         public SwitchParameter PSGallery { get; set; }
 
+        /// <summary>
+        /// When specified, registers Microsoft Artifact Registry repository.
+        /// </summary>
+        [Parameter(Mandatory = true, ParameterSetName = MARParameterSet, HelpMessage = "Switch used to indicate registering Microsoft Artifact Registry repository.")]
+        [Alias("MAR")]
+        public SwitchParameter MicrosoftArtifactRegistry { get; set; }
+
         /// <summary>
         /// Specifies a hashtable of repositories and is used to register multiple repositories at once.
         /// </summary>
@@ -74,6 +84,7 @@ class RegisterPSResourceRepository : PSCmdlet, IDynamicParameters
         /// </summary>
         [Parameter(ParameterSetName = NameParameterSet)]
         [Parameter(ParameterSetName = PSGalleryParameterSet)]
+        [Parameter(ParameterSetName = MARParameterSet)]
         public SwitchParameter Trusted { get; set; }
 
         /// <summary>
@@ -84,6 +95,7 @@ class RegisterPSResourceRepository : PSCmdlet, IDynamicParameters
         /// </summary>
         [Parameter(ParameterSetName = NameParameterSet)]
         [Parameter(ParameterSetName = PSGalleryParameterSet)]
+        [Parameter(ParameterSetName = MARParameterSet)]
         [ValidateRange(0, 100)]
         public int Priority { get; set; } = DefaultPriority;
 
@@ -122,6 +134,7 @@ public object GetDynamicParameters()
             // It should also not appear when using the 'Repositories' parameter set.
             if (ParameterSetName.Equals(PSGalleryParameterSet) ||
                 ParameterSetName.Equals(RepositoriesParameterSet) ||
+                ParameterSetName.Equals(MARParameterSet) ||
                 PSRepositoryInfo.IsValidContainerRegistryURL(Uri))
             {
                 return null;
@@ -218,6 +231,24 @@ protected override void ProcessRecord()
                     }
                     break;
 
+                case MARParameterSet:
+                    if (MicrosoftArtifactRegistry)
+                    {
+                        try
+                        {
+                            items.Add(MicrosoftArtifactRegistryParameterSetHelper(Priority, Trusted));
+                        }
+                        catch (Exception e)
+                        {
+                            ThrowTerminatingError(new ErrorRecord(
+                                new PSInvalidOperationException(e.Message),
+                                "ErrorInMARParameterSet",
+                                ErrorCategory.InvalidArgument,
+                                this));
+                        }
+                    }
+                    break;
+
                 default:
                     Dbg.Assert(false, "Invalid parameter set");
                     break;
@@ -262,6 +293,34 @@ private PSRepositoryInfo PSGalleryParameterSetHelper(int repoPriority, bool repo
             return addedRepo;
         }
 
+        private PSRepositoryInfo MicrosoftArtifactRegistryParameterSetHelper(int repoPriority, bool repoTrusted)
+        {
+            WriteDebug("In RegisterPSResourceRepository::MicrosoftArtifactRegistryParameterSetHelper()");
+            Uri marUri = new Uri(MicrosoftArtifactRegistryRepoUri);
+            WriteDebug("Internal name and uri values for Microsoft Artifact Registry are hardcoded and validated. Priority and trusted values, if passed in, also validated");
+            var addedRepo = RepositorySettings.AddToRepositoryStore(MicrosoftArtifactRegistryRepoName,
+                marUri,
+                repoPriority,
+                repoTrusted,
+                apiVersion: null,
+                repoCredentialInfo: null,
+                credentialProvider: null,
+                Force,
+                this,
+                out string errorMsg);
+
+            if (!string.IsNullOrEmpty(errorMsg))
+            {
+                ThrowTerminatingError(new ErrorRecord(
+                    new PSInvalidOperationException(errorMsg),
+                    "RepositoryCredentialSecretManagementUnavailableModule",
+                    ErrorCategory.ResourceUnavailable,
+                    this));
+            }
+
+            return addedRepo;
+        }
+
         private List<PSRepositoryInfo> RepositoriesParameterSetHelper()
         {
             WriteDebug("In RegisterPSResourceRepository::RepositoriesParameterSetHelper()");

src/code/RepositorySettings.cs

@@ -95,7 +95,7 @@ public static PSRepositoryInfo AddRepository(string repoName, Uri repoUri, int r
 
             if (repoName.Equals("MAR", StringComparison.OrdinalIgnoreCase))
             {
-                errorMsg = "Cannot register MAR with -Name parameter. The MAR repository is automatically registered. Try: Reset-PSResourceRepository to restore default repositories.";
+                errorMsg = "Cannot register MAR with -Name parameter. Try: Register-PSResourceRepository -MicrosoftArtifactRegistry.";
                 return null;
             }
 

test/ResourceRepositoryTests/RegisterPSResourceRepository.Tests.ps1

@@ -85,6 +85,15 @@ Describe "Test Register-PSResourceRepository" -tags 'CI' {
         $res.Priority | Should -Be 50
     }
 
+    It "register repository with MicrosoftArtifactRegistry parameter (MicrosoftArtifactRegistryParameterSet)" {
+        Unregister-PSResourceRepository -Name $MARName
+        $res = Register-PSResourceRepository -MicrosoftArtifactRegistry -PassThru
+        $res.Name | Should -Be $MARName
+        $res.Uri | Should -Be $MARUri
+        $res.Trusted | Should -Be True
+        $res.Priority | Should -Be 40
+    }
+
     It "register repository with PSGallery switch parameter value of false (PSGalleryParameterSet)" {
         Unregister-PSResourceRepository -Name $PSGalleryName
         $res = Register-PSResourceRepository -PSGallery:$false -PassThru
@@ -412,7 +421,7 @@ Describe "Test Register-PSResourceRepository" -tags 'CI' {
 
     It "should throw error when trying to register repository with ApiVersion unknown" {
         {Register-PSResourceRepository -Name $TestRepoName1 -Uri $tmpDir1Path -ApiVersion "unknown" -ErrorAction Stop} | Should -Throw -ErrorId "ParameterArgumentValidationError,Microsoft.PowerShell.PSResourceGet.Cmdlets.RegisterPSResourceRepository"
-        
+
         # Verify the repository was not created
         $repo = Get-PSResourceRepository $TestRepoName1 -ErrorAction SilentlyContinue
         $repo | Should -BeNullOrEmpty