modules/deploy/PrivateHelpers/Configuration/New-DeploymentPlan.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 New-DeploymentPlan {
    <#
    .SYNOPSIS
    Creates a deployment plan basing on global variables $Tokens, $ServerRoles and parameters passed to this function.
 
    .DESCRIPTION
    It iterates through resolved ServerRoles (created for given environment with Resolve-ServerRoles) and Steps defined in each ServerRole,
    and creates a deployment plan entry for each of such step.
    If the step is a DSC configuration (as opposed to function), it will be run and MOF files will be created for each node.
    The deployment plan has a form of array of hashtables @( $hashTableForNode1, $hashTableForNode2, ...) where each hashTable has the structure you can
    see in New-DeploymentPlanEntry:
 
    ConnectionParams = <ConnectionParameters object containing connection information for the destination server (where the packages will be deployed)>
    RunOnConnectionParams = <ConnectionParameters object containing connection information for the server where the deployment steps will run>
    IsLocalRun = <$True if destination server is the same as the server where the deployment steps will run>
    Environment = <Environment name>
    ServerRole = <ServerRole name>
    StepName = <Name of DSC configuration or custom function that will be run on the destination server>
    StepType = <'Configuration' for DSC configuration or 'Function' for custom function>
    StepMofDir = <Directory where the generated .mof file resides - only used if StepType = 'Configuration'>
    StepScriptBlockResolved = <resolved ScriptBlock that will be invoked when running the step>
    Tokens = <Hashtable containing resolved tokens - they can be varying between Environment/Nodes combinations>
    TokensOverride = <Hashtable containing tokens overriden by user - passed directly to deploy.ps1>
    PackageDirectory = <Path to the directory where the files required for the deployment will be copied - only used if deployment steps will not run locally>
    RequiredPackages = <List of packages required for the deployment as specified by the user in the configuration files>
    RebootHandlingMode = <Determines how to handle reboot requests - only used if StepType = 'Configuration'>
 
    .PARAMETER AllEnvironments
    Hashtable containing all environment definitions.
 
    .PARAMETER Environment
    Name of the environment where the packages will be deployed.
 
    .PARAMETER ServerRolesFilter
    List of ServerRole names that should be included in the deployment plan.
 
    .PARAMETER StepsFilter
    List of Steps to deploy - can be used if you don't want to deploy all steps defined in the configuration files.
    If not set, steps will be deployed according to the ServerRoles defined in the configuration files.
 
    .PARAMETER NodesFilter
    List of Nodes where steps have to be deployed - can be used if you don't want to deploy to all nodes defined in the configuration files.
    If not set, steps will be deployed to all nodes according to the ServerRoles defined in the configuration files.
 
    .PARAMETER TokensOverride
    A list of tokens to override. Token defined in the configuration files will be overrided with values specified in this array
    (tokens will be matched by name, ignoring categories).
 
    .PARAMETER DeployType
    Deployment type:
    - **All** - deploy everything according to configuration files (= Provision + Deploy)
    - **Provision** - deploy only provisioning steps (-StepsProvision)
    - **Deploy** - deploy only deploy steps (-StepsDeploy / -Steps)
    - **Adhoc** - deploy steps defined in $StepsFilter to server roles defined in $ServerRolesFilter and/or nodes defined in $NodesFilter
                      (note the steps do not need to be defined in server roles)
    .LINK
    Resolve-ServerRoles
 
    .EXAMPLE
    $Global:DeploymentPlan = New-DeploymentPlan -AllEnvironments $AllEnvironments -Environment $Environment -StepsFilter $StepsFilter
 
    #>

    [CmdletBinding()]
    [OutputType([PSCustomObject[]])]
    param(
        [Parameter(Mandatory=$true)]
        [hashtable]
        $AllEnvironments,

        [Parameter(Mandatory=$true)]
        [string[]]
        $Environment,

        [Parameter(Mandatory=$false)]
        [string[]]
        $ServerRolesFilter,

        [Parameter(Mandatory=$false)]
        [string[]]
        $StepsFilter,

        [Parameter(Mandatory=$false)]
        [string[]]
        $NodesFilter,

        [Parameter(Mandatory=$false)]
        [hashtable]
        $TokensOverride,

        [Parameter(Mandatory=$false)]
        [ValidateSet('All', 'Provision', 'Deploy', 'Adhoc')]
        [string]
        $DeployType = 'All'
    )

    $deploymentPlan = New-Object -TypeName System.Collections.ArrayList
    if ($TokensOverride) {
        $log = ($TokensOverride.GetEnumerator() | Foreach-Object { "$($_.Key)=$($_.Value)" }) -join ','
        Write-Log -Info "TokensOverride: $log"
    }

    foreach ($env in $Environment) {
        Write-Log -Info ("Processing environment '{0}', server roles filter '{1}', steps filter '{2}', nodes filter '{3}', deploy type '{4}'" -f `
            $env, ($ServerRolesFilter -join ','), ($StepsFilter -join ','), ($NodesFilter -join ','), $DeployType) -Emphasize

        $resolvedTokens = Resolve-Tokens -AllEnvironments $AllEnvironments -Environment $env -TokensOverride $TokensOverride
        
        $serverRoles = Resolve-ServerRoles `
            -AllEnvironments $AllEnvironments `
            -Environment $env `
            -ResolvedTokens $resolvedTokens `
            -ServerRolesFilter $ServerRolesFilter `
            -NodesFilter $NodesFilter `
            -StepsFilter $StepsFilter `
            -DeployType $deployType

        $entryNo = 1
        foreach ($serverRoleName in $serverRoles.Keys) {
            $serverRole = $serverRoles[$serverRoleName]
            foreach ($serverConnection in $serverRole.ServerConnections) {
                foreach ($node in $serverConnection.Nodes) {

                    $resolvedTokens = Resolve-Tokens -AllEnvironments $AllEnvironments -Environment $env -Node $node -TokensOverride $TokensOverride

                    foreach ($step in $serverRole.Steps) {
    
                        $createDeploymentPlanEntryParams = @{ 
                            EntryNo = $entryNo
                            Environment = $env
                            ServerRole = $serverRole
                            ServerConnection = $serverConnection
                            Node = $node
                            Step = $step
                            ResolvedTokens = $resolvedTokens
                            TokensOverride = $TokensOverride
                        }
                
                        $planEntry = New-DeploymentPlanEntry @createDeploymentPlanEntryParams
                        if ($planEntry) {
                            [void]($deploymentPlan.Add($planEntry))
                            $entryNo++
                        }
                    }
                }
            }
        }
    }
    return ,($deploymentPlan.ToArray())
}