Merge pull request #1 from wild-devops/develop

Develop

Author: wild-devops

README.md

@@ -69,7 +69,7 @@ The result looks like the followed output including information about:
 *  `PWSHAKE config:` - loaded config file content (may be rearranged due to overriding, interpolation, and merging metadata)
 *  `Arranged tasks:` - tasks to be executed in actual order
 *  `Invoke task:` - invoked tasks name
-*  `Execute <step|powershell|cmd|msbuild>:` - invoked steps caption
+*  `Execute <step|powershell|cmd>:` - invoked steps caption
 *  Everything else - invoked scripts output
 
 ```

doc/step.md

@@ -6,16 +6,15 @@ The internal representation of a single **step** looks like a following **Powers
 ```
 @{
   name = $null;
+  when = "`$true";
+  work_dir = $null;
+  on_error = "throw";
   script = $null;
   powershell = $null;
   cmd = $null;
-  msbuild = @{
-    project = $null;
-    targets = $null;
-    properties = $null;
-  };
-  when = "`$true";
   invoke_tasks = $null;
+  template = $null;
+  parameters = @{};
 }
 ```
 
@@ -47,19 +46,16 @@ So, the full allowed form of the `- [step]:` element could be the following:
   script: script_name
   powershell: "some inline powershell code"
   cmd: "other inline cmd.exe commands"
-  msbuild:
-    project: some_project_file_name
-    targets: "List,Of,Targets"
-    properties: "MyProperty=Assigned"
+  template: my_template
   when: $true
 ...
 ```
-But **PWSHAKE** engine take pecedence over the given structure items and executes only the first non empty item, in this case `script:` item with '`script_name`' value, all others (`powershell:`, `cmd:`, `msbuild:`) are ignored.
+But **PWSHAKE** engine take pecedence over the given structure items and executes only the first non empty item, in this case `script:` item with '`script_name`' value, all others (`powershell:`, `cmd:`, `template:`) are ignored.
 
 * ### - `[step]:` element implicit shortenings
   Since the actual payload in the executed structure have only the two elements:
   * `name:`
-  * first non empty of `[script: | powershell: | cmd: | msbuild:]`
+  * first non empty of `[script: | powershell: | cmd:]`
 
   There are allowed some implicit shortenings in the `[step]:` element `yaml` syntax.
 
@@ -99,24 +95,6 @@ But **PWSHAKE** engine take pecedence over the given structure items and execute
   - name: Deploy package
     cmd: npm publish
   ```
-  
-* ### - `[msbuild]:` element implicit shortenings
-  All things described above are eligible for the `msbuild:` element.
-
-
-  Since the actual payload of this element is the **MSBuild** project file name, so the shortening syntax use this value as a `project:` element value.
-
-  Example:
-  ```
-  - name: Build
-    msbuild: some_project_file_name
-  ```
-  This is actually the same as:
-  ```
-  - name: Build
-    msbuild:
-      project: some_project_file_name
-  ```
 
 * ### - `[powershell|cmd]:` element implicit shortenings
   Since the `[powershell|cmd]:` elements contain inline code that can be too long and\or complex to use it as the meaningful name, so the `name:` property for these shortenings is generated from the `.GetHashCode()` method of the supplied inline string to distinct each other inline step  in the **PWSHAKE** engine log.

doc/tasks.md

@@ -120,19 +120,6 @@ Every named element of the `tasks:` can contain some definitions to provide more
           -multiline -code -with -long ^
           -list -of -fake -parameters
     ```
-  * `- msbuild:` - element to run **MSBuild** with particular settings
-
-    Example:
-    ```
-    tasks:
-      build:
-      - msbuild: .\MySolution.sln
-      - msbuild:
-          project: .\MyProject.csproj
-          targets: TransformConfigs
-          properties: Configuration=Debug
-    ```
-    The above are 2 calls to **MSBuild**: the first is in shortened form and just uses default target (`Build`) and default options, the second uses given parameters `targets:` and `properties:` passed from `pwshake.yaml` config.
 
   * `- [step]:` - an implicit element to fulfill the particular step settings in explicit way
 
@@ -147,7 +134,8 @@ Every named element of the `tasks:` can contain some definitions to provide more
         cmd: echo 'step2'
       - step3:
           name: Do msbuild task
-          msbuild:
+          template: msbuild
+          parameters:
             project: .\MyProject.csproj
             targets: TransformConfigs
             properties: Configuration=Debug

examples/example.msbuild.proj

@@ -1,18 +1,18 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003"
-		 ToolsVersion="4.0"
+     ToolsVersion="4.0"
      DefaultTargets="Hello">
 
