Сценарии Powershell: рекомендуемый способ реализации ShouldProcess, когда вызовы функций вложены?
Тест script:
function outer
{
[cmdletbinding(supportsshouldprocess=$true)]
param($s)
process
{
$pscmdlet.shouldprocess("outer $s", "ShouldProcess") | out-null
"" | out-file "outer $s"
inner ImplicitPassthru
inner VerbosePassthru -Verbose:$Verbose
inner WhatifPassthru -WhatIf:$WhatIf
}
}
function inner
{
[cmdletbinding(supportsshouldprocess=$true)]
param($s)
process
{
$pscmdlet.shouldprocess("inner $s", "ShouldProcess") | out-null
"" | out-file "inner $s"
}
}
"`n** NORMAL **"
outer normal
"`n** VERBOSE **"
outer verbose -Verbose
"`n** WHATIF **"
outer whatif -WhatIf
Вывод:
** NORMAL **
VERBOSE: Performing operation "ShouldProcess" on Target "inner VerbosePassthru".
What if: Performing operation "ShouldProcess" on Target "inner WhatifPassthru".
What if: Performing operation "Output to File" on Target "inner WhatifPassthru".
** VERBOSE **
VERBOSE: Performing operation "ShouldProcess" on Target "outer verbose".
VERBOSE: Performing operation "ShouldProcess" on Target "inner VerbosePassthru".
What if: Performing operation "ShouldProcess" on Target "inner WhatifPassthru".
What if: Performing operation "Output to File" on Target "inner WhatifPassthru".
** WHATIF **
What if: Performing operation "ShouldProcess" on Target "outer whatif".
What if: Performing operation "Output to File" on Target "outer whatif".
What if: Performing operation "ShouldProcess" on Target "inner ImplicitPassthru".
What if: Performing operation "Output to File" on Target "inner ImplicitPassthru".
What if: Performing operation "ShouldProcess" on Target "inner VerbosePassthru".
What if: Performing operation "Output to File" on Target "inner VerbosePassthru".
What if: Performing operation "ShouldProcess" on Target "inner WhatifPassthru".
What if: Performing operation "Output to File" on Target "inner WhatifPassthru".
На мой взгляд, здесь есть несколько странностей:
- Задание -WhatIf: $foo будет всегда включать $WhatIf в вызываемый (и его вызываемые), независимо от того, что такое $foo.
- Когда вы указываете -WhatIf "для реального" (без ограничения его на существующую переменную), он распространяется на неявные вызовы. Нет необходимости в passthru или splatting.
- В отличие от -WhatIf, явный -Verbose не каскадирует, чтобы вызвать неявно.
- Когда вы пытаетесь вручную passthru -Verbose: $foo, вы видите, что поведение похоже на -WhatIf: $foo. Но это влияет только на скрипты, которые вручную проверяют $psCmdlet.ShouldProcess() - встроенные командлеты не затрагиваются.
N.B.: подтверждение ведет себя точно так же, как WhatIf. Я пропустил его для краткости.
Поиск в Интернете и Connect, я почти не вижу подробного обсуждения поведения IfProcess (pro или con), относящегося к расширенным функциям. Ближе всего сообщение от Джеймса О'Нила, в котором рекомендуется передать один экземпляр $psCdlet в стек вызовов. Тем не менее, он делает это, чтобы решить совершенно другую проблему (избегая нескольких запросов -Confirm). Между тем, когда вы придерживаетесь стандартного $psCmdlet, предоставляемого каждой функции, я не вижу документов о том, чего ожидать... гораздо меньше шаблонов проектирования, лучших практик и т.д.
Ответы
Ответ 1
Вы действительно не можете ссылаться на $WhatIf или $Verbose, поскольку они синтезированы для вас, т.е. эти переменные не существуют в вашей функции. Если пользователь указывает их, вы можете получить их через $PSBoundParameters, но если пользователь не указал, то, очевидно, они не будут в этой хеш-таблице.
Когда вы передадите значение коммутатору, PowerShell выполнит типичный процесс принуждения, чтобы попытаться преобразовать указанное значение в bool. Поскольку $whatif не определен, это вычисляется до $null, в результате чего значение switch устанавливается равным $true. Вероятно, это связано с тем, что он явно указывает, что переключатель явно не имеет значения, которое эквивалентно просто заданию -Whatif без значения. Это можно увидеть, когда вы отслеживаете привязку параметров:
function Foo
{
[CmdletBinding(SupportsShouldProcess=1)]
param()
Process
{
$PSBoundParameters
}
}
Trace-Command -name ParameterBinding -expr {Foo -whatif:$xyzzy} -PSHost
DEBUG: BIND NAMED cmd line args [Foo]
DEBUG: BIND arg [] to parameter [WhatIf]
DEBUG: COERCE arg to [System.Management.Automation.SwitchParameter]
DEBUG: Arg is null or not present, type is SWITCHPARAMTER, value is true.
DEBUG: BIND arg [True] to param [WhatIf] SUCCESSFUL
DEBUG: BIND POSITIONAL cmd line args [Foo]
DEBUG: MANDATORY PARAMETER CHECK on cmdlet [Foo]
DEBUG: CALLING BeginProcessing
DEBUG: CALLING EndProcessing
Параметр $WhatIfPreference и $VerbosePreference устанавливается соответствующим образом во внешнем на основе того, был ли внешний вызов вызван с -verbose или -whatif. Я вижу, что эти значения распространяются на внутреннее просто отлично. Казалось бы, есть ошибка PowerShell с $pscmdlet.ShouldProcess. Похоже, что в этом случае не стоит оценивать значение $VerbosePreference. Вы можете попробовать пройти через -Verbose на внутреннюю, так вот:
inner VerbosePassthru -Verbose:($VerbosePreference -eq 'Continue')
Другой вариант - использовать Get-Variable -Scope:
function Outer
{
[CmdletBinding(SupportsShouldProcess=1)]
param()
Process
{
$pscmdlet.ShouldProcess("Outer process", '') > $null
inner
#inner -Verbose:($VerbosePreference -eq 'Continue')
}
}
function Inner
{
[CmdletBinding(SupportsShouldProcess=1)]
param()
Process
{
$pscmdlet = (Get-Variable -Scope 1 -Name PSCmdlet).Value
$pscmdlet.ShouldProcess("Inner process", '') > $null
"Inner $VerbosePreference"
}
}
Outer -Verbose
Я не уверен, что мне это нравится, потому что это означает, что вы знаете, что внешний - это 1 уровень выше внутреннего. Вы можете "ходить" в стеке области поиска, ища следующую переменную PSCmdlet до стека. Это фактически избавляет от необходимости проходить в PSCmdlet (что является грубым), но это все еще взломать. Вы должны рассмотреть вопрос об ошибке в MS Connect.
Ответ 2
Я хотел написать точно такой же вопрос, и я пишу это почти 7 лет спустя. Я удивлен, что команда Microsoft PowerShell еще не исправила это. Я воспроизвел эту проблему с помощью PowerShell версии 6 Preview (последняя версия).
У меня появилось простое обходное решение, то есть внутри функции Inner
мы создаем и запускаем scriptblock
, устанавливая флаг -Verbose
, проверяя $VerbosePreference
, который правильно установлен на Continue
, хотя это не соблюдается ShouldProcess
:
Function Outer {
[CmdletBinding(SupportsShouldProcess=$true, ConfirmImpact="Medium")]
param([string]$Name)
Process {
Write-Host "Outer called";
Inner $Name
}
}
Function Inner {
[CmdletBinding(SupportsShouldProcess=$true, ConfirmImpact="Medium")]
param([string]$Name)
Process {
if (-not ($PSBoundParameters.ContainsKey('Verbose'))) {
$PSBoundParameters.Add('Verbose', [bool]$VerbosePreference -eq 'Continue');
}
& {
[CmdletBinding(SupportsShouldProcess=$true, ConfirmImpact="Medium")]
param([string]$Name)
if ($PSCmdlet.ShouldProcess($Name, "Inner")) {
Write-Host "Inner called";
}
} @PSBoundParameters;
}
}
Export-ModuleMember *