Merge: 0.7.5

d365fo.tools/d365fo.tools.psd1

@@ -3,7 +3,7 @@
 	RootModule        = 'd365fo.tools.psm1'
 
 	# Version number of this module.
-	ModuleVersion     = '0.7.4'
+	ModuleVersion     = '0.7.5'
 
 	# ID used to uniquely identify this module
 	GUID              = '7c7b26d4-f764-4cb0-a692-459a0a689dbb'
@@ -156,6 +156,7 @@
 		'Get-D365RunbookLogFile',
 
 		'Get-D365SDPCleanUp',
+		'Get-D365SDPDetails',
 
 		'Get-D365Table',
 		'Get-D365TableField',

d365fo.tools/d365fo.tools.psm1

@@ -1,5 +1,5 @@
 $script:ModuleRoot = $PSScriptRoot
-$script:ModuleVersion = "0.7.4"
+$script:ModuleVersion = "0.7.5"
 
 # Detect whether at some level dotsourcing was enforced
 $script:doDotSource = Get-PSFConfigValue -FullName d365fo.tools.Import.DoDotSource -Fallback $false

d365fo.tools/functions/get-d365sdpdetails.ps1

@@ -0,0 +1,168 @@
+
+<#
+    .SYNOPSIS
+        Get details from the Software Deployable Package
+
+    .DESCRIPTION
+        Details details about the inner modules / packages that a Software Deployable Contains
+
+    .PARAMETER Path
+        Path to the Software Deployable Package that you want to work against
+
+        The cmdlet supports a path to a zip-file or directory with the unpacked content
+
+    .EXAMPLE
+        PS C:\> Get-D365SDPDetails -Path 'C:\Temp\RV-10.0.36.44.zip'
+
+        This will display the basic details about the package.
+        The package is a zip file.
+
+        A result set example:
+
+        Platform PlatformVersion Modules
+        -------- --------------- -------
+        Update55 7.0.6651.92     {@{Name=RapidValue; Version=7.0.6651.92}, @{Name=TCLCommon; Version=7.0.6651.92}, @{Name=TC...
+
+    .EXAMPLE
+        PS C:\> Get-D365SDPDetails -Path 'C:\Temp\RV-10.0.36.44'
+
+        This will display the basic details about the package.
+        The package is extracted to a local folder.
+
+        A result set example:
+
+        Platform PlatformVersion Modules
+        -------- --------------- -------
+        Update55 7.0.6651.92     {@{Name=RapidValue; Version=7.0.6651.92}, @{Name=TCLCommon; Version=7.0.6651.92}, @{Name=TC...
+
+    .EXAMPLE
+        PS C:\> Get-D365SDPDetails -Path 'C:\Temp\RV-10.0.36.44.zip' | Select-Object -ExpandProperty Modules
+
+        This will display the module details that are part of the package.
+        The package is a zip file.
+
+        A result set example:
+
+        Name       Version
+        ----       -------
+        RapidValue 7.0.6651.92
+        TCLCommon  7.0.6651.92
+        TCLLabel   7.0.6651.92
+
+    .NOTES
+        Author: Mötz Jensen (@Splaxi)
+#>#
+function Get-D365SDPDetails {
+    [CmdletBinding()]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")]
+    param (
+        [Parameter(Mandatory = $True)]
+        [Alias('File')]
+        [string] $Path
+    )
+
+    $pathWorkDirectory = "$([System.IO.Path]::GetTempPath())d365fo.tools\$([System.Guid]::NewGuid().Guid)"
+    #Make sure the work path is created and available
+    New-Item -Path $pathWorkDirectory -ItemType Directory -Force -ErrorAction Ignore > $null
+    $pathHotfix = Join-Path -Path $pathWorkDirectory -ChildPath "HotfixInstallationInfo.xml"
+
+    Invoke-TimeSignal -Start
+
+    if ($Path.EndsWith(".zip")) {
+        <#
+            If we have a zip file, we'll extract the files, to mimic a folder
+            Will copy to the default Windows temporary folder
+        #>
+
+        Unblock-File -Path $Path
+
+        $file = [System.IO.File]::Open($Path, [System.IO.FileMode]::Open)
+        $zipArch = [System.IO.Compression.ZipArchive]::new($file)
+        $zipEntry = $zipArch.GetEntry("HotfixInstallationInfo.xml")
+
+        if (-not $zipEntry) {
+            $messageString = "Unable to find the <c='em'>HotfixInstallationInfo.xml</c> file inside the archive. It would indicate the <c='em'>$Path</c> isn't a valid software deployable package."
+            Write-PSFMessage -Level Host -Message $messageString
+            Stop-PSFFunction -Message "Stopping because HotfixInstallationInfo.xml wasn't found." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', '')))
+        }
+
+        if (Test-PSFFunctionInterrupt) { return }
+
+        [System.IO.Compression.ZipFileExtensions]::ExtractToFile($zipEntry, $pathHotfix, $true)
+
+
+        foreach ($nuget in $($zipArch.Entries | Where-Object Fullname -like "AOSService\Packages\*.nupkg")) {
+            $pathNuget = "$pathWorkDirectory\$($nuget.name).zip"
+
+            # The nuget file contains module name in correct casing
+            [System.IO.Compression.ZipFileExtensions]::ExtractToFile($nuget, $pathNuget, $true)
+
+        }
+
+        # Clear out any zip archive objects from memory
+        if ($zipArch) {
+            $zipArch.Dispose()
+        }
+
+        if ($file) {
+            $file.Close()
+            $file.Dispose()
+        }
+    }
+    else {
+        <#
+            Will copy to the default Windows temporary folder
+        #>
+        Copy-Item -Path "$Path\HotfixInstallationInfo.xml" -Destination $pathHotfix -Force
+
+        foreach ($nuget in $(Get-ChildItem -Path "$Path\AOSService\Packages\*.nupkg")) {
+            Copy-Item -Path $nuget.FullName -Destination "$pathWorkDirectory\$($nuget.Name).zip" -Force
+        }
+    }
+
+    if (Test-PSFFunctionInterrupt) { return }
+
+    [System.Collections.Generic.List[System.Object]] $modules = @()
+
+    foreach ($nuget in $(Get-ChildItem -Path "$pathWorkDirectory\*.nupkg.zip")) {
+        <#
+            nuget contains a nuspec file
+            nuspec is a XML containing the details we are looking for
+        #>
+        $pathXml = $nuget.FullName + ".nuspec"
+
+        $fileNuget = [System.IO.File]::Open($nuget.FullName, [System.IO.FileMode]::Open)
+        $zipNuget = [System.IO.Compression.ZipArchive]::new($fileNuget)
+        $zipNugetEntry = $zipNuget.Entries | Where-Object Name -like "*.nuspec" | Select-Object -First 1
+        [System.IO.Compression.ZipFileExtensions]::ExtractToFile($zipNugetEntry, $pathXml, $true)
+
+        [xml] $moduleSpec = Get-Content -Path $pathXml -Raw
+
+        $modules.Add(
+            [PSCustomObject]@{
+                Name    = $moduleSpec.package.metadata.summary
+                Version = $moduleSpec.package.metadata.version
+            }
+        )
+    }
+
+    # Clear out any inner zip archive objects from memory
+    if ($zipNuget) {
+        $zipArch.Dispose()
+    }
+
+    if ($fileNuget) {
+        $file.Close()
+        $file.Dispose()
+    }
+
+    [xml] $hotfix = Get-Content -Path "$pathWorkDirectory\HotfixInstallationInfo.xml" -Raw
+
+    [PSCustomObject]@{
+        Platform        = $hotfix.HotfixInstallationInfo.PlatformReleaseDisplayName
+        PlatformVersion = $hotfix.HotfixInstallationInfo.PlatformVersion
+        Modules         = $modules
+    }
+
+    Invoke-TimeSignal -End
+}

d365fo.tools/functions/set-d365rsatconfiguration.ps1

@@ -24,6 +24,10 @@
         $true will make RSAT start adding the operation options in the excel parameter file
         $false will stop RSAT from adding the operation options in the excel parameter file
 
+    .PARAMETER RSATConfigFilename
+        Specifies the file name of the RSAT configuration file. Default is 'Microsoft.Dynamics.RegressionSuite.WpfApp.exe.config'
+        If you are using an older version of RSAT, you might need to change this to 'Microsoft.Dynamics.RegressionSuite.WindowsApp.exe.config'
+
     .EXAMPLE
         PS C:\> Set-D365RsatConfiguration -LogGenerationEnabled $true
 
@@ -58,14 +62,17 @@ function Set-D365RsatConfiguration {
         [bool] $VerboseSnapshotsEnabled,
 
         [Parameter(Mandatory = $false)]
-        [bool] $AddOperatorFieldsToExcelValidationEnabled
+        [bool] $AddOperatorFieldsToExcelValidationEnabled,
+
+        [Parameter(Mandatory = $false)]
+        $RSATConfigFilename = "Microsoft.Dynamics.RegressionSuite.WpfApp.exe.config"
     )
 
-    $configPath = Join-Path $Script:RsatPath "Microsoft.Dynamics.RegressionSuite.WindowsApp.exe.config"
+    $configPath = Join-Path $Script:RsatPath $RSATConfigFilename
 
     if (-not (Test-PathExists -Path $configPath -Type Leaf)) {
-        Write-PSFMessage -Level Critical -Message "The 'Microsoft.Dynamics.RegressionSuite.WindowsApp.exe.config' file could not be found on the system."
-        Stop-PSFFunction -Message  "Stopping because the 'Microsoft.Dynamics.RegressionSuite.WindowsApp.exe.config' file could not be located."
+        Write-PSFMessage -Level Critical -Message "The '$RSATConfigFilename' file could not be found on the system."
+        Stop-PSFFunction -Message  "Stopping because the '$RSATConfigFilename' file could not be located."
         return
     }
 
@@ -74,17 +81,23 @@ function Set-D365RsatConfiguration {
 
         if ($PSBoundParameters.Keys -contains "LogGenerationEnabled") {
             $logGenerationAttribute = $xmlConfig.SelectNodes('//appSettings//add[@key="LogGeneration"]')
-            $logGenerationAttribute.SetAttribute('value', $LogGenerationEnabled.ToString().ToLower())
+            if ($logGenerationAttribute) {
+                $logGenerationAttribute.SetAttribute('value', $LogGenerationEnabled.ToString().ToLower())
+            }
         }
 
         if ($PSBoundParameters.Keys -contains "VerboseSnapshotsEnabled") {
             $verboseSnapshotsAttribute = $xmlConfig.SelectNodes('//appSettings//add[@key="VerboseSnapshotsEnabled"]')
-            $verboseSnapshotsAttribute.SetAttribute('value', $VerboseSnapshotsEnabled.ToString().ToLower())
+            if ($verboseSnapshotsAttribute) {
+                $verboseSnapshotsAttribute.SetAttribute('value', $VerboseSnapshotsEnabled.ToString().ToLower())
+            }
         }
 
         if ($PSBoundParameters.Keys -contains "AddOperatorFieldsToExcelValidationEnabled") {
             $addOperatorFieldsToExcelValidationAttribute = $xmlConfig.SelectNodes('//appSettings//add[@key="AddOperatorFieldsToExcelValidation"]')
-            $addOperatorFieldsToExcelValidationAttribute.SetAttribute('value', $AddOperatorFieldsToExcelValidationEnabled.ToString().ToLower())
+            if ($addOperatorFieldsToExcelValidationAttribute) {
+                $addOperatorFieldsToExcelValidationAttribute.SetAttribute('value', $AddOperatorFieldsToExcelValidationEnabled.ToString().ToLower())
+            }
         }
 
         $xmlConfig.Save($configPath)

d365fo.tools/tests/functions/Get-D365SDPDetails.Tests.ps1

@@ -0,0 +1,36 @@
+Describe "Get-D365SDPDetails Unit Tests" -Tag "Unit" {
+	BeforeAll {
+		# Place here all things needed to prepare for the tests
+	}
+	AfterAll {
+		# Here is where all the cleanup tasks go
+	}
+
+	Describe "Ensuring unchanged command signature" {
+		It "should have the expected parameter sets" {
+			(Get-Command Get-D365SDPDetails).ParameterSets.Name | Should -Be '__AllParameterSets'
+		}
+
+		It 'Should have the expected parameter Path' {
+			$parameter = (Get-Command Get-D365SDPDetails).Parameters['Path']
+			$parameter.Name | Should -Be 'Path'
+			$parameter.ParameterType.ToString() | Should -Be System.String
+			$parameter.IsDynamic | Should -Be $False
+			$parameter.ParameterSets.Keys | Should -Be '__AllParameterSets'
+			$parameter.ParameterSets.Keys | Should -Contain '__AllParameterSets'
+			$parameter.ParameterSets['__AllParameterSets'].IsMandatory | Should -Be $True
+			$parameter.ParameterSets['__AllParameterSets'].Position | Should -Be 0
+			$parameter.ParameterSets['__AllParameterSets'].ValueFromPipeline | Should -Be $False
+			$parameter.ParameterSets['__AllParameterSets'].ValueFromPipelineByPropertyName | Should -Be $False
+			$parameter.ParameterSets['__AllParameterSets'].ValueFromRemainingArguments | Should -Be $False
+		}
+	}
+
+	Describe "Testing parameterset __AllParameterSets" {
+		<#
+		__AllParameterSets -Path
+		__AllParameterSets -Path
+		#>
+	}
+
+}

d365fo.tools/tests/functions/Set-D365RsatConfiguration.Tests.ps1

@@ -50,12 +50,25 @@
 			$parameter.ParameterSets['__AllParameterSets'].ValueFromPipelineByPropertyName | Should -Be $False
 			$parameter.ParameterSets['__AllParameterSets'].ValueFromRemainingArguments | Should -Be $False
 		}
+		It 'Should have the expected parameter RSATConfigFilename' {
+			$parameter = (Get-Command Set-D365RsatConfiguration).Parameters['RSATConfigFilename']
+			$parameter.Name | Should -Be 'RSATConfigFilename'
+			$parameter.ParameterType.ToString() | Should -Be System.Object
+			$parameter.IsDynamic | Should -Be $False
+			$parameter.ParameterSets.Keys | Should -Be '__AllParameterSets'
+			$parameter.ParameterSets.Keys | Should -Contain '__AllParameterSets'
+			$parameter.ParameterSets['__AllParameterSets'].IsMandatory | Should -Be $False
+			$parameter.ParameterSets['__AllParameterSets'].Position | Should -Be 3
+			$parameter.ParameterSets['__AllParameterSets'].ValueFromPipeline | Should -Be $False
+			$parameter.ParameterSets['__AllParameterSets'].ValueFromPipelineByPropertyName | Should -Be $False
+			$parameter.ParameterSets['__AllParameterSets'].ValueFromRemainingArguments | Should -Be $False
+		}
 	}
 
 	Describe "Testing parameterset __AllParameterSets" {
 		<#
 		__AllParameterSets -
-		__AllParameterSets -LogGenerationEnabled -VerboseSnapshotsEnabled -AddOperatorFieldsToExcelValidationEnabled
+		__AllParameterSets -LogGenerationEnabled -VerboseSnapshotsEnabled -AddOperatorFieldsToExcelValidationEnabled -RSATConfigFilename
 		#>
 	}