Merge pull request #5 from PowershellFrameworkCollective/tests-Upgrade

Complete Tests overhaul

Author: FriedrichWeinmann

PSModuleDevelopment/PSModuleDevelopment.psm1

@@ -1,5 +1,5 @@
-$script:PSModuleDevelopmentModuleRoot = $PSScriptRoot
-$script:PSModuleDevelopmentModuleVersion = '2.0.0.0'
+$script:PSModuleRoot = $PSScriptRoot
+$script:PSModuleVersion = "2.0.0.0"
 
 $script:doDotSource = $false
 if (Get-PSFConfigValue -Name PSModuleDevelopment.Import.DoDotSource) { $script:doDotSource = $true }
@@ -36,14 +36,14 @@ function Import-PSMDFile
 
 
 # Perform Actions before loading the rest of the content
-. Import-PSMDFile -Path "$PSModuleDevelopmentModuleRoot\internal\scripts\preload.ps1"
+. Import-PSMDFile -Path "$PSModuleRoot\internal\scripts\preload.ps1"
 
 #region Load functions
-foreach ($function in (Get-ChildItem "$PSModuleDevelopmentModuleRoot\functions" -Recurse -File -Filter "*.ps1"))
+foreach ($function in (Get-ChildItem "$PSModuleRoot\functions" -Recurse -File -Filter "*.ps1"))
 {
 	. Import-PSMDFile -Path $function.FullName
 }
 #endregion Load functions
 
 # Perform Actions after loading the module contents
-. Import-PSMDFile -Path "$PSModuleDevelopmentModuleRoot\internal\scripts\postload.ps1"
+. Import-PSMDFile -Path "$PSModuleRoot\internal\scripts\postload.ps1"

PSModuleDevelopment/PSModuleDevelopment.psproj

@@ -11,7 +11,7 @@
     <Folder>functions\performance</Folder>
     <Folder>functions\help</Folder>
     <Folder>snippets</Folder>
-    <Folder>functions\wix</Folder>
+    <Folder>internal\functions\wix</Folder>
     <Folder>internal</Folder>
     <Folder>internal\configurations</Folder>
     <Folder>functions\format</Folder>
@@ -22,6 +22,7 @@
     <Folder>tests</Folder>
     <Folder>tests\functions</Folder>
     <Folder>tests\general</Folder>
+    <Folder>internal\functions</Folder>
   </Folders>
   <Files>
     <File Build="2">PSModuleDevelopment.psd1</File>
@@ -38,10 +39,10 @@
     <File Build="2" Shared="False" ReferenceFunction="Invoke-New-PssModuleProject_ps1">functions\utility\New-PssModuleProject.ps1</File>
     <File Build="2">en-us\about_psmoduledevelopment.help.txt</File>
     <File Build="2" Shared="False" ReferenceFunction="Invoke-Set-PSMDModulePath_ps1">functions\utility\Set-PSMDModulePath.ps1</File>
-    <File Build="2" Shared="True" ReferenceFunction="Invoke-Get-PSMDWixConfig_ps1">functions\wix\Get-PSMDWixConfig.ps1</File>
-    <File Build="2" Shared="True" ReferenceFunction="Invoke-Set-PSMDWixConfig_ps1">functions\wix\Set-PSMDWixConfig.ps1</File>
-    <File Build="2" Shared="True" ReferenceFunction="Invoke-Invoke-PSMDWixBuild_ps1">functions\wix\Invoke-PSMDWixBuild.ps1</File>
-    <File Build="2" Shared="False" ReferenceFunction="Invoke-Invoke-PSMDWixBuild2_ps1">functions\wix\Invoke-PSMDWixBuild2.ps1</File>
+    <File Build="2" Shared="True" ReferenceFunction="Invoke-Get-PSMDWixConfig_ps1">internal\functions\wix\Get-PSMDWixConfig.ps1</File>
+    <File Build="2" Shared="True" ReferenceFunction="Invoke-Set-PSMDWixConfig_ps1">internal\functions\wix\Set-PSMDWixConfig.ps1</File>
+    <File Build="2" Shared="True" ReferenceFunction="Invoke-Invoke-PSMDWixBuild_ps1">internal\functions\wix\Invoke-PSMDWixBuild.ps1</File>
+    <File Build="2" Shared="False" ReferenceFunction="Invoke-Invoke-PSMDWixBuild2_ps1">internal\functions\wix\Invoke-PSMDWixBuild2.ps1</File>
     <File Build="2" Shared="False" ReferenceFunction="Invoke-wix_ps1">internal\configurations\wix.ps1</File>
     <File Build="2" Shared="False" ReferenceFunction="Invoke-debug_ps1">internal\configurations\debug.ps1</File>
     <File Build="2" Shared="False" ReferenceFunction="Invoke-license_ps1">internal\scripts\license.ps1</File>

