Functions/Import-ExternalModule.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 |
describe "BitTitan.Runbooks.Modules/Import-ExternalModule" -Tag "module", "unit" { # Import the function to test . "$($PSScriptRoot)\Import-ExternalModule.ps1" # Declare external functions and mocks function Get-ChildItem { param ($Path, $ErrorAction) } function Install-Module { param ($Name, $RequiredVersion) } # Declare convenience variables $userModulesPath = "$($env:USERPROFILE)\Documents\WindowsPowerShell\Modules" context "when no version is not currently installed" { # Mock Get-ChildItem mock Get-ChildItem {} # Mock Install-Module mock Install-Module {} # Mock Import-Module mock Import-Module {} it "installs the required version of the module and imports it" { # Call the function Import-ExternalModule MyExternalModule -RequiredVersion 1.2.3.5 -ErrorAction SilentlyContinue -ErrorVariable errorVariable # Verify the mocks Assert-MockCalled Get-ChildItem -Times 1 -Exactly -ParameterFilter { $Path -eq "$($userModulesPath)\MyExternalModule" } Assert-MockCalled Install-Module -Times 1 -Exactly -ParameterFilter { $Name -eq "MyExternalModule" -and $RequiredVersion -eq "1.2.3.5" } Assert-MockCalled Import-Module -Times 1 -Exactly -ParameterFilter { $Name -eq "$($userModulesPath)\MyExternalModule" -and $RequiredVersion -eq "1.2.3.5" } # Verify the output $errorVariable | Should BeNullOrEmpty } # Mock Get-ChildItem mock Get-ChildItem {} it "installs the module and imports it" { # Call the function Import-ExternalModule MyExternalModule -ErrorAction SilentlyContinue -ErrorVariable errorVariable # Verify the mocks Assert-MockCalled Get-ChildItem -Times 1 -Exactly -ParameterFilter { $Path -eq "$($userModulesPath)\MyExternalModule" } -Scope it Assert-MockCalled Install-Module -Times 1 -Exactly -ParameterFilter { $Name -eq "MyExternalModule" -and $RequiredVersion -eq $null } -Scope it Assert-MockCalled Import-Module -Times 1 -Exactly -ParameterFilter { $Name -eq "$($userModulesPath)\MyExternalModule" -and $RequiredVersion -eq $null } -Scope it # Verify the output $errorVariable | Should BeNullOrEmpty } } context "when the required version is not currently installed" { # Mock Get-ChildItem mock Get-ChildItem { return @{ Name = "1.2.3.4" } } # Mock Install-Module mock Install-Module {} # Mock Import-Module mock Import-Module {} it "installs the required version of the module and imports it" { # Call the function Import-ExternalModule MyExternalModule -RequiredVersion 1.2.3.5 -ErrorAction SilentlyContinue -ErrorVariable errorVariable # Verify the mocks Assert-MockCalled Get-ChildItem -Times 1 -Exactly -ParameterFilter { $Path -eq "$($userModulesPath)\MyExternalModule" } Assert-MockCalled Install-Module -Times 1 -Exactly -ParameterFilter { $Name -eq "MyExternalModule" -and $RequiredVersion -eq "1.2.3.5" } Assert-MockCalled Import-Module -Times 1 -Exactly -ParameterFilter { $Name -eq "$($userModulesPath)\MyExternalModule" -and $RequiredVersion -eq "1.2.3.5" } # Verify the output $errorVariable | Should BeNullOrEmpty } # Mock Get-ChildItem mock Get-ChildItem {} it "installs the module and imports it" { # Call the function Import-ExternalModule MyExternalModule -ErrorAction SilentlyContinue -ErrorVariable errorVariable # Verify the mocks Assert-MockCalled Get-ChildItem -Times 1 -Exactly -ParameterFilter { $Path -eq "$($userModulesPath)\MyExternalModule" } -Scope it Assert-MockCalled Install-Module -Times 1 -Exactly -ParameterFilter { $Name -eq "MyExternalModule" -and $RequiredVersion -eq $null } -Scope it Assert-MockCalled Import-Module -Times 1 -Exactly -ParameterFilter { $Name -eq "$($userModulesPath)\MyExternalModule" -and $RequiredVersion -eq $null } -Scope it # Verify the output $errorVariable | Should BeNullOrEmpty } } context "when the required version is currently installed" { # Mock Get-ChildItem mock Get-ChildItem { return @{ Name = "1.2.3.4" } } # Mock Install-Module mock Install-Module {} # Mock Import-Module mock Import-Module {} it "imports the required version of the module" { # Call the function Import-ExternalModule MyExternalModule -RequiredVersion 1.2.3.4 -ErrorAction SilentlyContinue -ErrorVariable errorVariable # Verify the mocks Assert-MockCalled Get-ChildItem -Times 1 -Exactly -ParameterFilter { $Path -eq "$($userModulesPath)\MyExternalModule" } -Scope it Assert-MockCalled Install-Module -Times 0 -Exactly -Scope it Assert-MockCalled Import-Module -Times 1 -Exactly -ParameterFilter { $Name -eq "$($userModulesPath)\MyExternalModule" -and $RequiredVersion -eq "1.2.3.4" } -Scope it # Verify the output $errorVariable | Should BeNullOrEmpty } it "imports the module" { # Call the function Import-ExternalModule MyExternalModule -ErrorAction SilentlyContinue -ErrorVariable errorVariable # Verify the mocks Assert-MockCalled Get-ChildItem -Times 1 -Exactly -ParameterFilter { $Path -eq "$($userModulesPath)\MyExternalModule" } -Scope it Assert-MockCalled Install-Module -Times 0 -Exactly -Scope it Assert-MockCalled Import-Module -Times 1 -Exactly -ParameterFilter { $Name -eq "$($userModulesPath)\MyExternalModule" -and $RequiredVersion -eq $null } -Scope it # Verify the output $errorVariable | Should BeNullOrEmpty } } # Declare the functions to throw an exception $functionsToThrowExceptions = @( "Get-ChildItem", "Install-Module", "Import-Module" ) foreach ($function in $functionsToThrowExceptions) { context "when $($function) throws an exception" { # Mock Get-ChildItem mock Get-ChildItem { return @{ Name = "1.2.3.4" } } # Mock Install-Module mock Install-Module {} # Mock Import-Module mock Import-Module {} # Mock the function to throw an exception mock $function { throw "throws exception" } it "fails to install/import the module and outputs an error" { # Call the function Import-ExternalModule MyExternalModule -RequiredVersion 1.2.3.5 -ErrorAction SilentlyContinue -ErrorVariable errorVariable # Verify the output $errorVariable | Should Not BeNullOrEmpty } } } } |