Merge pull request #5 from Lombiq/issue/FINI-448

FINI-448: Utility scripts SQL auth

Author: Piedone

OrchardCore/Reset-OrchardCoreApp/Reset-OrchardCoreApp.psm1

@@ -37,6 +37,12 @@ function Reset-OrchardCoreApp
 
         [Parameter(ParameterSetName = "ServerDB")]
         [string] $SetupDatabaseName = "OrchardCore",
+        
+        [Parameter(ParameterSetName = "ServerDB")]
+        [string] $SetupDatabaseSqlUser = "sa",
+        
+        [Parameter(ParameterSetName = "ServerDB")]
+        [string] $SetupDatabaseSqlPassword = $null,
 
         [Parameter(ParameterSetName = "ServerDB")]
         [switch] $Force,
@@ -163,7 +169,7 @@ function Reset-OrchardCoreApp
 
             "Using the following database name: `"$SetupDatabaseName`"."
 
-            if (New-SqlServerDatabase -SqlServerName $SetupDatabaseServerName -DatabaseName $SetupDatabaseName -Force:$Force.IsPresent -ErrorAction Stop)
+            if (New-SqlServerDatabase -SqlServerName $SetupDatabaseServerName -DatabaseName $SetupDatabaseName -Force:$Force.IsPresent -ErrorAction Stop -UserName $SetupDatabaseSqlUser -Password $SetupDatabaseSqlPassword)
             {
                 "Database `"$SetupDatabaseServerName\$SetupDatabaseName`" created!"
             }
@@ -179,8 +185,17 @@ function Reset-OrchardCoreApp
                 }
             }
 
+            $Security = if (-not $SetupDatabaseSqlPassword) 
+            { 
+                "Integrated Security=True"
+            }
+            else 
+            {
+                "User Id=$SetupDatabaseSqlUser;Password=$SetupDatabaseSqlPassword"    
+            }
+
             # MARS is necessary for Orchard.
-            $SetupDatabaseConnectionString = "Server=$SetupDatabaseServerName;Database=$SetupDatabaseName;Integrated Security=True;MultipleActiveResultSets=True;"
+            $SetupDatabaseConnectionString = "Server=$SetupDatabaseServerName;Database=$SetupDatabaseName;$Security;MultipleActiveResultSets=True;"
         }
 
 

Readme.md

