Private/Convert-SpecToFunction.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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
function Convert-SpecToFunction {
    Param
    (
        [parameter(Mandatory = $true,Position = 0)]
        [Object]
        $Resource,
        [parameter(Mandatory = $true,Position = 1)]
        [ValidateSet("Resource","Property")]
        [String]
        $ResourceType
    )
    $ModPath = $Script:VaporshellPath
    $folder = "$($ModPath)\Public"
    $Name = $Resource.Name
    $Link = $Resource.Value.Documentation
    $Properties = $Resource.Value.Properties.PSObject.Properties
    $ShortName = $Name.Replace("AWS::","")
    $BaseTypeName = "Vaporshell.Resource." + ($ShortName -replace "\..*").Replace("::",".")
    $TypeName = "Vaporshell.Resource." + $ShortName.Replace("::",".")
    switch ($ResourceType) {
        Resource {
            $Dir = "$folder\Resource Types"
            $FunctionName = "New-VS" + ($ShortName -replace "\..*").Replace("::","")
            $Synopsis = "Adds an $Name resource to the template"
        }
        Property {
            $Dir = "$folder\Resource Property Types"
            $FunctionName = "Add-VS" + $ShortName.Replace("::","").Replace(".","")
            $Synopsis = "Adds an $Name resource property to the template"
        }
    }
    $PS1Path = "$Dir\$FunctionName.ps1"
    $scriptContents = @()
    $scriptContents += @"
function $FunctionName {
    <#
    .SYNOPSIS
        $Synopsis

    .DESCRIPTION
        $Synopsis

    .LINK
        $Link

"@
 
    if ($ResourceType -ne "Property") {
        $scriptContents += @"
    .PARAMETER LogicalId
        The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance.`n
"@

    }

    foreach ($Prop in $Properties) {
        $scriptContents += @"
    .PARAMETER $($Prop.Name)
"@

        $pList = $Prop.value.psobject.properties
        foreach ($p in $pList) {
            $scriptContents += "`t`t$($p.Name): $($p.Value) "
        }
        $scriptContents += ""
    }

    if ($Name -eq "AWS::AutoScaling::AutoScalingGroup" -or $Name -eq "AWS::EC2::Instance" -or $Name -eq "AWS::CloudFormation::WaitCondition") {
        $scriptContents += @"
    .PARAMETER CreationPolicy
        Use the CreationPolicy attribute when you want to wait on resource configuration actions before stack creation proceeds. For example, if you install and configure software applications on an EC2 instance, you might want those applications to be running before proceeding. In such cases, you can add a CreationPolicy attribute to the instance, and then send a success signal to the instance after the applications are installed and configured.

        You must use the "Add-CreationPolicy" function here.`n
"@

    }

    if ($ResourceType -ne "Property") {
        $scriptContents += @"
    .PARAMETER DeletionPolicy
        With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.

        To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to use or modify those resources after you delete their stacks.

        You must use one of the following options: "Delete","Retain","Snapshot"


    .PARAMETER DependsOn
        With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute.

        This parameter takes a string or list of strings representing Logical IDs of resources that must be created prior to this resource being created.


    .PARAMETER Metadata
        The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute to add those interpreted values.

        You must use a PSCustomObject containing key/value pairs here. This will be returned when describing the resource using AWS CLI.


    .PARAMETER UpdatePolicy
        Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group.

        You must use the "Add-UpdatePolicy" function here.
    

    .PARAMETER Condition
        Logical ID of the condition that this resource needs to be true in order for this resource to be provisioned.`n
"@

    }
    $scriptContents += @"
    .FUNCTIONALITY
        Vaporshell
    #>
    [OutputType('$TypeName')]
    [cmdletbinding()]
"@

    if ($passProps = $Properties.Name | Where-Object {$_ -like "*Password*" -or $_ -like "*Credential*"}) {
        foreach ($passProp in $passProps) {
            $scriptContents += @"
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword","$passProp")]
"@

        }
        $scriptContents += @"
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPasswordParams","")]
"@

    }
    $scriptContents += @"
    Param
    (
"@

    if ($ResourceType -ne "Property") {
        $scriptContents += @"
        [parameter(Mandatory = `$true,Position = 0)]
        [ValidateScript( {
                if (`$_ -match "^[a-zA-Z0-9]*$") {
                    `$true
                }
                else {
                    `$PSCmdlet.ThrowTerminatingError((New-VSError -String 'The LogicalID must be alphanumeric (a-z, A-Z, 0-9) and unique within the template.'))
                }
            })]
        [System.String]
        `$LogicalId,
"@

    }
    $PCount = 0
    $Properties | ForEach-Object {$PCount++}
    $i = 0
    foreach ($Prop in $Properties) {
        $i++
        if ($ResourceType -ne "Property") {
            $ParamName = "$($Prop.Name),"
        }
        elseif ($i -lt [int]$PCount) {
            $ParamName = "$($Prop.Name),"
        }
        else {
            $ParamName = "$($Prop.Name)"
        }
        if ($Prop.Value.Required -eq "True") {
            $Mandatory = '$true'
        }
        else {
            $Mandatory = '$false'
        }
        if ($Prop.Value.ItemType) {
            if ($Prop.Value.ItemType -eq "Tag") {
                $scriptContents += @"
        [parameter(Mandatory = $Mandatory)]
        [ValidateScript( {
                `$allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject"
                if ([string]`$(`$_.PSTypeNames) -match "(`$((`$allowedTypes|ForEach-Object{[RegEx]::Escape(`$_)}) -join '|'))") {
                    `$true
                }
                else {
                    `$PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: `$(`$allowedTypes -join ", "). The current types of the value are: `$(`$_.PSTypeNames -join ", ")."))
                }
            })]
        `$$ParamName
"@

            }
            else {
                $ValTypeName = "$($BaseTypeName).$($Prop.Value.ItemType)"
                $scriptContents += @"
        [parameter(Mandatory = $Mandatory)]
        [ValidateScript( {
                `$allowedTypes = "$ValTypeName"
                if ([string]`$(`$_.PSTypeNames) -match "(`$((`$allowedTypes|ForEach-Object{[RegEx]::Escape(`$_)}) -join '|'))") {
                    `$true
                }
                else {
                    `$PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: `$(`$allowedTypes -join ", "). The current types of the value are: `$(`$_.PSTypeNames -join ", ")."))
                }
            })]
        `$$ParamName
"@

            }
        }
        elseif ($Prop.Name -eq "UserData") {
            $scriptContents += @"
        [parameter(Mandatory = $Mandatory)]
        [ValidateScript( {
                `$allowedTypes = "Vaporshell.Function.Base64","Vaporshell.Resource.UserData"
                if ([string]`$(`$_.PSTypeNames) -match "(`$((`$allowedTypes|ForEach-Object{[RegEx]::Escape(`$_)}) -join '|'))") {
                    `$true
                }
                else {
                    `$PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: `$(`$allowedTypes -join ", "). The current types of the value are: `$(`$_.PSTypeNames -join ", ")."))
                }
            })]
        `$$ParamName
"@

        }
        elseif ($Prop.Value.Type -eq "Map") {
            $scriptContents += @"
        [parameter(Mandatory = $Mandatory)]
        [System.Collections.Hashtable]
        `$$ParamName
