Script to convert library to arm/json (#256)

* Initial version of conversion script
* Refresh of script, review ready
* Fix based on comment
* utilities/tools
* Recursive removal of metadata on templates

utilities/tools/ConvertTo-ARMTemplate.ps1

@@ -0,0 +1,144 @@
+<#
+.SYNOPSIS
+This script converts the module library from bicep to json based ARM templates.
+
+.DESCRIPTION
+The script finds all 'deploy.bicep' files and tries to convert them to json based ARM templates
+by using the following steps.
+1. Remove existing deploy.json files (to avoid collision)
+2.a Convert deploy.bicep to deploy.json using bicep build
+2.b Clean up the json file, i.e removing the metadata property
+3. Remove bicep files and folders
+4. Replace deploy.bicep with deploy.json in workflow files
+
+.PARAMETER Path
+Mandatory. The path to the root of the repo.
+
+.PARAMETER CleanUp
+Optional. Perform cleanup of bicep files after conversion.
+
+.EXAMPLE
+. .\utilities\tools\ConvertTo-ARMTemplate.ps1 -Path . -CleanUp -Verbose
+
+Converts bicep modules to json based ARM template, cleaning up all bicep files after conversion.
+#>
+[CmdletBinding(SupportsShouldProcess)]
+param (
+    [Parameter(Mandatory)]
+    [string] $Path,
+
+    [Parameter()]
+    [switch] $CleanUp
+)
+
+#region Helper functions
+
+<#
+.SYNOPSIS
+A function to recursively remove 'metadata' property from a provided object.
+This object is expected to be an ARM template converted to a PowerShell custom object.
+The function uses the object reference rather than recreating/copying the object.
+
+.PARAMETER TemplateObject
+Mandatory. The ARM template converted to a PowerShell custom object.
+
+.EXAMPLE
+$JSONFileContent = Get-Content -Path $JSONFilePath
+$JSONObj = $JSONFileContent | ConvertFrom-Json
+Remove-JSONMetadata -TemplateObject $JSONObj
+
+Reads content from a ARM/JSON file, converts it to a PSCustomObject and removes 'metadata' property under the template and recursively on all nested deployments.
+
+#>
+function Remove-JSONMetadata {
+    [CmdletBinding()]
+    param (
+        [Parameter(Mandatory)]
+        [psobject] $TemplateObject
+    )
+    $TemplateObject.PSObject.Properties.Remove('metadata')
+    $TemplateObject.resources | Where-Object type -eq 'Microsoft.Resources/deployments' | ForEach-Object {
+        Remove-JSONMetadata -TemplateObject $_.properties.template
+    }
+}
+
+#endregion
+
+$rootPath = Get-Item -Path $Path | Select-Object -ExpandProperty FullName
+$armFolderPath = Join-Path -Path $rootPath -ChildPath 'arm'
+
+# Get all bicep files
+$bicepFiles = Get-ChildItem -Path $armFolderPath -Filter deploy.bicep -Recurse
+Write-Verbose "Convert bicep to json - $($bicepFiles.count) files"
+foreach ($bicepFile in $bicepFiles) {
+    $bicepFilePath = $bicepFile.FullName
+    Write-Verbose "$bicepFilePath - Processing"
+    $moduleFolderPath = $bicepFile.Directory.FullName
+    Write-Verbose "$bicepFilePath - ModuleFolderPath - $moduleFolderPath"
+    $JSONFilePath = Join-Path -Path $moduleFolderPath -ChildPath 'deploy.json'
+    Write-Verbose "$bicepFilePath - JSONFilePath - $JSONFilePath"
+    $bicepFolderPath = Join-Path -Path $moduleFolderPath -ChildPath '.bicep'
+
+    # Remove existing json files
+    Write-Verbose "$bicepFilePath - Removing deploy.json"
+    if (Test-Path -Path $JSONFilePath) {
+        if ($PSCmdlet.ShouldProcess("File in path [$bicepFilePath]", 'Remove')) {
+            Remove-Item -Path $JSONFilePath -Force -Verbose
+        }
+        Write-Verbose "$bicepFilePath - Removing deploy.json - Done"
+    } else {
+        Write-Verbose "$bicepFilePath - Removing deploy.json - Skipped - Nothing to delete"
+    }
+
+    # Convert bicep to json
+    Write-Verbose "$bicepFilePath - Convert to json"
+    if ($PSCmdlet.ShouldProcess("File in path [$bicepFilePath]", 'Convert')) {
+        az bicep build --file $bicepFilePath --outfile $JSONFilePath
+    }
+    Write-Verbose "$bicepFilePath - Convert to json - Done"
+
+    # Cleanup json, remove metadata property in json
+    Write-Verbose "$bicepFilePath - Clean up json"
+    if (Test-Path -Path $JSONFilePath) {
+        $JSONFileContent = Get-Content -Path $JSONFilePath
+        $JSONObj = $JSONFileContent | ConvertFrom-Json
+        Remove-JSONMetadata -TemplateObject $JSONObj
+        $JSONFileContent = $JSONObj | ConvertTo-Json -Depth 100
+        if ($PSCmdlet.ShouldProcess("File in path [$JSONFilePath]", 'Overwrite')) {
+            Set-Content -Value $JSONFileContent -Path $JSONFilePath
+        }
+        Write-Verbose "$bicepFilePath - Clean up json - Done"
+    } else {
+        Write-Verbose "$bicepFilePath - Clean up json - Skipped - File not found (deploy.json)"
+    }
+
+    # Remove bicep files and folders
+    Write-Verbose "$bicepFilePath - Clean up bicep files"
+    if ($CleanUp) {
+        if ($PSCmdlet.ShouldProcess("File in path [$bicepFilePath]", 'Remove')) {
+            Remove-Item -Path $bicepFilePath -Force
+        }
+        Write-Verbose "$bicepFilePath - Clean up bicep files - Removed deploy.bicep"
+        if (Test-Path -Path $bicepFolderPath) {
+            if ($PSCmdlet.ShouldProcess("File in path [$bicepFolderPath]", 'Remove')) {
+                Remove-Item -Path $bicepFolderPath -Recurse -Force
+            }
+            Write-Verbose "$bicepFilePath - Clean up bicep files - Removed .bicep folder"
+        }
+    }
+}
+
+# Replace .bicep with .json in workflow files
+$workflowFolderPath = Join-Path -Path $rootPath -ChildPath '.github\workflows'
+$workflowFiles = Get-ChildItem -Path $workflowFolderPath -Filter 'ms.*.yml' -File
+Write-Verbose "Update workflow files - $($workflowFiles.count) files"
+foreach ($workflowFile in $workflowFiles) {
+    Write-Verbose "$workflowFile - Processing"
+    $content = Get-Content -Path $workflowFile
+    $content = $content.Replace("deploy.bicep'", "deploy.json'")
+    if ($PSCmdlet.ShouldProcess("File in path [$workflowFile]", 'Overwrite')) {
+        Set-Content -Value $content -Path $workflowFile
+    }
+    Write-Verbose "$workflowFile - Processing - Done"
+}
+Write-Verbose "Update workflow files - $($workflowFiles.count) files - Done"