Update tests for ResourceBase 2.0 (#2386)

Author: dan-hughes

CHANGELOG.md

@@ -167,6 +167,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `SqlProtocol`
   - Refactored to use the public command `Get-SqlDscServerProtocolName` instead
     of the deprecated private function `Get-ProtocolNameProperties`
+- `Class-Based Dsc Resource Tests`
+  - Updated tests for ResourceBase 2.0.
 
 ### Fixed
 

source/Classes/020.SqlAgentAlert.ps1

@@ -149,17 +149,13 @@ class SqlAgentAlert : SqlResourceBase
     [SqlAgentAlert] Get()
     {
         # Call base implementation to get current state
-        $currentState = ([ResourceBase] $this).Get()
-
-        return $currentState
+        return ([ResourceBase] $this).Get()
     }
 
     [System.Boolean] Test()
     {
         # Call base implementation to test current state
-        $inDesiredState = ([ResourceBase] $this).Test()
-
-        return $inDesiredState
+        return ([ResourceBase] $this).Test()
     }
 
     [void] Set()

tests/QA/ScriptAnalyzer.Tests.ps1

@@ -66,9 +66,7 @@ BeforeDiscovery {
 
     $moduleFiles = Get-ChildItem -Path $sourcePath -Recurse -Include @('*.psm1', '*.ps1')
 
-    $testCases = @()
-
-    foreach ($moduleFile in $moduleFiles)
+    $testCases = foreach ($moduleFile in $moduleFiles)
     {
         # Skipping Examples on Linux and macOS as they cannot be parsed.
         if (($IsLinux -or $IsMacOs) -and $moduleFile.FullName -match 'Examples')
@@ -90,8 +88,8 @@ BeforeDiscovery {
         $escapedRepositoryPath = [System.Text.RegularExpressions.RegEx]::Escape($repositoryPathNormalized)
         $relativePath = $moduleFilePathNormalized -replace ($escapedRepositoryPath + '/')
 
-        $testCases += @{
-            ScriptPath = $moduleFile.FullName
+        @{
+            ScriptPath   = $moduleFile.FullName
             RelativePath = $relativePath
         }
     }
@@ -102,24 +100,21 @@ Describe 'Script Analyzer Rules' {
         BeforeAll {
             $repositoryPath = Resolve-Path -Path (Join-Path -Path $PSScriptRoot -ChildPath '../..')
             $scriptAnalyzerSettingsPath = Join-Path -Path $repositoryPath -ChildPath '.vscode/analyzersettings.psd1'
-        }
-
-        It 'Should pass all PS Script Analyzer rules for file ''<RelativePath>''' -ForEach $testCases {
-            $pssaError = Invoke-ScriptAnalyzer -Path $ScriptPath -Settings $scriptAnalyzerSettingsPath
 
             $parseErrorTypes = @(
                 'TypeNotFound'
                 'RequiresModuleInvalid'
             )
+        }
 
+        It 'Should pass all PS Script Analyzer rules for file ''<RelativePath>''' -ForEach $testCases {
             # Filter out reported parse errors that is unable to be resolved in source files
-            $pssaError = $pssaError |
+            $pssaError = Invoke-ScriptAnalyzer -Path $ScriptPath -Settings $scriptAnalyzerSettingsPath |
                 Where-Object -FilterScript {
                     $_.RuleName -notin $parseErrorTypes
                 }
 
-            $report = $pssaError |
-                Format-Table -AutoSize | Out-String -Width 200
+            $report = $pssaError | Format-Table -AutoSize | Out-String -Width 200
 
             $pssaError | Should -HaveCount 0 -Because "all script analyzer rules should pass.`r`n`r`n $report`r`n"
         }

tests/QA/module.tests.ps1

@@ -127,22 +127,18 @@ BeforeDiscovery {
     $allModuleFunctions = & $mut { Get-Command -Module $args[0] -CommandType Function } $script:moduleName
 
     # Build test cases.
-    $testCasesAllModuleFunction = @()
-
-    foreach ($function in $allModuleFunctions)
+    $testCasesAllModuleFunction = foreach ($function in $allModuleFunctions)
     {
-        $testCasesAllModuleFunction += @{
+        @{
             Name = $function.Name
         }
     }
 
     $allPublicCommand = (Get-Command -Module $script:moduleName).Name
 
-    $testCasesPublicCommand = @()
-
-    foreach ($command in $allPublicCommand)
+    $testCasesPublicCommand = foreach ($command in $allPublicCommand)
     {
-        $testCasesPublicCommand += @{
+        @{
             Name = $command
         }
     }
@@ -218,9 +214,7 @@ Describe 'Comment-based help structure' -Tags 'helpQuality' {
                 # Split into lines to check each one
                 $helpLines = $helpBlock -split "`n"
 
-                $invalidDirectives = @()
-
-                foreach ($line in $helpLines)
+                $invalidDirectives = foreach ($line in $helpLines)
                 {
                     # Check if line starts with whitespace followed by a period and text
                     if ($line -match '^\s+\.([a-zA-Z]+)')
@@ -230,7 +224,7 @@ Describe 'Comment-based help structure' -Tags 'helpQuality' {
                         # Check if it's a valid directive
                         if ($directive -notin $validDirectives)
                         {
-                            $invalidDirectives += $directive
+                            $directive
                         }
                     }
                 }

tests/TestHelpers/CommonTestHelper.psm1

@@ -252,11 +252,12 @@ function Get-NetIPAddressNetwork
 
     $networkAddress = ([IPAddress]($IPAddress.Address -band $subnetMask.Address)).IPAddressToString
 
-    $networkObject = New-Object -TypeName PSCustomObject
-    Add-Member -InputObject $networkObject -MemberType NoteProperty -Name 'IPAddress' -Value $IPAddress
-    Add-Member -InputObject $networkObject -MemberType NoteProperty -Name 'PrefixLength' -Value $PrefixLength
-    Add-Member -InputObject $networkObject -MemberType NoteProperty -Name 'SubnetMask' -Value $subnetMask
-    Add-Member -InputObject $networkObject -MemberType NoteProperty -Name 'NetworkAddress' -Value $networkAddress
+    $networkObject = [PSCustomObject] @{
+        IPAddress      = $IPAddress
+        PrefixLength   = $PrefixLength
+        SubnetMask     = $subnetMask
+        NetworkAddress = $networkAddress
+    }
 
     return $networkObject
 }
@@ -423,7 +424,7 @@ function Test-SetupArgument
     $actualValues.Count | Should -Be $ExpectedArgument.Count `
         -Because ('the expected arguments was: {0}' -f ($ExpectedArgument.Keys -join ','))
 
-    Write-Verbose -Message 'Verified actual setup argument values against expected setup argument values' -Verbose
+    Write-Verbose -Message 'Verified actual setup argument values against expected setup argument values'
 
     foreach ($argumentKey in $ExpectedArgument.Keys)
     {