feat: Inject-ArmContent.ps1: support absolute paths to external files to inject (#280)

Co-authored-by: Stijn Moreels <9039753+stijnmoreels@users.noreply.github.com>

Author: vromantp

docs/preview/02-Features/powershell/arm.md

@@ -70,10 +70,12 @@ It is possible to supply injection instructions in the injection annotation, thi
 | `InjectAsJsonObject`  | Tests if the content is valid JSON and makes sure the content is injected without surrounding double quotes |
 
 Usage of multiple injection instructions is supported as well, for example if you need both the `EscapeJson` and `ReplaceSpecialChars` functionality.
+The reference to the file to inject can either be a path relative to the 'parent' file or an absolute path.
 
 Some examples are:
 ```powershell
 ${ FileToInject = ".\Parent Directory\file.xml" }
+${ FileToInject = "c:\Parent Directory\file.xml" }
 ${ FileToInject = ".\Parent Directory\file.xml", EscapeJson, ReplaceSpecialChars }
 ${ FileToInject = '.\Parent Directory\file.json', InjectAsJsonObject }
 ```

src/Arcus.Scripting.ARM/Scripts/Inject-ArmContent.ps1

@@ -3,7 +3,9 @@
     
     ${ fileToInject.xml }
     ${ FileToInject=file.xml }
+    ${ FileToInject=c:\file.xml }
     ${ FileToInject = ".\Parent Directory\file.xml" }
+    ${ FileToInject = "c:\Parent Directory\file.xml" }
     ${ FileToInject = ".\Parent Directory\file.xml", EscapeJson, ReplaceSpecialChars }
     ${ FileToInject = '.\Parent Directory\file.json', InjectAsJsonObject }
  #>
@@ -12,6 +14,20 @@ param (
     [string] $Path = $PSScriptRoot
 )
 
+function Get-FullyQualifiedChildFilePath {
+    param(
+        [parameter(mandatory=$true)] [string] $ParentFilePath,
+        [parameter(mandatory=$true)] [string] $ChildFilePath
+    )
+
+    $parentDirectoryPath = Split-Path $ParentFilePath -Parent
+    # Note: in case of a fully qualified (i.e. absolute) child path the Combine-function discards the parent directory path;
+    #  otherwise the relative child path is combined with the parent directory
+    $combinedPath = [System.IO.Path]::Combine($parentDirectoryPath, $ChildFilePath)
+    $fullPath = [System.IO.Path]::GetFullPath($combinedPath)
+    return $fullPath
+}
+
 function InjectFile {
     param(
         [string] $filePath
@@ -34,11 +50,9 @@ function InjectFile {
             throw "The file part '$filePart' of the injection instruction could not be parsed correctly"
         }
 
-        $relativePathOfFileToInject = $fileMatch.Groups["File"];
-        $fullPathOfFileToInject = Join-Path (Split-Path $filePath -Parent) $relativePathOfFileToInject
-        $fileToInjectIsFound = Test-Path -Path $fullPathOfFileToInject -PathType Leaf
-        if ($false -eq $fileToInjectIsFound) {
-            throw "No file can be found at '$fullPathofFileToInject'"
+        $fullPathOfFileToInject = Get-FullyQualifiedChildFilePath -ParentFilePath $filePath -ChildFilePath $fileMatch.Groups["File"]
+        if (-not(Test-Path -Path $fullPathOfFileToInject -PathType Leaf)) {
+            throw "No file can be found at '$fullPathOfFileToInject'"
         }
 
         # Inject content recursively first
@@ -116,7 +130,7 @@ $psScriptFileName = $MyInvocation.MyCommand.Name
 
 $PathIsFound = Test-Path -Path $Path
 if ($false -eq $PathIsFound) {
-    throw "Passed allong path '$Path' doesn't point to valid file path"
+    throw "Passed along path '$Path' doesn't point to valid file path"
 }
 
 Write-Host "Starting $psScriptFileName script on path $Path"

src/Arcus.Scripting.Tests.Integration/Arcus.Scripting.ARM.tests.ps1

@@ -20,7 +20,7 @@ InModuleScope Arcus.Scripting.ARM {
                 }
             }
             if ([Environment]::OSVersion.VersionString -like "*Windows*") {
-                It "Replaces file path with file contents as JSON object (windows)" {
+                It "Replaces relative file path with file contents as JSON object (windows)" {
                     # Arrange
                     $armTemplateFile = "$PSScriptRoot\Files\arm-template-object (windows).json"
                     try {
@@ -36,8 +36,29 @@ InModuleScope Arcus.Scripting.ARM {
                         Get-Content $originalFile | Out-File -FilePath $armTemplateFile
                     }
                 }
+                It "Replaces absolute file path with file contents as JSON object (windows)" {
+                    # Arrange
+                    $armTemplateFile = "$PSScriptRoot\Files\arm-template-object-absolutepath (windows).json"
+                    $armTemplateDirectory = Split-Path $armTemplateFile -Parent
+                    $armTemplate = Get-Content -path $armTemplateFile -Raw
+                    $armTemplate = $armTemplate -replace '#{ArmTemplateDirectory}#', $armTemplateDirectory
+                    $armTemplate | Set-Content -Path $armTemplateFile
+
+                    try {
+                        # Act
+                        Inject-ArmContent -Path $armTemplateFile
+
+                        # Assert
+                        $expected = Get-Content "$PSScriptRoot\Files\arm-template-object-value (windows).json"
+                        $actual = Get-Content $armTemplateFile
+                        $actual[7] | Should -Be '    "value": "{\r\n   \"test\": \"this is a test value\"\r\n}",'
+                    } finally {
+                        $originalFile = "$PSScriptRoot\Files\arm-template-object-absolutepath-org (windows).json"
+                        Get-Content $originalFile | Out-File -FilePath $armTemplateFile
+                    }
+                }
             } else {
-                It "Replaces file path with file contents as JSON object (linux)" {
+                It "Replaces relative file path with file contents as JSON object (linux)" {
                     # Arrange
                     $armTemplateFile = "$PSScriptRoot\Files\arm-template-object (linux).json"
                     try {
@@ -53,6 +74,27 @@ InModuleScope Arcus.Scripting.ARM {
                         Get-Content $originalFile | Out-File -FilePath $armTemplateFile
                     }
                 }
+                It "Replaces absolute file path with file contents as JSON object (linux)" {
+                    # Arrange
+                    $armTemplateFile = "$PSScriptRoot\Files\arm-template-object-absolutepath (linux).json"
+                    $armTemplateDirectory = Split-Path $armTemplateFile -Parent
+                    $armTemplate = Get-Content -path $armTemplateFile -Raw
+                    $armTemplate = $armTemplate -replace '#{ArmTemplateDirectory}#', $armTemplateDirectory
+                    $armTemplate | Set-Content -Path $armTemplateFile
+
+                    try {
+                        # Act
+                        Inject-ArmContent -Path $armTemplateFile
+
+                        # Assert
+                        $expected = Get-Content "$PSScriptRoot\Files\arm-template-object-value (linux).json"
+                        $actual = Get-Content $armTemplateFile
+                        $actual[7] | Should -Be '    "value": "{\n   \"test\": \"this is a test value\"\n}",'
+                    } finally {
+                        $originalFile = "$PSScriptRoot\Files\arm-template-object-absolutepath-org (linux).json"
+                        Get-Content $originalFile | Out-File -FilePath $armTemplateFile
+                    }
+                }
             }
             It "Replaces file path with file contents as escaped JSON and replaced special characters" {
                 # Arrange