Tests/Integration/MSFT_xExchActiveSyncVirtualDirectory.Integration.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
<#
    .SYNOPSIS
        Automated integration test for MSFT_xExchActiveSyncVirtualDirectory DSC Resource.
        This test module requires use of credentials.
        The first run through of the tests will prompt for credentials from the logged on user.
#>


#region HEADER
[System.String]$script:moduleRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot)
[System.String]$script:DSCModuleName = 'xExchange'
[System.String]$script:DSCResourceFriendlyName = 'xExchActiveSyncVirtualDirectory'
[System.String]$script:DSCResourceName = "MSFT_$($script:DSCResourceFriendlyName)"

Import-Module -Name (Join-Path -Path $script:moduleRoot -ChildPath (Join-Path -Path 'Tests' -ChildPath (Join-Path -Path 'TestHelpers' -ChildPath 'xExchangeTestHelper.psm1'))) -Force
Import-Module -Name (Join-Path -Path $script:moduleRoot -ChildPath (Join-Path -Path 'Modules' -ChildPath 'xExchangeHelper.psm1')) -Force
Import-Module -Name (Join-Path -Path $script:moduleRoot -ChildPath (Join-Path -Path 'DSCResources' -ChildPath (Join-Path -Path "$($script:DSCResourceName)" -ChildPath "$($script:DSCResourceName).psm1")))

#Check if Exchange is installed on this machine. If not, we can't run tests
[System.Boolean]$exchangeInstalled = Get-IsSetupComplete

#endregion HEADER