"@

        }
        elseif ($Prop.Value.PrimitiveType -eq "Integer" -or $Prop.Value.PrimitiveType -eq "Number") {
            $scriptContents += @"
        [parameter(Mandatory = $Mandatory)]
        [Int]
        `$$ParamName
"@

        }
        elseif ($Prop.Value.PrimitiveType -eq "Double") {
            $scriptContents += @"
        [parameter(Mandatory = $Mandatory)]
        [System.Double]
        `$$ParamName
"@

        }
        elseif ($Prop.Value.PrimitiveType -eq "Boolean") {
            $scriptContents += @"
        [parameter(Mandatory = $Mandatory)]
        [System.Boolean]
        `$$ParamName
"@

        }
        elseif ($Prop.Value.PrimitiveType -eq "Json") {
            $scriptContents += @"
        [parameter(Mandatory = $Mandatory)]
        [ValidateScript( {
                `$allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject"
                if ([string]`$(`$_.PSTypeNames) -match "(`$((`$allowedTypes|ForEach-Object{[RegEx]::Escape(`$_)}) -join '|'))") {
                    `$true
                }
                else {
                    `$PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: `$(`$allowedTypes -join ", "). The current types of the value are: `$(`$_.PSTypeNames -join ", ")."))
                }
            })]
        `$$ParamName
"@

        }
        elseif ($Prop.Value.PrimitiveType -eq "String") {
            if ($ParamName -eq "LoggingLevel") {
                $scriptContents += @"
        [parameter(Mandatory = $Mandatory)]
        [ValidateSet("OFF","ERROR","INFO")]
        `$$ParamName
