Add more script analyzer tests (#215)

To detect bad config

Excludes extra tests under centos, as I cant get DSC on CentOS to detect pick up the modules.

Author: matt-richardson

OctopusDSC/Examples/cOctopusWorkerPool.ps1

@@ -15,7 +15,7 @@ Configuration SampleConfig
             Url = "https://octopus.example.com"
             Ensure = 'Present'
             WorkerPoolName = 'My Ops Worker Pool'
-            WorkerPoolDescription "A worker pool for operational tasks"
+            WorkerPoolDescription = "A worker pool for operational tasks"
             SpaceID = "spaces-1"
             OctopusCredentials = $creds
         }

Tests/OctopusDSC.Tests.ps1

@@ -4,24 +4,72 @@ Describe "PSScriptAnalyzer" {
         'PSUseShouldProcessForStateChangingFunctions'
     )
 
-    $path = Resolve-Path "$PSCommandPath/../../OctopusDSC/DSCResources"
-    Write-Output "Running PsScriptAnalyzer against $path"
-    $results = @(Invoke-ScriptAnalyzer $path -recurse -exclude $excludedRules)
-    $results | ConvertTo-Json | Out-File PsScriptAnalyzer-DSCResources.log
-
     It "Should have zero PSScriptAnalyzer issues in OctopusDSC/DSCResources" {
+        $path = Resolve-Path "$PSCommandPath/../../OctopusDSC/DSCResources"
+        Write-Output "Running PsScriptAnalyzer against $path"
+        $results = @(Invoke-ScriptAnalyzer $path -recurse -exclude $excludedRules)
+        $results | ConvertTo-Json | Out-File PsScriptAnalyzer-DSCResources.log
+
         $results.length | Should Be 0
     }
 
-    $path = Resolve-Path "$PSCommandPath/../../OctopusDSC/Tests"
-    Write-Output "Running PsScriptAnalyzer against $path"
-    $results = @(Invoke-ScriptAnalyzer $path -recurse -exclude $excludedRules)
-    $results | ConvertTo-Json | Out-File PsScriptAnalyzer-Tests.log
-
-    # it'd be nice to run the PsScriptAnalyzer on `./OctopusDSC/Examples`, but I couldn't get it to detect the DSCModule on mac nor on linux
     It "Should have zero PSScriptAnalyzer issues in OctopusDSC/Tests" {
+        $path = Resolve-Path "$PSCommandPath/../../OctopusDSC/Tests"
+        Write-Output "Running PsScriptAnalyzer against $path"
+        $results = @(Invoke-ScriptAnalyzer $path -recurse -exclude $excludedRules)
+        $results | ConvertTo-Json | Out-File PsScriptAnalyzer-Tests.log
+
         $results.length | Should Be 0
     }
+
+    #unfortunately, cant get the following tests to run on our CentOS buildagent
+    #keep getting:  
+    # "Undefined DSC resource 'cOctopusServer'. Use Import-DSCResource to import the resource."
+    #even though it works fine on ubuntu locally 
+    $isRunningUnderTeamCity = (Test-Path Env:\TEAMCITY_PROJECT_NAME)
+    if (-not $isRunningUnderTeamCity) 
+    {
+        $existingPSModulePath = $env:PSModulePath
+        $path = Resolve-Path "$PSCommandPath/../../"
+        if ($isLinux -or $IsMacOS) {
+            $newPath = "$($env:PSModulePath):$path"
+        } else {
+            $newPath = "$($env:PSModulePath);$path"
+        }
+        Write-Output "Setting `$env:PSModulePath to '$newPath'"
+        $env:PSModulePath = $newPath
+
+        $excludedRules += 'PSAvoidUsingConvertToSecureStringWithPlainText'
+
+        It "Should have zero PSScriptAnalyzer issues in Scenarios" {
+            $path = Resolve-Path "$PSCommandPath/../../Tests/Scenarios"
+            Write-Output "Running PsScriptAnalyzer against $path"
+            $results = @(Invoke-ScriptAnalyzer $path -recurse -exclude $excludedRules)
+            $results | ConvertTo-Json | Out-File PsScriptAnalyzer-Scenarios.log
+            if ($IsLinux -or $IsMacOS) {
+                $results = $results | where-object {
+                    # these DSC resources are available on linux
+                    ($_.Message -ne "Undefined DSC resource 'LocalConfigurationManager'. Use Import-DSCResource to import the resource.") -and
+                    ($_.Message -ne "Undefined DSC resource 'Script'. Use Import-DSCResource to import the resource.") -and
+                    ($_.Message -ne "Undefined DSC resource 'User'. Use Import-DSCResource to import the resource.") -and
+                    ($_.Message -ne "Undefined DSC resource 'Group'. Use Import-DSCResource to import the resource.") -and
+                    # it's getting confused - Group here is actually the DSC resource, not an alias.
+                    ($_.Message -ne "'Group' is an alias of 'Group-Object'. Alias can introduce possible problems and make scripts hard to maintain. Please consider changing alias to its full content.")
+                }
+            }
+            $results.length | Should Be 0
+        }
+
+        It "Should have zero PSScriptAnalyzer issues in Examples" {
+            $path = Resolve-Path "$PSCommandPath/../../OctopusDSC/Examples"
+            Write-Output "Running PsScriptAnalyzer against $path"
+            $results = @(Invoke-ScriptAnalyzer $path -recurse -exclude $excludedRules)
+            $results | ConvertTo-Json | Out-File PsScriptAnalyzer-Examples.log
+
+            $results.length | Should Be 0
+        }
+        $env:PSModulePath = $existingPSModulePath
+    }
 }
 
 Describe "OctopusDSC.psd1" {