Environments.Tests.ps1

#Requires -Modules @{ ModuleName = 'Pester'; RequiredVersion = '5.7.1' }

[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
    'PSUseDeclaredVarsMoreThanAssignments', '',
    Justification = 'Pester grouping syntax: known issue.'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
    'PSAvoidUsingConvertToSecureStringWithPlainText', '',
    Justification = 'Used to create a secure string for testing.'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
    'PSAvoidUsingWriteHost', '',
    Justification = 'Log outputs to GitHub Actions logs.'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
    'PSAvoidLongLines', '',
    Justification = 'Long test descriptions and skip switches'
)]
[CmdletBinding()]
param()

BeforeAll {
    $testName = 'Environments'
    $os = $env:RUNNER_OS
    $id = $env:GITHUB_RUN_ID
    if (-not $id) {
        throw 'GITHUB_RUN_ID is required for Environments tests.'
    }
}

Describe 'Environments' {
    $authCases = . "$PSScriptRoot/Data/AuthCases.ps1"

    Context 'As <Type> using <Case> on <Target>' -ForEach $authCases {
        BeforeAll {
            $context = Connect-GitHubAccount @connectParams -PassThru -Silent
            LogGroup 'Context' {
                Write-Host ($context | Format-List | Out-String)
            }
            if ($AuthType -eq 'APP') {
                LogGroup 'Context - Installation' {
                    $context = Connect-GitHubApp @connectAppParams -PassThru -Default -Silent
                    Write-Host ($context | Format-List | Out-String)
                }
            }
            $repoPrefix = "$testName-$os-$TokenType"
            $repoName = "$repoPrefix-$id"
            $environmentName = "$testName-$os-$TokenType-$id"

            LogGroup "Using Repository - [$repoName]" {
                if ($OwnerType -in ('repository', 'enterprise')) {
                    $repo = $null
                } else {
                    $repoParams = @{
                        Name      = $repoName
                        AddReadme = $true
                        License   = 'mit'
                        Gitignore = 'VisualStudio'
                    }
                    $repo = switch ($OwnerType) {
                        'user' { Set-GitHubRepository @repoParams }
                        'organization' { Set-GitHubRepository @repoParams -Organization $Owner }
                    }
                }
                Write-Host ($repo | Select-Object * | Out-String)
            }

            # Clean up stale environments from prior runs with the same GITHUB_RUN_ID.
            # This keeps isolated reruns self-contained even when the global BeforeAll did not reset the repository.
            if ($repo) {
                LogGroup "Pre-test Cleanup - Existing Environments on [$repoName]" {
                    $existingEnvironments = Get-GitHubEnvironment -Owner $owner -Repository $repoName -ErrorAction SilentlyContinue
                    if ($existingEnvironments) {
                        Write-Host ($existingEnvironments | Format-Table | Out-String)
                        $existingEnvironments | Remove-GitHubEnvironment -Confirm:$false
                    } else {
                        Write-Host 'No existing environments to clean up.'
                    }
                }
            }
        }

        AfterAll {
            Get-GitHubContext -ListAvailable | Disconnect-GitHubAccount -Silent
            Write-Host ('-' * 60)
        }

        It 'Get-GitHubEnvironment - should return an empty list when no environments exist' -Skip:($OwnerType -in ('repository', 'enterprise')) {
            $result = Get-GitHubEnvironment -Owner $owner -Repository $repoName
            LogGroup 'Environment' {
                Write-Host ($result | Format-Table | Out-String)
            }
            $result | Should -BeNullOrEmpty
        }
        It 'Get-GitHubEnvironment - should return null when retrieving a non-existent environment' -Skip:($OwnerType -in ('repository', 'enterprise')) {
            $result = Get-GitHubEnvironment -Owner $owner -Repository $repoName -Name $environmentName
            LogGroup 'Environment' {
                Write-Host ($result | Format-Table | Out-String)
            }
            $result | Should -BeNullOrEmpty
        }
        It 'Set-GitHubEnvironment - should successfully create an environment with a wait timer of 10' -Skip:($OwnerType -in ('repository', 'enterprise')) {
            $result = Set-GitHubEnvironment -Owner $owner -Repository $repoName -Name $environmentName -WaitTimer 10
            LogGroup 'Environment' {
                Write-Host ($result | Format-List | Out-String)
            }
            $result | Should -Not -BeNullOrEmpty
            $result | Should -BeOfType [GitHubEnvironment]
            $result.Name | Should -Be $environmentName
            $result.ProtectionRules.wait_timer | Should -Be 10
        }
        It 'Get-GitHubEnvironment - should retrieve the environment that was created' -Skip:($OwnerType -in ('repository', 'enterprise')) {
            $result = Get-GitHubEnvironment -Owner $owner -Repository $repoName -Name $environmentName
            LogGroup 'Environment' {
                Write-Host ($result | Format-List | Out-String)
            }
            $result | Should -Not -BeNullOrEmpty
            $result.Name | Should -Be $environmentName
        }
        It 'Set-GitHubEnvironment - should successfully create an environment with a slash in its name' -Skip:($OwnerType -in ('repository', 'enterprise')) {
            $result = Set-GitHubEnvironment -Owner $owner -Repository $repoName -Name "$environmentName/$os"
            LogGroup 'Environment' {
                Write-Host ($result | Format-List | Out-String)
            }
            $result | Should -Not -BeNullOrEmpty
            $result.Name | Should -Be "$environmentName/$os"
        }
        It 'Get-GitHubEnvironment - should retrieve the environment with a slash in its name' -Skip:($OwnerType -in ('repository', 'enterprise')) {
            $result = Get-GitHubEnvironment -Owner $owner -Repository $repoName -Name "$environmentName/$os"
            LogGroup 'Environment' {
                Write-Host ($result | Format-Table | Out-String)
            }
            $result | Should -Not -BeNullOrEmpty
            $result.Name | Should -Be "$environmentName/$os"
        }
        It 'Remove-GitHubEnvironment - should delete the environment with a slash in its name without errors' -Skip:($OwnerType -in ('repository', 'enterprise')) {
            {
                Get-GitHubEnvironment -Owner $owner -Repository $repoName -Name "$environmentName/$os" | Remove-GitHubEnvironment -Confirm:$false
            } | Should -Not -Throw
        }
        It 'Get-GitHubEnvironment - should return null when retrieving the deleted environment with a slash in its name' -Skip:($OwnerType -in ('repository', 'enterprise')) {
            $result = Get-GitHubEnvironment -Owner $owner -Repository $repoName -Name "$environmentName/$os"
            LogGroup 'Environment' {
                Write-Host ($result | Format-Table | Out-String)
            }
            $result | Should -BeNullOrEmpty
        }
        It 'Get-GitHubEnvironment - should list one remaining environment' -Skip:($OwnerType -in ('repository', 'enterprise')) {
            $result = Get-GitHubEnvironment -Owner $owner -Repository $repoName
            LogGroup 'Environment' {
                Write-Host ($result | Format-Table | Out-String)
            }
            $result.Count | Should -Be 1
        }
        It 'Remove-GitHubEnvironment - should delete the remaining environment without errors' -Skip:($OwnerType -in ('repository', 'enterprise')) {
            { Remove-GitHubEnvironment -Owner $owner -Repository $repoName -Name $environmentName -Confirm:$false } | Should -Not -Throw
        }
        It 'Get-GitHubEnvironment - should return null when retrieving an environment that does not exist' -Skip:($OwnerType -in ('repository', 'enterprise')) {
            $result = Get-GitHubEnvironment -Owner $owner -Repository $repoName -Name $environmentName
            LogGroup 'Environment' {
                Write-Host ($result | Format-Table | Out-String)
            }
            $result | Should -BeNullOrEmpty
        }
    }
}