Cmdlets/Interface/Sync-StepTemplate.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
<#
Copyright 2016 ASOS.com Limited
 
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.
#>


<#
.NAME
    Sync-ScriptTemplate
     
.SYNOPSIS
    Uploads the step template into Octopus if it has changed
 
.DESCRIPTION
    This will only upload if the step template has changed
     
.PARAMETER Path
    The path to the step template to upload
     
.PARAMETER UseCache
    If Octopus Retrieval Operations should be cached, this is used when called from Invoke-TeamCityCiUpload where this function is called mulitple times
    When being run interactivley the use of the cache could cause unexpected behaviour
 
.INPUTS
    None. You cannot pipe objects to Sync-StepTemplate.
 
.OUTPUTS
    None.
#>

function Sync-StepTemplate {
    [CmdletBinding()]
    [OutputType("System.Collections.Hashtable")]
    param (
        [Parameter(Mandatory=$true)][ValidateScript({ Test-Path $_ })][System.String]$Path,
        [Parameter(Mandatory=$false)][System.Management.Automation.SwitchParameter]$UseCache
    )
    
    $templateName = Get-VariableFromScriptFile -Path $Path -VariableName StepTemplateName
    $stepTemplate =  Invoke-OctopusOperation -Action Get -ObjectType ActionTemplates -ObjectId "All" -UseCache:$UseCache | ? Name -eq $templateName
    
    $result = @{UploadCount = 0} 
    
    $newStepTemplate = New-StepTemplateObject -Path $Path
    if ($null -eq $stepTemplate) {
        Write-TeamCityMessage "Step template '$templateName' does not exist. Creating"
        
        $stepTemplate = Invoke-OctopusOperation -Action New -ObjectType ActionTemplates -Object $newStepTemplate
        $result.UploadCount++
    } else {
        $stepTemplate.Properties = Convert-PSObjectToHashTable $stepTemplate.Properties
        $stepTemplate.Parameters = @($stepTemplate.Parameters | % {
            $newParameter = Convert-PSObjectToHashTable $_
            $newParameter.DisplaySettings = Convert-PSObjectToHashTable $newParameter.DisplaySettings
            $newParameter
        })

        if (Compare-StepTemplate -OldTemplate $stepTemplate -NewTemplate $newStepTemplate) {
            Write-TeamCityMessage "Script template '$templateName' has changed. Updating"

            $newStepTemplate.Version = $stepTemplate.Version + 1

            $stepTemplate = Invoke-OctopusOperation -Action Update -ObjectType ActionTemplates -ObjectId $stepTemplate.Id -Object $newStepTemplate
            $result.UploadCount++
        }
    }
    
    $result
}