tasks/report.properties.Tests.ps1

# <copyright file="report.properties.Tests.ps1" company="Endjin Limited">
# Copyright (c) Endjin Limited. All rights reserved.
# </copyright>

BeforeAll {
    $propertiesPath = $PSCommandPath.Replace('.Tests.ps1','.ps1')

    # Each case must be evaluated in a fresh scope, because the properties file uses '??=' and
    # would therefore skip any value already present.
    function Get-ReportProperty {
        param (
            [string] $Name,
            # Mirrors the state every real build is in when this properties file loads: ZeroFailed.DevOps.Common
            # is imported first and its 'cicd-server.properties.ps1' defines '$IsGitHubActions = $false'; only the
            # 'DetectCICDServer' task, which runs after every extension has been imported, sets it to $true.
            # The variable is always defined, never left undefined: when 'RunPesterTests' runs inside a ZeroFailed
            # build, the build's own '$IsGitHubActions' is visible to these tests through the scope chain, so the
            # helper has to shadow it to control the scenario at all.
            [object] $IsGitHubActions = $false,
            [hashtable] $EnvironmentVariables = @{}
        )

        $originalEnv = @{}
        foreach ($key in $EnvironmentVariables.Keys) {
            $originalEnv[$key] = [Environment]::GetEnvironmentVariable($key)
            [Environment]::SetEnvironmentVariable($key, $EnvironmentVariables[$key])
        }
        try {
            & {
                param($path, $ghActions, $propertyName)

                # Stand-in for the InvokeBuild 'property' command, which only exists during a build
                function property {
                    param($Name, $Default)
                    $value = [Environment]::GetEnvironmentVariable($Name)
                    if ($value) { $value } else { $Default }
                }

                $IsGitHubActions = $ghActions
                . $path
                Get-Variable -Name $propertyName -ValueOnly
            } $propertiesPath $IsGitHubActions $Name
        }
        finally {
            foreach ($key in $originalEnv.Keys) {
                [Environment]::SetEnvironmentVariable($key, $originalEnv[$key])
            }
        }
    }
}

Describe 'report.properties' {

    Context 'UseGitHubFlavour' {

        It 'should always be defined as a boolean, never left null' {
            $result = Get-ReportProperty -Name UseGitHubFlavour `
                                         -EnvironmentVariables @{ GITHUB_ACTIONS = $null; ZF_BUILD_DOTNET_USE_GITHUB_FLAVOUR = $null }
            $result | Should -BeOfType [bool]
            $result | Should -BeFalse
        }

        It 'should be true on GitHub Actions even though $IsGitHubActions is still $false when the properties load' {
            # Regression test for https://github.com/zerofailed/ZeroFailed.Build.DotNet/issues/35: DevOps.Common
            # defines '$IsGitHubActions = $false' before this file is loaded, so a default that read the variable
            # never fell through to the GITHUB_ACTIONS environment check.
            Get-ReportProperty -Name UseGitHubFlavour `
                               -IsGitHubActions $false `
                               -EnvironmentVariables @{ GITHUB_ACTIONS = 'true'; ZF_BUILD_DOTNET_USE_GITHUB_FLAVOUR = $null } |
                Should -BeTrue
        }

        It 'should be false when running elsewhere' {
            Get-ReportProperty -Name UseGitHubFlavour `
                               -EnvironmentVariables @{ GITHUB_ACTIONS = $null; ZF_BUILD_DOTNET_USE_GITHUB_FLAVOUR = $null } |
                Should -BeFalse
        }

        It 'should be overridable to false via ZF_BUILD_DOTNET_USE_GITHUB_FLAVOUR on GitHub Actions' {
            Get-ReportProperty -Name UseGitHubFlavour `
                               -EnvironmentVariables @{ GITHUB_ACTIONS = 'true'; ZF_BUILD_DOTNET_USE_GITHUB_FLAVOUR = 'false' } |
                Should -BeFalse
        }

        It 'should be overridable to true via ZF_BUILD_DOTNET_USE_GITHUB_FLAVOUR when running elsewhere' {
            Get-ReportProperty -Name UseGitHubFlavour `
                               -EnvironmentVariables @{ GITHUB_ACTIONS = $null; ZF_BUILD_DOTNET_USE_GITHUB_FLAVOUR = 'true' } |
                Should -BeTrue
        }
    }
}