-
Notifications
You must be signed in to change notification settings - Fork 60
/
OctopusDSC.Tests.ps1
309 lines (270 loc) · 16 KB
/
OctopusDSC.Tests.ps1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
Describe "OctopusDSC" {
BeforeDiscovery {
. (Join-Path -Path $PSScriptRoot -ChildPath "powershell-helpers.ps1")
}
Describe "PSScriptAnalyzer" {
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 @(
'PSUseShouldProcessForStateChangingFunctions'
'PSReviewUnusedParameter' # too many false positives from https://github.com/PowerShell/PSScriptAnalyzer/issues/1472
))
$results | ConvertTo-Json | Out-File PsScriptAnalyzer-DSCResources.log
$results.length | Should -Be 0
}
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 @('PSUseShouldProcessForStateChangingFunctions'))
$results | ConvertTo-Json | Out-File PsScriptAnalyzer-Tests.log
$results.length | Should -Be 0
}
Context "Scenarios" {
$script:existingPSModulePath = ""
BeforeAll {
$script: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
}
AfterAll {
$env:PSModulePath = $script:existingPSModulePath
}
It "Should have zero PSScriptAnalyzer issues in Scenarios" {
$isRunningUnderTeamCity = (Test-Path Env:\TEAMCITY_PROJECT_NAME)
if ($isRunningUnderTeamCity) {
#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
Set-ItResult -Inconclusive -Because "We couldnt get this test to run on our CentOS buildagent"
} else {
$path = Resolve-Path "$PSCommandPath/../../E2ETests/Scenarios"
Write-Output "Running PsScriptAnalyzer against $path"
$results = @(Invoke-ScriptAnalyzer $path -recurse -exclude @('PSUseShouldProcessForStateChangingFunctions', 'PSAvoidUsingConvertToSecureStringWithPlainText'))
$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" {
$isRunningUnderTeamCity = (Test-Path Env:\TEAMCITY_PROJECT_NAME)
if ($isRunningUnderTeamCity) {
#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
Set-ItResult -Inconclusive -Because "We couldnt get this test to run on our CentOS buildagent"
} else {
$path = Resolve-Path "$PSCommandPath/../../OctopusDSC/Examples"
Write-Output "Running PsScriptAnalyzer against $path"
$results = @(Invoke-ScriptAnalyzer $path -recurse -exclude @('PSUseShouldProcessForStateChangingFunctions', 'PSAvoidUsingConvertToSecureStringWithPlainText'))
$results | ConvertTo-Json | Out-File PsScriptAnalyzer-Examples.log
$results.length | Should -Be 0
}
}
}
}
Describe "OctopusDSC.psd1" {
It "Should be valid" {
$path = Resolve-Path "$PSCommandPath/../../OctopusDSC/DSCResources"
$modules = Get-ChildItem $path -Directory
$path = Resolve-Path "$PSCommandPath/../../OctopusDSC"
Import-LocalizedData -BaseDirectory $path -FileName OctopusDSC.psd1 -BindingVariable Data
$expected = ($Data.DscResourcesToExport | Sort-Object) -join ","
$actual = (($modules.Name | Sort-Object) -join ",")
$actual | Should -Be $expected
}
}
Describe "Modules have no parse errors" {
BeforeDiscovery {
$path = Resolve-Path "$PSCommandPath/../../OctopusDSC/DSCResources"
$schemaMofFiles = Get-ChildItem $path -Recurse -Filter *.mof
}
Describe "<schemaMofFile>" -ForEach $schemaMofFiles {
BeforeAll {
$schemaMofFile = $_
}
It "The module <moduleFileName> should have no parse errors" {
$moduleFile = Get-Item ($schemaMofFile.FullName -replace ".schema.mof", ".psm1")
$tokens = $null
$parseErrors = $null
[System.Management.Automation.Language.Parser]::ParseFile($moduleFile.FullName, [ref] $tokens, [ref] $parseErrors)
$parseErrorTestCases += @{ moduleFileName = $moduleFile.Name; parseErrorCount = $parseErrors.length }
$parseErrorCount = $parseErrors.length
$parseErrorCount | should -be 0
}
}
}
Describe "Mandatory parameters are marked correctly" {
BeforeDiscovery {
$path = Resolve-Path "$PSCommandPath/../../OctopusDSC/DSCResources"
$schemaMofFiles = Get-ChildItem $path -Recurse -Filter *.mof
}
Describe "<schemaMofFile>" -ForEach $schemaMofFiles {
BeforeDiscovery {
$schemaMofFile = $_
$schemaMofFileContent = Get-Content $schemaMofFile.FullName
$moduleFile = Get-Item ($schemaMofFile.FullName -replace ".schema.mof", ".psm1")
$tokens = $null;
$parseErrors = $null;
$ast = [System.Management.Automation.Language.Parser]::ParseFile($moduleFile.FullName, [ref] $tokens, [ref] $parseErrors);
$filter = { $true }
$astMembers = $ast.FindAll($filter, $true);
}
Describe "<line>" -ForEach $schemaMofFileContent {
function Get-TestCase($functionName, $astMembers, $propertyName, $moduleFileName, $propertyType)
{
$param = Get-ParameterFromFunction -functionName $functionName -astMembers $astMembers -propertyName $propertyName
$paramisMandatory = $param -contains "[Parameter(Mandatory)]"
return @{
functionName = $functionName;
propertyName = $propertyName;
moduleFileName = $moduleFile.Name;
propertyType = $propertyType;
paramisMandatory = $paramisMandatory
}
}
BeforeDiscovery {
$line = $_
$mandatoryParamTestCases = @()
if ($line -Match "\s*(\[.*\b(Required|Key)\b.*\])\s*(.*) (.*);") {
$propertyType = $matches[2]
$propertyName = $matches[4].Replace("[]", "");
$mandatoryParamTestCases += Get-TestCase "Get-TargetResource" $astMembers $propertyName $moduleFile.Name $propertyType
$mandatoryParamTestCases += Get-TestCase "Set-TargetResource" $astMembers $propertyName $moduleFile.Name $propertyType
$mandatoryParamTestCases += Get-TestCase "Test-TargetResource" $astMembers $propertyName $moduleFile.Name $propertyType
}
}
It "Parameter '<propertyName>' in function '<functionName>' should Be marked with [Parameter(Mandatory)] in <moduleFileName> as its a <propertyType> property" -ForEach $mandatoryParamTestCases {
param($functionName, $propertyName, $moduleFileName, $propertyType, $paramisMandatory)
$paramisMandatory | Should -Be $true
}
}
}
}
Describe "Non-mandatory parameters are marked correctly" {
BeforeDiscovery {
$path = Resolve-Path "$PSCommandPath/../../OctopusDSC/DSCResources"
$schemaMofFiles = Get-ChildItem $path -Recurse -Filter *.mof
}
Describe "<schemaMofFile>" -ForEach $schemaMofFiles {
BeforeDiscovery {
$schemaMofFile = $_
$schemaMofFileContent = Get-Content $schemaMofFile.FullName
$moduleFile = Get-Item ($schemaMofFile.FullName -replace ".schema.mof", ".psm1")
$tokens = $null;
$parseErrors = $null;
$ast = [System.Management.Automation.Language.Parser]::ParseFile($moduleFile.FullName, [ref] $tokens, [ref] $parseErrors);
$filter = { $true }
$astMembers = $ast.FindAll($filter, $true);
}
Describe "<line>" -ForEach $schemaMofFileContent {
function Get-TestCase($functionName, $astMembers, $propertyName, $moduleFileName, $propertyType)
{
$param = Get-ParameterFromFunction -functionName $functionName -astMembers $astMembers -propertyName $propertyName
$paramisMandatory = $param -contains "[Parameter(Mandatory)]"
return @{
functionName = $functionName;
propertyName = $propertyName;
moduleFileName = $moduleFile.Name;
propertyType = $propertyType;
paramisMandatory = $paramisMandatory
}
}
BeforeDiscovery {
$line = $_
$nonMandatoryParamTestCases = @()
if ($line -NotMatch "\s*(\[.*\b(Required|Key)\b.*\])\s*(.*) (.*);" -And $line -Match "\s*(\[.*\])\s*(.*) (.*);") {
$propertyType = $matches[1]
$propertyName = $matches[3].Replace("[]", "");
$nonMandatoryParamTestCases += Get-TestCase "Get-TargetResource" $astMembers $propertyName $moduleFile.Name $propertyType
$nonMandatoryParamTestCases += Get-TestCase "Set-TargetResource" $astMembers $propertyName $moduleFile.Name $propertyType
$nonMandatoryParamTestCases += Get-TestCase "Test-TargetResource" $astMembers $propertyName $moduleFile.Name $propertyType
}
}
It "Parameter <propertyName> in function <functionName> should not be marked with [Parameter(Mandatory)] in <moduleFileName> as its not mandatory in the mof" -ForEach $nonMandatoryParamTestCases {
param($functionName, $propertyName, $moduleFileName, $propertyType, $paramisMandatory)
$paramisMandatory | Should -Be $false
}
}
}
}
Describe "Test/Get/Set-TargetResource all implement the same properties" {
BeforeDiscovery {
$path = Resolve-Path "$PSCommandPath/../../OctopusDSC/DSCResources"
$schemaMofFiles = Get-ChildItem $path -Recurse -Filter *.mof
}
Describe "<schemaMofFile>" -ForEach $schemaMofFiles {
BeforeDiscovery {
$schemaMofFile = $_
$schemaMofFileContent = Get-Content $schemaMofFile.FullName
$moduleFile = Get-Item ($schemaMofFile.FullName -replace ".schema.mof", ".psm1")
$tokens = $null;
$parseErrors = $null;
$ast = [System.Management.Automation.Language.Parser]::ParseFile($moduleFile.FullName, [ref] $tokens, [ref] $parseErrors);
$filter = { $true }
$astMembers = $ast.FindAll($filter, $true);
}
Describe "<line>" -ForEach $schemaMofFileContent {
function Get-TestCase($functionName, $astMembers, $propertyName, $moduleFileName, $propertyType) {
$param = Get-ParameterFromFunction -functionName $functionName -astMembers $astMembers -propertyName $propertyName
$paramExists = $null -ne $param
return @{
functionName = $functionName;
propertyName = $propertyName;
moduleFileName = $moduleFile.Name;
paramExists = $paramExists
}
}
BeforeDiscovery {
$line = $_
$cases = @()
if ($line -match "\s*(\[.*\])\s*(.*) (.*);") {
$propertyName = $matches[3].Replace("[]", "");
$cases += Get-TestCase "Get-TargetResource" $astMembers $propertyName $moduleFile.Name
$cases += Get-TestCase "Set-TargetResource" $astMembers $propertyName $moduleFile.Name
$cases += Get-TestCase "Test-TargetResource" $astMembers $propertyName $moduleFile.Name
}
}
It "Function <functionName> should have parameter <propertyName> in <moduleFileName> as its a defined in the .schema.mof file" -TestCases $cases {
param($functionName, $propertyName, $moduleFileName, $paramExists)
$paramExists | Should -be $true
}
}
}
}
Describe "Configuration Scenarios" {
BeforeDiscovery {
$path = Resolve-Path "$PSCommandPath/../../E2ETests/Scenarios"
$name = @{label="name";expression={[System.Io.Path]::GetFileNameWithoutExtension($_.Name)}};
$fullName = @{label="fullName";expression={$_.FullName}};
$specPath = @{label="specPath";expression={"$path/../Spec/$([System.Io.Path]::GetFileNameWithoutExtension($_.Name).ToLower() + '.Tests.ps1')"}};
$cases = @(Get-ChildItem $path -Recurse -Filter *.ps1 | Select-Object -Property $name, $fullName, $specPath) | ConvertTo-Hashtable
}
It "Configuration block in scenario <name> should have the same name as the file" -ForEach $cases {
param([string]$name, [string]$fullName)
$fullName | Should -FileContentMatch "Configuration $name"
}
It "Scenario <name> should have a matching spec at <specPath>" -ForEach $cases {
param([string]$name, [string]$fullName, [string]$specPath)
(Resolve-Path $specPath) | Should -Exist
}
}
}