Tests/Unit/cNtfsAuditInheritance.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 |
#requires -Version 4.0 -Modules Pester $Global:DSCModuleName = 'cNtfsAccessControl' $Global:DSCResourceName = 'cNtfsAuditInheritance' #region Header $ModuleRoot = Split-Path -Path $Script:MyInvocation.MyCommand.Path -Parent | Split-Path -Parent | Split-Path -Parent if ( (-not (Test-Path -Path (Join-Path -Path $ModuleRoot -ChildPath 'DSCResource.Tests') -PathType Container)) -or (-not (Test-Path -Path (Join-Path -Path $ModuleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -PathType Leaf)) ) { & git @('clone', 'https://github.com/PowerShell/DscResource.Tests.git', (Join-Path -Path $ModuleRoot -ChildPath 'DSCResource.Tests')) } Import-Module -Name (Join-Path -Path $ModuleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force $TestEnvironment = Initialize-TestEnvironment ` -DSCModuleName $Global:DSCModuleName ` -DSCResourceName $Global:DSCResourceName ` -TestType Unit #endregion try { #region Unit Tests InModuleScope $Global:DSCResourceName { #region Helper Functions function Set-NewTempFileAclInheritance { <# .SYNOPSIS Creates temporary files for unit testing of the cNtfsPermissionsInheritance DSC resource. .DESCRIPTION The Set-NewTempFileAclInheritance function creates temporary files and performs the following actions on them: - Grants Full Control permission to the calling user to ensure the file can be removed later. - Optionally disables NTFS permissions inheritance and removes inherited permissions. #> [CmdletBinding()] param ( [Parameter(Mandatory = $false)] [ValidateNotNullOrEmpty()] [String] $Path = (Join-Path -Path ([System.IO.Path]::GetTempPath()) -ChildPath ([System.IO.Path]::GetRandomFileName())), [Parameter(Mandatory = $false)] [Boolean] $Enabled = $true, [Parameter(Mandatory = $false)] [Switch] $PassThru ) try { $File = New-Item -Path $Path -ItemType File -Force -ErrorAction Stop -Verbose:$VerbosePreference $Acl = $File.GetAccessControl() if ($Enabled -eq $true -and $Acl.AreAuditRulesProtected -eq $true) { $Acl.SetAuditRuleProtection($false, $false) } elseif ($Enabled -eq $false -and $Acl.AreAuditRulesProtected -eq $false) { $Acl.SetAuditRuleProtection($true, $false) } $CurrentUser = [System.Security.Principal.WindowsIdentity]::GetCurrent().Name $AuditRule = New-Object -TypeName System.Security.AccessControl.FileSystemAuditRule ` -ArgumentList @( $CurrentUser, 'FullControl', 'None', 'None', 'Failure' ) $Acl.AddAuditRule($AuditRule) [System.IO.File]::SetAccessControl($File.FullName, $Acl) if ($PassThru) { return $File } } catch { throw } } #endregion Describe "$Global:DSCResourceName\Get-TargetResource" { Context 'Inheritance is enabled' { $Path = 'TestDrive:\' + [System.IO.Path]::GetRandomFileName() Set-NewTempFileAclInheritance -Path $Path -Enabled $true It 'Should return Enabled set to True' { $Result = Get-TargetResource -Path $Path $Result.Enabled | Should Be $true } } Context 'Inheritance is disabled' { $Path = 'TestDrive:\' + [System.IO.Path]::GetRandomFileName() Set-NewTempFileAclInheritance -Path $Path -Enabled $false It 'Should return Enabled set to False' { $Result = Get-TargetResource -Path $Path $Result.Enabled | Should Be $false } } } Describe "$Global:DSCResourceName\Test-TargetResource" { Context 'Inheritance is enabled' { $Path = 'TestDrive:\' + [System.IO.Path]::GetRandomFileName() Set-NewTempFileAclInheritance -Path $Path -Enabled $true It 'Should return True if Enabled is True' { Test-TargetResource -Path $Path -Enabled $true | Should Be $true } It 'Should return False if Enabled is False' { Test-TargetResource -Path $Path -Enabled $false | Should Be $false } } Context 'Inheritance is disabled' { $Path = 'TestDrive:\' + [System.IO.Path]::GetRandomFileName() Set-NewTempFileAclInheritance -Path $Path -Enabled $false It 'Should return True if Enabled is False' { Test-TargetResource -Path $Path -Enabled $false | Should Be $true } It 'Should return False if Enabled is True' { Test-TargetResource -Path $Path -Enabled $true | Should Be $false } } } Describe "$Global:DSCResourceName\Set-TargetResource" { Context 'Enabled is True' { $Path = 'TestDrive:\' + [System.IO.Path]::GetRandomFileName() Set-NewTempFileAclInheritance -Path $Path -Enabled $false It 'Should enable inheritance' { Test-TargetResource -Path $Path -Enabled $true | Should Be $false Set-TargetResource -Path $Path -Enabled $true Test-TargetResource -Path $Path -Enabled $true | Should Be $true } } Context 'Enabled is False and PreserveInherited is True' { $Path = 'TestDrive:\' + [System.IO.Path]::GetRandomFileName() $File = Set-NewTempFileAclInheritance -Path $Path -Enabled $true -PassThru It 'Should disable inheritance and convert inherited permissions into explicit permissions' { $DaclBeforeSet = (Get-Acl -Path $File.FullName -Audit).Audit Test-TargetResource -Path $Path -Enabled $false | Should Be $false Set-TargetResource -Path $Path -Enabled $false -PreserveInherited $true Test-TargetResource -Path $Path -Enabled $false | Should Be $true $DaclAfterSet = (Get-Acl -Path $File.FullName -Audit).Audit ($DaclBeforeSet.Count - $DaclAfterSet.Count) -le 1 | Should Be $true } } Context 'Enabled is False and PreserveInherited is False' { $Path = 'TestDrive:\' + [System.IO.Path]::GetRandomFileName() $File = Set-NewTempFileAclInheritance -Path $Path -Enabled $true -PassThru It 'Should disable inheritance and remove inherited permissions' { Test-TargetResource -Path $Path -Enabled $false | Should Be $false Set-TargetResource -Path $Path -Enabled $false -PreserveInherited $false Test-TargetResource -Path $Path -Enabled $false | Should Be $true } } } Describe "$Global:DSCResourceName\Set-FileSystemAccessControl" { $Path = 'TestDrive:\' + [System.IO.Path]::GetRandomFileName() $File = New-Item -Path $Path -ItemType File $Acl = $File.GetAccessControl() $AuditRule = New-Object -TypeName System.Security.AccessControl.FileSystemAuditRule ` -ArgumentList @( 'BUILTIN\Users', 'FullControl', 'None', 'None', 'Failure' ) $Acl.AddAuditRule($AuditRule) It 'Should not throw' { {Set-FileSystemAccessControl -Path $Path -Acl $Acl} | Should Not Throw } It 'Should throw if Path is invalid' { $Path = 'TestDrive:\' + [System.IO.Path]::GetRandomFileName() {Set-FileSystemAccessControl -Path $Path -Acl $Acl} | Should Throw } It 'Should throw if Acl is invalid' { {Set-FileSystemAccessControl -Path $Path -Acl $null} | Should Throw } } } #endregion } finally { #region Footer Restore-TestEnvironment -TestEnvironment $TestEnvironment #endregion } |