PowerShell/test/powershell/engine/COM/COM.Basic.Tests.ps1

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.

Describe 'Basic COM Tests' -Tags "CI" {
    BeforeAll {
        $defaultParamValues = $PSDefaultParameterValues.Clone()
        $PSDefaultParameterValues["it:skip"] = ![System.Management.Automation.Platform]::IsWindowsDesktop
    }

    AfterAll {
        $global:PSDefaultParameterValues = $defaultParamValues
    }

    BeforeAll {
        $null = New-Item -Path $TESTDRIVE/file1 -ItemType File
        $null = New-Item -Path $TESTDRIVE/file2 -ItemType File
        $null = New-Item -Path $TESTDRIVE/file3 -ItemType File
    }

    It "Should enumerate files from a folder" {
        $shell = New-Object -ComObject "Shell.Application"
        $folder = $shell.Namespace("$TESTDRIVE")
        $items = $folder.Items()

        ## $items is a collection of all items belong to the folder, and it should be enumerated.
        $items.Count | Should -Be 3
        $items | Measure-Object | ForEach-Object Count | Should -Be $items.Count

        $names = $items | ForEach-Object { $_.Name }
        $names -join "," | Should -Be "file1,file2,file3"
    }

    It "Should enumerate IEnumVariant interface object without exception" {
        $shell = New-Object -ComObject "Shell.Application"
        $folder = $shell.Namespace("$TESTDRIVE")
        $items = $folder.Items()

        ## $enumVariant is an IEnumVariant interface of all items belong to the folder, and it should be enumerated.
        $enumVariant = $items._NewEnum()
        $items.Count | Should -Be 3
        $enumVariant | Measure-Object | ForEach-Object Count | Should -Be $items.Count
    }

    It "Should enumerate drives" {
        $fileSystem = New-Object -ComObject scripting.filesystemobject
        $drives = $fileSystem.Drives

        ## $drives is a read-only collection of all available drives, and it should be enumerated.
        $drives | Measure-Object | ForEach-Object Count | Should -Be $drives.Count
        ## $element should be the first drive from the enumeration. It shouldn't be the same as $drives,
        ## but it should be the same as '$drives.Item($element.DriveLetter)'
        $element = $drives | Select-Object -First 1
        [System.Object]::ReferenceEquals($element, $drives) | Should -BeFalse
        $element | Should -Be $drives.Item($element.DriveLetter)
    }

    It "Should be able to enumerate 'IADsMembers' object" {
        $group = [ADSI]"WinNT://./Users,Group"
        $members = $group.Invoke('Members')
        $names = $members | ForEach-Object { $_.GetType().InvokeMember('Name', 'GetProperty', $null, $_, $null) }
        $names | Should -Contain 'INTERACTIVE'
    }

    It "ToString() should return method paramter names" {
        $shell = New-Object -ComObject "Shell.Application"
        $fullSignature = $shell.AddToRecent.ToString()

        $fullSignature | Should -BeExactly "void AddToRecent (Variant varFile, string bstrCategory)"
    }

    Context 'GetMember/SetMember/InvokeMember binders should have more restricted rule for COM object' {
        BeforeAll {
            if ([System.Management.Automation.Platform]::IsWindowsDesktop) {
                $null = New-Item -Path $TESTDRIVE/bar -ItemType Directory -Force

                $shell = New-Object -ComObject "Shell.Application"
                $folder = $shell.Namespace("$TESTDRIVE")
                $item = $folder.Items().Item(0)
                $item = [psobject]::AsPSObject($item)

                ## Create a PSObject that has an instance member 'Name' and a script method 'Windows'
                $str = Add-Member -InputObject "abc" -MemberType NoteProperty -Name Name -Value "Hello" -PassThru
                $str = Add-Member -InputObject $str -MemberType ScriptMethod -Name Windows -Value { "Windows" } -PassThru
            }
        }

        It "GetMember binder should differentiate PSObject that wraps COM object from other PSObjects" {
            ## GetMember on the member name 'Name'.
            $entry1 = ($item, "bar")
            $entry2 = ($str, "Hello")

            foreach ($pair in ($entry1, $entry2, $entry2, $entry1, $entry1, $entry2)) {
                $pair[0].Name | Should -Be $pair[1]
            }
        }

        It "SetMember binder should differentiate PSObject that wraps COM object from other PSObjects" {
            ## SetMember on the member name 'Name'
            $entry1 = ($item, "foo")
            $entry2 = ($str, "World")

            foreach ($pair in ($entry1, $entry2)) {
                $pair[0].Name = $pair[1]
                $pair[0].Name | Should -Be $pair[1]
            }
        }

        It "InvokeMember binder should differentiate PSObject that wraps COM object from other PSObjects" {
            if (Test-IsWindowsArm64) {
                Set-ItResult -Pending -Because "COMException: The server process could not be started because the configured identity is incorrect. Check the username and password."
            }

            ## InvokeMember on the member name 'Windows'
            $shell | ForEach-Object { $_.Windows() } > $null

            ## '$str' is a PSObject that wraps a string, but with ScriptMethod 'Windows'
            $str.Windows() | Should -Be "Windows"
        }
    }
}