Fixed bug with nested filters interpolation

Author: wild-devops

README.md

@@ -1,5 +1,5 @@
 [![GitHub workflows (all tests)](https://github.com/wild-devops/pwshake/workflows/all%20tests/badge.svg)](/actions/workflows/tests.yml)
-[![GitHub release (latest by date)](https://img.shields.io/github/v/release/wild-devops/pwshake)](/releases/tag/v1.5.0)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/wild-devops/pwshake)](/releases/tag/v1.5.1)
 [![PowerShell Gallery](https://img.shields.io/powershellgallery/v/pwshake)](https://www.powershellgallery.com/packages/pwshake)
 [![PowerShell Gallery](https://img.shields.io/powershellgallery/dt/pwshake)](https://www.powershellgallery.com/packages/pwshake)
 
@@ -123,7 +123,7 @@ invoke_tasks:
 attributes:
   pwshake_module_path: /path/to/pwshake/module/source
   pwshake_path: /absolute/path/to/your/working/directory
-  pwshake_version: 1.6.0
+  pwshake_version: 1.5.1
   work_dir: /absolute/path/to/process/working/directory
   pwshake_log_path: /absolute/path/to/your/working/directory/my_pwshake.log
   some_attribute: this is an attribute value

examples/4.complex/v1.0/includes/module1.yaml

@@ -6,5 +6,5 @@ attributes_overrides:
 tasks:
   role1: role3
 apply_roles:
-  - role1
-  - role2
+- role1
+- role2

examples/4.complex/v1.0/includes/module3.yaml

@@ -2,7 +2,7 @@ roles:
   role2: role2
   role3: role3
 apply_roles:
-  - role1
-  - role2
-  - role5
-  - role6
+- role1
+- role2
+- role5
+- role6

pwshake/pwshake.psd1

@@ -12,7 +12,7 @@
 RootModule = 'pwshake.psm1'
 
 # Version number of this module.
-ModuleVersion = '1.6.0'
+ModuleVersion = '1.5.1'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

pwshake/scripts/Arrange-Tasks.ps1

@@ -1,13 +1,13 @@
 function Arrange-Tasks {
   [CmdletBinding()]
   param (
-    [Parameter(Position = 0, Mandatory = $true)]
-    [hashtable]$config,
+    [Parameter(Position = 0, Mandatory = $true, ValueFromPipeline = $true)]
+    [object[]]$depends_on,
 
-    [Parameter(Position = 1, Mandatory = $false)]
-    [object[]]$depends_on = $config.invoke_tasks,
+    [Parameter(Mandatory = $false)]
+    [hashtable]$config = (Peek-Config),
 
-    [Parameter(Position = 2, Mandatory = $false)]
+    [Parameter(Mandatory = $false)]
     [int]$depth = 0
   )
   process {
@@ -18,19 +18,21 @@ function Arrange-Tasks {
     $tasks = @()
 
     foreach ($name in $depends_on) {
+      "Arrange-Tasks:foreach:`$name:`n$(cty $name)" | f-log-dbg
       if (-not ($config.tasks.Keys -contains $name)) {
         throw "Task '$name' is undefined in the PWSHAKE config."
       }
 
       $task = Build-Task $config.tasks[$name] $name
 
       if ($task.depends_on) {
-        $tasks += (Arrange-Tasks $config $task.depends_on ($depth + 1))
+        $tasks += ($task.depends_on | Arrange-Tasks -depth ($depth + 1))
       }
 
       $tasks += $task
     }
 
+    "Arrange-Tasks:Out:`$tasks:`n$(cty $tasks)" | f-log-dbg
     return $tasks
   }
 }

pwshake/scripts/Interpolate-Attributes.ps1

@@ -15,10 +15,10 @@ function Interpolate-Attributes {
           "Interpolate-Attributes:$($counter):`$substitute:$substitute" | f-log-dbg
           if ($substitute -match '^\$\((?<eval>.*)\)$') {
             "Interpolate-Attributes:$($counter):`$eval:{$($matches.eval)}" | f-log-dbg
-            $value = Invoke-Expression (ConvertFrom-Json "`"$($matches.eval)`"")
+            $value = "`"$($matches.eval)`"" | ConvertFrom-Json | Invoke-Expression
           } elseif ($substitute -match '^(?<filter>\$\S+):(?<input>.*)') {
             "Interpolate-Attributes:$($counter):`$filter:{$($matches.filter)}:`$input:{$($matches.input)}" | f-log-dbg
-            $value = $matches.input | & "f-$($matches.filter)"
+            $value = "`"$($matches.input)`"" | ConvertFrom-Json | & f-$($matches.filter)
             "Interpolate-Attributes:$($counter):`$value:{$value}" | f-log-dbg
           } else {
             $value = Invoke-Expression "`$config.attributes.$substitute" -ErrorAction Stop

pwshake/scripts/Invoke-Step.ps1

@@ -15,8 +15,8 @@ function Invoke-Step {
 
     try {
       "Invoke-Step:In:$(@{'$_'=$_} | ConvertTo-Yaml)" | f-log-dbg
-      $step = $step | Build-Step
-      "Invoke-Step:Build-Step:$(@{'$step'=$step} | ConvertTo-Yaml)" | f-log-dbg
+      $step = $_ = $_ | Build-Step
+      "Invoke-Step:Build-Step:$(@{'$_'=$_} | ConvertTo-Yaml)" | f-log-dbg
 
       if ($step['$context'].template_key) {
         # add alias to simplify templates definition
@@ -59,7 +59,7 @@ function Invoke-Step {
     } catch {
       $_ | f-log-err
       if ($step.on_error -eq 'throw') {
-        (Peek-Context).thrown = $true
+        (Peek-Context).caught = $true
         throw $_
       }
     } finally {

pwshake/scripts/Invoke-Task.ps1

@@ -4,7 +4,7 @@ function Invoke-Task {
         [Parameter(Position = 0, Mandatory = $true, ValueFromPipeline = $true)]
         [hashtable]$task,
 
-        [Parameter(Position = 1, Mandatory = $false)]
+        [Parameter(Mandatory = $false)]
         [hashtable]$config = (Coalesce (Peek-Config), @{})
     )
     process {
@@ -21,11 +21,11 @@ function Invoke-Task {
             Push-Location (Build-Path "$($task.work_dir)" $config)
 
             foreach ($step in $task.steps) {
-                (Peek-Context).thrown = $false
+                (Peek-Context).caught = $false
                 $step | Invoke-Step -work_dir $task.work_dir
             }
         } catch {
-            if (-not (Peek-Context).thrown) {
+            if (-not (Peek-Context).caught) {
                 # if it was not thrown in execution context, it should be logged
                 $_ | f-log-err
             }

pwshake/scripts/Invoke-pwshake.ps1

@@ -61,15 +61,14 @@ function Invoke-pwshake {
                 }
             }
 
-            $arranged_tasks = Arrange-Tasks (Peek-Config)
+            $arranged_tasks = (Peek-Config).invoke_tasks | Arrange-Tasks
             "Invoke-pwshake:`$arranged_tasks:`n$(ConvertTo-Yaml $arranged_tasks)" | f-log-dbg
 
             Push-Location (Peek-Config).attributes.work_dir
-            foreach ($task in $arranged_tasks) {
-                Invoke-Task $task
-            }
+            $arranged_tasks | Invoke-Task
+            
         } catch {
-            if (-not (Peek-Context).thrown) {
+            if (-not (Peek-Context).caught) {
                 # if it was not thrown in execution context, it should be logged
                 $_ | f-log-err
             }

pwshake/templates/invoke_steps.yaml

@@ -1,6 +1,4 @@
 pwshake-context:
   templates:
     invoke_steps:
-      each:
-        items: $[[$_.invoke_steps]]
-        action: $_ | Invoke-Step
+      powershell: $_.invoke_steps | Invoke-Step

pwshake/templates/invoke_tasks.yaml

@@ -2,19 +2,10 @@ pwshake-context:
   templates:
     invoke_tasks:
       powershell: |
-        $tasks = Arrange-Tasks $config $_.invoke_tasks
-        foreach ($task in $tasks) {
-            Invoke-Task $task $config
-        }
+        $_.invoke_tasks | Arrange-Tasks | Invoke-Task
     apply_roles:
       powershell: |
-        $tasks = Arrange-Tasks $config $_.apply_roles
-        foreach ($task in $tasks) {
-            Invoke-Task $task $config
-        }
+        $_.apply_roles | Arrange-Tasks | Invoke-Task
     invoke_run_lists:
       powershell: |
-        $tasks = Arrange-Tasks $config $_.invoke_run_lists
-        foreach ($task in $tasks) {
-            Invoke-Task $task $config
-        }
+        $_.invoke_run_lists | Arrange-Tasks | Invoke-Task

pwshake/templates/script.yaml

@@ -4,8 +4,8 @@ pwshake-context:
       powershell: |
         $paths = $config.scripts_directories | ForEach-Object { Join-Path $config.attributes.pwshake_path -ChildPath $_ }
         $script_path = Get-ChildItem $paths -File `
-            | Where-Object BaseName -eq $step.script `
+            | Where-Object BaseName -eq $_.script `
             | Select-Object -ExpandProperty FullName
         "Script file: $script_path" | f-log-info
-        if (-not $script_path) { throw "Script file: $($step.script).* not found." }
+        if (-not $script_path) { throw "Script file: $($_.script).* not found." }
         & $script_path -attributes $config.attributes

tests/Arrange-Tasks.Context.ps1

@@ -8,7 +8,7 @@ Context "Arrange-Tasks" {
     $config.invoke_tasks = @('role1')
 
     It "Should return an Object[]" {
-        (Arrange-Tasks $config) -is [Object[]] | Should -BeTrue
+        ($config.invoke_tasks | Arrange-Tasks) -is [Object[]] | Should -BeTrue
     }
 
     It "Should throw on circular reference in depends_on" {
@@ -18,7 +18,7 @@ Context "Arrange-Tasks" {
             depends_on = @('role1')
         }
 
-        { Arrange-Tasks $config } `
+        { $config.invoke_tasks | Arrange-Tasks } `
             | Should -Throw "Circular reference detected for dependant tasks in:"
     }
 }

tests/Build-Template.Context.ps1

@@ -138,11 +138,10 @@ Context "Build-Template" {
 '@  | ConvertFrom-Yaml | ForEach-Object steps | Select-Object -First 1 | `
       Build-Template | Ensure-Template -sb { param($actual)
       $actual.on_error | Should -Be 'continue'
-      $actual.powershell | Should -BeLike 'if (-not $each.items) { throw*'
-      $actual.items[0].echo | Should -Be 'say'
-      $actual.items[1].invoke_steps[0].echo | Should -Be 'hello'
-      $actual.action | Should -Be '$_ | Invoke-Step'
-      $actual['$context'].template_key | Should -Be 'each'
+      $actual.powershell | Should -BeLike '$_.invoke_steps | Invoke-Step'
+      $actual.invoke_steps[0].echo | Should -Be 'say'
+      $actual.invoke_steps[1].invoke_steps[0].echo | Should -Be 'hello'
+      $actual['$context'].template_key | Should -Be 'invoke_steps'
     }
   }
 

tests/Interpolate-Attributes.Context.ps1

@@ -121,4 +121,16 @@ Context "Interpolate-Attributes" {
             }
         } | Should -Throw "Circular reference detected for substitutions: {{a}} {{b}} {{c}}"
     }
+
+    It "Should substitute special characters" {
+        $chars = '`~!@#$qwest%^&*()_-=+\|][}{";?.,></№' + "'"
+
+        Interpolate-Attributes @{
+            attributes = @{a="{{b}}";b='{{$secured:{{c}}}}';c=$chars};
+        } | Interpolate-Attributes | New-Variable -Name actual
+
+        $actual.attributes.a | Should -Be $chars
+        $actual.attributes.b | Should -Be $chars
+        $actual.attributes.c | Should -Be $chars
+    }
 }