Fix issues for Az.Tools.Installer (Azure#20577)

msJinLei · web-flow · commit 8cbb06fb2833 · 2023-01-06T09:51:29.000+08:00
* Fix issues for Az.Tools.Installer

 1. Fix bugs in installation and updating
 2. Fix coding formatting issues
 3. Add test cases of installation and updating without Repository

* Address review comments
diff --git a/tools/Az.Tools.Installer/Az.Tools.Installer.psm1 b/tools/Az.Tools.Installer/Az.Tools.Installer.psm1
@@ -356,7 +356,7 @@ function Get-AzModuleFromRemote {
         $modulesWithVersion = @()
         $containValidModule = if ($Name) {$Name -Contains 'Az.Accounts'} else {$false}
         $module = $null
-        foreach($module in $modules.Dependencies) {
+        foreach ($module in $modules.Dependencies) {
             if ($module.Name -eq 'Az.Accounts') {
                 if ($UseExactAccountVersion) {
                     $version = $accountVersion
@@ -400,7 +400,7 @@ function Remove-AzureRM {
     process {
         try {
             $azureModuleNames = (Get-InstalledModule -Name Azure* -ErrorAction Stop).Name | Where-Object {$_ -match "Azure(\.[a-zA-Z0-9]+)?" -or $_ -match "AzureRM(\.[a-zA-Z0-9]+)?"}
-            foreach($moduleName in $azureModuleNames) {
+            foreach ($moduleName in $azureModuleNames) {
                 PowerShellGet\Uninstall-Module -Name $moduleName -AllVersion -AllowPrerelease -ErrorAction Continue
             }
         }
@@ -427,7 +427,7 @@ $exportedFunctions = @( Get-ChildItem -Path $PSScriptRoot/exports/*.ps1 -Recurse
 $internalFunctions = @( Get-ChildItem -Path $PSScriptRoot/internal/*.ps1 -ErrorAction SilentlyContinue )
 
 $allFunctions = $internalFunctions + $exportedFunctions
-foreach($function in $allFunctions) {
+foreach ($function in $allFunctions) {
     try {
         . $function.Fullname
     }
diff --git a/tools/Az.Tools.Installer/exports/Uninstall-AzModule.ps1 b/tools/Az.Tools.Installer/exports/Uninstall-AzModule.ps1
@@ -125,7 +125,7 @@ function Uninstall-AzModule {
                                 "$_"
                             }
                         }
-                        foreach($versionString in $versionStrings) {
+                        foreach ($versionString in $versionStrings) {
                             PowerShellGet\Uninstall-Module -Name $moduleName -RequiredVersion $versionString -AllowPrerelease -ErrorAction 'Continue'
                         }
                     }
diff --git a/tools/Az.Tools.Installer/exports/Update-AzModule.ps1 b/tools/Az.Tools.Installer/exports/Update-AzModule.ps1
@@ -91,7 +91,10 @@ function Update-AzModule {
             $findModuleParams.Add('Repository', $Repository)
         }
         $modulesToUpdate = Get-AzModuleFromRemote @findModuleParams
-        $Repository = $modulesToUpdate.Repository | Select-Object -First 1
+        if ($modulesToUpdate) {
+            $Repository = $modulesToUpdate.Repository | Select-Object -First 1
+        }
+
         $moduleUpdateTable = $modulesToUpdate | Foreach-Object { [PSCustomObject]@{
             Name = $_.Name
             VersionBeforeUpdate = [Version] ($groupSet[$_.Name] | Select-Object -First 1)
@@ -120,7 +123,7 @@ function Update-AzModule {
 
             if ($WhatIfPreference) {
                 $module = $null
-                foreach($module in $moduleUpdateTable) {
+                foreach ($module in $moduleUpdateTable) {
                     Write-Host "WhatIf: Will update $($module.Name) from $($module.VersionBeforeUpdate) to $($module.VersionUpdate)."
                 }
             }
diff --git a/tools/Az.Tools.Installer/internal/Install-AzModuleInternal.ps1 b/tools/Az.Tools.Installer/internal/Install-AzModuleInternal.ps1
@@ -86,7 +86,7 @@ function Install-AzModuleInternal {
                     }
                     $downloader.WaitForAllTasks()
                     $file = $null
-                    foreach($file in $fileList) {
+                    foreach ($file in $fileList) {
                         if (!(Test-Path -Path $file.Path)) {
                             Throw "[$Invoker] Fail to download $($file.Name) to $tempRepo. Please check your network connection and retry."
                         }
diff --git a/tools/Az.Tools.Installer/internal/Install-AzModule_Default.ps1 b/tools/Az.Tools.Installer/internal/Install-AzModule_Default.ps1
@@ -80,12 +80,15 @@ function Install-AzModule_Default {
 
         $modules = @()
         $modules += Get-AzModuleFromRemote @findModuleParams | Sort-Object -Property Name
-        $Repository = $modules.Repository | Select-Object -First 1
+        if ($modules) {
+            $Repository = $modules.Repository | Select-Object -First 1
+        }
 
         if($Name) {
             $moduleExcluded = $Name | Where-Object {!$modules -or $modules.Name -NotContains $_}
             if ($moduleExcluded) {
                 $azVersion = if ($RequiredAzVersion) {$RequiredAzVersion} else {"Latest"}
+                $Repository = if ($Repository) {$Repository} else {'the registered repositories'}
                 Write-Error "[$Invoker] The following specified modules:$moduleExcluded cannot be found in $Repository with the $azVersion version."
             }
         }
diff --git a/tools/Az.Tools.Installer/test/Install-AzModule.Tests.ps1 b/tools/Az.Tools.Installer/test/Install-AzModule.Tests.ps1
@@ -26,15 +26,15 @@ Describe 'Install-AzModule' {
         $modules.Name | Should -Contain 'Az.Storage'
         $modules.Name | Should -Contain 'Az.Network'
         $modules.Name | Should -Contain 'Az.Compute'
-        $modules.Name | Should -Contain 'Az.KeyVault'       
+        $modules.Name | Should -Contain 'Az.KeyVault'
     }
 
     It 'InstallByNamePrerelease' {
         $output = Install-AzModule -Name storage,neTwork,maps,Az.keyvault -Repository PSGallery -AllowPrerelease
         $output.Count | Should -Be 5
         $modules = Get-AzSubModule
         $modules.Count | Should -Be 5
-        $modules.Name | Should -Contain 'Az.Accounts'        
+        $modules.Name | Should -Contain 'Az.Accounts'
         $modules.Name | Should -Contain 'Az.Storage'
         $modules.Name | Should -Contain 'Az.Network'
         $modules.Name | Should -Contain 'Az.Maps'
@@ -44,12 +44,12 @@ Describe 'Install-AzModule' {
         $output.Count | Should -Be 4
         $modules = Get-AzSubModule
         $modules.Count | Should -Be 6
-        $modules.Name | Should -Contain 'Az.Accounts'        
+        $modules.Name | Should -Contain 'Az.Accounts'
         $modules.Name | Should -Contain 'Az.Storage'
         $modules.Name | Should -Contain 'Az.Network'
         $modules.Name | Should -Contain 'Az.Maps'
         $modules.Name | Should -Contain 'Az.KeyVault'
-        $modules.Name | Should -Contain 'Az.Resources'               
+        $modules.Name | Should -Contain 'Az.Resources'
     }
 
     It 'InstallByNameLatest' {
@@ -105,7 +105,35 @@ Describe 'Install-AzModule' {
         $modules.Name | Should -Contain 'Az.Storage'
     }
 
+    It 'InstallWithoutRepository' {
+        $repos = [Array](Get-PSRepository | Where-Object {$_.Name -ne 'PSGallery'})
+        if ($repos -ne $null) {
+            $repos | Unregister-PSRepository
+        }
+        try {
+            $output = Install-AzModule -Name storage,neTwork -RequiredAzVersion 6.3 -Scope 'CurrentUser'
+            $output.Count | Should -Be 3
+            $modules = Get-AzSubModule
+            $modules.Count | Should -Be 3
+            $modules.Name | Should -Contain 'Az.Accounts'
+            $modules.Name | Should -Contain 'Az.Storage'
+            $modules.Name | Should -Contain 'Az.Network'
+        }
+        finally {
+            foreach ($repo in $repos) {
+                if ($repo.Name -ne 'PSGallery') {
+                    $parameters = @{
+                        Name = $repo.Name
+                        SourceLocation = $repo.SourceLocation
+                        InstallationPolicy = $repo.InstallationPolicy
+                    }
+                    Register-PSRepository @parameters
+                }
+            }
+        }
+    }
+
     AfterEach {
-        Remove-AllAzModule       
+        Remove-AllAzModule
     }
-}
+}
diff --git a/tools/Az.Tools.Installer/test/Update-AzModule.Tests.ps1 b/tools/Az.Tools.Installer/test/Update-AzModule.Tests.ps1
@@ -59,7 +59,7 @@ Describe 'Update-AzModule' {
         $modules.Name | Should -Contain 'Az.Network'  
         $modules.Name | Should -Contain 'Az.Storage'  
         
-        foreach($module in $output) {
+        foreach ($module in $output) {
             (Find-Module -Name $module.Name -Repository PSGallery).Version | Should -Be $module.VersionUpdate
         }
     }
@@ -84,6 +84,29 @@ Describe 'Update-AzModule' {
         $output.Count | Should -Be 1
     }
 
+    It 'UpdateWithoutRepository' {
+        $repos = [Array](Get-PSRepository | Where-Object {$_.Name -ne 'PSGallery'})
+        if ($repos -ne $null) {
+            $repos | Unregister-PSRepository
+        }
+        try {
+            $output = Update-AzModule -Name storage -Scope 'CurrentUser'
+            $output.Count | Should -Be 2
+        }
+        finally {
+            foreach ($repo in $repos) {
+                if ($repo.Name -ne 'PSGallery') {
+                    $parameters = @{
+                        Name = $repo.Name
+                        SourceLocation = $repo.SourceLocation
+                        InstallationPolicy = $repo.InstallationPolicy
+                    }
+                    Register-PSRepository @parameters
+                }
+            }
+        }
+    }
+
     AfterEach {
         Remove-AllAzModule       
     }

Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ function Uninstall-AzModule {`
`125`	`125`	`"$_"`
`126`	`126`	`}`
`127`	`127`	`}`
`128`		`- foreach($versionString in $versionStrings) {`
	`128`	`+ foreach ($versionString in $versionStrings) {`
`129`	`129`	`PowerShellGet\Uninstall-Module -Name $moduleName -RequiredVersion $versionString -AllowPrerelease -ErrorAction 'Continue'`
`130`	`130`	`}`
`131`	`131`	`}`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,10 @@ function Update-AzModule {`
`91`	`91`	`$findModuleParams.Add('Repository', $Repository)`
`92`	`92`	`}`
`93`	`93`	`$modulesToUpdate = Get-AzModuleFromRemote @findModuleParams`
`94`		`- $Repository = $modulesToUpdate.Repository \| Select-Object -First 1`
	`94`	`+ if ($modulesToUpdate) {`
	`95`	`+ $Repository = $modulesToUpdate.Repository \| Select-Object -First 1`
	`96`	`+ }`
	`97`	`+`
`95`	`98`	`$moduleUpdateTable = $modulesToUpdate \| Foreach-Object { [PSCustomObject]@{`
`96`	`99`	`Name = $_.Name`
`97`	`100`	`VersionBeforeUpdate = [Version] ($groupSet[$_.Name] \| Select-Object -First 1)`
`@@ -120,7 +123,7 @@ function Update-AzModule {`
`120`	`123`
`121`	`124`	`if ($WhatIfPreference) {`
`122`	`125`	`$module = $null`
`123`		`- foreach($module in $moduleUpdateTable) {`
	`126`	`+ foreach ($module in $moduleUpdateTable) {`
`124`	`127`	`Write-Host "WhatIf: Will update $($module.Name) from $($module.VersionBeforeUpdate) to $($module.VersionUpdate)."`
`125`	`128`	`}`
`126`	`129`	`}`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ function Install-AzModuleInternal {`
`86`	`86`	`}`
`87`	`87`	`$downloader.WaitForAllTasks()`
`88`	`88`	`$file = $null`
`89`		`- foreach($file in $fileList) {`
	`89`	`+ foreach ($file in $fileList) {`
`90`	`90`	`if (!(Test-Path -Path $file.Path)) {`
`91`	`91`	`Throw "[$Invoker] Fail to download $($file.Name) to $tempRepo. Please check your network connection and retry."`
`92`	`92`	`}`