PSBoundParameters is empty in v5 at runtime of tests

[simonsabin]

PsBoundParamIssue.ps1.txt

General summary of the issue

PSBoundParameters isn't populated as the scripts are now run in two phases. I believe this is a breaking change in v5.

Rather than checking PSBoundParameters on has to check the variables PSDrive (or other variable checking solution) to check if the variable has been defined, and has a value, i.e. passed in using a PesterContainer

Describe your environment

Pester version : 5.1.1 C:\Users\SimonSabin\OneDrive\Documents2\PowerShell\Modules\Pester\5.1.1\Pester.psm1
PowerShell version : 7.0.1
OS version : Microsoft Windows NT 10.0.19041.0

Steps to reproduce

See Attached file

Expected Behavior

PSBoundParameters is populated with parameters at runtime.

Current Behavior

PSBoundParameters is only available at discovery not at runtime, this is different to the behaviour in v4.

Possible Solution? (optional)

Not sure if a change is required, except to document the change in behaviour.

[nohwnd]

Note to self: The Data should be merged with the splat to allow this in It and BeforeAll etc..

Get-Module Pester  | remove-module;
/p/pester/build.ps1
Import-Module  /p/pester/bin/pester.psd1

$c = [pesterconfiguration]::Default

$c.Run.PassThru = $true
$c.output.Verbosity = "Diagnostic"
$c.Run.Container = new-Pestercontainer -scriptblock {

  param ($a, $b)

  BeforeAll {
    param ($a)

    $g = $a
  }

  Describe 'test' {


    it 'it' {
        param ($a)
        Write-Host -ForegroundColor cyan  $PSBoundParameters
    }
 }
} -Data @{ a = "aaa"; b = "bbb" }

$r = Invoke-Pester -configuration $c

[nohwnd]

This is way more difficult than #1542 and has little benefit at the moment. Moving it out of the milestone.

To make this work consistently we would have to merge all parent data with the internal scriptBlock contexts (like $Pester object) when invoking every block. Which seems costly for almost no benefit because the variables nicely flow down using variable inheritance.

[simonsabin]

I’ll look to put it in the docs somewhere that one shouldn’t use it

[fflaten]

Was about to add it to breaking changes from v4 to v5, but I can't really reproduce it in Pester 4.10.1.
PSBoundParameters isn't listed inside It.. Am I doing something wrong?

Pester v4.10.1
Executing all tests in '.\git\pester\samples\demoIssue1828v4.tests.ps1'

Executing script .\git\pester\samples\demoIssue1828v4.tests.ps1
VERBOSE: Pester version 4.10.1
VERBOSE: Before Test

Key Value
--- -----
foo A new value for foo


Foo=A new value for foo

  Describing Test
VERBOSE: During  Test

Foo=A new value for foo
    [+] Test psboundparameters 0ms
Tests completed in 36ms
Tests Passed: 1, Failed: 0, Skipped: 0, Pending: 0, Inconclusive: 0

[nohwnd]

@simonsabin friendly ping on this :)

[simonsabin]

The repro is a little confusing. It shows that whilst PSBoundParameters is not set, the variable $foo has been set.
This means you can't use PSBoundParamaters in BeforeAll in v5.0

[fflaten]

The repro is a little confusing. It shows that whilst PSBoundParameters is not set, the variable $foo has been set.

This means you can't use PSBoundParamaters in BeforeAll in v5.0

The issue mentions this behavior as a v5-regression, but I can't even get it to work in v4. Can you?

This affects whether it should be documented in breaking changes or just some general doc.

[simonsabin]

When you run this code, for the v 4.10.1 The output from the script block outside of the describe runs and has PSBoundparameters assigned see my results below.

get-module pester | remove-module 
import-module pester -MaximumVersion 4.10.1

{
param($foo)  

write-verbose "Pester version $((get-module pester).Version)" -verbose
Write-verbose "Before Test Not in any code block"  -Verbose
Write-verbose "Bound Parameters is "  -Verbose
Write-verbose ($PSBoundParameters| Convertto-json |out-string)  -Verbose
Write-verbose "The Variable is Foo is set to =($foo)" -Verbose

Describe "Test"{
    It "Test psboundparameters"{
        Write-verbose "During  Test" -Verbose
        Write-verbose "Bound Parameters is "  -Verbose
        Write-verbose ($PSBoundParameters| Convertto-json |out-string)  -Verbose
        Write-verbose "The Variable is Foo is set to =($foo)" -Verbose
        }
    }
} |out-file ".\my.tests.ps1";

invoke-pester -Script @{Path=".\my.tests.ps1";Parameters=@{foo="A new value for foo"}}

remove-module Pester
import-module pester -MinimumVersion 5.0.0

{
param($foo)  
BeforeDiscovery{
    write-verbose "Pester version $((get-module pester).Version)" -verbose
    Write-verbose "Before Test in BeforeDiscovery" -Verbose
    Write-verbose ($PSBoundParameters| convertto-json|out-string) -Verbose
    Write-verbose "The Variable is Foo is set to =($foo)" -Verbose
}
BeforeAll{
    write-verbose "Pester version $((get-module pester).Version)" -verbose
    Write-verbose "Before Test in BeforeAll" -Verbose
    Write-verbose ($PSBoundParameters| convertto-json|out-string) -Verbose
    Write-verbose "The Variable is Foo is set to =($foo)" -Verbose
}
Describe "Test"{
    It "Test psboundparameters"{
        Write-verbose "During  Test" -Verbose
        Write-verbose "Bound Parameters is "  -Verbose
        Write-verbose ($PSBoundParameters| Convertto-json |out-string)  -Verbose
        Write-verbose "The Variable is Foo is set to =($foo)" -Verbose
        }
}
}|out-file ".\my.tests2.ps1";
invoke-pester -Container (New-PesterContainer -Path ".\my.tests2.ps1" -Data @{foo="A new value for foo"})

