Export-DbaDacPackage.Tests.ps1

$CommandName = $MyInvocation.MyCommand.Name.Replace(".Tests.ps1", "")
Write-Host -Object "Running $PSCommandPath" -ForegroundColor Cyan
. "$PSScriptRoot\constants.ps1"

Describe "$CommandName Unit Tests" -Tag 'UnitTests' {
    Context "Validate parameters" {
        [object[]]$params = (Get-Command $CommandName).Parameters.Keys | Where-Object { $_ -notin ('whatif', 'confirm') }
        [object[]]$knownParameters = 'SqlInstance', 'SqlCredential', 'Database', 'ExcludeDatabase', 'AllUserDatabases', 'Path', 'FilePath', 'DacOption', 'ExtendedParameters', 'ExtendedProperties', 'Type', 'Table', 'EnableException'
        $knownParameters += [System.Management.Automation.PSCmdlet]::CommonParameters
        It "Should only contain our specific parameters" {
            (@(Compare-Object -ReferenceObject ($knownParameters | Where-Object { $_ }) -DifferenceObject $params).Count ) | Should Be 0
        }
    }
}

Describe "$commandname Integration Tests" -Tags "IntegrationTests" {
    BeforeAll {
        $random = Get-Random
        $dbname = "dbatoolsci_exportdacpac_$random"
        try {
            $server = Connect-DbaInstance -SqlInstance $script:instance1
            $null = $server.Query("Create Database [$dbname]")
            $db = Get-DbaDatabase -SqlInstance $script:instance1 -Database $dbname
            $null = $db.Query("CREATE TABLE dbo.example (id int, PRIMARY KEY (id));
            INSERT dbo.example
            SELECT top 100 object_id
            FROM sys.objects")
        } catch { } # No idea why appveyor can't handle this

        $testFolder = 'C:\Temp\dacpacs'

        $dbName2 = "dbatoolsci:2_$random"
        $dbName2Escaped = "dbatoolsci`$2_$random"

        $null = New-DbaDatabase -SqlInstance $script:instance1 -Name $dbName2
    }
    AfterAll {
        Remove-DbaDatabase -SqlInstance $script:instance1 -Database $dbname, $dbName2 -Confirm:$false
    }

    # See https://github.com/dataplat/dbatools/issues/7038
    Context "Ensure the database name is part of the generated filename" {
        It "Database name is included in the output filename" {
            $result = Export-DbaDacPackage -SqlInstance $script:instance1 -Database $dbname
            $result.Path | Should -BeLike "*$($dbName)*"
        }

        It "Database names with invalid filesystem chars are successfully exported" {
            $result = Export-DbaDacPackage -SqlInstance $script:instance1 -Database $dbname, $dbName2
            $result.Path.Count | Should -Be 2
            $result.Path[0] | Should -BeLike "*$($dbName)*"
            $result.Path[1] | Should -BeLike "*$($dbName2Escaped)*"
        }
    }
    Context "Extract dacpac" {
        BeforeEach {
            New-Item $testFolder -ItemType Directory -Force
            Push-Location $testFolder
        }
        AfterEach {
            Pop-Location
            Remove-Item $testFolder -Force -Recurse
        }
        if ((Get-DbaDbTable -SqlInstance $script:instance1 -Database $dbname -Table example)) {
            # Sometimes appveyor bombs
            It "exports a dacpac" {
                $results = Export-DbaDacPackage -SqlInstance $script:instance1 -Database $dbname
                $results.Path | Should -Not -BeNullOrEmpty
                Test-Path $results.Path | Should -Be $true
                if (($results).Path) {
                    Remove-Item -Confirm:$false -Path ($results).Path -ErrorAction SilentlyContinue
                }
            }
            It "exports to the correct directory" {
                $relativePath = '.\'
                $expectedPath = (Resolve-Path $relativePath).Path
                $results = Export-DbaDacPackage -SqlInstance $script:instance1 -Database $dbname -Path $relativePath
                $results.Path | Split-Path | Should -Be $expectedPath
                Test-Path $results.Path | Should -Be $true
            }
            It "exports dacpac with a table list" {
                $relativePath = '.\extract.dacpac'
                $expectedPath = Join-Path (Get-Item .) 'extract.dacpac'
                $results = Export-DbaDacPackage -SqlInstance $script:instance1 -Database $dbname -FilePath $relativePath -Table example
                $results.Path | Should -Be $expectedPath
                Test-Path $results.Path | Should -Be $true
                if (($results).Path) {
                    Remove-Item -Confirm:$false -Path ($results).Path -ErrorAction SilentlyContinue
                }
            }
            It "uses EXE to extract dacpac" {
                $exportProperties = "/p:ExtractAllTableData=True"
                $results = Export-DbaDacPackage -SqlInstance $script:instance1 -Database $dbname -ExtendedProperties $exportProperties
                $results.Path | Should -Not -BeNullOrEmpty
                Test-Path $results.Path | Should -Be $true
                if (($results).Path) {
                    Remove-Item -Confirm:$false -Path ($results).Path -ErrorAction SilentlyContinue
                }
            }
        }
    }
    Context "Extract bacpac" {
        BeforeEach {
            New-Item $testFolder -ItemType Directory -Force
            Push-Location $testFolder
        }
        AfterEach {
            Pop-Location
            Remove-Item $testFolder -Force -Recurse
        }
        if ((Get-DbaDbTable -SqlInstance $script:instance1 -Database $dbname -Table example)) {
            # Sometimes appveyor bombs
            It "exports a bacpac" {
                $results = Export-DbaDacPackage -SqlInstance $script:instance1 -Database $dbname -Type Bacpac
                $results.Path | Should -Not -BeNullOrEmpty
                Test-Path $results.Path | Should -Be $true
                if (($results).Path) {
                    Remove-Item -Confirm:$false -Path ($results).Path -ErrorAction SilentlyContinue
                }
            }
            It "exports bacpac with a table list" {
                $relativePath = '.\extract.bacpac'
                $expectedPath = Join-Path (Get-Item .) 'extract.bacpac'
                $results = Export-DbaDacPackage -SqlInstance $script:instance1 -Database $dbname -FilePath $relativePath -Table example -Type Bacpac
                $results.Path | Should -Be $expectedPath
                Test-Path $results.Path | Should -Be $true
                if (($results).Path) {
                    Remove-Item -Confirm:$false -Path ($results).Path -ErrorAction SilentlyContinue
                }
            }
            It "uses EXE to extract bacpac" {
                $exportProperties = "/p:TargetEngineVersion=Default"
                $results = Export-DbaDacPackage -SqlInstance $script:instance1 -Database $dbname -ExtendedProperties $exportProperties -Type Bacpac
                $results.Path | Should -Not -BeNullOrEmpty
                Test-Path $results.Path | Should -Be $true
                if (($results).Path) {
                    Remove-Item -Confirm:$false -Path ($results).Path -ErrorAction SilentlyContinue
                }
            }
        }
    }
}