if ($exchangeInstalled)
{
    #Get required credentials to use for the test
    $shellCredentials = Get-TestCredential

    #Get the Server FQDN for using in URL's
    if ($null -eq $serverFqdn)
    {
        $serverFqdn = [System.Net.Dns]::GetHostByName($env:COMPUTERNAME).HostName
    }

    if ($null -eq $webCertAuthInstalled)
    {
        $webCertAuth = Get-WindowsFeature -Name Web-Cert-Auth

        if ($webCertAuth.InstallState -ne 'Installed')
        {
            $webCertAuthInstalled = $false
            Write-Verbose -Message 'Web-Cert-Auth is not installed. Skipping certificate based authentication tests.'
        }
        else
        {
            $webCertAuthInstalled = $true
        }
    }

    if ($webCertAuthInstalled -eq $true)
    {
        #Get the thumbprint to use for ActiveSync Cert Based Auth
        if ($null -eq $cbaCertThumbprint)
        {
            $cbaCertThumbprint = Read-Host -Prompt 'Enter the thumbprint of an Exchange certificate to use when enabling Certificate Based Authentication'
        }
    }

    Describe 'Test Setting Properties with xExchActiveSyncVirtualDirectory' {
        $testParams = @{
            Identity =  "$($env:COMPUTERNAME)\Microsoft-Server-ActiveSync (Default Web Site)"
            Credential = $shellCredentials
            AutoCertBasedAuth = $false
            AutoCertBasedAuthThumbprint = ''
            BadItemReportingEnabled = $false
            BasicAuthEnabled = $true
            ClientCertAuth = 'Ignore'
            CompressionEnabled = $true
            ExtendedProtectionFlags = @('AllowDotlessspn','NoServicenameCheck')
            ExtendedProtectionSPNList = @('http/mail.fabrikam.com','http/mail.fabrikam.local','http/wxweqc')
            ExtendedProtectionTokenChecking = 'Allow'
            ExternalAuthenticationMethods = @('Basic','Kerberos')
            ExternalUrl = "https://$($serverFqdn)/Microsoft-Server-ActiveSync"
            InstallIsapiFilter = $true
            InternalAuthenticationMethods = @('Basic','Kerberos')
            InternalUrl = "https://$($serverFqdn)/Microsoft-Server-ActiveSync"
            MobileClientCertificateAuthorityURL = 'http://whatever.com/CA'
            MobileClientCertificateProvisioningEnabled = $true
            MobileClientCertTemplateName = 'MyTemplateforEAS'
            #Name = "$($Node.NodeName) EAS Site"
            RemoteDocumentsActionForUnknownServers = 'Block'
            RemoteDocumentsAllowedServers = @('AllowedA','AllowedB')
            RemoteDocumentsBlockedServers = @('BlockedA','BlockedB')
            RemoteDocumentsInternalDomainSuffixList = @('InternalA','InternalB')
            SendWatsonReport = $false
            WindowsAuthEnabled = $false
        }

        $expectedGetResults = @{
            Identity =  "$($env:COMPUTERNAME)\Microsoft-Server-ActiveSync (Default Web Site)"
            BadItemReportingEnabled = $false
            BasicAuthEnabled = $true
            ClientCertAuth = 'Ignore'
            CompressionEnabled = $true
            ExtendedProtectionTokenChecking = 'Allow'
            ExternalUrl = "https://$($serverFqdn)/Microsoft-Server-ActiveSync"
            InternalAuthenticationMethods = @('Basic','Kerberos')
            InternalUrl = "https://$($serverFqdn)/Microsoft-Server-ActiveSync"
            MobileClientCertificateAuthorityURL = 'http://whatever.com/CA'
            MobileClientCertificateProvisioningEnabled = $true
            MobileClientCertTemplateName = 'MyTemplateforEAS'
            #Name = "$($Node.NodeName) EAS Site"
            RemoteDocumentsActionForUnknownServers = 'Block'
            SendWatsonReport = $false
            WindowsAuthEnabled = $false
        }

        Test-TargetResourceFunctionality -Params $testParams `
                                         -ContextLabel 'Set standard parameters' `
                                         -ExpectedGetResults $expectedGetResults

        Test-ArrayContentsEqual -TestParams $testParams `
                                -DesiredArrayContents $testParams.ExtendedProtectionFlags `
                                -GetResultParameterName 'ExtendedProtectionFlags' `
                                -ContextLabel 'Verify ExtendedProtectionFlags' `
                                -ItLabel 'ExtendedProtectionSPNList should contain three values'

        Test-ArrayContentsEqual -TestParams $testParams `
                                -DesiredArrayContents $testParams.ExtendedProtectionSPNList `
                                -GetResultParameterName 'ExtendedProtectionSPNList' `
                                -ContextLabel 'Verify ExtendedProtectionSPNList' `
                                -ItLabel 'ExtendedProtectionSPNList should contain three values'

        Test-ArrayContentsEqual -TestParams $testParams `
                                -DesiredArrayContents $testParams.ExternalAuthenticationMethods `
                                -GetResultParameterName 'ExternalAuthenticationMethods' `
                                -ContextLabel 'Verify ExternalAuthenticationMethods' `
                                -ItLabel 'ExternalAuthenticationMethods should contain two values'

        Test-ArrayContentsEqual -TestParams $testParams `
                                -DesiredArrayContents $testParams.InternalAuthenticationMethods `
                                -GetResultParameterName 'InternalAuthenticationMethods' `
                                -ContextLabel 'Verify InternalAuthenticationMethods' `
                                -ItLabel 'InternalAuthenticationMethods should contain two values'

        Test-ArrayContentsEqual -TestParams $testParams `
                                -DesiredArrayContents $testParams.RemoteDocumentsAllowedServers `
                                -GetResultParameterName 'RemoteDocumentsAllowedServers' `
                                -ContextLabel 'Verify RemoteDocumentsAllowedServers' `
                                -ItLabel 'RemoteDocumentsAllowedServers should contain two values'

        Test-ArrayContentsEqual -TestParams $testParams `
                                -DesiredArrayContents $testParams.RemoteDocumentsBlockedServers `
                                -GetResultParameterName 'RemoteDocumentsBlockedServers' `
                                -ContextLabel 'Verify RemoteDocumentsBlockedServers' `
                                -ItLabel 'RemoteDocumentsBlockedServers should contain two values'

        Test-ArrayContentsEqual -TestParams $testParams `
                                -DesiredArrayContents $testParams.RemoteDocumentsInternalDomainSuffixList `
                                -GetResultParameterName 'RemoteDocumentsInternalDomainSuffixList' `
                                -ContextLabel 'Verify RemoteDocumentsInternalDomainSuffixList' `
                                -ItLabel 'RemoteDocumentsInternalDomainSuffixList should contain two values'

        $testParams.ExternalUrl = ''
        $testParams.InternalUrl = ''
        $expectedGetResults.ExternalUrl = ''
        $expectedGetResults.InternalUrl = ''

        Test-TargetResourceFunctionality -Params $testParams `
                                         -ContextLabel 'Try with empty URLs' `
                                         -ExpectedGetResults $expectedGetResults

        if ($webCertAuthInstalled -eq $true)
        {
            $testParams.AutoCertBasedAuth = $true
            $testParams.AutoCertBasedAuthThumbprint = $cbaCertThumbprint
            $testParams.ClientCertAuth = 'Required'
            $expectedGetResults.ClientCertAuth = 'Required'

            Test-TargetResourceFunctionality -Params $testParams `
                                             -ContextLabel 'Try enabling certificate based authentication' `
                                             -ExpectedGetResults $expectedGetResults
        }

        Context 'Test missing ExtendedProtectionFlags for ExtendedProtectionSPNList' {
            $caughtException = $false
            $testParams.ExtendedProtectionFlags = @('NoServicenameCheck')
            try
            {
                Set-TargetResource @testParams | Out-Null
            }
            catch
            {
                $caughtException = $true
            }

            It 'Should hit exception for missing ExtendedProtectionFlags AllowDotlessSPN' {
                $caughtException | Should Be $true
            }

            It 'Test results should be true after adding missing ExtendedProtectionFlags' {
                $testParams.ExtendedProtectionFlags = @('AllowDotlessSPN')
                Set-TargetResource @testParams
                $testResults = Test-TargetResource @testParams
                $testResults | Should Be $true
            }
        }

        Context 'Test invalid combination in ExtendedProtectionFlags' {
            $caughtException = $false
            $testParams.ExtendedProtectionFlags = @('NoServicenameCheck','None')
            try
            {
                Set-TargetResource @testParams | Out-Null
            }
            catch
            {
                $caughtException = $true
            }

            It 'Should hit exception for invalid combination ExtendedProtectionFlags' {
                $caughtException | Should Be $true
            }

            It 'Test results should be true after correction of ExtendedProtectionFlags' {
                $testParams.ExtendedProtectionFlags = @('AllowDotlessSPN')
                Set-TargetResource @testParams
                $testResults = Test-TargetResource @testParams
                $testResults | Should Be $true
            }
        }

        $testParams.ActiveSyncServer = "https://eas.$($env:USERDNSDOMAIN)/Microsoft-Server-ActiveSync"
        $testParams.Remove('ExternalUrl')
        $expectedGetResults.ActiveSyncServer = "https://eas.$($env:USERDNSDOMAIN)/Microsoft-Server-ActiveSync"
        $expectedGetResults.ExternalUrl = "https://eas.$($env:USERDNSDOMAIN)/Microsoft-Server-ActiveSync"

        Test-TargetResourceFunctionality -Params $testParams `
                                         -ContextLabel 'Try by setting External URL via ActiveSyncServer' `
                                         -ExpectedGetResults $expectedGetResults

        #Set values back to default
        $testParams = @{
            Identity =  "$($env:COMPUTERNAME)\Microsoft-Server-ActiveSync (Default Web Site)"
            Credential = $shellCredentials
            BadItemReportingEnabled = $true
            BasicAuthEnabled = $false
            ClientCertAuth = 'Ignore'
            CompressionEnabled = $false
            ExtendedProtectionFlags = 'None'
            ExtendedProtectionSPNList = $null
            ExtendedProtectionTokenChecking = 'None'
            ExternalAuthenticationMethods = $null
            InternalAuthenticationMethods = $null
            MobileClientCertificateAuthorityURL = $null
            MobileClientCertificateProvisioningEnabled = $false
            MobileClientCertTemplateName = $null
            RemoteDocumentsActionForUnknownServers = 'Allow'
            RemoteDocumentsAllowedServers = $null
            RemoteDocumentsBlockedServers = $null
            RemoteDocumentsInternalDomainSuffixList = $null
            SendWatsonReport = $true
            WindowsAuthEnabled = $true
        }

        $expectedGetResults = @{
            Identity =  "$($env:COMPUTERNAME)\Microsoft-Server-ActiveSync (Default Web Site)"
            BadItemReportingEnabled = $true
            BasicAuthEnabled = $false
            ClientCertAuth = 'Ignore'
            CompressionEnabled = $false
            ExtendedProtectionTokenChecking = 'None'
            ExtendedProtectionFlags = [System.String[]]@()
            ExtendedProtectionSPNList = [System.String[]]@()
            ExternalAuthenticationMethods = [System.String[]]@()
            InternalAuthenticationMethods = [System.String[]]@()
            MobileClientCertificateAuthorityURL = ''
            MobileClientCertificateProvisioningEnabled = $false
            MobileClientCertTemplateName = ''
            RemoteDocumentsActionForUnknownServers = 'Allow'
            RemoteDocumentsAllowedServers = $null
            RemoteDocumentsBlockedServers = $null
            RemoteDocumentsInternalDomainSuffixList = $null
            SendWatsonReport = $true
            WindowsAuthEnabled = $true
        }

        Test-TargetResourceFunctionality -Params $testParams `
                                         -ContextLabel 'Reset values to default' `
                                         -ExpectedGetResults $expectedGetResults
    }
}
else
{
    Write-Verbose -Message 'Tests in this file require that Exchange is installed to be run.'
}