PSModuleDevelopment/en-us/about_psmoduledevelopment.help.txt

@@ -132,7 +132,7 @@ LONG DESCRIPTION
 	#                           The Need for Speed                            #
 	#-------------------------------------------------------------------------#
 
-	Speed matters. 
+	Speed matters.
 	In order to develop high performance code however, you need to have the
 	tools to measure speed accurately. PowerShell has out of the box a tool
 	that helps with that: 'Measure-Command'
@@ -165,6 +165,10 @@ LONG DESCRIPTION
 	#                                Changelog                                #
 	#-------------------------------------------------------------------------#
 
+	2.1.0.1 (???)
+	  - new: Included suite of tests, in order to provide a more reliable user
+	         experience.
+	
 	2.0.0.0 (December 18th, 2017)
 	  - Breaking change: Renamed all commands to include the PSMD prefix
 	  - New function: Find-PSMDFileContent (alias: find), to swiftly search in
@@ -206,7 +210,7 @@ LONG DESCRIPTION
 	  - New Alias: hex --> Get-HelpEx
 	    Because getting help should be simple.
 
-	1.2.0.0 (August 15th, 2016): 
+	1.2.0.0 (August 15th, 2016):
 	  - New function: Get-ExHelp
 	    Provides localized help to better test modules with localized help
 		content.

PSModuleDevelopment/functions/assembly/Expand-PSMDTypeName.ps1