-	<PropertyGroup>
-		<Configuration Condition="'$(Configuration)' == ''">Debug</Configuration>
-	</PropertyGroup>
+  <PropertyGroup>
+    <Configuration Condition="'$(Configuration)' == ''">Debug</Configuration>
+  </PropertyGroup>
 
   <Target Name="Hello">
-    <Message Text="Hello from MSBuild with $(Configuration) mode." />
+    <Message Text="Hello from MSBuild with $(Configuration) mode." Importance="High" />
   </Target>
 
   <Target Name="Build">
-    <Message Text="Building in $(Configuration) mode." />
+    <Message Text="Building in $(Configuration) mode." Importance="High" />
     <Error Text="Something went wrong." />
   </Target>
 

examples/msbuild_pwshake.yaml

@@ -1,19 +1,40 @@
 attributes:
   configuration: Release
 
-# List of directories relative to this file location where executable scripts are looking for (can be omitted)
-scripts_directories:
-  - .
+templates:
+  doitall:
+    parameters:
+      payload:
+    cmd: >
+      [[payload]]
+  dotnet:
+    template: doitall
+    parameters:
+      payload: dotnet [[command]] [[options]]
+      command:
+      options: --version
+  msbuild:
+    template: dotnet
+    parameters:
+      command: msbuild
+      options: >
+        [[project]]
+        /t:[[targets]]
+        /p:[[properties]]
+      project: '{{pwshake_path}}/example.msbuild.proj'
+      targets: Hello
+      properties: Configuration=Debug
 
-# Declaration of run lists that compose and determine order of executing for scripts
 tasks:
   msbuild:
-  - msbuild: '{{pwshake_path}}\example.msbuild.proj'
-  - msbuild:
-      project: '{{pwshake_path}}\example.msbuild.proj'
+  - template: msbuild
+  - template: msbuild
+    on_error: continue
+    parameters:
       targets: Build
       properties: Configuration={{configuration}}
+  - pwsh: Write-Host '<<something>>'
+  - template: dotnet
 
-# Run lists to current execute
 invoke_tasks:
 - msbuild

examples/pwshake_config.yaml

@@ -68,11 +68,11 @@ tasks:
     scripts:
     - create_linux
     - update_linux
-    - name: Check msbuild step parsing relative to pwshake_path
-      msbuild: build.properties
+    - name: Check the step parsing relative to pwshake_path
+      cmd: build.properties
       when: $false
-    - name: Check msbuild step parsing relative to work_dir
-      msbuild: build.properties
+    - name: Check the step parsing relative to work_dir
+      cmd: build.properties
       when: $false
 
 # Run lists to execute

pwshake.ps1

@@ -22,7 +22,7 @@ param(
   [switch]$DryRun,
 
   [Parameter(Mandatory = $false)]
-  [string]$Version = "1.0.0"
+  [string]$Version = "1.1.0"
 )
 
 $ErrorActionPreference = "Stop"

pwshake/pwshake.psd1

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

pwshake/scripts/Execute-Step.ps1

@@ -15,7 +15,9 @@ function Execute-Step {
             return;
         }
 
