Merge pull request #164 from PowershellFrameworkCollective/actionsExt

FriedrichWeinmann · web-flow · commit 00ecf0b3526e · 2021-11-11T11:57:24.000+01:00
2.2.10.128
diff --git a/PSModuleDevelopment/PSModuleDevelopment.psd1 b/PSModuleDevelopment/PSModuleDevelopment.psd1
@@ -4,7 +4,7 @@
 	RootModule = 'PSModuleDevelopment.psm1'
 
 	# Version number of this module.
-	ModuleVersion = '2.2.10.123'
+	ModuleVersion = '2.2.10.128'
 
 	# ID used to uniquely identify this module
 	GUID = '37dd5fce-e7b5-4d57-ac37-832055ce49d6'
@@ -27,8 +27,8 @@
 	# Modules that must be imported into the global environment prior to importing
 	# this module
 	RequiredModules	       = @(
-		@{ ModuleName = 'PSFramework'; ModuleVersion = '1.6.198' }
-		@{ ModuleName = 'string'; ModuleVersion = '0.6.1' }
+		@{ ModuleName = 'PSFramework'; ModuleVersion = '1.6.205' }
+		@{ ModuleName = 'string'; ModuleVersion = '1.0.0' }
 	)
 
 	# Assemblies that must be loaded prior to importing this module
diff --git a/PSModuleDevelopment/bin/PSModuleDevelopment.dll b/PSModuleDevelopment/bin/PSModuleDevelopment.dll
diff --git a/PSModuleDevelopment/bin/PSModuleDevelopment.pdb b/PSModuleDevelopment/bin/PSModuleDevelopment.pdb
diff --git a/PSModuleDevelopment/bin/PSModuleDevelopment.xml b/PSModuleDevelopment/bin/PSModuleDevelopment.xml
diff --git a/PSModuleDevelopment/changelog.md b/PSModuleDevelopment/changelog.md
@@ -1,5 +1,13 @@
 ﻿# Changelog
 
+## 2.2.10.128 (2021-11-11)
+
++ New: Action: deployModule - Deploys a module to the target computer(s)
++ Upd: Invoke-PSMDBuildProject - Added parameter resolution from artifacts and configuration
++ Upd: Invoke-PSMDBuildProject - Added automatic artifacts resolution based on value of a parameter: %!Name!% will be resolved to the artifact named "Name".
++ Upd: Invoke-PSMDBuildProject - Added `-InheritArtifacts` parameter to allow keeping artifacts around created before starting the pipeline
++ Fix: Invoke-PSMDTemplate - Invoking templates on PS5.1 fails with invalid replace
+
 ## 2.2.10.123 (2021-07-21)
 
 - Fix: Template PSFProject - fixed string test modulename
diff --git a/PSModuleDevelopment/functions/build/Invoke-PSMDBuildProject.ps1 b/PSModuleDevelopment/functions/build/Invoke-PSMDBuildProject.ps1
@@ -18,23 +18,27 @@
 		Mandatory if no build project has been selected as the default project.
 		Use the Select-PSMDBuildProject to define a default project (and optionally persist the choice across sessions)
 	
+	.PARAMETER InheritArtifacts
+		Accept artifacts that were generated before ever executing this pipeline.
+		By default, any artifacts previously provisioned are cleared on pipeline start.
+	
 	.PARAMETER RetainArtifacts
 		Whether, after executing the project, its artifacts should be retained.
 		By default, any artifacts created during a build project will be discarded upon project completion.
-	
+		
 		Artifacts are similar to variables to the pipeline and can be used to pass data throughout the pipeline.
 		
 		+ Use Publish-PSMDBuildArtifact to create a new artifact.
 		+ Use Get-PSMDBuildArtifact to access existing build artifacts.
 	
 	.EXAMPLE
 		PS C:\> Invoke-PSMDBuildProject -Path .\VMDeployment.build.Json
-	
+		
 		Execute the build file "VMDeployment.build.json" from the current folder
 	
 	.EXAMPLE
 		PS C:\> build
-	
+		
 		Execute the default build project.
 #>
 	[Alias('build')]
@@ -43,12 +47,17 @@
 		[string]
 		$Path,
 		
+		[switch]
+		$InheritArtifacts,
+		
 		[switch]
 		$RetainArtifacts
 	)
 	
 	begin {
-		$script:buildArtifacts = @{ }
+		if (-not $InheritArtifacts) {
+			$script:buildArtifacts = @{ }
+		}
 		$buildStatus = @{ }
 		
 		$projectPath = $Path
@@ -158,6 +167,10 @@
 			}
 			if (-not $parameters.Parameters) { $parameters.Parameters = @{ } }
 			if (-not $parameters.ParametersFromArtifacts) { $parameters.ParametersFromArtifacts = @{ } }
