public/Log-Rotate.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
$here = Split-Path -Parent $MyInvocation.MyCommand.Path
$sut = (Split-Path -Leaf $MyInvocation.MyCommand.Path) -replace '\.Tests\.', '.'
. "$here\$sut"

Describe "Log-Rotate" -Tag 'Unit' {
    $initScriptblock = {
        $configFile = 'foo'

        Mock Test-Path { $true }
        Mock Test-Path -ParameterFilter { $Path -eq 'foo' -and !$PathType } { $true }
        Mock Get-Item { [pscustomobject]@{ FullName = 'foo' } }
        Mock Test-Path -ParameterFilter { $Path -eq 'foo' -and $PathType } { $false }
        Mock Get-ChildItem {}
        Mock Get-Content {}
        function Compile-Full-Config {}
        Mock Compile-Full-Config {}
        function Validate-Full-Config {}
        Mock Validate-Full-Config {}

        function New-BlockFactory {}
        Mock New-BlockFactory {
            $BlockFactory = [PSCustomObject]@{}
            $BlockFactory | Add-Member -Name 'Create' -MemberType ScriptMethod -Value {}
            $BlockFactory | Add-Member -Name 'GetAll' -MemberType ScriptMethod -Value {
                @{
                    '/path/to/foo/bar/' = @{
                        'LogFiles' = @()
                        'Options' = @()
                    }
                }
            }
            $BlockFactory
        }
        function New-LogFactory {}
        Mock New-LogFactory {
            $LogFactory = [PSCustomObject]@{}
            $LogFactory | Add-Member -Name 'InitStatus' -MemberType ScriptMethod -Value {}
            $LogFactory | Add-Member -Name 'DumpStatus' -MemberType ScriptMethod -Value {}
            $LogFactory
        }
        function New-LogObject {}
        Mock New-LogObject {}
        function Process-Local-Block {}
        Mock Process-Local-Block {}

    }


    Context 'Invalid parameters (Non-Terminating)' {

        $ErrorActionPreference = 'Continue'

        It 'errors when config is null' {
            $invalidConfig = $null

            $err = Log-Rotate -Config $invalidConfig -ErrorVariable err 2>&1
            $err | ? { $_ -is [System.Management.Automation.ErrorRecord] } | % { $_.Exception.Message } | Should -Contain "No config file(s) specified."
        }

        It 'errors when config is an non-existing file' {
            $invalidConfig = 'foo'
            Mock Test-Path { $false }

            $err = Log-Rotate -Config $invalidConfig 2>&1
            $err | ? { $_ -is [System.Management.Automation.ErrorRecord] } | % { $_.Exception.Message } | Should -Contain "Invalid config path specified: $invalidConfig"
        }

        It 'errors when configAsString is null' {
            $invalidConfigAsString = $null

            $err = Log-Rotate -ConfigAsString $invalidConfigAsString 2>&1
            $err | ? { $_ -is [System.Management.Automation.ErrorRecord] } | % { $_.Exception.Message } | Should -Contain "No config file(s) specified."
        }
    }

    Context 'Invalid parameters (Terminating)' {

        $ErrorActionPreference = 'Stop'

        It 'errors when config is null' {
            $invalidConfig = $null

            { Log-Rotate -Config $invalidConfig 2>$null } | Should -Throw "No config file(s) specified."
        }

        It 'errors when config is an non-existing file' {
            $invalidConfig = 'foo'
            Mock Test-Path { $false }
6
            { Log-Rotate -Config $invalidConfig  2>$null } | Should -Throw "Invalid config path specified: $invalidConfig"
        }

        It 'errors when configAsString is null' {
            $invalidConfigAsString = $null

            { Log-Rotate -ConfigAsString $invalidConfigAsString 2>$null } | Should -Throw "No config file(s) specified."
        }
    }

    Context 'Functionality' {

        $ErrorActionPreference = 'Stop'

        It 'shows the help' {
            $help = Log-Rotate -Help

            $help | Should -Not -Be $null
        }

        It 'compiles configuration from one config file' {
            . $initScriptBlock
            Mock Compile-Full-Config {}

            Log-Rotate -config $configFile

            Assert-MockCalled Compile-Full-Config -Times 1
        }

        It 'compiles configuration from multiple config files' {
            . $initScriptBlock
            Mock Test-Path -ParameterFilter { $Path -eq 'foo' -and $PathType } { $false }
            Mock Compile-Full-Config {}

            Log-Rotate -config $configFile

            Assert-MockCalled Compile-Full-Config -Times 1
        }

        It 'validates configuration' {
            . $initScriptBlock
            Mock Validate-Full-Config {}

            Log-Rotate -config $configFile

            Assert-MockCalled Validate-Full-Config -Times 1
        }

        It 'instantiates singleton BlockFactory' {
            . $initScriptBlock
            Mock New-BlockFactory {
                $BlockFactory = [PSCustomObject]@{}
                $BlockFactory | Add-Member -Name 'Create' -MemberType ScriptMethod -Value {}
                $BlockFactory | Add-Member -Name 'GetAll' -MemberType ScriptMethod -Value {
                    @{
                        '/path/to/foo/bar/' = @{
                            'LogFiles' = @()
                            'Options' = @()
                        }
                    }
                }
                $BlockFactory
            }

            Log-Rotate -config $configFile

            Assert-MockCalled New-BlockFactory -Times 1
        }

        It 'instantiates singleton LogFactory' {
            . $initScriptBlock

            Log-Rotate -config $configFile

            Assert-MockCalled New-LogFactory -Times 1
        }

        It 'instantiates singleton LogObject' {
            . $initScriptBlock

            Log-Rotate -config $configFile

            Assert-MockCalled New-LogObject -Times 1
        }

        It 'creates block objects from configuration' {
            . $initScriptBlock
            Mock New-BlockFactory {
                $BlockFactory = [PSCustomObject]@{}
                $BlockFactory | Add-Member -Name 'Create' -MemberType ScriptMethod -Value {
                    'create'
                }
                $BlockFactory | Add-Member -Name 'GetAll' -MemberType ScriptMethod -Value {
                    @{
                        '/path/to/foo/bar/' = @{
                            'LogFiles' = @()
                            'Options' = @()
                        }
                    }
                }
                $BlockFactory
            }

            $result = Log-Rotate -config $configFile

            $result | Should -Be 'create'
        }

        It 'initializes the rotation state file' {
            . $initScriptBlock
            Mock New-LogFactory {
                $LogFactory = [PSCustomObject]@{}
                $LogFactory | Add-Member -Name 'InitStatus' -MemberType ScriptMethod -Value {
                    'initstatus'
                }
                $LogFactory | Add-Member -Name 'DumpStatus' -MemberType ScriptMethod -Value {}
                $LogFactory
            }

            $result = Log-Rotate -config $configFile

            $result | Should -Be 'initstatus'
        }

        It 'processes a block configuration' {
            . $initScriptBlock

            Log-Rotate -config $configFile

            Assert-MockCalled Process-Local-Block -Times 1
        }

        It 'dumps the rotation state file' {
            . $initScriptBlock

            Mock New-LogFactory {
                $LogFactory = [PSCustomObject]@{}
                $LogFactory | Add-Member -Name 'InitStatus' -MemberType ScriptMethod -Value {}
                $LogFactory | Add-Member -Name 'DumpStatus' -MemberType ScriptMethod -Value {
                    'dumpstatus'
                }
                $LogFactory
            }

            $result = Log-Rotate -config $configFile

            $result | Should -Be 'dumpstatus'
        }

        It 'Throws no exception only when specified' {
            . $initScriptBlock
            Mock Process-Local-Block {
                Write-Error 'foo' -ErrorAction Continue
            }

            # Expect no exception
            $err = Log-Rotate -config $configFile -ErrorAction Continue  2>&1
            $err | ? { $_ -is [System.Management.Automation.ErrorRecord] } | % { $_.Exception.Message } | Should -Be 'foo'
        }

        It 'Throws exception only when specified' {
            . $initScriptBlock
            Mock Process-Local-Block {
                Write-Error 'foo' -ErrorAction Stop
            }

            # Expect exception
            { Log-Rotate -config $configFile -ErrorAction Stop } | Should -Throw 'foo'
        }

    }
}