My results are as below

Pester v4.10.1
Executing all tests in '.\my.tests.ps1'

Executing script .\my.tests.ps1
VERBOSE: Pester version 4.10.1
VERBOSE: Before Test Not in any code block
VERBOSE: Bound Parameters is
VERBOSE: {
"foo": "A new value for foo"
}

VERBOSE: The Variable is Foo is set to =(A new value for foo)

Describing Test
VERBOSE: During Test
VERBOSE: Bound Parameters is
VERBOSE: {}

VERBOSE: The Variable is Foo is set to =(A new value for foo)
[+] Test psboundparameters 6ms
Tests completed in 130ms
Tests Passed: 1, Failed: 0, Skipped: 0, Pending: 0, Inconclusive: 0

Starting discovery in 1 files.
VERBOSE: Pester version 5.2.2
VERBOSE: Before Test in BeforeDiscovery
VERBOSE: {}

VERBOSE: The Variable is Foo is set to =(A new value for foo)
Discovery finished in 49ms.
Running tests.
VERBOSE: Pester version 5.2.2
VERBOSE: Before Test in BeforeAll
VERBOSE: {}

VERBOSE: The Variable is Foo is set to =(A new value for foo)
VERBOSE: During Test
VERBOSE: Bound Parameters is
VERBOSE: {}

VERBOSE: The Variable is Foo is set to =(A new value for foo)
[+] C:\Users\SimonSabin\source\repos\template.sql\src\TemplateProject.tests\my.tests2.ps1 249ms (20ms|185ms)
Tests completed in 253ms
Tests Passed: 1, Failed: 0, Skipped: 0 NotRun: 0

[simonsabin]

I should add this is in relation to PSBound paramaters in an undefined block outside of describe in V4 compared to a BeforeAll or BeforeDiscovery in V5.

Its not in relation to use within an It block

[fflaten]

Aha, thanks! So it's only missing in the discovery phase in v5, It's never been available during test execution (It-blocks in v4, Run-phase in general in v5).

Thoughts on where this should be documented on https://pester.dev? A note-block at the end of https://pester.dev/docs/usage/data-driven-tests#providing-external-data-to-tests maybe saying that $PSBoundParameters are unavailable in general? Thinking it might be mostly relevant for parameterized scripts.

[simonsabin]

Sounds sensible Simon Sabin

…

________________________________ From: Frode Flaten ***@***.***> Sent: Saturday, June 26, 2021 2:27:26 PM To: pester/Pester ***@***.***> Cc: Simon Sabin ***@***.***>; Mention ***@***.***> Subject: Re: [pester/Pester] PSBoundParameters is empty in v5 at runtime of tests (#1828) Aha, thanks! So it's only missing in the discovery phase in v5, It's never been available during test execution (It-blocks in v4, Run-phase in general in v5). Thoughts on where this should be documented on https://pester.dev<https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fpester.dev%2F&data=04%7C01%7CSimon%40sabin.io%7C05922363c87e484b5f3a08d938a624b3%7C6be9de4c2c6c473fbf0fe892cb984687%7C0%7C0%7C637603108495762420%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=uSu4tgxT61yCN%2FHN%2BiT6Ik71kNUH%2BRb6ah%2FAkITiLzg%3D&reserved=0>? A note-block at the end of https://pester.dev/docs/usage/data-driven-tests#providing-external-data-to-tests<https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fpester.dev%2Fdocs%2Fusage%2Fdata-driven-tests%23providing-external-data-to-tests&data=04%7C01%7CSimon%40sabin.io%7C05922363c87e484b5f3a08d938a624b3%7C6be9de4c2c6c473fbf0fe892cb984687%7C0%7C0%7C637603108495772378%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=D6DW7qmws4rQgqksS3Q705xQdkuhFPieRnumn0l8o%2FI%3D&reserved=0> maybe saying that $PSBoundParameters are unavailable in general? Thinking it might be mostly relevant for parameterized scripts. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fpester%2FPester%2Fissues%2F1828%23issuecomment-869001654&data=04%7C01%7CSimon%40sabin.io%7C05922363c87e484b5f3a08d938a624b3%7C6be9de4c2c6c473fbf0fe892cb984687%7C0%7C0%7C637603108495772378%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=rULJ5VAy3KFPdyVBV%2BIVp%2BlFa24RkDAjMdpNwz4mOFE%3D&reserved=0>, or unsubscribe<https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAAJHM27P3FDAG7O4BJPJLNDTUXIT5ANCNFSM4WHZZC6Q&data=04%7C01%7CSimon%40sabin.io%7C05922363c87e484b5f3a08d938a624b3%7C6be9de4c2c6c473fbf0fe892cb984687%7C0%7C0%7C637603108495782340%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=fzN6su%2FxQq3vcbB97jUd9JASm5wAXNn8YT7SZ0VlNLE%3D&reserved=0>.