brand-new XPlat connection string builder

nvarscar · nvarscar · commit 2e3bfeb51eaf · 2019-01-07T13:00:03.000-06:00
diff --git a/functions/Invoke-DBOQuery.ps1 b/functions/Invoke-DBOQuery.ps1
@@ -175,6 +175,7 @@ function Invoke-DBOQuery {
         #Build connection string
         #$connString = Get-ConnectionString -Configuration $config -Type $Type
         #$dbUpConnection = Get-ConnectionManager -ConnectionString $connString -Type $Type
+        Write-PSFMessage -Level Debug -Message "Getting the connection object"
         $dbUpConnection = Get-ConnectionManager -Configuration $config -Type $Type
         $dbUpSqlParser = Get-SqlParser -Type $Type
         $status = [DBOpsDeploymentStatus]::new()
@@ -183,6 +184,7 @@ function Invoke-DBOQuery {
         if ($null -ne $dbUpConnection.IsScriptOutputLogged -and -Not $config.Silent) {
             $dbUpConnection.IsScriptOutputLogged = $true
         }
+        Write-PSFMessage -Level Verbose -Message "Establishing connection with $Type $($config.SqlInstance)"
         try {
             $managedConnection = $dbUpConnection.OperationStarting($dbUpLog, $null)
         }
@@ -214,6 +216,7 @@ function Invoke-DBOQuery {
         foreach ($qText in $queryText) {
             $queryList += Resolve-VariableToken $qText $config.Variables
         }
+        Write-PSFMessage -Level Debug -Message "Preparing to run $($queryList.Count) queries"
         try {
             $ds = [System.Data.DataSet]::new()
             $qCount = 0
diff --git a/internal/functions/Get-ConnectionString.ps1 b/internal/functions/Get-ConnectionString.ps1
@@ -4,35 +4,80 @@ function Get-ConnectionString {
         [DBOpsConfig]$Configuration,
         [DBOps.ConnectionType]$Type
     )
-    #Build connection string
+    # Build connection string
     if (!$Configuration.ConnectionString) {
-        $CSBuilder = [System.Data.SqlClient.SqlConnectionStringBuilder]::new()
-        $CSBuilder["Server"] = $Configuration.SqlInstance
-        if ($Configuration.Database) { $CSBuilder["Database"] = $Configuration.Database }
-        if ($Configuration.Encrypt) { $CSBuilder["Encrypt"] = $true }
-        $CSBuilder["Connection Timeout"] = $Configuration.ConnectionTimeout
+        $csBuilder = switch ($Type) {
+            SqlServer { [System.Data.SqlClient.SqlConnectionStringBuilder]::new() }
+            PostgreSQL { [Npgsql.NpgsqlConnectionStringBuilder]::new() }
+            Oracle { [Oracle.ManagedDataAccess.Client.OracleConnectionStringBuilder]::new() }
+            MySQL { [MySql.Data.MySqlClient.MySqlConnectionStringBuilder]::new() }
+        }
+        # finding all the right connection string properties
+        $conn = @{}
+        foreach ($key in 'Server', 'Data Source') {
+            if ($csBuilder.ContainsKey($key)) { $conn.Server = $key; break }
+        }
+        if (-not $conn.Server) {
+            Stop-PSFFunction -Message "Failed to find a Server property in the connection string object" -EnableException $true
+        }
 
-        if ($Configuration.Credential) {
-            $CSBuilder["User ID"] = $Configuration.Credential.UserName
-            $CSBuilder["Password"] = $Configuration.Credential.GetNetworkCredential().Password
+        foreach ($key in 'Connection Timeout', 'Timeout') {
+            if ($csBuilder.ContainsKey($key)) { $conn.ConnectionTimeout = $key; break }
         }
-        elseif ($Configuration.Username) {
-            if ($Password) {
-                $currentCred = [pscredential]::new($Configuration.Username, $Password)
+        if (-not $conn.ConnectionTimeout) {
+            Stop-PSFFunction -Message "Failed to find a Timeout property in the connection string object" -EnableException $true
+        }
+
+        # support for servername:port and trimming
+        if ($Configuration.SqlInstance -match '^\s*(.+)[:|,]\s*(\d+)\s*$') {
+            $server = $Matches[1]
+            $port = $Matches[2]
+        }
+        else {
+            $server = $Configuration.SqlInstance
+            $port = $null
+        }
+        if ($port) {
+            # check if port is an independent property and set it, otherwise add the port back to the connection string
+            if ($csBuilder.ContainsKey('Port')) {
+                $csBuilder[$conn.Server] = $server
+                $csBuilder.Port = $port
             }
             else {
+                if ($Type -eq [DBOps.ConnectionType]::SqlServer) {
+                    $csBuilder[$conn.Server] = "$server,$port"
+                }
+                else {
+                    $csBuilder[$conn.Server] = "$server`:$port"
+                }
+            }
+        }
+
+        if ($Configuration.Database -and $csBuilder.ContainsKey('Database')) { $csBuilder["Database"] = $Configuration.Database }
+        if ($Configuration.Encrypt -and $csBuilder.ContainsKey('Encrypt')) { $csBuilder["Encrypt"] = $true }
+        if ($Configuration.ApplicationName -and $csBuilder.ContainsKey('Application Name')) { $csBuilder["Application Name"] = $Configuration.ApplicationName }
+        if ($Configuration.ExecutionTimeout -and $csBuilder.ContainsKey('Command Timeout')) { $csBuilder["Command Timeout"] = $Configuration.ExecutionTimeout }
+        $csBuilder[$conn.ConnectionTimeout] = $Configuration.ConnectionTimeout
+        # define authentication
+        if ($Configuration.Credential) {
+            $csBuilder["User ID"] = $Configuration.Credential.UserName
+            $csBuilder["Password"] = $Configuration.Credential.GetNetworkCredential().Password
+        }
+        elseif ($Configuration.Username) {
+            $csBuilder["User ID"] = $Configuration.UserName
+            if ($Configuration.Password) {
                 $currentCred = [pscredential]::new($Configuration.Username, $Configuration.Password)
+                $csBuilder["Password"] = $currentCred.GetNetworkCredential().Password
             }
-            $CSBuilder["User ID"] = $currentCred.UserName
-            $CSBuilder["Password"] = $currentCred.GetNetworkCredential().Password
         }
         else {
-            $CSBuilder["Integrated Security"] = $true
-        }
-        if ($Type -eq 'SQLServer') {
-            $CSBuilder["Application Name"] = $Configuration.ApplicationName
+            if ($csBuilder.ContainsKey('Integrated Security')) {
+                $csBuilder["Integrated Security"] = $true
+            }
         }
-        return $CSBuilder.ToString()
+        # generate the connection string
+        $connString = $csBuilder.ToString()
+        return $connString
     }
     else {
         return $Configuration.ConnectionString
diff --git a/tests/Install-DBOPackage.Tests.ps1 b/tests/Install-DBOPackage.Tests.ps1
@@ -34,15 +34,17 @@ $fullConfigSource = Join-PSFPath -Normalize "$here\etc\full_config.json"
 $testPassword = 'TestPassword'
 $encryptedString = $testPassword | ConvertTo-SecureString -Force -AsPlainText | ConvertTo-EncryptedString
 $newDbName = "_test_$commandName"
+$dropDatabaseScript = 'IF EXISTS (SELECT * FROM sys.databases WHERE name = ''{0}'') BEGIN ALTER DATABASE [{0}] SET SINGLE_USER WITH ROLLBACK IMMEDIATE; DROP DATABASE [{0}]; END' -f $newDbName
+$createDatabaseScript = 'IF NOT EXISTS (SELECT * FROM sys.databases WHERE name = ''{0}'') BEGIN CREATE DATABASE [{0}]; END' -f $newDbName
 
 Describe "Install-DBOPackage integration tests" -Tag $commandName, IntegrationTests {
     BeforeAll {
         if ((Test-Path $workFolder) -and $workFolder -like '*.Tests.dbops') { Remove-Item $workFolder -Recurse }
         $null = New-Item $workFolder -ItemType Directory -Force
         $null = New-Item $unpackedFolder -ItemType Directory -Force
         (Get-Content $fullConfigSource -Raw) -replace 'replaceMe', $encryptedString | Out-File $fullConfig -Force
-        $dropDatabaseScript = 'IF EXISTS (SELECT * FROM sys.databases WHERE name = ''{0}'') BEGIN ALTER DATABASE [{0}] SET SINGLE_USER WITH ROLLBACK IMMEDIATE; DROP DATABASE [{0}]; END' -f $newDbName
         $null = Invoke-DBOQuery -SqlInstance $script:mssqlInstance -Silent -Credential $script:mssqlCredential -Database master -Query $dropDatabaseScript
+        $null = Invoke-DBOQuery -SqlInstance $script:mssqlInstance -Credential $script:mssqlCredential -Database master -Query $createDatabaseScript
     }
     AfterAll {
         if ((Test-Path $workFolder) -and $workFolder -like '*.Tests.dbops') { Remove-Item $workFolder -Recurse }
@@ -54,6 +56,8 @@ Describe "Install-DBOPackage integration tests" -Tag $commandName, IntegrationTe
             $p1 = New-DBOPackage -ScriptPath $v1scripts -Name "$workFolder\pv1" -Build 1.0 -Force
         }
         It "should deploy version 1.0 to a new database using -CreateDatabase switch" {
+            # Drop database and allow the function to create it
+            $null = Invoke-DBOQuery -SqlInstance $script:mssqlInstance -Silent -Credential $script:mssqlCredential -Database master -Query $dropDatabaseScript
             $testResults = Install-DBOPackage $p1 -CreateDatabase -SqlInstance $script:mssqlInstance -Credential $script:mssqlCredential -Database $newDbName -SchemaVersionTable $logTable -OutputFile "$workFolder\log.txt" -Silent
             $testResults.Successful | Should Be $true
             $testResults.Scripts.Name | Should Be $v1Journal
diff --git a/tests/Install-DBOSqlScript.Tests.ps1 b/tests/Install-DBOSqlScript.Tests.ps1
@@ -29,21 +29,24 @@ $packageFileName = Join-PSFPath -Normalize $workFolder "dbops.package.json"
 $cleanupPackageName = Join-PSFPath -Normalize "$here\etc\TempCleanup.zip"
 $outFile = Join-PSFPath -Normalize "$here\etc\outLog.txt"
 $newDbName = "_test_$commandName"
+$dropDatabaseScript = 'IF EXISTS (SELECT * FROM sys.databases WHERE name = ''{0}'') BEGIN ALTER DATABASE [{0}] SET SINGLE_USER WITH ROLLBACK IMMEDIATE; DROP DATABASE [{0}]; END' -f $newDbName
+$createDatabaseScript = 'IF NOT EXISTS (SELECT * FROM sys.databases WHERE name = ''{0}'') BEGIN CREATE DATABASE [{0}]; END' -f $newDbName
 
 Describe "Install-DBOSqlScript integration tests" -Tag $commandName, IntegrationTests {
     BeforeAll {
         if ((Test-Path $workFolder) -and $workFolder -like '*.Tests.dbops') { Remove-Item $workFolder -Recurse }
         $null = New-Item $workFolder -ItemType Directory -Force
-        $dropDatabaseScript = 'IF EXISTS (SELECT * FROM sys.databases WHERE name = ''{0}'') BEGIN ALTER DATABASE [{0}] SET SINGLE_USER WITH ROLLBACK IMMEDIATE; DROP DATABASE [{0}]; END' -f $newDbName
         $null = Invoke-DBOQuery -SqlInstance $script:mssqlInstance -Silent -Credential $script:mssqlCredential -Database master -Query $dropDatabaseScript
+        $null = Invoke-DBOQuery -SqlInstance $script:mssqlInstance -Silent -Credential $script:mssqlCredential -Database master -Query $createDatabaseScript
     }
     AfterAll {
-        $null = Invoke-DBOQuery -SqlInstance $script:mssqlInstance -Silent -Credential $script:mssqlCredential -Database $newDbName -InputFile $cleanupScript
         if ((Test-Path $workFolder) -and $workFolder -like '*.Tests.dbops') { Remove-Item $workFolder -Recurse }
         $null = Invoke-DBOQuery -SqlInstance $script:mssqlInstance -Silent -Credential $script:mssqlCredential -Database master -Query $dropDatabaseScript
     }
     Context "testing regular deployment with CreateDatabase specified" {
         It "should deploy version 1.0 to a new database using -CreateDatabase switch" {
+            # drop the database before installing the package
+            $null = Invoke-DBOQuery -SqlInstance $script:mssqlInstance -Silent -Credential $script:mssqlCredential -Database master -Query $dropDatabaseScript
             $testResults = Install-DBOSqlScript -ScriptPath $v1scripts -CreateDatabase -SqlInstance $script:mssqlInstance -Credential $script:mssqlCredential -Database $newDbName -SchemaVersionTable $logTable -OutputFile "$workFolder\log.txt" -Silent
             $testResults.Successful | Should Be $true
             $testResults.Scripts.Name | Should Be (Resolve-Path $v1scripts).Path
diff --git a/tests/Invoke-DBODeployment.Tests.ps1 b/tests/Invoke-DBODeployment.Tests.ps1
@@ -29,6 +29,8 @@ $packageFileName = Join-PSFPath -Normalize $workFolder "dbops.package.json"
 $cleanupPackageName = Join-PSFPath -Normalize "$here\etc\TempCleanup.zip"
 $outFile = Join-PSFPath -Normalize "$here\etc\outLog.txt"
 $newDbName = "_test_$commandName"
+$dropDatabaseScript = 'IF EXISTS (SELECT * FROM sys.databases WHERE name = ''{0}'') BEGIN ALTER DATABASE [{0}] SET SINGLE_USER WITH ROLLBACK IMMEDIATE; DROP DATABASE [{0}]; END' -f $newDbName
+$createDatabaseScript = 'IF NOT EXISTS (SELECT * FROM sys.databases WHERE name = ''{0}'') BEGIN CREATE DATABASE [{0}]; END' -f $newDbName
 
 Describe "Invoke-DBODeployment integration tests" -Tag $commandName, IntegrationTests {
     BeforeAll {
@@ -37,8 +39,6 @@ Describe "Invoke-DBODeployment integration tests" -Tag $commandName, Integration
         $null = New-Item $unpackedFolder -ItemType Directory -Force
         $packageName = New-DBOPackage -Path (Join-Path $workFolder 'tmp.zip') -ScriptPath $tranFailScripts -Build 1.0 -Force
         $null = Expand-Archive -Path $packageName -DestinationPath $workFolder -Force
-        $dropDatabaseScript = 'IF EXISTS (SELECT * FROM sys.databases WHERE name = ''{0}'') BEGIN ALTER DATABASE [{0}] SET SINGLE_USER WITH ROLLBACK IMMEDIATE; DROP DATABASE [{0}]; END' -f $newDbName
-        $createDatabaseScript = 'IF NOT EXISTS (SELECT * FROM sys.databases WHERE name = ''{0}'') BEGIN CREATE DATABASE [{0}]; END' -f $newDbName
         $null = Invoke-DBOQuery -SqlInstance $script:mssqlInstance -Silent -Credential $script:mssqlCredential -Database master -Query $dropDatabaseScript
         $null = Invoke-DBOQuery -SqlInstance $script:mssqlInstance -Silent -Credential $script:mssqlCredential -Database master -Query $createDatabaseScript
     }
diff --git a/tests/referenced.pester.ps1 b/tests/referenced.pester.ps1
@@ -0,0 +1,19 @@
+﻿Param
+(
+    [string[]]$Path = '.',
+    [string[]]$Tag
+
+)
+$params = @{
+    Path = $Path | ForEach-Object {
+        $item = switch -regex ($_) {
+            '\.Tests\.ps1' { $_ }
+            default { $_.Replace('.ps1', '.Tests.ps1') }
+        }
+        Get-Item $item
+    }
+}
+if ($Tag) {
+    $params += @{ Tag = $Tag}
+}
+& $PSScriptRoot\manual.pester.ps1 @params
