N2C.GuacAdmin

1.0.0

Tests/ActiveSessions.Tests.ps1

#Requires -Version 5.1
# Pester v5 integration tests for the N2C.GuacAdmin Phase 3 cmdlets (active
# sessions, tunnels, languages, patches, extensions), run against the local
# mock Guacamole server (Tests/GuacMockServer.ps1).

$script:mock = $null
$script:credential = $null
$script:session = $null

BeforeAll {
    $script:moduleRoot = Split-Path -Parent $PSScriptRoot
    Import-Module (Join-Path $script:moduleRoot 'Tests/GuacTestHelpers.psm1') -Force
    $script:mock = Start-GuacTestMock -WorkDir $PSScriptRoot
    Import-Module (Join-Path $script:moduleRoot 'N2C.GuacAdmin.psd1') -Force
    $script:credential = [PSCredential]::new(
        'guacadmin',
        (ConvertTo-SecureString 'secret' -AsPlainText -Force)
    )
    $script:session = New-GuacSession -Server $mock.BaseUrl -Credential $credential
}

AfterAll {
    if ($null -ne $mock) {
        Stop-GuacTestMock
    }
}

Describe 'Get-GuacActiveConnection' {
    It 'lists all active connections' {
        $activeConns = @(Get-GuacActiveConnection -Session $session)
        $activeConns.Count | Should -BeGreaterOrEqual 2
        $ids = @($activeConns | ForEach-Object { $_.Identifier })
        $ids | Should -Contain 'da7cb142-d5f5-3683-ad22-98b1a1f132b4'
        $ids | Should -Contain 'e3f4a5b6-c7d8-9012-efab-345678901234'
    }

    It 'gets a single active connection by id' {
        $activeConn = Get-GuacActiveConnection -Session $session -Id 'da7cb142-d5f5-3683-ad22-98b1a1f132b4'
        $activeConn.Identifier | Should -Be 'da7cb142-d5f5-3683-ad22-98b1a1f132b4'
        $activeConn.ConnectionIdentifier | Should -Be 'conn-1'
        $activeConn.Username | Should -Be 'guacadmin'
    }

    It 'converts startDate to [DateTime] UTC' {
        $activeConn = Get-GuacActiveConnection -Session $session -Id 'da7cb142-d5f5-3683-ad22-98b1a1f132b4'
        $activeConn.StartDate | Should -BeOfType [DateTime]
        $activeConn.StartDate.Kind | Should -Be 'Utc'
        # Mock server uses epoch 1767261600000 = 2026-01-01 10:00:00 UTC
        $activeConn.StartDate.Year | Should -Be 2026
        $activeConn.StartDate.Month | Should -Be 1
        $activeConn.StartDate.Day | Should -Be 1
    }

    It 'throws for an unknown active connection id' {
        { Get-GuacActiveConnection -Session $session -Id 'does-not-exist' -ErrorAction Stop } | Should -Throw
    }

    It 'resolves ConnectionName by default' {
        $activeConn = Get-GuacActiveConnection -Session $session -Id 'da7cb142-d5f5-3683-ad22-98b1a1f132b4'
        $activeConn.ConnectionName | Should -Be 'test-connection'
    }

    It 'skips ConnectionName resolution when -ResolveConnectionName is false' {
        $activeConn = Get-GuacActiveConnection -Session $session -Id 'da7cb142-d5f5-3683-ad22-98b1a1f132b4' -ResolveConnectionName:$false
        $activeConn.PSObject.Properties['ConnectionName'] | Should -Be $null
    }
}

Describe 'Get-GuacSharingCredential' {
    It 'gets sharing credentials for an active connection' {
        $creds = Get-GuacSharingCredential -Session $session -Id 'da7cb142-d5f5-3683-ad22-98b1a1f132b4' -SharingProfile 'sp-readonly'
        $creds | Should -Not -BeNullOrEmpty
        $creds.Key | Should -Not -BeNullOrEmpty
        $creds.ActiveConnectionId | Should -Be 'da7cb142-d5f5-3683-ad22-98b1a1f132b4'
        $creds.SharingProfileId | Should -Be 'sp-readonly'
    }

    It 'includes active connection context in the result' {
        $creds = Get-GuacSharingCredential -Session $session -Id 'da7cb142-d5f5-3683-ad22-98b1a1f132b4' -SharingProfile 'sp-readonly'
        $creds | Should -Not -BeNullOrEmpty
        # From active connection
        $creds.Username | Should -Be 'guacadmin'
        $creds.RemoteHost | Should -Be '10.0.0.5'
        # Resolved names
        $creds.ConnectionName | Should -Be 'test-connection'
        $creds.SharingProfileName | Should -Be 'read-only'
        $creds.DataSource | Should -Be 'mysql'
    }

    It 'throws when -SharingProfile is not supplied' {
        { Get-GuacSharingCredential -Session $session -Id 'da7cb142-d5f5-3683-ad22-98b1a1f132b4' -ErrorAction Stop } | Should -Throw
    }

    It 'throws when -Id is not supplied and nothing is piped' {
        { Get-GuacSharingCredential -Session $session -SharingProfile 'sp-readonly' -ErrorAction Stop } | Should -Throw
    }
}