@@ -15,6 +15,10 @@ For the Azure-related scripts you'll need the Azure (the new "Az") PowerShell mo
 
 To be able to import SQL Server export files (bacpac files) you'll need to import the *SqlServer\Import-BacpacToSqlServer\Import-BacpacToSqlServer.reg* registry script. Then you'll be able to right click on bacpac files and select "Import to SQL Server with PowerShell", or simply double-click on them. This needs the DAC Framework so if you get a "No SQL Package executable found for importing the database!" error then install it from [here](https://docs.microsoft.com/en-us/sql/tools/sqlpackage/sqlpackage-download?view=sql-server-ver15).
 
+If you are working on a remote database without SQL Server locally installed (eg. Azure or the [Docker container](https://hub.docker.com/_/microsoft-mssql-server)) you have to install "PowerShell Extensions for Microsoft SQL Server 2012". Despite the name it works with newer versions as well. See [this tutorial](https://sqlpadawan.com/2018/08/01/how-to-install-sql-server-sqlps-powershell-module/).
+
+As of writing this document [SQL Server in Docker doesn't support Windows authentication](https://github.com/microsoft/mssql-docker/issues/165). You can use the commands that support SQL authentication (eg. `Reset-OrchardCoreApp`) by providing a user name and password with the appropriate arguments.
+
 
 ## Installing the PowerShell modules
 
@@ -42,7 +46,7 @@ On what the different scripts do specifically and how to use them take a look at
     - ExportLastCommitToGit: Exports the files changed in the last commit of a hg repo to a git repo as a patch.
 - SqlServer: A lot of scripts for common SQL Server tasks.
     - Get-DefaultSqlServerName: Gets the name of the default local SQL Server instance.
-    - Import-BacpacToSqlServer: Imports a .bacpac file to a database on a local SQL Server instance. With the attached Registry file you can also add an Explorer context menu shortcut to it.
+    - Import-BacpacToSqlServer: Imports a .bacpac file to a database on a local SQL Server instance. With the attached Registry file you can also add an Explorer context menu shortcut to it. Use the Docker version if you need that, but make sure to edit the `-ConnectionString` value first!
     - New-SqlServerDatabase: Creates a new database on the given SQL Server instance, after dropping it first if it already exists.
     - Test-SqlServer: Tests the connection to a local SQL Server instance.
     - Test-SqlServerDatabase: Checks whether the given database exists in a local SQL Server instance.

SqlServer/Import-BacpacToSqlServer/Import-BacpacToSqlServer.docker.edit.reg

@@ -0,0 +1,32 @@
+<#
+.Synopsis
+   Creates a new SQL Server connection object.
+#>
+
+[System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SqlServer.ConnectionInfo")
+
+function New-SqlServerConnection
+{
+    [CmdletBinding()]
+    Param
+    (
+        [Parameter(Mandatory = $true)]
+        [string] $ServerName,
+
+        [string] $UserName = $null,
+
+        [string] $Password = $null
+    )
+
+    Process
+    {
+        if (-not $UserName -or -not $Password) 
+        {
+            New-Object -TypeName Microsoft.SqlServer.Management.Common.ServerConnection -ArgumentList $ServerName
+        }
+        else
+        {
+            New-Object -TypeName Microsoft.SqlServer.Management.Common.ServerConnection -ArgumentList $ServerName, $UserName, $Password
+        }
+    }
+}

SqlServer/New-SqlServerConnection/New-SqlServerConnection.psm1

@@ -19,19 +19,19 @@ function New-SqlServerDatabase
         [Parameter(Mandatory = $true)]
         [string] $DatabaseName,
 
-        [switch] $Force
+        [switch] $Force,
+        
+        [string] $UserName = $null,
+
+        [string] $Password = $null
     )
 
     Process
     {
-        if (!(Test-SqlServer $SqlServerName))
-        {
-            throw ("Could not find SQL Server at `"$SqlServerName`"!")
-        }
-
-        $server = New-Object ("Microsoft.SqlServer.Management.Smo.Server") $SqlServerName
+        $serverConnection = New-SqlServerConnection $SqlServerName $UserName $Password
+        $server = New-Object -TypeName Microsoft.SqlServer.Management.Smo.Server -ArgumentList $serverConnection
 
-        if (Test-SqlServerDatabase -SqlServerName $SqlServerName -DatabaseName $DatabaseName)
+        if (Test-SqlServerDatabase -SqlServerName $SqlServerName -DatabaseName $DatabaseName -UserName $UserName -Password $Password)
         {
             if ($Force.IsPresent)
             {

SqlServer/New-SqlServerDatabase/New-SqlServerDatabase.psm1

@@ -14,11 +14,17 @@ function Test-SqlServer
     Param
     (
         [Parameter(Mandatory = $true)]
-        [string] $ServerName
+        [string] $ServerName,
+
+        [string] $UserName = $null,
+
+        [string] $Password = $null
     )
 
     Process
     {
-        return (New-Object ("Microsoft.SqlServer.Management.Smo.Server") $ServerName).InstanceName -ne $null
+        $Connection = New-SqlServerConnection $ServerName $UserName $Password
+
+        return (New-Object ("Microsoft.SqlServer.Management.Smo.Server") $Connection).InstanceName -ne $null
     }
 }

SqlServer/Test-SqlServer/Test-SqlServer.psm1

@@ -17,17 +17,31 @@ function Test-SqlServerDatabase
         [string] $SqlServerName,
 
         [Parameter(Mandatory = $true)]
-        [string] $DatabaseName
+        [string] $DatabaseName,
+
+        [string] $UserName = $null,
+
+        [string] $Password = $null
     )
 
     Process
     {
-        if (!(Test-SqlServer $SqlServerName))
+        if (!(Test-SqlServer $SqlServerName $UserName $Password))
         {
             throw ("Could not find SQL Server at `"$SqlServerName`"!")
         }
 
-        $server = New-Object ("Microsoft.SqlServer.Management.Smo.Server") $SqlServerName
-        return ($server.Databases | Where-Object { $PSItem.Name -eq $DatabaseName }) -ne $null
+        $server = New-SqlServerConnection $SqlServerName $UserName $Password
+        $server.Connect()
+        
+        # This works even for remote servers when $server.Databases returns empty.
+        $databases = New-Object "System.Collections.Generic.HashSet[string]"
+        $reader = $server.ExecuteReader("SELECT name FROM sys.databases")
+        while ($reader.Read()) { $databases.Add($reader.GetString(0).ToUpperInvariant()) | Out-Null }
+        
+        $reader.Close()
+        $server.Disconnect()
+
+        return $databases.Contains($DatabaseName.ToUpperInvariant())
     }
 }