Functions/TestDrive.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
#
function New-TestDrive ([Switch]$PassThru) {
    $Path = New-RandomTempDirectory
    $DriveName = "TestDrive"

    if (-not (Microsoft.PowerShell.Management\Test-Path -Path $Path))
    {
        New-Item -ItemType Container -Path $Path | Out-Null
    }

    #setup the test drive
    if ( -not (Test-Path "${DriveName}:\") )
    {
        New-PSDrive -Name $DriveName -PSProvider FileSystem -Root $Path -Scope Global -Description "Pester test drive" | Out-Null
    }

    #publish the global TestDrive variable used in few places within the module
    if (-not (Test-Path "Variable:Global:DriveName"))
    {
        New-Variable -Name $DriveName -Scope Global -Value $Path
    }

    if ( $PassThru ) { Get-PSDrive -Name $DriveName }
}


function Clear-TestDrive ([String[]]$Exclude) {
    $Path = (Microsoft.PowerShell.Management\Get-PSDrive -Name TestDrive).Root
    if (Microsoft.PowerShell.Management\Test-Path -Path $Path )
    {
        #Get-ChildItem -Exclude did not seem to work with full paths
        Microsoft.PowerShell.Management\Get-ChildItem -Recurse -Path $Path |
        Microsoft.PowerShell.Utility\Sort-Object -Descending  -Property "FullName" |
        Microsoft.PowerShell.Core\Where-Object { $Exclude -NotContains $_.FullName } |
        Microsoft.PowerShell.Management\Remove-Item -Force -Recurse
    }
}

function New-RandomTempDirectory {
    do
    {
        $Path = Join-Path -Path $env:TEMP -ChildPath ([Guid]::NewGuid())
    } until (-not (  Microsoft.PowerShell.Management\Test-Path -Path $Path ))

    New-Item -ItemType Container -Path $Path
}

function Get-TestDriveItem {
    #moved here from Pester.psm1
    param( [string]$Path )

    Assert-DescribeInProgress -CommandName Get-TestDriveItem
    Get-Item $(Join-Path $TestDrive $Path )
}

function Get-TestDriveChildItem {
    $Path = (Microsoft.PowerShell.Management\Get-PSDrive -Name TestDrive).Root
    if (Microsoft.PowerShell.Management\Test-Path -Path $Path )
    {
        Microsoft.PowerShell.Management\Get-ChildItem -Recurse -Path $Path
    }
}

function Remove-TestDrive {

    $DriveName = "TestDrive"
    $Drive = Get-PSDrive -Name $DriveName -ErrorAction $script:IgnoreErrorPreference
    $Path = ($Drive).Root


    if ($pwd -like "$DriveName*" ) {
        #will staying in the test drive cause issues?
        #TODO review this
        Write-Warning -Message "Your current path is set to ${pwd}:. You should leave ${DriveName}:\ before leaving Describe."
    }

    if ( $Drive )
    {
        $Drive | Remove-PSDrive -Force -ErrorAction $script:IgnoreErrorPreference
    }

    if (Microsoft.PowerShell.Management\Test-Path -Path $Path)
    {
        Microsoft.PowerShell.Management\Remove-Item -Path $Path -Force -Recurse
    }

    if (Get-Variable -Name $DriveName -Scope Global -ErrorAction $script:IgnoreErrorPreference) {
        Remove-Variable -Scope Global -Name $DriveName -Force
    }
}

function Setup {
    #included for backwards compatibility
    param(
    [switch]$Dir,
    [switch]$File,
    $Path,
    $Content = "",
    [switch]$PassThru
    )

    Assert-DescribeInProgress -CommandName Setup

    $TestDriveName = Get-PSDrive TestDrive | Select -ExpandProperty Root

    if ($Dir) {
        $item = New-Item -Name $Path -Path "${TestDriveName}\" -Type Container -Force
    }
    if ($File) {
        $item = $Content | New-Item -Name $Path -Path "${TestDriveName}\" -Type File -Force
    }

    if($PassThru) {
        return $item
    }
}