+			
+			# Resolve Parameters
+			$parameters.Parameters = Resolve-PSMDBuildStepParameter -Parameters $parameters.Parameters -FromArtifacts $parameters.ParametersFromArtifacts -ProjectName $parameters.ProjectName -StepName $parameters.StepName
+			
 			try { $null = & $actionObject.Action $parameters }
 			catch {
 				Write-StepResult @resultDef -Status Failed -Data $_ -ContinueLabel main
diff --git a/PSModuleDevelopment/functions/build/Resolve-PSMDBuildStepParameter.ps1 b/PSModuleDevelopment/functions/build/Resolve-PSMDBuildStepParameter.ps1
@@ -1,11 +1,18 @@
 ﻿function Resolve-PSMDBuildStepParameter {
 <#
 	.SYNOPSIS
-		Update missing build action parameters from the configuration system.
+		Resolves and consolidates the overall parameters of a given step.
 	
 	.DESCRIPTION
-		Update missing build action parameters from the configuration system.
-		This command is for use within the defined code of build actions.
+		Resolves and consolidates the overall parameters of a given step.
+		This ensures that individual actions do not have to implement manual resolution and complex conditionals.
+		Sources of parameters:
+		- Explicitly defined parameter in the step
+		- Value from Artifacts
+		- Value from Configuration (only if not otherwise sourced)
+		- Value from implicit artifact resolution: Any value that is formatted like this:
+		  "%!NameOfArtifact!%" will be replaced with the value of the artifact of the same name.
+		  This supports wildcard resolution, so "%!Session.*!%" will resolve to all artifacts with a name starting with "Session."
 	
 	.PARAMETER Parameters
 		The hashtable containing the currently specified parameters from the step configuration within the build project file.
@@ -64,6 +71,14 @@
 			$Parameters[$pair.Key] = (Get-PSMDBuildArtifact -Name $pair.Value).Value
 		}
 		
+		# Resolve implicit artifact references
+		foreach ($key in $($Parameters.Keys)) {
+			if ($Parameters.$key -notlike '%!*!%') { continue }
+			
+			$artifactName = $Parameters.$key -replace '^%!(.+?)!%$', '$1'
+			$Parameters[$Key] = (Get-PSMDBuildArtifact -Name $artifactName).Value
+		}
+		
 		$Parameters
 	}
 }
diff --git a/PSModuleDevelopment/functions/templating/Invoke-PSMDTemplate.ps1 b/PSModuleDevelopment/functions/templating/Invoke-PSMDTemplate.ps1
@@ -320,10 +320,10 @@
 				$fileName = $Item.Name
 				if (-not $Raw) {
 					foreach ($param in $Item.FileSystemParameterFlat) {
-						$fileName = $fileName.Replace("$($identifier)$($param)$($identifier)", $ParameterFlat[$param], $true, $null)
+						$fileName = [PSModuleDevelopment.Utility.UtilityHost]::Replace($fileName,"$($identifier)$($param)$($identifier)", $ParameterFlat[$param], $false)
 					}
 					foreach ($param in $Item.FileSystemParameterScript) {
-						$fileName = $fileName.Replace("$($identifier)$($param)$($identifier)", $ParameterScript[$param], $true, $null)
+						$fileName = [PSModuleDevelopment.Utility.UtilityHost]::Replace($fileName, "$($identifier)$($param)$($identifier)", $ParameterScript[$param], $false)
 					}
 				}
 				$destPath = Join-Path $Path $fileName
@@ -332,10 +332,10 @@
 					$text = $Item.Value
 					if (-not $Raw) {
 						foreach ($param in $Item.ContentParameterFlat) {
-							$text = $text.Replace("$($identifier)$($param)$($identifier)", $ParameterFlat[$param], $true, $null)
+							$text = [PSModuleDevelopment.Utility.UtilityHost]::Replace($text, "$($identifier)$($param)$($identifier)", $ParameterFlat[$param], $false)
 						}
 						foreach ($param in $Item.ContentParameterScript) {
-							$text = $text.Replace("$($identifier)!$($param)!$($identifier)", $ParameterScript[$param], $true, $null)
+							$text = [PSModuleDevelopment.Utility.UtilityHost]::Replace($text, "$($identifier)!$($param)!$($identifier)", $ParameterScript[$param], $false)
 						}
 					}
 					[System.IO.File]::WriteAllText($destPath, $text, $Encoding)
