Tasks/Tasks.Bts.ps1

#region Copyright & License

# Copyright © 2012 - 2020 François Chabot
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

#endregion

Set-StrictMode -Version Latest

# Synopsis: Deploy a Microsoft BizTalk Server Application
task Deploy-BizTalkApplication Add-BizTalkApplication, Deploy-BizTalkArtifacts

# Synopsis: Patch a Microsoft BizTalk Server Application's Binaries
task Patch-BizTalkApplication Deploy-BizTalkArtifacts

# Synopsis: Undeploy a Microsoft BizTalk Server Application
task Undeploy-BizTalkApplication -If { -not $SkipUndeploy } Undeploy-BizTalkArtifacts, Remove-BizTalkApplication

# Synopsis: Deploy all Microsoft BizTalk Server Artifacts
task Deploy-BizTalkArtifacts `
    Deploy-Schemas, `
    Deploy-Transforms, `
    Deploy-Assemblies, `
    Deploy-Components, `
    Deploy-PipelineComponents, `
    Deploy-Pipelines, `
    Deploy-Orchestrations, `
    Deploy-Bindings

# Synopsis: Undeploy all Microsoft BizTalk Server Artifacts
task Undeploy-BizTalkArtifacts `
    Undeploy-Orchestrations, `
    Undeploy-Pipelines, `
    Undeploy-PipelineComponents, `
    Undeploy-Components, `
    Undeploy-Assemblies, `
    Undeploy-Transforms, `
    Undeploy-Schemas

# Synopsis: Create a Microsoft BizTalk Server Application with References to Its Dependant Microsoft BizTalk Server Applications
task Add-BizTalkApplication -If { ($Manifest.Properties.Type -eq 'Application') -and -not (Test-BizTalkApplication $ApplicationName) } {
    $arguments = @{ Name = $ApplicationName }
    if (![string]::IsNullOrWhiteSpace($Manifest.Properties.Description)) {
        $arguments.Description = $Manifest.Properties.Description
    }
    if ($Manifest.Properties.References | Test-Any) {
        Write-Build DarkGreen "Adding Microsoft BizTalk Server Application '$ApplicationName' with References to Microsoft BizTalk Server Applications '$($Manifest.Properties.References -join ''', ''')'"
        $arguments.References = $Manifest.Properties.References
    } else {
        Write-Build DarkGreen "Adding Microsoft BizTalk Server Application '$ApplicationName'"
    }
    New-BizTalkApplication @arguments
}
# Synopsis: Delete a Microsoft BizTalk Server Application
task Remove-BizTalkApplication -If { ($Manifest.Properties.Type -eq 'Application') -and (Test-BizTalkApplication -Name $ApplicationName) } Stop-Application, {
    Write-Build DarkGreen "Removing Microsoft BizTalk Server Application '$ApplicationName'"
    Remove-BizTalkApplication -Name $ApplicationName
}
# Synopsis: Stop a Microsoft BizTalk Server Application
task Stop-Application {
    Write-Build DarkGreen "Stopping Microsoft BizTalk Server Application '$ApplicationName'"
    Stop-BizTalkApplication -Name $ApplicationName -TerminateServiceInstances:$TerminateServiceInstances
}

# Synopsis: Add Assemblies to the GAC
task Deploy-Assemblies {
    $Resources | ForEach-Object -Process {
        Install-GacAssembly -Path $_.Path
    }
}
# Synopsis: Remove Assemblies from the GAC
task Undeploy-Assemblies {
    $Resources | ForEach-Object -Process {
        Uninstall-GacAssembly -Path $_.Path
    }
}

# Synopsis: Deploy Microsoft BizTalk Server Application Bindings and Enforce Artifacts' Expected States
task Deploy-Bindings Import-Bindings, Install-FileAdapterPaths, Initialize-BizTalkServices

# Synopsis: Import Microsoft BizTalk Server Application Bindings
task Import-Bindings Expand-Bindings, {
    $Resources | ForEach-Object -Process {
        Import-Bindings -Path "$($_.Path).xml" -ApplicationName $ApplicationName
    }
}
# Synopsis: Generate Microsoft BizTalk Server Application Bindings
task Expand-Bindings {
    $Resources | ForEach-Object -Process {
        $arguments = @{
            Path              = $_.Path
            TargetEnvironment = $TargetEnvironment
            BindingFilePath   = "$($_.Path).xml"
        }
        if (![string]::IsNullOrEmpty($_.EnvironmentSettingOverridesRootPath)) {
            $arguments.EnvironmentSettingOverridesRootPath = $_.EnvironmentSettingOverridesRootPath
        }
        if ($_.AssemblyProbingPaths | Test-Any) {
            $arguments.AssemblyProbingPaths = $_.AssemblyProbingPaths
        }
        Expand-Bindings @arguments
    }
}
# Synopsis: Create FILE Adapter-based Receive Locations' and Send Ports' Folders
task Install-FileAdapterPaths -If { $Manifest.Properties.Type -eq 'Application' } {
    Write-Build DarkGreen "Creating '$ApplicationName' file-based receive locations and send ports' folders"
    Get-TaskResourceGroup -Name Bindings | ForEach-Object -Process {
        #TODO support another user account than BUILTIN\Users, see BTDF
        Invoke-Tool -Command { InstallUtil /ShowCallStack /TargetEnvironment=$TargetEnvironment /SetupFileAdapterPaths /Users='BUILTIN\Users' /EnvironmentSettingOverridesRootPath="$($_.EnvironmentSettingOverridesRootPath)" /AssemblyProbingPaths="$($_.AssemblyProbingPaths -join ';')" "$($_.Path)" }
    }
    # TODO corresponding undeploy task
}
# Synopsis: Start Microsoft BizTalk Server Application Services
task Initialize-BizTalkServices -If { $Manifest.Properties.Type -eq 'Application' } {
    Write-Build DarkGreen "Initializing '$ApplicationName' services"
    Get-TaskResourceGroup -Name Bindings | ForEach-Object -Process {
        Invoke-Tool -Command { InstallUtil /ShowCallStack /TargetEnvironment=$TargetEnvironment /InitializeServices /EnvironmentSettingOverridesRootPath="$($_.EnvironmentSettingOverridesRootPath)" /AssemblyProbingPaths="$($_.AssemblyProbingPaths -join ';')" "$($_.Path)" }
    }
}

# Synopsis: Add Components to the GAC and Run Their Installer
task Deploy-Components Undeploy-Components, {
    $Resources | ForEach-Object -Process {
        Install-Component -Path $_.Path -SkipInstallUtil:$SkipInstallUtil
    }
}
# Synopsis: Run Components Uninstaller and Remove Them from the GAC
task Undeploy-Components {
    $Resources | ForEach-Object -Process {
        Uninstall-Component -Path $_.Path -SkipInstallUtil:$SkipInstallUtil
    }
}

# Synopsis: Install Microsoft BizTalk Server Pipelines and Add Their Containing Assemblies to the GAC
task Deploy-Pipelines -If { $Manifest.Properties.Type -eq 'Application' } {
    $Resources | ForEach-Object -Process {
        if ($SkipMgmtDbDeployment) {
            Install-GacAssembly -Path $_.Path
        } else {
            Add-BizTalkResource -Path $_.Path -ApplicationName $ApplicationName
        }
    }
}
# Synopsis: Remove Microsoft BizTalk Server Pipelines' Containing Assemblies from the GAC
task Undeploy-Pipelines -If { $Manifest.Properties.Type -eq 'Application' } {
    $Resources | ForEach-Object -Process {
        Uninstall-GacAssembly -Path $_.Path
    }
}

# Synopsis: Deploy Microsoft BizTalk Server Pipeline Components and Add Them to the GAC
task Deploy-PipelineComponents {
    $Resources | ForEach-Object -Process {
        Copy-Item -Path $_.Path -Destination "$(Join-Path -Path $env:BTSINSTALLPATH -ChildPath 'Pipeline Components')" -Force
        Install-GacAssembly -Path $_.Path
    }
}
# Synopsis: Undeploy Microsoft BizTalk Server Pipeline Components and Remove Them from the GAC
task Undeploy-PipelineComponents Recycle-AppPool, {
    $Resources | ForEach-Object -Process {
        $pc = [System.IO.Path]::Combine($env:BTSINSTALLPATH, 'Pipeline Components', [System.IO.Path]::GetFileName($_.Path))
        if (Test-Path -Path $pc) {
            Remove-Item -Path $pc -Force
        }
        Uninstall-GacAssembly -Path $_.Path
    }
}

# Synopsis: Install Microsoft BizTalk Server Orchestrations and Add Their Containing Assemblies to the GAC
task Deploy-Orchestrations -If { $Manifest.Properties.Type -eq 'Application' } {
    $Resources | ForEach-Object -Process {
        if ($SkipMgmtDbDeployment) {
            Install-GacAssembly -Path $_.Path
        } else {
            Add-BizTalkResource -Path $_.Path -ApplicationName $ApplicationName
        }
    }
}
# Synopsis: Remove Microsoft BizTalk Server Orchestrations' Containing Assemblies from the GAC
task Undeploy-Orchestrations -If { $Manifest.Properties.Type -eq 'Application' } {
    $Resources | ForEach-Object -Process {
        Uninstall-GacAssembly -Path $_.Path
    }
}

# Synopsis: Install Microsoft BizTalk Server Schemas and Add Their Containing Assemblies to the GAC
task Deploy-Schemas -If { $Manifest.Properties.Type -eq 'Application' } {
    $Resources | ForEach-Object -Process {
        if ($SkipMgmtDbDeployment) {
            Install-GacAssembly -Path $_.Path
        } else {
            Add-BizTalkResource -Path $_.Path -ApplicationName $ApplicationName
        }
    }
}
# Synopsis: Remove Microsoft BizTalk Server Schemas' Containing Assemblies from the GAC
task Undeploy-Schemas -If { $Manifest.Properties.Type -eq 'Application' } {
    $Resources | ForEach-Object -Process {
        Uninstall-GacAssembly -Path $_.Path
    }
}

# Synopsis: Install Microsoft BizTalk Server Transforms and Add Their Containing Assemblies to the GAC
task Deploy-Transforms -If { $Manifest.Properties.Type -eq 'Application' } {
    $Resources | ForEach-Object -Process {
        if ($SkipMgmtDbDeployment) {
            Install-GacAssembly -Path $_.Path
        } else {
            Add-BizTalkResource -Path $_.Path -ApplicationName $ApplicationName
        }
    }
}
# Synopsis: Remove Microsoft BizTalk Server Transforms' Containing Assemblies from the GAC
task Undeploy-Transforms -If { $Manifest.Properties.Type -eq 'Application' } {
    $Resources | ForEach-Object -Process {
        Uninstall-GacAssembly -Path $_.Path
    }
}

# SIG # Begin signature block
# MIIJEgYJKoZIhvcNAQcCoIIJAzCCCP8CAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUMyjdf6kqrq96DBrqqhQbILSt
# jAigggWhMIIFnTCCA1GgAwIBAgIQKBOAjgMDO55A7UJ/k/g5nTBBBgkqhkiG9w0B
# AQowNKAPMA0GCWCGSAFlAwQCAQUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQC
# AQUAogMCASAwJjEkMCIGA1UEAwwbaWNyYWZ0c29mdHdhcmVAc3RhdGVsZXNzLmJl
# MB4XDTIwMDYyMzExNDM1NloXDTIxMDYyMzEyMDM1NlowJjEkMCIGA1UEAwwbaWNy
# YWZ0c29mdHdhcmVAc3RhdGVsZXNzLmJlMIICIjANBgkqhkiG9w0BAQEFAAOCAg8A
# MIICCgKCAgEAmQcb0GwlBHBHBJZ9vNM8EewN7T+nhsWVU0WBoWnIw6UAT99Rw9x5
# RcfOQU2hxqKmR1k+iI6B+qddpTC3VLSChA/mh1P4pCDDsZeyR/0nn/r/DezhDe8x
# 5jckjR88KSRcgDoh0kLjgfrToDpx9EvBcwXmNJKDwBIWu5SBvk04beU4XO7OHjBo
# g0kMaHxCZc9HcWfdzBefP+fbVzu6f1j1WgEqZn9sr1ML2ulHRdu26+56xGq9RZGJ
# vXyY1mY+K5mqBcET+1bV2pZnBrM3Gc/hlmvTkwrC0ZGBALLZWZqqpLVrDCY5eoHP
# w2C0kA4JzK4Q1o218s+wXbuDcjYRIZqBSwI8fizR/4DS+6dEjfa3kzs2z/MrkJOk
# hJ06tiMSRr55tX1DR8NwVLdiNqZYvs4zP2ZNRMMI8uFCjkP/Wn1hfBr+GSPlgdLq
# 2TFishY2pj5O1WlE/tCz+B0YLhPWdfbVEp8kB3fGBsVf7uw4STK/wDA1MYRIHikt
# w+K9gtdf0eIR9dYX9CMwoDN2TNLK6vnCWMrzWFe5EOU3/oljUBkyQT838a5A6wMu
# cGeu7Cwjdigylt7ULaTglL7ORIyaRbzkltxd+1oaQ21kjl4ef0ZD2gWLj7bwrZR+
# KWCfmaHFoZlVRKNPtScuyOnilPGGZ6T7SNuwVxSXFRtbp+cQea4UxxUCAwEAAaNf
# MF0wDgYDVR0PAQH/BAQDAgeAMBMGA1UdJQQMMAoGCCsGAQUFBwMDMBcGA1UdEQQQ
# MA6CDHN0YXRlbGVzcy5iZTAdBgNVHQ4EFgQUq4sCoE2IqN4K4uwNuibjqd5yNNQw
# QQYJKoZIhvcNAQEKMDSgDzANBglghkgBZQMEAgEFAKEcMBoGCSqGSIb3DQEBCDAN
# BglghkgBZQMEAgEFAKIDAgEgA4ICAQBR98amLpANKFlc7mPlkaV4ZtS2uTmbJ6dO
# qzyWKJ2yTmv7U9yq8PdEH9mPJlxYvGyNgxqHoocKv1SdjgYh27SM8pDnsfU2NpER
# 6K/3sICy6Orh9vhC+U18Bp93WoLEezolaBcF0co3/o+HazOvs/2zBFONFHMkef9/
# 3Bipm0sd95teHo53vLKViHbjSmoGxYsvJJiYITB4Zeo6xgUAmwcUpL1To62Lb3RP
# CDLKZQ5h8Ir07nncV4HLq+0qF3+G9Y0IXHJv6Qcr/XTTLo0J877HRqS37WJcgF8+
# 2nbZbqO9NVvp14A4nTqpeDFmzewDU33hiZvzuLHBj//OgLgGZ9lJPxCu0tVxfFWZ
# INHg1YHp3lMaAw00Q3tb/vhc5kE6Kl7FnXnUTsu4j+vUoaFMWhYezoyn9m4rD+xN
# RITrbLPZdWAZvVOJ8ehmswRhfiMZ1npwbrk7KU1UTsmMS7PHREWSyUM28WlMFf2i
# ut8TlY/MV/adUGr2GpqBWhxp5DRgfl1uamKm2wFlCra3/kReVlQgC/Bbod2JOgJW
# t8zCbO4nJx+fJYwM9RG70h/TmuqzP8uChsHtKcgs2YtXmSm12JZakXY4IflInI7p
# ddDEs9UOfsWXDsqpvmFQZbwgGeNeEsPk3Fdm1MzDtS9PBXMk4jGGXNzEsVUgwf42
# 2HuDWeX/4jGCAtswggLXAgEBMDowJjEkMCIGA1UEAwwbaWNyYWZ0c29mdHdhcmVA
# c3RhdGVsZXNzLmJlAhAoE4COAwM7nkDtQn+T+DmdMAkGBSsOAwIaBQCgeDAYBgor
# BgEEAYI3AgEMMQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEE
# MBwGCisGAQQBgjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBTO
# oGvRmOZkMptknN/W/7njYnoR1jANBgkqhkiG9w0BAQEFAASCAgB9lFFnG3dqBHjB
# Q++HMoKcfm8PQ690JHarZhvkFCwto2XlijcBiM9RzDVjtO4kiMCRSs4uMkeqr2Za
# aO6QljS2g5GBIXnIHyyKe6mv412iz/elzc5P0IfoZEwOnRffFeOk5hDQG+L1MtO3
# i9lxdPEfbsc51sGUpW6eld8X/9Nx2zgkZli+AyCyCosZzBZakxWAIDLM0pUjqDX/
# LU0s7NfoqzaP/5Yul8kmwdQP55SFnGRmfcsWtrK9IqHpx8D5Au3dVknYSH0rHJ/N
# Zp9BBSlUUeaFqGw3cP4MvKaobLpi743U9b3+wtlkwAeifQOsgleof/vQGqXot34W
# v+Zdb6Tv218dK9DVCklboUk4MA6INVc4Gir5UaxttffDNkZ99X/a2gs+/ISl6sFc
# Kri+03JA/Ns5X+YJ7Lx3AaPn6C9ycJiYRzAuz0OzM2bVlZK0B9mr9oT0KqikYUmV
# 6NamUNwghzHZX5WJoLY5A5AdwSDc9+aXMoao1f3ojUjukR4hHSIzZN/gO43b8NY2
# UvI/aHf/ZqYyTQcH9va1Vnntc4WlR8A2iH+cQHC8fM++fQ1RGztEffr6s1LRsJ1N
# ZHSRKfKuOCqDYEoUHeunccbUQY0tVKUhyD7nFR4aIu2qjcjcMTjQdUgj+btSfusg
# 6tiVTwvz3fC5GbfqWiBRUV1NmIA8Wg==
# SIG # End signature block