1f252f8bba
# PR Summary Wrap tests in pester blocks to prepare for pesterv5 ## PR Context <!-- Provide a little reasoning as to why this Pull Request helps and why you have opened it. --> ## PR Checklist - [x] [PR has a meaningful title](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - Use the present tense and imperative mood when describing your changes - [x] [Summarized changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [x] [Make sure all `.h`, `.cpp`, `.cs`, `.ps1` and `.psm1` files have the correct copyright header](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [x] This PR is ready to merge and is not [Work in Progress](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---work-in-progress). - If the PR is work in progress, please add the prefix `WIP:` or `[ WIP ]` to the beginning of the title (the `WIP` bot will keep its status check at `Pending` while the prefix is present) and remove the prefix when the PR is ready. - **[Breaking changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#making-breaking-changes)** - [x] None - **OR** - [ ] [Experimental feature(s) needed](https://github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/reference/6/Microsoft.PowerShell.Core/About/about_Experimental_Features.md) - [ ] Experimental feature name(s): <!-- Experimental feature name(s) here --> - **User-facing changes** - [x] Not Applicable - **OR** - [ ] [Documentation needed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [ ] Issue filed: <!-- Number/link of that issue here --> - **Testing - New and feature** - [x] N/A or can only be tested interactively - **OR** - [ ] [Make sure you've added a new test if existing tests do not effectively test the code changed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#before-submitting) - **Tooling** - [x] I have considered the user experience from a tooling perspective and don't believe tooling will be impacted. - **OR** - [ ] I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include: - Impact on [PowerShell Editor Services](https://github.com/PowerShell/PowerShellEditorServices) which is used in the [PowerShell extension](https://github.com/PowerShell/vscode-powershell) for VSCode (which runs in a different PS Host). - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features. - Impact on [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) (which provides linting & formatting in the editor extensions). - Impact on [EditorSyntax](https://github.com/PowerShell/EditorSyntax) (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
97 lines
4.3 KiB
PowerShell
97 lines
4.3 KiB
PowerShell
# Copyright (c) Microsoft Corporation.
|
|
# Licensed under the MIT License.
|
|
#
|
|
# Functional tests to verify basic conditions for IO to the powershell.config.json files
|
|
# The properties files are supported on non-Windows OSes, but the tests are specific to
|
|
# Windows so that file IO can be verified using supported cmdlets.
|
|
#
|
|
|
|
Describe "User-Specific powershell.config.json Modifications" -Tags "CI" {
|
|
|
|
BeforeAll {
|
|
# Skip these tests when run against "InBox" PowerShell
|
|
$IsInbox = $PSHOME.EndsWith('\WindowsPowerShell\v1.0', [System.StringComparison]::OrdinalIgnoreCase)
|
|
$productName = "PowerShell"
|
|
|
|
#skip all tests on non-windows platform
|
|
$originalDefaultParameterValues = $PSDefaultParameterValues.Clone()
|
|
$IsNotSkipped = ($IsWindows -and !$IsInbox) # Only execute for PowerShell on Windows
|
|
$PSDefaultParameterValues["it:skip"] = !$IsNotSkipped
|
|
|
|
if ($IsNotSkipped) {
|
|
# Discover the user-specific powershell.config.json file
|
|
$userSettingsDir = [System.IO.Path]::Combine($env:USERPROFILE, "Documents", $productName)
|
|
$userPropertiesFile = Join-Path $userSettingsDir "powershell.config.json"
|
|
|
|
# Save the file for restoration after the tests are complete
|
|
$backupPropertiesFile = ""
|
|
if (Test-Path $userPropertiesFile) {
|
|
$backupPropertiesFile = Join-Path $userSettingsDir "ORIGINAL_powershell.config.json"
|
|
Copy-Item -Path $userPropertiesFile -Destination $backupPropertiesFile -Force -ErrorAction Continue
|
|
}
|
|
elseif (-not (Test-Path $userSettingsDir)) {
|
|
# create the directory if it does not already exist
|
|
$null = New-Item -Type Directory -Path $userSettingsDir -Force -ErrorAction SilentlyContinue
|
|
}
|
|
|
|
# Save the original Process ExecutionPolicy. The tests assume that it is Undefined
|
|
$processExecutionPolicy = Get-ExecutionPolicy -Scope Process
|
|
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Undefined
|
|
}
|
|
}
|
|
|
|
BeforeEach {
|
|
if ($IsNotSkipped) {
|
|
Set-Content -Path $userPropertiesFile -Value '{"Microsoft.PowerShell:ExecutionPolicy":"RemoteSigned"}'
|
|
}
|
|
}
|
|
|
|
AfterAll {
|
|
if ($IsNotSkipped) {
|
|
if (-not $backupPropertiesFile)
|
|
{
|
|
# Remove powershell.config.json if it did not exist before the tests
|
|
Remove-Item -Path $userPropertiesFile -Force -ErrorAction SilentlyContinue
|
|
}
|
|
else
|
|
{
|
|
# Restore the original powershell.config.json file if it existed before the test pass.
|
|
Move-Item -Path $backupPropertiesFile -Destination $userPropertiesFile -Force -ErrorAction Continue
|
|
}
|
|
|
|
# Restore the original Process ExecutionPolicy
|
|
Set-ExecutionPolicy -Scope Process -ExecutionPolicy $processExecutionPolicy
|
|
}
|
|
|
|
$global:PSDefaultParameterValues = $originalDefaultParameterValues
|
|
}
|
|
|
|
It "Verify Queries to Missing File Return Default Value" {
|
|
Remove-Item $userPropertiesFile -Force
|
|
|
|
Get-ExecutionPolicy -Scope CurrentUser | Should -Be "Undefined"
|
|
|
|
# Verify the file was not created during the test
|
|
{ $propFile = Get-Item $userPropertiesFile -ErrorAction Stop } | Should -Throw -ErrorId "PathNotFound,Microsoft.PowerShell.Commands.GetItemCommand"
|
|
}
|
|
|
|
It "Verify Queries for Non-Existant Properties Return Default Value" {
|
|
# Create a valid file with no values
|
|
Set-Content -Path $userPropertiesFile -Value "{}"
|
|
|
|
Get-ExecutionPolicy -Scope CurrentUser | Should -Be "Undefined"
|
|
}
|
|
|
|
It "Verify Writes Update Properties" {
|
|
Get-Content -Path $userPropertiesFile | Should -Be '{"Microsoft.PowerShell:ExecutionPolicy":"RemoteSigned"}'
|
|
Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Bypass
|
|
Get-Content -Path $userPropertiesFile | Should -Be '{"Microsoft.PowerShell:ExecutionPolicy":"Bypass"}'
|
|
}
|
|
|
|
It "Verify Writes Create the File if Not Present" {
|
|
Remove-Item $userPropertiesFile -Force
|
|
Test-Path $userPropertiesFile | Should -BeFalse
|
|
Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Bypass
|
|
Get-Content -Path $userPropertiesFile | Should -Be '{"Microsoft.PowerShell:ExecutionPolicy":"Bypass"}'
|
|
}
|
|
}
|