diff --git a/PSModuleDevelopment/internal/buildActions/command.action.ps1 b/PSModuleDevelopment/internal/buildActions/command.action.ps1
@@ -5,7 +5,6 @@
 	
 	$rootPath = $Parameters.RootPath
 	$actualParameters = $Parameters.Parameters
-	$actualParameters = Resolve-PSMDBuildStepParameter -Parameters $actualParameters -FromArtifacts $Parameters.ParametersFromArtifacts -ProjectName $Parameters.ProjectName -StepName $Parameters.StepName
 	
 	#region Process Parameters
 	if (-not $actualParameters.Command) {
diff --git a/PSModuleDevelopment/internal/buildActions/copy-item.action.ps1 b/PSModuleDevelopment/internal/buildActions/copy-item.action.ps1
@@ -5,7 +5,6 @@
 	
 	$rootPath = $Parameters.RootPath
 	$actualParameters = $Parameters.Parameters
-	$actualParameters = Resolve-PSMDBuildStepParameter -Parameters $actualParameters -FromArtifacts $Parameters.ParametersFromArtifacts -ProjectName $Parameters.ProjectName -StepName $Parameters.StepName
 	
 	#region Utility Functions
 	function ConvertTo-PSSession {
diff --git a/PSModuleDevelopment/internal/buildActions/deployModule.action.ps1 b/PSModuleDevelopment/internal/buildActions/deployModule.action.ps1
@@ -0,0 +1,92 @@
+﻿$action = {
+	param (
+		$Parameters
+	)
+
+	trap {
+		if ($workingDirectory) {
+			Remove-Item -Path $workingDirectory -Recurse -Force -ErrorAction SilentlyContinue
+		}
+		throw $_
+	}
+	
+	$rootPath = $Parameters.RootPath
+	$actualParameters = $Parameters.Parameters
+	
+	#region Validate Input
+	if (-not $actualParameters.Session) {
+		throw "No Sessions specified!"
+	}
+	
+	if ($actualParameters.Session | Where-Object State -NE Opened) {
+		throw "Sessions not open!"
+	}
+	if ($actualParameters.Repository -and (-not (Get-PSRepository -Name $actualParameters.Repository -ErrorAction Ignore))) {
+		throw "Repository $($actualParameters.Repository) not found!"
+	}
+	
+	foreach ($module in $actualParameters.Module) {
+		if ($module -notmatch '\\|/') { continue }
+		
+		try { $null = Resolve-PSFPath -Path $module -Provider FileSystem }
+		catch { throw "Unable to resolve path: $module"}
+	}
+	#endregion Validate Input
+	
+	#region Prepare modules to transfer
+	$workingDirectory = Join-Path -Path (Get-PSFPath -Name temp) -ChildPath "psmd_action_$(Get-Random)"
+	$null = New-Item -Path $workingDirectory -ItemType Directory -Force -ErrorAction Stop
+	
+	$saveModuleParam = @{
+		Path = $workingDirectory
+		Repository = $actualParameters.Repository
+	}
+	
+	foreach ($module in $actualParameters.Module) {
+		if ($module -notmatch '\\|/') {
+			if ($actualParameters.Repository) {
+				Save-Module $module @saveModuleParam
+				continue
+			}
+			$moduleObject = Get-Module -Name $module -ListAvailable | Sort-Object Version -Descending | Select-Object -First 1
+			if (-not $moduleObject) {
+				throw "Cannot find module $module!"
+			}
+			Copy-Item -Path $moduleObject.ModuleBase -Destination "$workingDirectory\$($moduleObject.Name)" -Recurse -Force
+			continue
+		}
+		
+		foreach ($path in Resolve-PSFPath -Path $module -Provider FileSystem) {
+			if (Test-Path -LiteralPath $path -PathType Leaf) { $path = Split-Path -LiteralPath $path }
+			Copy-Item -LiteralPath $path -Destination $workingDirectory -Recurse -Force
+		}
+	}
+	#endregion Prepare modules to transfer
+	
+	foreach ($moduleFolder in Get-ChildItem -Path $workingDirectory) {
+		if (-not $actualParameters.NoDelete) {
+			Invoke-Command -Session $actualParameters.Session -ScriptBlock {
+				param ($Name)
+				if (-not (Test-Path -Path "$env:ProgramFiles\WindowsPowerShell\Modules\$Name")) { return }
+				Remove-Item -Path "$env:ProgramFiles\WindowsPowerShell\Modules\$Name" -Recurse -Force
+			} -ArgumentList $moduleFolder.Name
+		}
+		foreach ($session in $actualParameters.Session) {
+			Copy-Item -LiteralPath $moduleFolder.FullName -Destination "$env:ProgramFiles\WindowsPowerShell\Modules" -Recurse -Force -ToSession $session -ErrorAction Stop
+		}
+	}
+}
+
+$params = @{
+	Name	    = 'deployModule'
+	Action	    = $action
+	Description = 'Deploys a module to the target computer(s)'
+	Parameters  = @{
+		Session    = '(mandatory) The PSRemoting sessions to deploy the module through.'
+		Module	   = '(mandatory) A list of names or paths of modules to deploy. Can be used in any combination, specifying by name will use the latest version found on the local computer unless also using he "Repository" parameter to specify an alternate source.'
+		Repository = 'The repository from which to download the module(s) (and any dependencies). Modules will be sourced locally if empty.'
+		NoDelete   = '[bool] Whether to keep other versions of the target module on the remote machine. By default, all other versions will be deleted.'
+	}
+}
+
+Register-PSMDBuildAction @params
diff --git a/PSModuleDevelopment/internal/buildActions/new-pssession.action.ps1 b/PSModuleDevelopment/internal/buildActions/new-pssession.action.ps1
@@ -5,7 +5,6 @@
 	
 	$rootPath = $Parameters.RootPath
 	$actualParameters = $Parameters.Parameters
-	$actualParameters = Resolve-PSMDBuildStepParameter -Parameters $actualParameters -FromArtifacts $Parameters.ParametersFromArtifacts -ProjectName $Parameters.ProjectName -StepName $Parameters.StepName
 	
 	if (-not $actualParameters.ArtifactName) { throw "No ArtifactName specified! Unable to publish remoting session for build." }
 	if (-not ($actualParameters.VMName -or $actualParameters.ComputerName)) { throw "Neither ComputerName nor VMName specified, unable to connect to nothing!" }
diff --git a/PSModuleDevelopment/internal/buildActions/remove-item.action.ps1 b/PSModuleDevelopment/internal/buildActions/remove-item.action.ps1
@@ -5,7 +5,6 @@
 	
 	$rootPath = $Parameters.RootPath
 	$actualParameters = $Parameters.Parameters
-	$actualParameters = Resolve-PSMDBuildStepParameter -Parameters $actualParameters -FromArtifacts $Parameters.ParametersFromArtifacts -ProjectName $Parameters.ProjectName -StepName $Parameters.StepName
 	
 	if (-not $actualParameters.Path) {
 		throw "Invalid parameters! Specify a Path to delete."
diff --git a/PSModuleDevelopment/internal/buildActions/remove-pssession.action.ps1 b/PSModuleDevelopment/internal/buildActions/remove-pssession.action.ps1
@@ -5,7 +5,6 @@
 	
 	$rootPath = $Parameters.RootPath
 	$actualParameters = $Parameters.Parameters
-	$actualParameters = Resolve-PSMDBuildStepParameter -Parameters $actualParameters -FromArtifacts $Parameters.ParametersFromArtifacts -ProjectName $Parameters.ProjectName -StepName $Parameters.StepName
 	
 	if ($actualParameters.All) {
 		foreach ($artifact in Get-PSMDBuildArtifact -Tag pssession) {
diff --git a/PSModuleDevelopment/internal/buildActions/script.action.ps1 b/PSModuleDevelopment/internal/buildActions/script.action.ps1
@@ -5,7 +5,6 @@
 	
 	$rootPath = $Parameters.RootPath
 	$actualParameters = $Parameters.Parameters
-	$actualParameters = Resolve-PSMDBuildStepParameter -Parameters $actualParameters -FromArtifacts $Parameters.ParametersFromArtifacts -ProjectName $Parameters.ProjectName -StepName $Parameters.StepName
 	
 	#region Process Parameters
 	if (-not $actualParameters.Path) {
diff --git a/library/PSModuleDevelopment/PSModuleDevelopment/Utility/UtilityHost.cs b/library/PSModuleDevelopment/PSModuleDevelopment/Utility/UtilityHost.cs
@@ -1,9 +1,7 @@
 ﻿using System;
 using System.Collections.Generic;
-using System.Linq;
 using System.Management.Automation.Host;
 using System.Text;
-using System.Threading.Tasks;
 
 namespace PSModuleDevelopment.Utility
 {
@@ -124,5 +122,58 @@ private static HashSet<char> CharListToSet(string charList)
             }
             return set;
         }
+
+        /// <summary>
+        /// Replace a value in a string with another.
+        /// Extends the default c# String.Replace with the capability to be case-insensitive.
+        /// </summary>
+        /// <param name="String">The string to modify</param>
+        /// <param name="OldString">The value to look for and replace with someting else</param>
+        /// <param name="NewString">The value to insert where you found the previous value. Leave empty to just delete the original value.</param>
+        /// <param name="CaseSensitive">Whether to be case sensitive in your replacement. Defaults to false, this being PowerShell</param>
+        /// <returns>The original string, with all instances of the looked for value replaced with the new value.</returns>
+        public static string Replace(string String, string OldString, string NewString, bool CaseSensitive = false)
+        {
+            // Validate User Inputs (emulating the original C# behavior
+            if (String == null)
+                throw new ArgumentNullException(nameof(String));
+            if (String.Length == 0)
+                return String;
+            if (OldString == null)
+                throw new ArgumentNullException(nameof(OldString));
+            if (OldString.Length == 0)
+                throw new ArgumentException("String cannot be of zero length.");
+
+            StringComparison comparisonType = StringComparison.OrdinalIgnoreCase;
+            if (CaseSensitive)
+                comparisonType = StringComparison.Ordinal;
+
+
+            StringBuilder resultStringBuilder = new StringBuilder();
+
+            bool isReplacementNullOrEmpty = string.IsNullOrEmpty(NewString);
+
+            int foundAt;
+            int startSearchFromIndex = 0;
+            while ((foundAt = String.IndexOf(OldString, startSearchFromIndex, comparisonType)) != -1)
+            {
+                int charsUntilReplacement = foundAt - startSearchFromIndex;
+                bool isNothingToAppend = charsUntilReplacement == 0;
+                if (!isNothingToAppend)
+                    resultStringBuilder.Append(String, startSearchFromIndex, charsUntilReplacement);
+                
+                // Process the replacement.
+                if (!isReplacementNullOrEmpty)
+                    resultStringBuilder.Append(NewString);
+                
+                // Reset Search Index
+                startSearchFromIndex = foundAt + OldString.Length;
+                if (startSearchFromIndex == String.Length)
+                    return resultStringBuilder.ToString();
+            }
+
+            resultStringBuilder.Append(String, startSearchFromIndex, (String.Length - startSearchFromIndex));
+            return resultStringBuilder.ToString();
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -320,10 +320,10 @@`
`320`	`320`	`$fileName = $Item.Name`
`321`	`321`	`if (-not $Raw) {`
`322`	`322`	`foreach ($param in $Item.FileSystemParameterFlat) {`
`323`		`- $fileName = $fileName.Replace("$($identifier)$($param)$($identifier)", $ParameterFlat[$param], $true, $null)`
	`323`	`+ $fileName = [PSModuleDevelopment.Utility.UtilityHost]::Replace($fileName,"$($identifier)$($param)$($identifier)", $ParameterFlat[$param], $false)`
`324`	`324`	`}`
`325`	`325`	`foreach ($param in $Item.FileSystemParameterScript) {`
`326`		`- $fileName = $fileName.Replace("$($identifier)$($param)$($identifier)", $ParameterScript[$param], $true, $null)`
	`326`	`+ $fileName = [PSModuleDevelopment.Utility.UtilityHost]::Replace($fileName, "$($identifier)$($param)$($identifier)", $ParameterScript[$param], $false)`
`327`	`327`	`}`
`328`	`328`	`}`
`329`	`329`	`$destPath = Join-Path $Path $fileName`
`@@ -332,10 +332,10 @@`
`332`	`332`	`$text = $Item.Value`
`333`	`333`	`if (-not $Raw) {`
`334`	`334`	`foreach ($param in $Item.ContentParameterFlat) {`
`335`		`- $text = $text.Replace("$($identifier)$($param)$($identifier)", $ParameterFlat[$param], $true, $null)`
	`335`	`+ $text = [PSModuleDevelopment.Utility.UtilityHost]::Replace($text, "$($identifier)$($param)$($identifier)", $ParameterFlat[$param], $false)`
`336`	`336`	`}`
`337`	`337`	`foreach ($param in $Item.ContentParameterScript) {`
`338`		`- $text = $text.Replace("$($identifier)!$($param)!$($identifier)", $ParameterScript[$param], $true, $null)`
	`338`	`+ $text = [PSModuleDevelopment.Utility.UtilityHost]::Replace($text, "$($identifier)!$($param)!$($identifier)", $ParameterScript[$param], $false)`
`339`	`339`	`}`
`340`	`340`	`}`
`341`	`341`	`[System.IO.File]::WriteAllText($destPath, $text, $Encoding)`