"@

            }
            else {
                $scriptContents += @"
        [parameter(Mandatory = $Mandatory)]
        [ValidateScript( {
                `$allowedTypes = "System.String","Vaporshell.Function"
                if ([string]`$(`$_.PSTypeNames) -match "(`$((`$allowedTypes|ForEach-Object{[RegEx]::Escape(`$_)}) -join '|'))") {
                    `$true
                }
                else {
                    `$PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: `$(`$allowedTypes -join ", "). The current types of the value are: `$(`$_.PSTypeNames -join ", ")."))
                }
            })]
        `$$ParamName
"@

            }
        }
        else {
            $scriptContents += @"
        [parameter(Mandatory = $Mandatory)]
        `$$ParamName
"@

        }
    }

    if ($ResourceType -ne "Property") {
        if ($Name -eq "AWS::AutoScaling::AutoScalingGroup" -or $Name -eq "AWS::EC2::Instance" -or $Name -eq "AWS::CloudFormation::WaitCondition") {
            $scriptContents += @"
        [parameter(Mandatory = `$false)]
        [ValidateScript( {
                `$allowedTypes = "Vaporshell.Resource.CreationPolicy"
                if ([string]`$(`$_.PSTypeNames) -match "(`$((`$allowedTypes|ForEach-Object{[RegEx]::Escape(`$_)}) -join '|'))") {
                    `$true
                }
                else {
                    `$PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: `$(`$allowedTypes -join ", "). The current types of the value are: `$(`$_.PSTypeNames -join ", ")."))
                }
            })]
        `$CreationPolicy,
"@

        }
        $scriptContents += @"
        [ValidateSet("Delete","Retain","Snapshot")]
        [System.String]
        `$DeletionPolicy,
        [parameter(Mandatory = `$false)]
        [System.String[]]
        `$DependsOn,
        [parameter(Mandatory = `$false)]
        [ValidateScript( {
                `$allowedTypes = "System.Management.Automation.PSCustomObject"
                if ([string]`$(`$_.PSTypeNames) -match "(`$((`$allowedTypes|ForEach-Object{[RegEx]::Escape(`$_)}) -join '|'))") {
                    `$true
                }
                else {
                    `$PSCmdlet.ThrowTerminatingError((New-VSError -String "The UpdatePolicy parameter only accepts the following types: `$(`$allowedTypes -join ", "). The current types of the value are: `$(`$_.PSTypeNames -join ", ")."))
                }
            })]
        `$Metadata,
        [parameter(Mandatory = `$false)]
        [ValidateScript( {
                `$allowedTypes = "Vaporshell.Resource.UpdatePolicy"
                if ([string]`$(`$_.PSTypeNames) -match "(`$((`$allowedTypes|ForEach-Object{[RegEx]::Escape(`$_)}) -join '|'))") {
                    `$true
                }
                else {
                    `$PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: `$(`$allowedTypes -join ", "). The current types of the value are: `$(`$_.PSTypeNames -join ", ")."))
                }
            })]
        `$UpdatePolicy,
        [parameter(Mandatory = `$false)]
        `$Condition
    )
    Begin {
        `$ResourceParams = @{
            LogicalId = `$LogicalId
            Type = "$Name"
        }
        `$commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable')
    }
    Process {
        foreach (`$key in `$PSBoundParameters.Keys | Where-Object {`$commonParams -notcontains `$_}) {
            switch (`$key) {
                LogicalId {}
"@

        if ($Name -eq "AWS::AutoScaling::AutoScalingGroup" -or $Name -eq "AWS::EC2::Instance" -or $Name -eq "AWS::CloudFormation::WaitCondition") {
            $scriptContents += @"
                CreationPolicy {
                    `$ResourceParams.Add("CreationPolicy",`$CreationPolicy)
                }
"@

        }
        $scriptContents += @"
                DeletionPolicy {
                    `$ResourceParams.Add("DeletionPolicy",`$DeletionPolicy)
                }
                DependsOn {
                    `$ResourceParams.Add("DependsOn",`$DependsOn)
                }
                Metadata {
                    `$ResourceParams.Add("Metadata",`$Metadata)
                }
                UpdatePolicy {
                    `$ResourceParams.Add("UpdatePolicy",`$UpdatePolicy)
                }
                Condition {
                    `$ResourceParams.Add("Condition",`$Condition)
                }
"@

        foreach ($Prop in $Properties | Where-Object {$_.Value.Type -eq "List"}) {
            $scriptContents += @"
                $($Prop.Name) {
                    if (!(`$ResourceParams["Properties"])) {
                        `$ResourceParams.Add("Properties",([PSCustomObject]@{}))
                    }
                    `$ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name $($Prop.Name) -Value @(`$$($Prop.Name))
                }
"@

        }
        foreach ($Prop in $Properties | Where-Object {$_.Value.PrimitiveType -eq "Json"}) {
            $scriptContents += @"
                $($Prop.Name) {
                    if ((`$PSBoundParameters[`$key]).PSObject.TypeNames -contains "System.String"){
                        try {
                            `$JSONObject = (ConvertFrom-Json -InputObject `$PSBoundParameters[`$key] -ErrorAction Stop)
                        }
                        catch {
                            `$PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '`$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!"))
                        }
                    }
                    else {
                        `$JSONObject = ([PSCustomObject]`$PSBoundParameters[`$key])
                    }
                    if (!(`$ResourceParams["Properties"])) {
                        `$ResourceParams.Add("Properties",([PSCustomObject]@{}))
                    }
                    `$ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name `$key -Value `$JSONObject
                }
"@

        }
        $scriptContents += @"
                Default {
                    if (!(`$ResourceParams["Properties"])) {
                        `$ResourceParams.Add("Properties",([PSCustomObject]@{}))
                    }
                    `$ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name `$key -Value `$PSBoundParameters[`$key]
                }
            }
        }
    }
    End {
        `$obj = New-VaporResource @ResourceParams
        `$obj | Add-ObjectDetail -TypeName '$TypeName'
        Write-Verbose "Resulting JSON from `$(`$MyInvocation.MyCommand): ``n``n`$(@{`$obj.LogicalId = `$obj.Props} | ConvertTo-Json -Depth 5)``n"
    }
}
"@

    }
    else {
        $scriptContents += @"
    )
    Begin {
        `$obj = [PSCustomObject]@{}
        `$commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable')
    }
    Process {
        foreach (`$key in `$PSBoundParameters.Keys | Where-Object {`$commonParams -notcontains `$_}) {
            `$obj | Add-Member -MemberType NoteProperty -Name `$key -Value `$PSBoundParameters.`$key
        }
    }
    End {
        `$obj | Add-ObjectDetail -TypeName '$TypeName'
    }
}
"@

    }
    Set-Content -Value $scriptContents -Path $PS1Path -Encoding UTF8 -Force
}