Tests/Unit/MSFT_xSQLServerScript.Test.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
<#
    .SYNOPSIS
       Automated unit test for MSFT_xSQLServerScript DSC Resource
#>



$Script:DSCModuleName      = 'MSFT_xSQLServerScript' 
$Script:DSCResourceName    = 'MSFT_xSQLServerScript' 

#region HEADER

# Unit Test Template Version: 1.1.0
[String] $script:moduleRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot)
if ( (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests'))) -or `
     (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
{
    & git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $script:moduleRoot -ChildPath '\DSCResource.Tests\'))
}

Import-Module (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force
$TestEnvironment = Initialize-TestEnvironment `
    -DSCModuleName $script:DSCModuleName `
    -DSCResourceName $script:DSCResourceName `
    -TestType Unit 

#endregion HEADER

Add-Type -ErrorAction SilentlyContinue -TypeDefinition @'
namespace Microsoft.SqlServer.Management.PowerShell
{
    public class SqlPowerShellSqlExecutionException : System.Exception
    {
        public SqlPowerShellSqlExecutionException()
        {
        }
    }
}
'@
 

# Begin Testing
try
{
    #region Pester Test Initialization
        Function script:Invoke-SqlCmd {}
    #endregion Pester Test Initialization

    #region Test Sql script throws an error
    Describe 'Test Sql script throws an error' {
        Mock -CommandName Import-Module -MockWith {}        

        $testParameters = @{
            ServerInstance = $env:COMPUTERNAME 
            SetFilePath = "set.sql" 
            GetFilePath = "get.sql" 
            TestFilePath = "test.sql"
        }

        It 'Get method returns successfully' {         
            Mock -CommandName Invoke-SqlCmd -MockWith { "" }

            $result = Get-TargetResource @testParameters

            $result.ServerInstance | should be $testParameters.ServerInstance
            $result.SetFilePath | should be $testParameters.SetFilePath
            $result.GetFilePath | should be $testParameters.GetFilePath
            $result.TestFilePath | should be $testParameters.TestFilePath
            $result.GetType() | should be "hashtable"
        }

        It 'Test method returns false' {
            Mock -CommandName Invoke-SqlCmd -MockWith { throw New-Object Microsoft.SqlServer.Management.PowerShell.SqlPowerShellSqlExecutionException}

            Test-TargetResource @testParameters | should be $false
        }

        It 'Set method calls Invoke-SqlCmd' {
            Mock -CommandName Invoke-SqlCmd -MockWith { "" } -Verifiable

            $result = Set-TargetResource @testParameters

            Assert-MockCalled -CommandName Invoke-SqlCmd -Times 1
        }
    }
    #endregion Test Sql script throws an error

    #region Test Sql script returns null
    Describe 'Test Sql script returns null' {
        Mock -CommandName Import-Module -MockWith {}        
        Mock -CommandName Invoke-SqlCmd -MockWith { $null }

        $testParameters = @{
            ServerInstance = $env:COMPUTERNAME 
            SetFilePath = "set.sql" 
            GetFilePath = "get.sql" 
            TestFilePath = "test.sql"
        }

        It 'Get method returns successfully' {                     
            $result = Get-TargetResource @testParameters

            $result.ServerInstance | should be $testParameters.ServerInstance
            $result.SetFilePath | should be $testParameters.SetFilePath
            $result.GetFilePath | should be $testParameters.GetFilePath
            $result.TestFilePath | should be $testParameters.TestFilePath
            $result.GetType() | should be "hashtable"
        }

        It 'Test method returns true' {
            Test-TargetResource @testParameters | should be $true
        }
    }
    #endregion Test Sql script returns null

    #region Get SQl script throws and error
    Describe 'Get SQl script throws and error' {
        Mock -CommandName Import-Module -MockWith {}

        $testParameters = @{
            ServerInstance = $env:COMPUTERNAME 
            SetFilePath = "set.sql" 
            GetFilePath = "get.sql" 
            TestFilePath = "test.sql"
        }

        It 'Get throws when get sql script throws' {                     
            $throwMessage = "Failed to run SQL Script"

            Mock -CommandName Invoke-SqlCmd -MockWith { Throw $throwMessage }

            { Get-TargetResource @testParameters } | should throw $throwMessage
        }

        It 'Test method returns true' {
            Mock -CommandName Invoke-SqlCmd -MockWith { $null }

            Test-TargetResource @testParameters | should be $true
        }
    }
    #endregion

    #region Set-TargetResource throws when Set Sql script throws
    Describe 'Set-TargetResource throws when Set Sql script throws' {
        Mock -CommandName Import-Module -MockWith {}       
        Mock -CommandName Invoke-SqlCmd -MockWith { $null }

        $testParameters = @{
            ServerInstance = $env:COMPUTERNAME 
            SetFilePath = "set.sql" 
            GetFilePath = "get.sql" 
            TestFilePath = "test.sql"
        }

        It 'Get method returns successfully' {      
            $result = Get-TargetResource @testParameters

            $result.ServerInstance | should be $testParameters.ServerInstance
            $result.SetFilePath | should be $testParameters.SetFilePath
            $result.GetFilePath | should be $testParameters.GetFilePath
            $result.TestFilePath | should be $testParameters.TestFilePath
            $result.GetType() | should be "hashtable"
        }

        It 'Test method returns true' {
            Test-TargetResource @testParameters | should be $true
        }

        It 'Set method throws' {
            $throwMessage = "Failed to execute set Sql script"

            Mock -CommandName Invoke-SqlCmd -MockWith { throw $throwMessage }

            { Set-TargetResource @testParameters } | should throw $throwMessage
        }
    }
    #endregion

    #region Failed to import SQLPS module
    Describe 'Failed to import SQLPS module' {
        $throwMessage = "Failed to import module SQLPS"

        Mock -CommandName Import-Module -MockWith { throw $throwMessage }        

        $testParameters = @{
            ServerInstance = $env:COMPUTERNAME 
            SetFilePath = "set.sql" 
            GetFilePath = "get.sql" 
            TestFilePath = "test.sql"
        }

        It 'Get method throws' {         
            { $result = Get-TargetResource @testParameters } | should throw $throwMessage
        }

        It 'Test method throws' {
            { Test-TargetResource @testParameters } | should throw $throwMessage
        }

        It 'Set method throws' {
            { Set-TargetResource @testParameters} | should throw $throwMessage
        }
    }
    #endregion

}
finally
{
    #region FOOTER

    Restore-TestEnvironment -TestEnvironment $TestEnvironment

    #endregion
}