Use C# wrapper objects for PowerShell cmdlet output

[ryfu-msft]

Related to: #2796

Currently, the PowerShell module outputs a COM object which, based on feedback from the community, is not easily usable and also causes issues with certain behaviors such as getting properties and sorting by specific fields (id, version, etc.). This change fixes those issues by using a better formatted C# wrapper object around the data from the COM object and outputs that to PowerShell.

Tests:
I added basic Pester tests but did not include them in the pipeline as the module looks for the wingetdev package to be installed on the build machine (specifically executing WindowsPackageManagerServer.exe) before creating any COM instances. I will work on that in a separate PR but I have included the basic tests here which can be run locally while having the localhost webserver running. Since we already have basic E2E test coverage for the module, it is not absolutely necessary right now.

Microsoft Reviewers: Open in CodeFlow

[ryfu-msft]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[florelis]

Nit: Maybe add that it's the source name?

[ryfu-msft]

Changed to suggested.

[florelis]

What is this correlation data, and what format does the string have?

[ryfu-msft]

I'm honestly not sure, I even tried installing a package and manually failing it, but no output. I removed it entirely and if people want it back, I can add it again.

[yao-msft]

correlation data is passed in from caller for their own correlation purposes. We return it so caller can correlate to their operations

[florelis]

What's the difference between FoundCatalogPackage and InstalledCatalogPackage? Is it about which cmdlets they can be used in?

[ryfu-msft]

The only difference is whether we use InstalledVersion or DefaultInstallVersion to obtain the Version that we display to the user. I created a parent class called CatalogPackage that FoundCatalogPackage and InstalledCatalogPackage inherit from so that there less repeated properties.

[florelis]

I wonder if there is a way to do this all in one command. Something like

$package | Should -Be @{
  Name: 'TestExeInstaller'
  Id: 'AppInstallerTest.TestExeInstaller'
}

I have never used Pester and I don't know enough PS, so I genuinely don't know if something like that is possible.

[ryfu-msft]

I tried this and it didn't work. Also the documentation doesn't have anything like this so I will leave it as is.

[Trenly]

You would just need to do something like:

Function MatchesObject($ActualValue, $ExpectedValue, [switch] $Negate, [string] $Because){
 $succeeded = $true
  $failMessage = ''
  foreach ($key in $ExpectedValue.Keys){
    if ($ActualValue.Keys -contains $key){
       if ($ActualValue[$key] -ceq $ExpectedValue[$key]){
       }  else {
         $succeeded = $false
         $failMessage = "Failed to validate $key. Actual: $($ActualValue[$key]); Expected: $($ExpectedValue[$key])"
       }
    } else {
      $succeeded = $false
      $failMessage = "Failed to validate $key. Value not present in object"
    }
  }
  if ($Negate) {
    $succeeded = !$succeeded
  }
  return New-Object psobject -Property @{
    Succeeded = $succeeded
    FailureMessage = $failMessage
  }
}

Add-ShouldOperator -Name MatchObject -Test $function:MatchesObject -Alias MO

Then you could do

$package | Should -MatchObject @{ Name: 'TestExeInstaller' Id: 'AppInstallerTest.TestExeInstaller' }

https://pester.dev/docs/assertions/custom-assertions

[florelis]

I imagine there's Pester magic that makes this run before all tests? Is it possible to add a cleanup step to always uninstall the installed tests apps?

[ryfu-msft]

I added an AfterAll step that cleans up the installed test packages and sources that were added during the test.

[florelis]

Looks like AfterAll is executed once after all the tests. Could we want to uninstall the packages after each tests?

[Trenly]

You would just need to do something like:

Function MatchesObject($ActualValue, $ExpectedValue, [switch] $Negate, [string] $Because){
 $succeeded = $true
  $failMessage = ''
  foreach ($key in $ExpectedValue.Keys){
    if ($ActualValue.Keys -contains $key){
       if ($ActualValue[$key] -ceq $ExpectedValue[$key]){
       }  else {
         $succeeded = $false
         $failMessage = "Failed to validate $key. Actual: $($ActualValue[$key]); Expected: $($ExpectedValue[$key])"
       }
    } else {
      $succeeded = $false
      $failMessage = "Failed to validate $key. Value not present in object"
    }
  }
  if ($Negate) {
    $succeeded = !$succeeded
  }
  return New-Object psobject -Property @{
    Succeeded = $succeeded
    FailureMessage = $failMessage
  }
}

Add-ShouldOperator -Name MatchObject -Test $function:MatchesObject -Alias MO

Then you could do

$package | Should -MatchObject @{ Name: 'TestExeInstaller' Id: 'AppInstallerTest.TestExeInstaller' }

https://pester.dev/docs/assertions/custom-assertions

[Trenly]

Is Pester set up to collect all failures? If not, I think it should be
https://pester.dev/docs/assertions/should-command#collect-all-should-failures

[ryfu-msft]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).