Tests/AMPowerShellTemplate.tests.ps1
<#
Author: Flemming Rohde - flr@automize.dk #> #region variables #ModuleName $ModuleName = ($MyInvocation.MyCommand.Name).Substring(0, ($MyInvocation.MyCommand.Name).IndexOf(".tests.ps1")) $TestsFolderPath = Split-Path $MyInvocation.MyCommand.path #$temppath = $TestsFolderPath.Substring(0, $TestsFolderPath.LastIndexOf("\")) Set-location $TestsFolderPath Set-Location '..\' #Params for Module file $ModuleFileName = "$ModuleName.psm1" $ModuleFileParams = @{ name = $ModuleFileName path = ".\$ModuleFileName" } #Params for Manifest file $ManifestFileName = "$ModuleName.psd1" $manifestFileParams = @{ name = $ManifestFileName path = ".\$ManifestFileName" } #Params for test file $TestFileName = "$ModuleName.tests.ps1" $TestFileParams = @{ name = $TestFileName path = ".\Tests\$TestFileName" } #endregion <# .Synopsis Test a script with PowerShellScriptAnalyzer and Pester .DESCRIPTION Takes a name and path as parameters and does standard PowerShellScriptAnalyzer tests with Pester .EXAMPLE Test-SciptAnalyzer -Name PowerShellScript.ps1 -Path .\PowerShellScript.ps1 .FUNCTIONALITY Pester PowerShellScriptAnalyzer #> Function Test-SciptAnalyzer { param( [Parameter(Mandatory = $true)][ValidateNotNullOrEmpty()][String]$Name, [Parameter(Mandatory = $true)][ValidateNotNullOrEmpty()][String]$Path ) $analysis = Invoke-ScriptAnalyzer -Path $Path $scriptAnalyzerRules = Get-ScriptAnalyzerRule forEach ($rule in $scriptAnalyzerRules) { It "Should pass $rule" { If ($analysis.RuleName -contains $rule) { $analysis | Where-Object RuleName -EQ $rule -outvariable failures | Out-Default $failures.Count | Should -Be 0 -Because 'It is recommended to avoid in PowerShell scripts/modules' } } } } Describe "Verify $ModuleName Files" { Context "Verify minimum version of Pester" { It "Major Version should be at least 4" { ((Get-Module -Name Pester).Version.Major -ge 4)| Should be $true } It "Minor Version should be at least 2" { ((Get-Module -Name Pester).Version.Minor -ge 2) | Should be $true } } Context "Testing $ModuleFileName against PowerShellScriptAnalyzer rules" { Test-SciptAnalyzer @ModuleFileParams } Context "Testing $ManifestFileName against PowerShellScriptAnalyzer rules" { Test-SciptAnalyzer @manifestFileParams } Context "Testing $TestFileName against PowerShellScriptAnalyzer rules" { Test-SciptAnalyzer @TestFileParams } Context "PowerShell Manifest tests" { $ModuleManifestPath = ".\$ManifestFileName" $Manifest = Import-PowerShellDataFile -Path $ModuleManifestPath it "Must have the root module fullfilled" { $Manifest.rootmodule | Should not benullorempty } it "Must have the author key fullfilled" { $Manifest.Author | should not benullorempty } it "Must have the description key fullfilled" { $Manifest.Description | should not benullorempty } it "Must have the company name key fullfilled" { $Manifest.CompanyName | should not benullorempty } it "Must have version key fullfilled" { $Manifest.ModuleVersion | Should not benullorempty } it 'Must pass the Test-ModuleManifest Validation' { Test-ModuleManifest -Path $ModuleManifestPath | should be $true } } Context "Code Unit tests" { It 'Import the module' { {Import-Module .\$ModuleName} | Should -Not -Throw } It 'Check whatif property of New-AMPowerShellModule output is null' { New-AMPowerShellModule -Name MyModule -Path C:\MyPath\ -Author 'Flemming Rohde' -CompanyName Automize -Copyright 2018 -ModuleVersion 1.0.0.0 -Description testing -WhatIf | Should -Be $null } It 'Check whatif property of New-AMPowerShellScript output is null' { New-AMPowerShellScript -Name MyScript -Path C:\MyPath -Author 'Flemming Rohde' -CompanyName Automize -Copyright 2018 -ScriptVersion 1.0.0.0 -Description testing -WhatIf | Should -Be $null } It 'Test New-AMPowerShellModule' { Mock New-AMPowerShellModule {} New-AMPowerShellModule -Name MyModule -Path C:\MyPath\ -Author 'Flemming Rohde' -CompanyName Automize -Copyright 2018 -ModuleVersion 1.0.0.0 -Description testing | Should -Be $Null } It 'Test New-AMPowerShellScript' { Mock New-AMPowerShellScript {} New-AMPowerShellScript -Name MyScript -Path C:\MyPath -Author 'Flemming Rohde' -CompanyName Automize -Copyright 2018 -ScriptVersion 1.0.0.0 -Description testing | should -Be $null } It 'Remove the module' { {Remove-Module $ModuleName} | Should -Not -Throw } } Context "Verify Codesigning of files" { $files = Get-ChildItem -File -Recurse | Where-Object {$PSItem.name -notlike "*.json"} foreach ($file in $files) { it "$($file.name) should be signed" { (Get-AuthenticodeSignature -FilePath $file.FullName).Status | Should -Be 'Valid' } } } } #set-location ..\..\ # SIG # Begin signature block # MIIXwwYJKoZIhvcNAQcCoIIXtDCCF7ACAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB # gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR # AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUdao4OClcfvBjNTT4jXgCFupV # PGygghL2MIID7jCCA1egAwIBAgIQfpPr+3zGTlnqS5p31Ab8OzANBgkqhkiG9w0B # AQUFADCBizELMAkGA1UEBhMCWkExFTATBgNVBAgTDFdlc3Rlcm4gQ2FwZTEUMBIG # A1UEBxMLRHVyYmFudmlsbGUxDzANBgNVBAoTBlRoYXd0ZTEdMBsGA1UECxMUVGhh # d3RlIENlcnRpZmljYXRpb24xHzAdBgNVBAMTFlRoYXd0ZSBUaW1lc3RhbXBpbmcg # Q0EwHhcNMTIxMjIxMDAwMDAwWhcNMjAxMjMwMjM1OTU5WjBeMQswCQYDVQQGEwJV # UzEdMBsGA1UEChMUU3ltYW50ZWMgQ29ycG9yYXRpb24xMDAuBgNVBAMTJ1N5bWFu # dGVjIFRpbWUgU3RhbXBpbmcgU2VydmljZXMgQ0EgLSBHMjCCASIwDQYJKoZIhvcN # AQEBBQADggEPADCCAQoCggEBALGss0lUS5ccEgrYJXmRIlcqb9y4JsRDc2vCvy5Q # WvsUwnaOQwElQ7Sh4kX06Ld7w3TMIte0lAAC903tv7S3RCRrzV9FO9FEzkMScxeC # i2m0K8uZHqxyGyZNcR+xMd37UWECU6aq9UksBXhFpS+JzueZ5/6M4lc/PcaS3Er4 # ezPkeQr78HWIQZz/xQNRmarXbJ+TaYdlKYOFwmAUxMjJOxTawIHwHw103pIiq8r3 # +3R8J+b3Sht/p8OeLa6K6qbmqicWfWH3mHERvOJQoUvlXfrlDqcsn6plINPYlujI # fKVOSET/GeJEB5IL12iEgF1qeGRFzWBGflTBE3zFefHJwXECAwEAAaOB+jCB9zAd # BgNVHQ4EFgQUX5r1blzMzHSa1N197z/b7EyALt0wMgYIKwYBBQUHAQEEJjAkMCIG # CCsGAQUFBzABhhZodHRwOi8vb2NzcC50aGF3dGUuY29tMBIGA1UdEwEB/wQIMAYB # Af8CAQAwPwYDVR0fBDgwNjA0oDKgMIYuaHR0cDovL2NybC50aGF3dGUuY29tL1Ro # YXd0ZVRpbWVzdGFtcGluZ0NBLmNybDATBgNVHSUEDDAKBggrBgEFBQcDCDAOBgNV # HQ8BAf8EBAMCAQYwKAYDVR0RBCEwH6QdMBsxGTAXBgNVBAMTEFRpbWVTdGFtcC0y # MDQ4LTEwDQYJKoZIhvcNAQEFBQADgYEAAwmbj3nvf1kwqu9otfrjCR27T4IGXTdf # plKfFo3qHJIJRG71betYfDDo+WmNI3MLEm9Hqa45EfgqsZuwGsOO61mWAK3ODE2y # 0DGmCFwqevzieh1XTKhlGOl5QGIllm7HxzdqgyEIjkHq3dlXPx13SYcqFgZepjhq # IhKjURmDfrYwggSjMIIDi6ADAgECAhAOz/Q4yP6/NW4E2GqYGxpQMA0GCSqGSIb3 # DQEBBQUAMF4xCzAJBgNVBAYTAlVTMR0wGwYDVQQKExRTeW1hbnRlYyBDb3Jwb3Jh # dGlvbjEwMC4GA1UEAxMnU3ltYW50ZWMgVGltZSBTdGFtcGluZyBTZXJ2aWNlcyBD # QSAtIEcyMB4XDTEyMTAxODAwMDAwMFoXDTIwMTIyOTIzNTk1OVowYjELMAkGA1UE # BhMCVVMxHTAbBgNVBAoTFFN5bWFudGVjIENvcnBvcmF0aW9uMTQwMgYDVQQDEytT # eW1hbnRlYyBUaW1lIFN0YW1waW5nIFNlcnZpY2VzIFNpZ25lciAtIEc0MIIBIjAN # BgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAomMLOUS4uyOnREm7Dv+h8GEKU5Ow # mNutLA9KxW7/hjxTVQ8VzgQ/K/2plpbZvmF5C1vJTIZ25eBDSyKV7sIrQ8Gf2Gi0 # jkBP7oU4uRHFI/JkWPAVMm9OV6GuiKQC1yoezUvh3WPVF4kyW7BemVqonShQDhfu # ltthO0VRHc8SVguSR/yrrvZmPUescHLnkudfzRC5xINklBm9JYDh6NIipdC6Anqh # d5NbZcPuF3S8QYYq3AhMjJKMkS2ed0QfaNaodHfbDlsyi1aLM73ZY8hJnTrFxeoz # C9Lxoxv0i77Zs1eLO94Ep3oisiSuLsdwxb5OgyYI+wu9qU+ZCOEQKHKqzQIDAQAB # o4IBVzCCAVMwDAYDVR0TAQH/BAIwADAWBgNVHSUBAf8EDDAKBggrBgEFBQcDCDAO # BgNVHQ8BAf8EBAMCB4AwcwYIKwYBBQUHAQEEZzBlMCoGCCsGAQUFBzABhh5odHRw # Oi8vdHMtb2NzcC53cy5zeW1hbnRlYy5jb20wNwYIKwYBBQUHMAKGK2h0dHA6Ly90 # cy1haWEud3Muc3ltYW50ZWMuY29tL3Rzcy1jYS1nMi5jZXIwPAYDVR0fBDUwMzAx # oC+gLYYraHR0cDovL3RzLWNybC53cy5zeW1hbnRlYy5jb20vdHNzLWNhLWcyLmNy # bDAoBgNVHREEITAfpB0wGzEZMBcGA1UEAxMQVGltZVN0YW1wLTIwNDgtMjAdBgNV # HQ4EFgQURsZpow5KFB7VTNpSYxc/Xja8DeYwHwYDVR0jBBgwFoAUX5r1blzMzHSa # 1N197z/b7EyALt0wDQYJKoZIhvcNAQEFBQADggEBAHg7tJEqAEzwj2IwN3ijhCcH # bxiy3iXcoNSUA6qGTiWfmkADHN3O43nLIWgG2rYytG2/9CwmYzPkSWRtDebDZw73 # BaQ1bHyJFsbpst+y6d0gxnEPzZV03LZc3r03H0N45ni1zSgEIKOq8UvEiCmRDoDR # EfzdXHZuT14ORUZBbg2w6jiasTraCXEQ/Bx5tIB7rGn0/Zy2DBYr8X9bCT2bW+IW # yhOBbQAuOA2oKY8s4bL0WqkBrxWcLC9JG9siu8P+eJRRw4axgohd8D20UaF5Mysu # e7ncIAkTcetqGVvP6KUwVyyJST+5z3/Jvz4iaGNTmr1pdKzFHTx/kuDDvBzYBHUw # ggUlMIIEDaADAgECAhAG+v2wvXnjGcvHbHMjoqQyMA0GCSqGSIb3DQEBCwUAMHIx # CzAJBgNVBAYTAlVTMRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3 # dy5kaWdpY2VydC5jb20xMTAvBgNVBAMTKERpZ2lDZXJ0IFNIQTIgQXNzdXJlZCBJ # RCBDb2RlIFNpZ25pbmcgQ0EwHhcNMTYxMDE0MDAwMDAwWhcNMTkxMDIzMTIwMDAw # WjBiMQswCQYDVQQGEwJESzETMBEGA1UECBMKU3lkZGFubWFyazEQMA4GA1UEBxMH # S29sZGluZzEVMBMGA1UEChMMQXV0b21pemUgUC9TMRUwEwYDVQQDEwxBdXRvbWl6 # ZSBQL1MwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDD2i1LjPMTWQ/Z # IUu9hVd4zXoU0k4xoRI1hdS4T2uvNdQPIGksD0SIK86+cBqKLVe8V+Do4mkKmmc3 # OskJnetN0ebst/8/ssJBSTc9zrEjmMdwspRog0Wjnb37bJWo0/Oown86BPafFCJT # oFoTBq4rnERtHAX8W7eNky8Lv7VMzcyM7poaeh7LSRhoetd1j6WpOWlAnbzu+tis # kixhl+uViQRBMl7nAzHxAvoq+Qx9fF4WhRXP1IhL0I+xiEdFiUQBaEOGBX7H/yXc # qmK7yWux+mpCd1L+t9LjqwiG2YjamlzaRaq9xd8C/HNUX/c/mnQltsWE8GuMoTpX # oL+eEq8fAgMBAAGjggHFMIIBwTAfBgNVHSMEGDAWgBRaxLl7KgqjpepxA8Bg+S32 # ZXUOWDAdBgNVHQ4EFgQUtkZqp/lfcNEd55nXFliTnGvgwoMwDgYDVR0PAQH/BAQD # AgeAMBMGA1UdJQQMMAoGCCsGAQUFBwMDMHcGA1UdHwRwMG4wNaAzoDGGL2h0dHA6 # Ly9jcmwzLmRpZ2ljZXJ0LmNvbS9zaGEyLWFzc3VyZWQtY3MtZzEuY3JsMDWgM6Ax # hi9odHRwOi8vY3JsNC5kaWdpY2VydC5jb20vc2hhMi1hc3N1cmVkLWNzLWcxLmNy # bDBMBgNVHSAERTBDMDcGCWCGSAGG/WwDATAqMCgGCCsGAQUFBwIBFhxodHRwczov # L3d3dy5kaWdpY2VydC5jb20vQ1BTMAgGBmeBDAEEATCBhAYIKwYBBQUHAQEEeDB2 # MCQGCCsGAQUFBzABhhhodHRwOi8vb2NzcC5kaWdpY2VydC5jb20wTgYIKwYBBQUH # MAKGQmh0dHA6Ly9jYWNlcnRzLmRpZ2ljZXJ0LmNvbS9EaWdpQ2VydFNIQTJBc3N1 # cmVkSURDb2RlU2lnbmluZ0NBLmNydDAMBgNVHRMBAf8EAjAAMA0GCSqGSIb3DQEB # CwUAA4IBAQA0zGCo40Bv+7KNre6TTDWf/2k0Tzauzwy3oesHg3pd7ZgQcPTU5er3 # vLXCKQwb8bmsPw3XpL0u1CkjdiqaO6S4qv3pGbyg9qnDXeFPJhg+i5VaTGb+PMSa # +nquQtdHhxfj5VEdt6nJlG/cBPMf/cH3O7/AzngCY1KGClKhtgLphHVF15oMj2Rt # Bu/jHSqWQAZOIXg7lvNfcRDI6DHwtMXVa4pVDJJM26SsLfpdoJnVOAbWUbkzf8BX # QDDp/pG/M9mrADKmPb+dy5EnX0SWwyZd3t/cIw7+AkpXbKGv3TJLSKQMdvW+bqZ0 # /VCcF796baLjQYXi28I4pkAabr5gt2u4MIIFMDCCBBigAwIBAgIQBAkYG1/Vu2Z1 # U0O1b5VQCDANBgkqhkiG9w0BAQsFADBlMQswCQYDVQQGEwJVUzEVMBMGA1UEChMM # RGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3d3cuZGlnaWNlcnQuY29tMSQwIgYDVQQD # ExtEaWdpQ2VydCBBc3N1cmVkIElEIFJvb3QgQ0EwHhcNMTMxMDIyMTIwMDAwWhcN # MjgxMDIyMTIwMDAwWjByMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQg # SW5jMRkwFwYDVQQLExB3d3cuZGlnaWNlcnQuY29tMTEwLwYDVQQDEyhEaWdpQ2Vy # dCBTSEEyIEFzc3VyZWQgSUQgQ29kZSBTaWduaW5nIENBMIIBIjANBgkqhkiG9w0B # AQEFAAOCAQ8AMIIBCgKCAQEA+NOzHH8OEa9ndwfTCzFJGc/Q+0WZsTrbRPV/5aid # 2zLXcep2nQUut4/6kkPApfmJ1DcZ17aq8JyGpdglrA55KDp+6dFn08b7KSfH03sj # lOSRI5aQd4L5oYQjZhJUM1B0sSgmuyRpwsJS8hRniolF1C2ho+mILCCVrhxKhwjf # DPXiTWAYvqrEsq5wMWYzcT6scKKrzn/pfMuSoeU7MRzP6vIK5Fe7SrXpdOYr/mzL # fnQ5Ng2Q7+S1TqSp6moKq4TzrGdOtcT3jNEgJSPrCGQ+UpbB8g8S9MWOD8Gi6CxR # 93O8vYWxYoNzQYIH5DiLanMg0A9kczyen6Yzqf0Z3yWT0QIDAQABo4IBzTCCAckw # EgYDVR0TAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwEwYDVR0lBAwwCgYI # KwYBBQUHAwMweQYIKwYBBQUHAQEEbTBrMCQGCCsGAQUFBzABhhhodHRwOi8vb2Nz # cC5kaWdpY2VydC5jb20wQwYIKwYBBQUHMAKGN2h0dHA6Ly9jYWNlcnRzLmRpZ2lj # ZXJ0LmNvbS9EaWdpQ2VydEFzc3VyZWRJRFJvb3RDQS5jcnQwgYEGA1UdHwR6MHgw # OqA4oDaGNGh0dHA6Ly9jcmw0LmRpZ2ljZXJ0LmNvbS9EaWdpQ2VydEFzc3VyZWRJ # RFJvb3RDQS5jcmwwOqA4oDaGNGh0dHA6Ly9jcmwzLmRpZ2ljZXJ0LmNvbS9EaWdp # Q2VydEFzc3VyZWRJRFJvb3RDQS5jcmwwTwYDVR0gBEgwRjA4BgpghkgBhv1sAAIE # MCowKAYIKwYBBQUHAgEWHGh0dHBzOi8vd3d3LmRpZ2ljZXJ0LmNvbS9DUFMwCgYI # YIZIAYb9bAMwHQYDVR0OBBYEFFrEuXsqCqOl6nEDwGD5LfZldQ5YMB8GA1UdIwQY # MBaAFEXroq/0ksuCMS1Ri6enIZ3zbcgPMA0GCSqGSIb3DQEBCwUAA4IBAQA+7A1a # JLPzItEVyCx8JSl2qB1dHC06GsTvMGHXfgtg/cM9D8Svi/3vKt8gVTew4fbRknUP # UbRupY5a4l4kgU4QpO4/cY5jDhNLrddfRHnzNhQGivecRk5c/5CxGwcOkRX7uq+1 # UcKNJK4kxscnKqEpKBo6cSgCPC6Ro8AlEeKcFEehemhor5unXCBc2XGxDI+7qPjF # Emifz0DLQESlE/DmZAwlCEIysjaKJAL+L3J+HNdJRZboWR3p+nRka7LrZkPas7CM # 1ekN3fYBIM6ZMWM9CBoYs4GbT8aTEAb8B4H6i9r5gkn3Ym6hU/oSlBiFLpKR6mhs # RDKyZqHnGKSaZFHvMYIENzCCBDMCAQEwgYYwcjELMAkGA1UEBhMCVVMxFTATBgNV # BAoTDERpZ2lDZXJ0IEluYzEZMBcGA1UECxMQd3d3LmRpZ2ljZXJ0LmNvbTExMC8G # A1UEAxMoRGlnaUNlcnQgU0hBMiBBc3N1cmVkIElEIENvZGUgU2lnbmluZyBDQQIQ # Bvr9sL154xnLx2xzI6KkMjAJBgUrDgMCGgUAoHgwGAYKKwYBBAGCNwIBDDEKMAig # AoAAoQKAADAZBgkqhkiG9w0BCQMxDAYKKwYBBAGCNwIBBDAcBgorBgEEAYI3AgEL # MQ4wDAYKKwYBBAGCNwIBFTAjBgkqhkiG9w0BCQQxFgQUi5dULQi99KQH6ZGdjcfg # mY88kKowDQYJKoZIhvcNAQEBBQAEggEAJG4wZwaexAVkilvB8OemR6YxJchIb5Da # 2keHJN10ZTUUfBBwn+Edg0uVah2Sc4g40Fi3IajEjjnjhyUCEtpa+nL7HCNC/mSB # k6JSYJ0FrhdoORELEqX1qIruAcPNobK2qjRIwQVGTvdK89a2Shs51abOmK7Hd/pF # CQT9dF2gprblyMhu0Hmb6sBQ6AISSE5bgJ1BgQBYqPp0ocTfpPPAzCDAi0L8JQj9 # jk7BnPskw6AZkt3WDV0jqjvLfcOQgACxFjokarI6xx1lXNws1js2ET5OME8rKhsv # hH6ehfJh/D2H3P5Bbm8FUR2wmRYQgN5aOnnq2iD6eNQpZS13quTUyqGCAgswggIH # BgkqhkiG9w0BCQYxggH4MIIB9AIBATByMF4xCzAJBgNVBAYTAlVTMR0wGwYDVQQK # ExRTeW1hbnRlYyBDb3Jwb3JhdGlvbjEwMC4GA1UEAxMnU3ltYW50ZWMgVGltZSBT # dGFtcGluZyBTZXJ2aWNlcyBDQSAtIEcyAhAOz/Q4yP6/NW4E2GqYGxpQMAkGBSsO # AwIaBQCgXTAYBgkqhkiG9w0BCQMxCwYJKoZIhvcNAQcBMBwGCSqGSIb3DQEJBTEP # Fw0xODEwMjkxNzU2MDFaMCMGCSqGSIb3DQEJBDEWBBTv+45fNOiragjvo7OFtmFp # A5YPFTANBgkqhkiG9w0BAQEFAASCAQBWUdXcjkT8/NAWai1I1MsZhnrKwVxrP/53 # T68VbjIGzOrZQD401hAa6BAObeLtusKwM9vY7kor2wWvKdNKGXIAHxTXnDz9B41p # //7Li1VkUeWEyyPwoS6DQ6XvRX9g7F0ZAgRQg9KJVMMYYmYL4HTXbrxvyP4m97eU # y+P9/ZZO9dUUCAGqqsmg47ebjqEUIvWnUK7Js8AoaUeBk7R1p6DgoOGnVy1x1Bxx # guSWErqIaFjArQVP2O5H+V8JL9mzx39SQWgdq6ms0t96FjwQ0cb4dCQ3SF6imiYp # cBtxlj+GyIcPRAFm0z1U7/8YJAOSERpnYi5wwwx+1f3dLkzgnWra # SIG # End signature block |