-        if ($step.script) {
+        if ($step.template) {
+            Execute-Step $config (Normalize-Template $step $config)
+        } elseif ($step.script) {
             $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 `
@@ -32,13 +34,6 @@ function Execute-Step {
                 $cmd += $item
             }
             Cmd-Shell $cmd -errorMessage "$($step.name) failed."
-        } elseif ($step.msbuild) {
-            $msbuild = "msbuild"
-            if (${is-Linux}) { $msbuild = "dotnet msbuild" }
-            $msbuild += " $($step.msbuild.project)"
-            if ($step.msbuild.targets) { $msbuild += " /t:$($step.msbuild.targets)" }
-            if ($step.msbuild.properties) { $msbuild += " /p:$($step.msbuild.properties)" }
-            Cmd-Shell $msbuild -errorMessage "$($step.name) failed."
         } elseif ($step.invoke_tasks) {
             $tasks = Arrange-Tasks $config $step.invoke_tasks
             foreach ($task in $tasks) {

pwshake/scripts/Invoke-Step.ps1

@@ -26,7 +26,7 @@ function Invoke-Step {
       }
       Push-Location (Normalize-Path "$($step.work_dir)" $config)
 
-      Log-Output "Execute step: $($step.name)" $config 6>&1
+      Log-Output "Execute step: $($step.name)" $config
       $logOut = @()
       $global:LASTEXITCODE = 0
       Execute-Step $config $step *>&1 | Tee-Object -Variable logOut | Log-Output -config $config

pwshake/scripts/Invoke-Task.ps1

@@ -11,7 +11,7 @@ function global:Invoke-Task {
         [bool]$dryRun = $false
     )
     process {
-        Log-Output "Invoke task: $($task.name)" $config 6>&1
+        Log-Output "Invoke task: $($task.name)" $config
 
         if (-not (Invoke-Expression $task.when)) {
             Log-Output "`t`tBypassed because of when: [$($task.when)] = $(Invoke-Expression $task.when)" $config

pwshake/scripts/Invoke-pwshake.ps1

@@ -21,12 +21,12 @@ function Invoke-pwshake {
                     | Override-Attributes `
                     | Interpolate-Attributes
 
-        Log-Output "PWSHAKE config:" $config 6>&1
-        Log-Output "$(ConvertTo-Yaml $config)" $config 6>&1
+        Log-Output "PWSHAKE config:" $config
+        Log-Output "$(ConvertTo-Yaml $config)" $config
 
         $arranged_tasks = Arrange-Tasks $config
-        Log-Output "Arranged tasks:" $config 6>&1
-        Log-Output "$(ConvertTo-Yaml $arranged_tasks)" $config 6>&1
+        Log-Output "Arranged tasks:" $config
+        Log-Output "$(ConvertTo-Yaml $arranged_tasks)" $config
 
         try {
             Push-Location $config.attributes.work_dir

pwshake/scripts/Normalize-Config.ps1

@@ -11,6 +11,7 @@ function Normalize-Config {
             attributes_overrides = @() + (Coalesce $config.attributes_overrides,  @());
             scripts_directories = @() + (Coalesce $config.scripts_directories, @());
             tasks = Coalesce $config.tasks, $config.tasks, $config.roles, @{};
+            templates = Coalesce $config.templates, @{};
             invoke_tasks = @() + (Coalesce $config.invoke_tasks, $config.invoke_run_lists, $config.apply_roles,  @());
         }
     }

pwshake/scripts/Normalize-MsBuild.ps1

@@ -17,7 +17,7 @@ function Normalize-Step {
         } elseif ($item -is [Hashtable]) {
             if ($item.Keys.Length) {
                 $key = $item.Keys | Select-Object -First 1
-                $reserved_keys = @('name','script','powershell','cmd','msbuild','when','invoke_tasks','work_dir','on_error')
+                $reserved_keys = @('name','script','powershell','cmd','template', 'parameters','when','invoke_tasks','work_dir','on_error')
                 if ((-not ($key -in $reserved_keys)) -and ($item[$key] -is [hashtable])) {
                     $item = $item[$key]
                     $item.name = Coalesce $item.name, $key
@@ -29,14 +29,15 @@ function Normalize-Step {
 
         return @{
             name = Coalesce $item.name, "step_$([Math]::Abs($item.GetHashCode()))";
-            script = $item.script;
-            powershell = Coalesce $item.powershell, $item.pwsh, '';
-            cmd = Coalesce $item.cmd, $item.shell, '';
-            msbuild = (Normalize-MsBuild $item.msbuild $config);
             when = (Normalize-When $item);
-            invoke_tasks = Coalesce $item.invoke_tasks, $item.apply_roles, $item.invoke_run_lists, @();
-            work_dir = Coalesce $item.work_dir, $item.in, '';
+            work_dir = Coalesce $item.work_dir, $item.in;
             on_error = Coalesce $item.on_error, 'throw';
+            script = $item.script;
+            powershell = Coalesce $item.powershell, $item.pwsh;
+            cmd = Coalesce $item.cmd, $item.shell;
+            invoke_tasks = Coalesce $item.invoke_tasks, $item.apply_roles, $item.invoke_run_lists, @();
+            template = $item.template;
+            parameters = Coalesce $item.parameters, @{};
         }
     }
 }

pwshake/scripts/Normalize-Step.ps1

@@ -0,0 +1,35 @@
+function Normalize-Template {
+    [CmdletBinding()]
+    param (
+      [Parameter(Position = 0, Mandatory = $false)]
+      [hashtable]$item,
+
+      [Parameter(Position = 1, Mandatory = $false)]
+      [hashtable]$config = @{},
+
+      [Parameter(Position = 2, Mandatory = $false)]
+      [int]$depth = 0
+    )    
+    process {
+        $ErrorActionPreference = "Stop"
+
+        if ($depth -gt 100) {
+            throw "Circular reference detected for templates in:`n$(ConvertFrom-Yaml $item)"
+        }
+
+        if (-not $item) { return $null }
+
+        $step = Normalize-Step $config.templates[$item.template] $config
+        $step.parameters = Merge-Hashtables $step.parameters $item.parameters
+        $parameters = $step.parameters.Clone()
+        foreach ($param in $parameters.Keys) {
+            $step = ($step | ConvertTo-Yaml).Replace("[[$param]]", $parameters[$param]) | ConvertFrom-Yaml
+        }
+
+        if ($step.template) {
+            $step = Normalize-Template $step $config ($depth + 1)
+        }
+
+        return $step
+    }
+}