modules/deploy/PrivateHelpers/Configuration/Invoke-DeploymentStep.ps1
|
<#
The MIT License (MIT) Copyright (c) 2015 Objectivity Bespoke Software Specialists Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #> function Invoke-DeploymentStep { <# .SYNOPSIS Invokes a DSC configuration or function. .DESCRIPTION It passes the parameters through to the DSC configuration/function if it expects them. Returns path to the generated .MOF file if StepName is a DSC configuration or empty string if it's a function. .PARAMETER StepName Name of the DSC configuration or function to invoke. .PARAMETER StepScriptBlockResolved Resolved step scriptblock (see [[Resolve-StepScriptBlock]]). .PARAMETER Node Name of the node - will be passed as 'NodeName' to the configuration. .PARAMETER Environment Environment name - will be passed as 'Environment' to the configuration. .PARAMETER ServerRole Server role name - will be passed as 'ServerRole' to the configuration. .PARAMETER Tokens Tokens resolved for the node/environment - will be passed as 'Tokens' to the configuration. .PARAMETER ConnectionParams Connection parameters as defined in server roles (object created by [[New-ConnectionParameters]]). .EXAMPLE $mofDir = Invoke-DeploymentStep -StepName $StepName -OutputPath $DscOutputPath -Node $Node -Environment $Environment -ResolvedTokens $resolvedTokens #> [CmdletBinding()] [OutputType([object])] param( [Parameter(Mandatory=$false)] [string] $StepName, [Parameter(Mandatory=$false)] [string] $StepScriptBlockResolved, [Parameter(Mandatory=$true)] [string] $Node, [Parameter(Mandatory=$true)] [string] $Environment, [Parameter(Mandatory=$true)] [string] $ServerRole, [Parameter(Mandatory=$true)] [hashtable] $Tokens, [Parameter(Mandatory=$true)] [object] $ConnectionParams ) <# $automaticParameters = @{ NodeName = '$Node' Environment = '$Environment' ServerRole = '$ServerRole' Tokens = '$Tokens' ConnectionParams = '$ConnectionParams' PackagesPath = '$packagesPath' } #> $packagesPath = (Get-ConfigurationPaths).PackagesPath $scriptBlockToRun = [scriptblock]::Create($StepScriptBlockResolved) Write-Log -Info "Step '$stepName' - running custom command: $StepScriptBlockResolved" & $scriptBlockToRun # ScriptCop suppression [void]$packagesPath } |