Added an optional database parameter to the Connect-RivetSession function.

Author: KhoiKy

CHANGELOG.md

@@ -3,6 +3,16 @@
 
 # Rivet Changelog
 
+## 0.21.0
+
+> Released 24 May 2023
+
+### Changed
+
+* Added an optional `Database` parameter to `Connect-RivetSession` function that allows specifying the default database
+to connect to when the Rivet session contains multiple databases.
+
+
 ## 0.20.0
 
 > Released 19 May 2023

Rivet/Functions/Connect-RivetSession.ps1

@@ -4,15 +4,30 @@ function Connect-RivetSession
     [CmdletBinding()]
     param(
         [Parameter(Mandatory)]
-        [Rivet_Session] $Session
+        [Rivet_Session] $Session,
+
+        [String] $Database
     )
 
     Set-StrictMode -Version 'Latest'
     Use-CallerPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState
 
-    # We want the first database to be the default database.
-    for($idx = $Session.Databases.Count - 1; $idx -ge 0 ; --$idx)
+    $databasesToConnect = & {
+        if( $Database )
+        {
+            $Database | Write-Output
+            return
+        }
+    
+        # If no Database specified, we want the first database to be the default database.
+        for($idx = $Session.Databases.Count - 1; $idx -ge 0 ; --$idx)
+        {
+            $Session.Databases[$idx].Name | Write-Output
+        }
+    }
+    
+    foreach ($db in $databasesToConnect)
     {
-        Connect-Database -Session $Session -Name $Session.Databases[$idx].Name
+        Connect-Database -Session $Session -Name $db
     }
 }

Rivet/Rivet.psd1

@@ -11,7 +11,7 @@
     RootModule = 'Rivet.psm1'
 
     # Version number of this module.
-    ModuleVersion = '0.20.0'
+    ModuleVersion = '0.21.0'
 
     # ID used to uniquely identify this module
     GUID = '8af34b47-259b-4630-a945-75d38c33b94d'

Test/Connect-RivetSession.Tests.ps1

@@ -0,0 +1,57 @@
+
+#Requires -Version 5.1
+Set-StrictMode -Version 'Latest'
+
+BeforeAll {
+    & (Join-Path -Path $PSScriptRoot -ChildPath 'Initialize-Test.ps1' -Resolve)
+
+    function ThenNoErrors
+    {
+        $Global:Error | Should -BeNullOrEmpty
+    }
+
+    function WhenConnectingRivet
+    {
+        param(
+            [String] $Database
+        )
+
+        $params = @{ }
+        if( $Database )
+        {
+            $params['Database'] = $Database
+        }
+
+        Connect-RivetSession -Session $RTSession @params
+    }
+}
+
+Describe 'Connect-RivetSession' {
+    AfterEach {
+        Stop-RivetTest
+    }
+
+    It 'should connect to specified database when given' {
+        Start-RivetTest -PhysicalDatabase @($RTDatabaseName, $RTDatabase2Name)
+        $RTSession.Connection.Database | Should -Be $RTDatabaseName
+        $RTSession.CurrentDatabase.Name | Should -Be $RTDatabaseName
+
+        WhenConnectingRivet -Database $RTDatabase2Name
+        $RTSession.Connection.Database | Should -Be $RTDatabase2Name
+        $RTSession.CurrentDatabase.Name | Should -Be $RTDatabase2Name
+
+        ThenNoErrors
+    }
+
+    It 'should connect to the default database when no databases are given' {
+        Start-RivetTest -PhysicalDatabase @($RTDatabaseName, $RTDatabase2Name)
+        $RTSession.Connection.Database | Should -Be $RTDatabaseName
+        $RTSession.CurrentDatabase.Name | Should -Be $RTDatabaseName
+
+        WhenConnectingRivet
+        $RTSession.Connection.Database | Should -Be $RTDatabaseName
+        $RTSession.CurrentDatabase.Name | Should -Be $RTDatabaseName
+
+        ThenNoErrors
+    }
+}