-
-
Notifications
You must be signed in to change notification settings - Fork 171
/
Show-Karma.Tests.ps1
374 lines (306 loc) · 13.8 KB
/
Show-Karma.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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
#region Header
if (-not (Get-Module PSKoans)) {
$moduleBase = Join-Path -Path $psscriptroot.Substring(0, $psscriptroot.IndexOf('\Tests')) -ChildPath 'PSKoans'
Import-Module $moduleBase -Force
}
#endregion
Describe 'Show-Karma' {
BeforeAll {
$StartingLocation = Get-PSKoanLocation
Set-PSKoanLocation -Path "$TestDrive/Koans"
$EditorSetting = Get-PSKoanSetting -Name Editor
Reset-PSKoan -Confirm:$false
}
AfterAll {
Set-PSKoanLocation -Path $StartingLocation
Set-PSKoanSetting -Name Editor -Value $EditorSetting
}
InModuleScope 'PSKoans' {
Context 'Default Behaviour' {
BeforeAll {
Mock Show-MeditationPrompt -ModuleName 'PSKoans' { }
Mock Get-Karma -ModuleName 'PSKoans' {
[PSCustomObject]@{
PSTypeName = 'PSKoans.Result'
Meditation = 'TestMeditation'
KoansPassed = 0
TotalKoans = 400
Describe = 'TestDescribe'
Expectation = 'ExpectedTest'
It = 'TestIt'
CurrentTopic = [PSCustomObject]@{
Name = 'TestTopic"'
Completed = 0
Total = 4
CurrentLine = 1
}
}
}
}
It 'should not produce output' {
Show-Karma | Should -BeNullOrEmpty
}
It 'should write the meditation prompts' {
Assert-MockCalled Show-MeditationPrompt -Times 2
}
It 'should call Get-Karma to examine the koans' {
Assert-MockCalled Get-Karma
}
}
Context 'With All Koans Completed' {
BeforeAll {
Mock Show-MeditationPrompt -ModuleName 'PSKoans' { $Complete }
Mock Get-Karma -ModuleName 'PSKoans' {
[PSCustomObject]@{
PSTypeName = 'PSKoans.CompleteResult'
KoansPassed = 10
TotalKoans = 10
RequestedTopci = $null
Complete = $true
}
}
}
It 'should not throw errors' {
{ Show-Karma } | Should -Not -Throw
}
}
Context 'With -ClearScreen Switch' {
BeforeAll {
Mock Clear-Host { }
Mock Show-MeditationPrompt -ModuleName 'PSKoans' { }
Mock Get-Karma -ModuleName 'PSKoans' {
[PSCustomObject]@{
PSTypeName = 'PSKoans.Result'
Meditation = 'TestMeditation'
KoansPassed = 0
TotalKoans = 400
Describe = 'TestDescribe'
Expectation = 'ExpectedTest'
It = 'TestIt'
CurrentTopic = [PSCustomObject]@{
Name = 'TestTopic"'
Completed = 0
Total = 4
CurrentLine = 1
}
}
}
}
It 'should not produce output' {
Show-Karma -ClearScreen | Should -Be $null
}
It 'should clear the screen' {
Assert-MockCalled Clear-Host -Times 1
}
It 'should write the meditation prompts' {
Assert-MockCalled Show-MeditationPrompt -Times 2
}
It 'should Invoke-Pester on each of the koans' {
Assert-MockCalled Get-Karma
}
}
Context 'With Nonexistent Koans Folder / No Koans Found' {
BeforeAll {
Mock Show-MeditationPrompt -ModuleName 'PSKoans' { }
Mock Get-PSKoan -ModuleName 'PSKoans' { }
Mock Update-PSKoan -ModuleName 'PSKoans' { throw 'Prevent recursion' }
Mock Write-Warning
Mock Test-Path { $false }
Mock Invoke-Item
Mock New-Item
}
BeforeEach {
$script:CurrentTopic = $null
}
It 'should attempt to populate koans and then recurse to reassess' {
{ Show-Karma } | Should -Throw -ExpectedMessage 'Prevent recursion'
}
It 'should display only the greeting prompt' {
Assert-MockCalled Show-MeditationPrompt -Times 1
}
It 'should display a warning before initiating a reset' {
Assert-MockCalled Write-Warning
}
It 'throws an error if a Topic is specified that matches nothing' {
{ Show-Karma -Topic 'AboutAbsolutelyNothing' } | Should -Throw -ErrorId 'PSKoans.TopicNotFound'
}
It 'should create PSKoans directory with -Library' {
{ Show-Karma -Library } | Should -Throw -ExpectedMessage 'Prevent recursion'
Assert-MockCalled Test-Path -Times 1
Assert-MockCalled Update-PSKoan -Times 1
Assert-MockCalled New-Item -Times 1
}
It 'should create PSKoans directory with -Contemplate' {
{ Show-Karma -Contemplate } | Should -Throw -ExpectedMessage 'Prevent recursion'
Assert-MockCalled Test-Path -Times 1
Assert-MockCalled Update-PSKoan -Times 1
Assert-MockCalled New-Item -Times 1
}
}
Context 'With -ListTopics Parameter' {
BeforeAll {
Mock Get-PSKoan
}
It 'should list all the koan topics' {
Show-Karma -ListTopics
Assert-MockCalled Get-PSKoan
}
}
Context 'With -Topic Parameter' {
BeforeAll {
Mock Show-MeditationPrompt -ModuleName 'PSKoans' { }
Mock Get-Karma -MockWith {
[PSCustomObject]@{
PSTypeName = 'PSKoans.Result'
Meditation = 'TestMeditation'
KoansPassed = 0
TotalKoans = 400
Describe = 'TestDescribe'
Expectation = 'ExpectedTest'
It = 'TestIt'
CurrentTopic = [PSCustomObject]@{
Name = 'TestTopic"'
Completed = 0
Total = 4
CurrentLine = 1
}
RequestedTopic = $Topic
}
} -ParameterFilter { $Topic }
}
It 'should call Get-Karma on the selected topic' {
Show-Karma -Topic TestTopic
Assert-MockCalled Get-Karma -ParameterFilter { $Topic -eq "TestTopic" }
}
}
Context 'With All Koans in a Single Topic Completed' {
BeforeAll {
Mock Show-MeditationPrompt -ModuleName 'PSKoans' { $Complete }
Mock Get-Karma -ModuleName 'PSKoans' {
[PSCustomObject]@{
PSTypeName = 'PSKoans.CompleteResult'
KoansPassed = 10
TotalKoans = 10
RequestedTopic = 'TestTopic'
Complete = $true
}
}
}
It 'should not throw errors' {
{ Show-Karma } | Should -Not -Throw
}
}
Context 'With -Contemplate Switch' {
BeforeAll {
$TestFile = New-TemporaryFile
Mock Invoke-Item { $Path }
Mock Get-Command { $true } -ParameterFilter { $Name -ne "missing_editor" }
Mock Get-Command { $false } -ParameterFilter { $Name -eq "missing_editor" }
Mock Start-Process {
@{ Editor = $FilePath; Arguments = $ArgumentList }
}
Mock Get-Karma -ModuleName 'PSKoans' {
$script:CurrentTopic = @{
Name = 'TestTopic'
Completed = 0
Total = 4
CurrentLine = 1
}
[PSCustomObject]@{
PSTypeName = 'PSKoans.Result'
Meditation = 'TestMeditation'
KoansPassed = 0
TotalKoans = 400
Describe = 'TestDescribe'
Expectation = 'ExpectedTest'
It = 'TestIt'
CurrentTopic = [PSCustomObject]$script:CurrentTopic
}
}
Mock Get-PSKoan {
[PSCustomObject]@{ Path = $TestFile.FullName }
} -ParameterFilter { $Topic -eq 'TestTopic' }
}
AfterAll {
$TestFile | Remove-Item
}
It 'invokes VS Code with "code" set as Editor with proper arguments' {
Set-PSKoanSetting -Name Editor -Value 'code'
$Result = Show-Karma -Contemplate
$Result.Editor | Should -BeExactly 'code'
$Result.Arguments[0] | Should -BeExactly '--goto'
$Result.Arguments[1] | Should -MatchExactly '"[^"]+":\d+'
$Result.Arguments[2] | Should -BeExactly '--reuse-window'
# Resolve-Path doesn't like embedded quotes
$Path = ($Result.Arguments[1] -split '(?<="):')[0] -replace '"'
$Path | Should -BeExactly (Resolve-Path -Path $Path).Path
Assert-MockCalled Get-Command -Times 1
Assert-MockCalled Start-Process -Times 1
$script:CurrentTopic | Should -BeNullOrEmpty
}
It 'opens the specified -Topic in the selected editor' {
Set-PSKoanSetting -Name Editor -Value 'code'
$Result = Show-Karma -Contemplate -Topic TestTopic
$Result.Arguments[1] | Should -MatchExactly ([regex]::Escape($TestFile.FullName))
Assert-MockCalled Get-Command -Times 1
Assert-MockCalled Start-Process -Times 1
$script:CurrentTopic | Should -BeNullOrEmpty
}
It 'invokes the set editor with unknown editor chosen' {
Set-PSKoanSetting -Name Editor -Value 'vim'
$Result = Show-Karma -Contemplate
$Result.Editor | Should -BeExactly 'vim'
$Result.Arguments | Should -MatchExactly '"[^"]+"'
# Resolve-Path doesn't like embedded quotes
$Path = $Result.Arguments -replace '"'
$Path | Should -BeExactly (Resolve-Path -Path $Path).Path
Assert-MockCalled Get-Command -Times 1
Assert-MockCalled Start-Process -Times 1
$script:CurrentTopic | Should -BeNullOrEmpty
}
It 'opens the file directly when selected editor is unavailable' {
Set-PSKoanSetting -Name Editor -Value "missing_editor"
Show-Karma -Contemplate | Should -BeExactly $TestFile.FullName
Assert-MockCalled Get-Command -Times 1 -ParameterFilter { $Name -eq "missing_editor" }
Assert-MockCalled Invoke-Item -Times 1
$script:CurrentTopic | Should -BeNullOrEmpty
}
}
Context 'With -Library Switch' {
BeforeAll {
Mock Get-Command { $true } -ParameterFilter { $Name -ne "missing_editor" }
Mock Get-Command { $false } -ParameterFilter { $Name -eq "missing_editor" }
Mock Start-Process {
@{ Editor = $FilePath; Arguments = $ArgumentList }
}
Mock Invoke-Item { $Path }
}
It 'invokes VS Code with "code" set as Editor with proper arguments' {
Set-PSKoanSetting -Name Editor -Value 'code'
$Result = Show-Karma -Library
$Result.Editor | Should -BeExactly 'code'
# Resolve-Path doesn't like embedded quotes
$Path = $Result.Arguments -replace '"'
$Path | Should -BeExactly (Resolve-Path -Path $Path).Path
Assert-MockCalled Get-Command -Times 1
Assert-MockCalled Start-Process -Times 1
}
It 'invokes the set editor with unknown editor chosen' {
Set-PSKoanSetting -Name Editor -Value 'vim'
$Result = Show-Karma -Library
$Result.Editor | Should -BeExactly 'vim'
# Resolve-Path doesn't like embedded quotes
$Path = $Result.Arguments -replace '"'
$Path | Should -BeExactly (Resolve-Path -Path $Path).Path
Assert-MockCalled Get-Command -Times 1
Assert-MockCalled Start-Process -Times 1
}
It 'opens the file directly when selected editor is unavailable' {
Set-PSKoanSetting -Name Editor -Value "missing_editor"
Show-Karma -Library | Should -BeExactly (Get-PSKoanLocation)
Assert-MockCalled Get-Command -Times 1 -ParameterFilter { $Name -eq "missing_editor" }
Assert-MockCalled Invoke-Item -Times 1
}
}
}
}