CLA-Assessment

1.7.0

Testing/Unit/PowerShell/Providers/TeamsProvider/Export-TeamsProvider.Tests.ps1

<#
 # Due to how the Error handling was implemented, mocked API calls have to be mocked inside a
 # mocked CommandTracker class
#>
$ProviderPath = "../../../../../Modules/Providers"
Import-Module (Join-Path -Path $PSScriptRoot -ChildPath "$($ProviderPath)/ExportTeamsProvider.psm1") -Function Export-TeamsProvider -Force
Import-Module (Join-Path -Path $PSScriptRoot -ChildPath "$($ProviderPath)/ProviderHelpers/CommandTracker.psm1") -Force

InModuleScope -ModuleName ExportTeamsProvider {
    Describe -Tag 'ExportTeamsProvider' -Name "Export-TeamsProvider" {
        BeforeAll {
            class MockCommandTracker {
                [string[]]$SuccessfulCommands = @()
                [string[]]$UnSuccessfulCommands = @()

                [System.Object[]] TryCommand([string]$Command, [hashtable]$CommandArgs, [bool]$SuppressWarning) {
                    # This is where you decide where you mock functions called by CommandTracker :)
                    try {
                        switch ($Command) {
                            "Get-CsTenant" {
                                $this.SuccessfulCommands += $Command
                                return [pscustomobject]@{}
                            }
                            "Get-CsTeamsMeetingPolicy" {
                                $this.SuccessfulCommands += $Command
                                return [pscustomobject]@{}
                            }
                            "Get-CsTenantFederationConfiguration" {
                                $this.SuccessfulCommands += $Command
                                return [pscustomobject]@{}
                            }
                            "Get-CsTeamsClientConfiguration" {
                                $this.SuccessfulCommands += $Command
                                return [pscustomobject]@{}
                            }
                            "Get-CsTeamsAppPermissionPolicy" {
                                $this.SuccessfulCommands += $Command
                                return [pscustomobject]@{}
                            }
                            "Get-CsTeamsMeetingBroadcastPolicy" {
                                $this.SuccessfulCommands += $Command
                                return [pscustomobject]@{}
                            }
                            "Get-M365UnifiedTenantSettings" {
                                $this.SuccessfulCommands += $Command
                                return [pscustomobject]@{}
                            }
                            default {
                                throw "ERROR you forgot to create a mock method for this cmdlet: $($Command)"
                            }
                        }
                        $Result = @()
                        $this.SuccessfulCommands += $Command
                        return $Result
                    }
                    catch {
                        if (-not $SuppressWarning) {
                            Write-Warning "Error running $($Command). $($_)"
                        }
                        $this.UnSuccessfulCommands += $Command
                        $Result = @()
                        return $Result
                    }
                }

                [System.Object[]] TryCommand([string]$Command, [hashtable]$CommandArgs) {
                    return $this.TryCommand($Command, $CommandArgs, $false)
                }

                [System.Object[]] TryCommand([string]$Command) {
                    return $this.TryCommand($Command, @{}, $false)
                }

                [void] AddSuccessfulCommand([string]$Command) {
                    $this.SuccessfulCommands += $Command
                }

                [void] AddUnSuccessfulCommand([string]$Command) {
                    $this.UnSuccessfulCommands += $Command
                }

                [string[]] GetUnSuccessfulCommands() {
                    return $this.UnSuccessfulCommands
                }

                [string[]] GetSuccessfulCommands() {
                    return $this.SuccessfulCommands
                }
            }
            function Get-CommandTracker {}
            Mock -ModuleName ExportTeamsProvider Get-CommandTracker {
                return [MockCommandTracker]::New()
            }
            function Test-CyberAssessmentValidProviderJson {
                param (
                    [string]
                    $Json
                )
                $Json = $Json.TrimEnd(",")
                $Json = "{$($Json)}"
                $ValidJson = $true
                try {
                    ConvertFrom-Json $Json -ErrorAction Stop | Out-Null
                }
                catch {
                    $ValidJson = $false;
                }
                $ValidJson
            }
        }
        It "returns valid JSON with interactive auth and unified settings available" {
                $Json = Export-TeamsProvider
                $ValidJson = Test-CyberAssessmentValidProviderJson -Json $Json | Select-Object -Last 1
                $ValidJson | Should -Be $true
            }
        It "returns valid JSON with CertificateBasedAuth" {
                $Json = Export-TeamsProvider -CertificateBasedAuth
                $ValidJson = Test-CyberAssessmentValidProviderJson -Json $Json | Select-Object -Last 1
                $ValidJson | Should -Be $true
            }
        It "returns valid JSON with interactive auth when unified settings unavailable" {
                # Mock scenario where Get-M365UnifiedTenantSettings returns nothing (older tenant)
                Mock -ModuleName ExportTeamsProvider Get-CommandTracker {
                    $Tracker = [MockCommandTracker]::New()
                    # Override the Get-M365UnifiedTenantSettings to return empty array
                    $Tracker | Add-Member -MemberType ScriptMethod -Name TryCommand -Value {
                        param([string]$Command, [hashtable]$CommandArgs = @{}, [bool]$SuppressWarning = $false)
                        # Parameters CommandArgs and SuppressWarning are required for signature compatibility
                        $null = $CommandArgs  # Satisfy PSScriptAnalyzer
                        $null = $SuppressWarning  # Satisfy PSScriptAnalyzer
                        if ($Command -eq "Get-M365UnifiedTenantSettings") {
                            $this.UnSuccessfulCommands += $Command
                            return @()  # Simulate cmdlet failure/no data
                        }
                        # Call original mock for other commands
                        switch ($Command) {
                            "Get-CsTenant" { $this.SuccessfulCommands += $Command; return [pscustomobject]@{} }
                            "Get-CsTeamsMeetingPolicy" { $this.SuccessfulCommands += $Command; return [pscustomobject]@{} }
                            "Get-CsTenantFederationConfiguration" { $this.SuccessfulCommands += $Command; return [pscustomobject]@{} }
                            "Get-CsTeamsClientConfiguration" { $this.SuccessfulCommands += $Command; return [pscustomobject]@{} }
                            "Get-CsTeamsAppPermissionPolicy" { $this.SuccessfulCommands += $Command; return [pscustomobject]@{} }
                            "Get-CsTeamsMeetingBroadcastPolicy" { $this.SuccessfulCommands += $Command; return [pscustomobject]@{} }
                            default { throw "ERROR you forgot to create a mock method for this cmdlet: $($Command)" }
                        }
                    } -Force
                    return $Tracker
                }
                $Json = Export-TeamsProvider
                $ValidJson = Test-CyberAssessmentValidProviderJson -Json $Json | Select-Object -Last 1
                $ValidJson | Should -Be $true
            }
        AfterAll {
            Remove-Module ExportTeamsProvider -Force -ErrorAction SilentlyContinue
            Remove-Module CommandTracker -Force -ErrorAction SilentlyContinue
        }
    }
}