Update azmodule test for version (#68)

oZakari · web-flow · commit 10e95d3f5c07 · 2023-08-16T10:19:00.000-05:00
# Pull Request

## Description

Description of changes: Updated Az module tests to check for a specific
version of at least 10.0.0.

## License

By submitting this pull request, I confirm that my contribution is made
under the terms of the projects associated license.
diff --git a/README.md b/README.md
@@ -40,8 +40,8 @@ Test-ALZRequirement
 
 Currently this tests for:
 
-* Supported minimum PowerShell version
-* Azure PowerShell Module
+* Supported minimum PowerShell version (7.1)
+* Supported minimum Az PowerShell module version (10.0.0)
 * Git
 * Azure CLI
 * Bicep
diff --git a/src/ALZ/Private/Test-Utility-Functions.ps1 b/src/ALZ/Private/Test-Utility-Functions.ps1
@@ -2,4 +2,7 @@
 function Get-PSVersion { $PSVersionTable }
 
 #Unable to mock $PSScriptRoot variable
-function Get-ScriptRoot { $PSScriptRoot }
+function Get-ScriptRoot { $PSScriptRoot }
+
+# Used to allow mocking of the Get-Module AZ
+function Get-AZVersion { Get-Module -Name Az -ListAvailable | Sort-Object -Property Version -Descending | Select-Object -First 1 }
diff --git a/src/ALZ/Public/Test-ALZRequirement.ps1 b/src/ALZ/Public/Test-ALZRequirement.ps1
@@ -85,13 +85,13 @@ function Test-ALZRequirement {
             Write-Error "Bicep is not installed. Please install Bicep."
             $result = $false
         }
-        # Check if Azure PowerShell module is installed
-        $azModule = Get-Module -Name Az -ListAvailable
-        if ($azModule) {
-            Write-Verbose "Azure PowerShell module is installed."
-        } else {
-            Write-Error "Azure PowerShell module is not installed. Please install the Azure PowerShell module."
+        # Check if AZ PowerShell module is the correct version
+        $azModule = Get-AZVersion
+        if ($azModule.Version.Major -lt 10) {
+            Write-Error "Az module version $($azModule.Version) is not supported. Please Upgrade to AZ module version 10.0.0 or higher."
             $result = $false
+        } else {
+            Write-Verbose "Az module version is supported."
         }
         if ($result) {
             return "ALZ requirements are met."
diff --git a/src/Tests/Unit/Private/Test-ALZRequirement.Tests.ps1 b/src/Tests/Unit/Private/Test-ALZRequirement.Tests.ps1
@@ -12,22 +12,27 @@ Import-Module $PathToManifest -Force
 #-------------------------------------------------------------------------
 
 InModuleScope 'ALZ' {
-    Describe 'Request-ConfigurationValue Public Function Tests' -Tag Unit {
+    Describe 'Test-ALZRequirement Public Function Tests' -Tag Unit {
         BeforeAll {
             $WarningPreference = 'SilentlyContinue'
             $ErrorActionPreference = 'SilentlyContinue'
         }
-        Context 'Non Az Module' {
+        Context 'Incompatible Az module version lower than 10.0.0' {
             BeforeEach {
-                Mock -CommandName Get-Module -MockWith {
-                    $null
+                Mock -CommandName Get-AZVersion -MockWith {
+                    [PSCustomObject]@{
+                        Version = [PSCustomObject]@{
+                            Major = 9
+                            Minor = 7
+                        }
+                    }
                 }
             }
-            It 'should return the not met for non AZ module' {
+            It 'should return the not met for non compatible az module versions' {
                 Test-ALZRequirement | Should -BeExactly "ALZ requirements are not met."
             }
         }
-        Context 'Incompatible Powershell version lower them 7' {
+        Context 'Incompatible Powershell version lower than 7' {
             BeforeEach {
                 Mock -CommandName Get-PSVersion -MockWith {
                     [PSCustomObject]@{
@@ -63,7 +68,7 @@ InModuleScope 'ALZ' {
                     $null
                 }
             }
-            It 'should return the not met for no git instalation' {
+            It 'should return the not met for no git installation' {
                 Test-ALZRequirement | Should -BeExactly "ALZ requirements are not met."
             }
         }
@@ -73,7 +78,7 @@ InModuleScope 'ALZ' {
                     $null
                 }
             }
-            It 'should return the not met for no Visual Studio Code instalation' {
+            It 'should return the not met for no Visual Studio Code installation' {
                 Test-ALZRequirement | Should -BeExactly "ALZ requirements are not met."
             }
         }
@@ -83,16 +88,18 @@ InModuleScope 'ALZ' {
                     $null
                 }
             }
-            It 'should return the not met for no bicep instalation' {
+            It 'should return the not met for no bicep installation' {
                 Test-ALZRequirement | Should -BeExactly "ALZ requirements are not met."
             }
         }
         Context 'Success' {
-
             BeforeEach {
-                Mock -CommandName Get-Module -MockWith {
+                Mock -CommandName Get-AZVersion -MockWith {
                     [PSCustomObject]@{
-                        Name = 'Az'
+                        Version = [PSCustomObject]@{
+                            Major = 10
+                            Minor = 0
+                        }
                     }
                 }
                 Mock -CommandName Get-PSVersion -MockWith {
@@ -123,7 +130,6 @@ InModuleScope 'ALZ' {
             It 'should return the expected results' {
                 Test-ALZRequirement | Should -BeExactly "ALZ requirements are met."
             }
-
         }
     }
 }
diff --git a/src/Tests/Unit/Public/Test-ALZRequirement.Tests.ps1 b/src/Tests/Unit/Public/Test-ALZRequirement.Tests.ps1
@@ -17,17 +17,22 @@ InModuleScope 'ALZ' {
             $WarningPreference = 'SilentlyContinue'
             $ErrorActionPreference = 'SilentlyContinue'
         }
-        Context 'Non Az Module' {
+        Context 'Incompatible Az module version lower than 10.0.0' {
             BeforeEach {
-                Mock -CommandName Get-Module -MockWith {
-                    $null
+                Mock -CommandName Get-AZVersion -MockWith {
+                    [PSCustomObject]@{
+                        Version = [PSCustomObject]@{
+                            Major = 9
+                            Minor = 7
+                        }
+                    }
                 }
             }
-            It 'should return the not met for non AZ module' {
+            It 'should return the not met for non compatible az module versions' {
                 Test-ALZRequirement | Should -BeExactly "ALZ requirements are not met."
             }
         }
-        Context 'Incompatible Powershell version lower them 7' {
+        Context 'Incompatible Powershell version lower than 7' {
             BeforeEach {
                 Mock -CommandName Get-PSVersion -MockWith {
                     [PSCustomObject]@{
@@ -63,7 +68,7 @@ InModuleScope 'ALZ' {
                     $null
                 }
             }
-            It 'should return the not met for no git instalation' {
+            It 'should return the not met for no git installation' {
                 Test-ALZRequirement | Should -BeExactly "ALZ requirements are not met."
             }
         }
@@ -73,7 +78,7 @@ InModuleScope 'ALZ' {
                     $null
                 }
             }
-            It 'should return the not met for no Visual Studio Code instalation' {
+            It 'should return the not met for no Visual Studio Code installation' {
                 Test-ALZRequirement | Should -BeExactly "ALZ requirements are not met."
             }
         }
@@ -83,15 +88,18 @@ InModuleScope 'ALZ' {
                     $null
                 }
             }
-            It 'should return the not met for no bicep instalation' {
+            It 'should return the not met for no bicep installation' {
                 Test-ALZRequirement | Should -BeExactly "ALZ requirements are not met."
             }
         }
         Context 'Success' {
             BeforeEach {
-                Mock -CommandName Get-Module -MockWith {
+                Mock -CommandName Get-AZVersion -MockWith {
                     [PSCustomObject]@{
-                        Name = 'Az'
+                        Version = [PSCustomObject]@{
+                            Major = 10
+                            Minor = 0
+                        }
                     }
                 }
                 Mock -CommandName Get-PSVersion -MockWith {

Original file line number	Diff line number	Diff line change
`@@ -12,22 +12,27 @@ Import-Module $PathToManifest -Force`
`12`	`12`	`#-------------------------------------------------------------------------`
`13`	`13`
`14`	`14`	`InModuleScope 'ALZ' {`
`15`		`- Describe 'Request-ConfigurationValue Public Function Tests' -Tag Unit {`
	`15`	`+ Describe 'Test-ALZRequirement Public Function Tests' -Tag Unit {`
`16`	`16`	`BeforeAll {`
`17`	`17`	`$WarningPreference = 'SilentlyContinue'`
`18`	`18`	`$ErrorActionPreference = 'SilentlyContinue'`
`19`	`19`	`}`
`20`		`- Context 'Non Az Module' {`
	`20`	`+ Context 'Incompatible Az module version lower than 10.0.0' {`
`21`	`21`	`BeforeEach {`
`22`		`- Mock -CommandName Get-Module -MockWith {`
`23`		`- $null`
	`22`	`+ Mock -CommandName Get-AZVersion -MockWith {`
	`23`	`+ [PSCustomObject]@{`
	`24`	`+ Version = [PSCustomObject]@{`
	`25`	`+ Major = 9`
	`26`	`+ Minor = 7`
	`27`	`+ }`
	`28`	`+ }`
`24`	`29`	`}`
`25`	`30`	`}`
`26`		`- It 'should return the not met for non AZ module' {`
	`31`	`+ It 'should return the not met for non compatible az module versions' {`
`27`	`32`	`Test-ALZRequirement \| Should -BeExactly "ALZ requirements are not met."`
`28`	`33`	`}`
`29`	`34`	`}`
`30`		`- Context 'Incompatible Powershell version lower them 7' {`
	`35`	`+ Context 'Incompatible Powershell version lower than 7' {`
`31`	`36`	`BeforeEach {`
`32`	`37`	`Mock -CommandName Get-PSVersion -MockWith {`
`33`	`38`	`[PSCustomObject]@{`
`@@ -63,7 +68,7 @@ InModuleScope 'ALZ' {`
`63`	`68`	`$null`
`64`	`69`	`}`
`65`	`70`	`}`
`66`		`- It 'should return the not met for no git instalation' {`
	`71`	`+ It 'should return the not met for no git installation' {`
`67`	`72`	`Test-ALZRequirement \| Should -BeExactly "ALZ requirements are not met."`
`68`	`73`	`}`
`69`	`74`	`}`
`@@ -73,7 +78,7 @@ InModuleScope 'ALZ' {`
`73`	`78`	`$null`
`74`	`79`	`}`
`75`	`80`	`}`
`76`		`- It 'should return the not met for no Visual Studio Code instalation' {`
	`81`	`+ It 'should return the not met for no Visual Studio Code installation' {`
`77`	`82`	`Test-ALZRequirement \| Should -BeExactly "ALZ requirements are not met."`
`78`	`83`	`}`
`79`	`84`	`}`
`@@ -83,16 +88,18 @@ InModuleScope 'ALZ' {`
`83`	`88`	`$null`
`84`	`89`	`}`
`85`	`90`	`}`
`86`		`- It 'should return the not met for no bicep instalation' {`
	`91`	`+ It 'should return the not met for no bicep installation' {`
`87`	`92`	`Test-ALZRequirement \| Should -BeExactly "ALZ requirements are not met."`
`88`	`93`	`}`
`89`	`94`	`}`
`90`	`95`	`Context 'Success' {`
`91`		`-`
`92`	`96`	`BeforeEach {`
`93`		`- Mock -CommandName Get-Module -MockWith {`
	`97`	`+ Mock -CommandName Get-AZVersion -MockWith {`
`94`	`98`	`[PSCustomObject]@{`
`95`		`- Name = 'Az'`
	`99`	`+ Version = [PSCustomObject]@{`
	`100`	`+ Major = 10`
	`101`	`+ Minor = 0`
	`102`	`+ }`
`96`	`103`	`}`
`97`	`104`	`}`
`98`	`105`	`Mock -CommandName Get-PSVersion -MockWith {`
`@@ -123,7 +130,6 @@ InModuleScope 'ALZ' {`
`123`	`130`	`It 'should return the expected results' {`
`124`	`131`	`Test-ALZRequirement \| Should -BeExactly "ALZ requirements are met."`
`125`	`132`	`}`
`126`		`-`
`127`	`133`	`}`
`128`	`134`	`}`
`129`	`135`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,17 +17,22 @@ InModuleScope 'ALZ' {`
`17`	`17`	`$WarningPreference = 'SilentlyContinue'`
`18`	`18`	`$ErrorActionPreference = 'SilentlyContinue'`
`19`	`19`	`}`
`20`		`- Context 'Non Az Module' {`
	`20`	`+ Context 'Incompatible Az module version lower than 10.0.0' {`
`21`	`21`	`BeforeEach {`
`22`		`- Mock -CommandName Get-Module -MockWith {`
`23`		`- $null`
	`22`	`+ Mock -CommandName Get-AZVersion -MockWith {`
	`23`	`+ [PSCustomObject]@{`
	`24`	`+ Version = [PSCustomObject]@{`
	`25`	`+ Major = 9`
	`26`	`+ Minor = 7`
	`27`	`+ }`
	`28`	`+ }`
`24`	`29`	`}`
`25`	`30`	`}`
`26`		`- It 'should return the not met for non AZ module' {`
	`31`	`+ It 'should return the not met for non compatible az module versions' {`
`27`	`32`	`Test-ALZRequirement \| Should -BeExactly "ALZ requirements are not met."`
`28`	`33`	`}`
`29`	`34`	`}`
`30`		`- Context 'Incompatible Powershell version lower them 7' {`
	`35`	`+ Context 'Incompatible Powershell version lower than 7' {`
`31`	`36`	`BeforeEach {`
`32`	`37`	`Mock -CommandName Get-PSVersion -MockWith {`
`33`	`38`	`[PSCustomObject]@{`
`@@ -63,7 +68,7 @@ InModuleScope 'ALZ' {`
`63`	`68`	`$null`
`64`	`69`	`}`
`65`	`70`	`}`
`66`		`- It 'should return the not met for no git instalation' {`
	`71`	`+ It 'should return the not met for no git installation' {`
`67`	`72`	`Test-ALZRequirement \| Should -BeExactly "ALZ requirements are not met."`
`68`	`73`	`}`
`69`	`74`	`}`
`@@ -73,7 +78,7 @@ InModuleScope 'ALZ' {`
`73`	`78`	`$null`
`74`	`79`	`}`
`75`	`80`	`}`
`76`		`- It 'should return the not met for no Visual Studio Code instalation' {`
	`81`	`+ It 'should return the not met for no Visual Studio Code installation' {`
`77`	`82`	`Test-ALZRequirement \| Should -BeExactly "ALZ requirements are not met."`
`78`	`83`	`}`
`79`	`84`	`}`
`@@ -83,15 +88,18 @@ InModuleScope 'ALZ' {`
`83`	`88`	`$null`
`84`	`89`	`}`
`85`	`90`	`}`
`86`		`- It 'should return the not met for no bicep instalation' {`
	`91`	`+ It 'should return the not met for no bicep installation' {`
`87`	`92`	`Test-ALZRequirement \| Should -BeExactly "ALZ requirements are not met."`
`88`	`93`	`}`
`89`	`94`	`}`
`90`	`95`	`Context 'Success' {`
`91`	`96`	`BeforeEach {`
`92`		`- Mock -CommandName Get-Module -MockWith {`
	`97`	`+ Mock -CommandName Get-AZVersion -MockWith {`
`93`	`98`	`[PSCustomObject]@{`
`94`		`- Name = 'Az'`
	`99`	`+ Version = [PSCustomObject]@{`
	`100`	`+ Major = 10`
	`101`	`+ Minor = 0`
	`102`	`+ }`
`95`	`103`	`}`
`96`	`104`	`}`
`97`	`105`	`Mock -CommandName Get-PSVersion -MockWith {`