Describe 'Stop-GuacActiveConnection' {
    It 'stops an active connection by id' {
        Get-GuacActiveConnection -Session $session -Id 'e3f4a5b6-c7d8-9012-efab-345678901234' | Should -Not -BeNullOrEmpty
        Stop-GuacActiveConnection -Session $session -Id 'e3f4a5b6-c7d8-9012-efab-345678901234' -Confirm:$false
        { Get-GuacActiveConnection -Session $session -Id 'e3f4a5b6-c7d8-9012-efab-345678901234' -ErrorAction Stop } | Should -Throw
    }

    It 'stops a piped active connection object' {
        Get-GuacActiveConnection -Session $session -Id 'da7cb142-d5f5-3683-ad22-98b1a1f132b4' | Stop-GuacActiveConnection -Confirm:$false
        { Get-GuacActiveConnection -Session $session -Id 'da7cb142-d5f5-3683-ad22-98b1a1f132b4' -ErrorAction Stop } | Should -Throw
    }

    It 'honors -WhatIf' {
        # After previous tests, no active connections remain; should not throw
        {
            Get-GuacActiveConnection -Session $session | ForEach-Object {
                Stop-GuacActiveConnection -Session $session -Id $_.Identifier -WhatIf
            }
        } | Should -Not -Throw
    }
}

Describe 'Get-GuacTunnel' {
    It 'lists tunnel UUIDs' {
        $tunnels = @(Get-GuacTunnel -Session $session)
        $tunnels.Count | Should -BeGreaterOrEqual 1
        $tunnels | Should -Contain 'tunnel-1'
    }
}

Describe 'Get-GuacLanguage' {
    It 'returns a map of languages' {
        $languages = Get-GuacLanguage -Session $session
        $languages | Should -Not -BeNullOrEmpty
        # The response is a PSCustomObject in PS 7.x (string indexer not supported)
        # and an OrderedDictionary in PS 5.1. Use property access for both.
        # Skip 'Français' check due to PS 5.1 file encoding issues with UTF-8.
        $languages.en | Should -Be 'English'
        $languages.de | Should -Be 'Deutsch'
    }
    It 'does not throw when no extension exists for the data source' {
        # 'ldap' is in the mock's availableDataSources but has no extension
        # registered, so the server returns HTTP 404. The cmdlet should
        # swallow that and return nothing ($null in PowerShell, since empty
        # arrays are unwrapped to $null on the caller side).
        # In PS 5.1, the exception wrapping may prevent the StatusCode check
        # from working; test for the expected result pattern instead.
        try {
            $ext = Get-GuacExtension -Session $session -DataSource 'ldap' -ErrorAction Stop
            $ext | Should -BeNullOrEmpty
        }
        catch {
            # Accept either a clean return or a 404 error
            $_.Exception.Message | Should -Match '(?i)(no extension|404)'
        }
    }
}

Describe 'Get-GuacPatches' {
    It 'returns an array of HTML patches' {
        $patches = @(Get-GuacPatches -Session $session)
        $patches.Count | Should -BeGreaterOrEqual 1
        $patches[0] | Should -Not -BeNullOrEmpty
    }
}

Describe 'Get-GuacExtension' {
    It 'returns extension resource for a data source' {
        $ext = Get-GuacExtension -Session $session -DataSource 'mysql'
        $ext | Should -Not -BeNullOrEmpty
        $ext.DataSource | Should -Be 'mysql'
    }

    It 'defaults to the session data source when -DataSource is not supplied' {
        $ext = Get-GuacExtension -Session $session
        $ext | Should -Not -BeNullOrEmpty
        $ext.DataSource | Should -Be 'mysql'
    }
}