@@ -25,7 +25,7 @@
 	{
 		foreach ($item in $InputObject)
 		{
-			if ($item -eq $null) { continue }
+			if ($null -eq $item) { continue }
 
 			$type = $item.GetType()
 			if ($type.FullName -eq "System.RuntimeType") { $type = $item }

PSModuleDevelopment/functions/assembly/Get-PSMDConstructor.ps1

@@ -41,7 +41,7 @@
 	{
 		foreach ($item in $InputObject)
 		{
-			if ($item -eq $null) { continue }
+			if ($null -eq $item) { continue }
 			if ($item -is [System.Type]) { $type = $item }
 			else { $type = $item.GetType() }
 

PSModuleDevelopment/functions/format/New-PSMDFormatTableDefinition.ps1

@@ -37,6 +37,7 @@
 	
 			Creates a format xml that only includes the columns LastWriteTime, FullName
 	#>
+	[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
 	[CmdletBinding()]
 	Param (
 		[Parameter(Mandatory = $true, ValueFromPipeline = $true)]

PSModuleDevelopment/functions/moduledebug/Remove-PSMDModuleDebug.ps1

@@ -9,6 +9,12 @@
 		
 		.PARAMETER Name
 			Name of modules whose debugging configuration should be removed.
+	
+		.PARAMETER Confirm
+			If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.
+		
+		.PARAMETER WhatIf
+			If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.
 		
 		.EXAMPLE
 			PS C:\> Remove-PSMDModuleDebug -Name "cPSNetwork"

PSModuleDevelopment/functions/moduledebug/Set-PSMDModuleDebug.ps1

@@ -28,12 +28,22 @@
 		.PARAMETER PostImportAction
 			Any scriptblock that should run after importing the module.
 			Only used when importing modules using the "Invoke-ModuleDebug" funtion, as his used for modules set to auto-import.
+	
+		.PARAMETER Priority
+			When importing modules in a debugging context, they are imported in the order of their priority.
+			The lower the number, the sooner it is imported.
 		
 		.PARAMETER AllAutoImport
 			Changes all registered modules to automatically import on powershell launch.
 		
 		.PARAMETER NoneAutoImport
 			Changes all registered modules to not automatically import on powershell launch.
+	
+		.PARAMETER Confirm
+			If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.
+		
+		.PARAMETER WhatIf
+			If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.
 		
 		.EXAMPLE
 			PS C:\> Set-PSMDModuleDebug -Name 'cPSNetwork' -AutoImport
@@ -60,7 +70,8 @@
 			Author: Friedrich Weinmann
 			Created on: August 7th, 2016
 	#>
-	[CmdletBinding(DefaultParameterSetName = "Name")]
+	[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
+	[CmdletBinding(DefaultParameterSetName = "Name", SupportsShouldProcess = $true)]
 	Param (
 		[Parameter(Mandatory = $true, Position = 0, ParameterSetName = "Name")]
 		[Alias('n')]
@@ -106,25 +117,31 @@
 	if ($AllAutoImport)
 	{
 		$allModules = Import-Clixml $PSModuleDevelopment_ModuleConfigPath
-		foreach ($module in $allModules)
+		if ($PSCmdlet.ShouldProcess(($allModules.Name -join ", "), "Configuring modules to automatically import"))
 		{
-			$module.AutoImport = $true
+			foreach ($module in $allModules)
+			{
+				$module.AutoImport = $true
+			}
+			Export-Clixml -InputObject $allModules -Path $PSModuleDevelopment_ModuleConfigPath
 		}
-		Export-Clixml -InputObject $allModules -Path $PSModuleDevelopment_ModuleConfigPath
 	}
 	#endregion AllAutoImport
 
-	#region AllAutoImport
+	#region NoneAutoImport
 	if ($NoneAutoImport)
 	{
 		$allModules = Import-Clixml $PSModuleDevelopment_ModuleConfigPath
-		foreach ($module in $allModules)
+		if ($PSCmdlet.ShouldProcess(($allModules.Name -join ", "), "Configuring modules to not automatically import"))
 		{
-			$module.AutoImport = $false
+			foreach ($module in $allModules)
+			{
+				$module.AutoImport = $false
+			}
+			Export-Clixml -InputObject $allModules -Path $PSModuleDevelopment_ModuleConfigPath
 		}
-		Export-Clixml -InputObject $allModules -Path $PSModuleDevelopment_ModuleConfigPath
 	}
-	#endregion AllAutoImport
+	#endregion NoneAutoImport
 
 	#region Name
 	# Import all module-configurations
@@ -133,11 +150,11 @@
 	# If a configuration already exists, change only those values that were specified
 	if ($module = $allModules | Where-Object { $_.Name -eq $Name })
 	{
-		if ($PSBoundParameters.ContainsKey("AutoImport")) { $module.AutoImport = $AutoImport.ToBool() }
-		if ($PSBoundParameters.ContainsKey("DebugMode")) { $module.DebugMode = $DebugMode.ToBool() }
-		if ($PSBoundParameters.ContainsKey("PreImportAction")) { $module.PreImportAction = $PreImportAction }
-		if ($PSBoundParameters.ContainsKey("PostImportAction")) { $module.PostImportAction = $PostImportAction }
-		if ($PSBoundParameters.ContainsKey("Priority")) { $module.Priority = $Priority }
+		if (Test-PSFParameterBinding -ParameterName "AutoImport") { $module.AutoImport = $AutoImport.ToBool() }
+		if (Test-PSFParameterBinding -ParameterName "DebugMode") { $module.DebugMode = $DebugMode.ToBool() }
+		if (Test-PSFParameterBinding -ParameterName "PreImportAction") { $module.PreImportAction = $PreImportAction }
+		if (Test-PSFParameterBinding -ParameterName "PostImportAction") { $module.PostImportAction = $PostImportAction }
+		if (Test-PSFParameterBinding -ParameterName "Priority") { $module.Priority = $Priority }
 	}
 	# If no configuration exists yet, create a new one with all parameters as specified
 	else
@@ -154,7 +171,10 @@
 
 	# Add new module configuration to all (if any) other previous configurations and export it to config file
 	$newModules = @(($allModules | Where-Object { $_.Name -ne $Name }), $module)
-	Export-Clixml -InputObject $newModules -Path $PSModuleDevelopment_ModuleConfigPath
+	if ($PSCmdlet.ShouldProcess($name, "Changing debug settings for module"))
+	{
+		Export-Clixml -InputObject $newModules -Path $PSModuleDevelopment_ModuleConfigPath
+	}
 	#endregion Name
 }
 Set-Alias -Name smd -Value Set-PSMDModuleDebug -Option AllScope -Scope Global

PSModuleDevelopment/functions/performance/Measure-PSMDCommandEx.ps1

@@ -54,7 +54,7 @@
 	#>
 	DynamicParam
 	{
-		# Create the dictionary 
+		# Create the dictionary
 		$______RuntimeParameterDictionary = New-Object System.Management.Automation.RuntimeDefinedParameterDictionary
 
 		#region Prepare ScriptBlock Parameter

PSModuleDevelopment/functions/refactor/Rename-PSMDParameter.ps1

@@ -59,6 +59,10 @@
 			
 			Renames the parameter 'Foo' of the command 'Get-Test' to 'Bar' for all scripts stored in 'C:\Scripts\Modules\MyModule'
 	#>
+	[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
+	[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSupportsShouldProcess", "")]
+	[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseDeclaredVarsMoreThanAssignments", "")]
+	[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseOutputTypeCorrectly", "")]
 	[CmdletBinding()]
 	Param (
 		[Parameter(Mandatory = $true)]
@@ -265,7 +269,7 @@
 				foreach ($property in $Ast.PSObject.Properties)
 				{
 					if ($property.Name -eq "Parent") { continue }
-					if ($property.Value -eq $null) { continue }
+					if ($null -eq $property.Value) { continue }
 
 					if (Get-Member -InputObject $property.Value -Name GetEnumerator -MemberType Method)
 					{
@@ -303,7 +307,7 @@
 		if ($name -notlike "-*") { $name = "-$name" }
 
 		$length = $Ast.Extent.EndOffset - $Ast.Extent.StartOffset
-		if ($Ast.Argument -ne $null) { $length = $Ast.Argument.Extent.StartOffset - $Ast.Extent.StartOffset - 1 }
+		if ($null -ne $Ast.Argument) { $length = $Ast.Argument.Extent.StartOffset - $Ast.Extent.StartOffset - 1 }
 
 		Add-FileReplacement -Path $Ast.Extent.File -Start $Ast.Extent.StartOffset -Length $length -NewContent $name
 	}
@@ -406,6 +410,7 @@
 
 	function Apply-FileReplacement
 	{
+		[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseApprovedVerbs", "")]
 		[CmdletBinding()]
 		Param (
 			[bool]
@@ -466,22 +471,6 @@
 		}
 	}
 
-	<#
-	$param = $com.Parameters.$Name
-	if ($param -eq $null)
-	{
-		Stop-PSFFunction -Message "Parameter $param not found on command $Command" -EnableException $EnableException -Category ObjectNotFound -Tag "fail", "input"
-		return
-	}
-	
-	$names = @()
-	$names += $param.Name
-	foreach ($alias in $param.Attributes.AliasNames)
-	{
-		if ($alias.Length -gt 0) { $names += $alias }
-	}
-	#>
-	
 	$files = Get-ChildItem -Path $Path -Recurse | Where-Object Extension -Match "\.ps1|\.psm1"
 
 	$issues = @()