Merge pull request #86 from sqlcollaborative/feature/tokens

Configurable variable tokens

Author: nvarscar

dbops.psm1

@@ -116,6 +116,32 @@ Register-PSFConfigValidation -Name "connectionType" -ScriptBlock {
     return $Result
 }
 
+Register-PSFConfigValidation -Name "tokenRegex" -ScriptBlock {
+    Param (
+        $Value
+    )
+    $failMessage = "Should contain capture group (token)"
+    $Result = New-Object PSObject -Property @{
+        Success = $True
+        Value   = $null
+        Message = ""
+    }
+    try {
+        if (([string]$Value) -is [string] -and [string]$Value -like '*(token)*') {
+            $Result.Value = [string]$Value
+        }
+        else {
+            $Result.Message = $failMessage
+            $Result.Success = $False
+        }
+    }
+    catch {
+        $Result.Message = "Failed to convert value to string. $failMessage"
+        $Result.Success = $False
+    }
+    return $Result
+}
+
 # defining defaults
 
 Set-PSFConfig -FullName dbops.ApplicationName -Value "dbops" -Initialize -Description "Application name in the connection string"
@@ -145,7 +171,8 @@ Set-PSFConfig -FullName dbops.mail.Subject -Value "DBOps deployment status" -Ini
 Set-PSFConfig -FullName dbops.security.encryptionkey -Value "~/.dbops.key" -Initialize -Description "Path to a custom encryption key used to encrypt/decrypt passwords. The key should be a binary file with a length of 128, 192 or 256 bits. Key will be generated automatically if not exists."
 Set-PSFConfig -FullName dbops.security.usecustomencryptionkey -Value ($PSVersionTable.Platform -eq 'Unix') -Validation bool -Initialize -Description "Determines whether to use a custom encryption key for storing passwords. Enabled by default only on Unix platforms."
 Set-PSFConfig -FullName dbops.rdbms.type -Value 'SqlServer' -Validation connectionType -Initialize -Description "Assumes a certain RDBMS as a default one for each command. SQLServer by default"
-Set-PSFConfig -FullName dbops.package.slim -Value $false -Validation bool -Initialize -Description "Decides whether to make the packages 'slim' and omit module files when creating the package. Default: false."
+Set-PSFConfig -FullName dbops.package.slim -Value $false -Validation bool -Initialize -Description "Decides whether to make the packages 'slim' and omit module files when creating the package. Default: `$false"
+Set-PSFConfig -FullName dbops.config.variabletoken -Value "\#\{(token)\}" -Validation tokenRegex -Initialize -Description "Variable replacement token. Regex string that will be replaced with values from -Variables parameters. Default: \#\{(token)\}"
 
 # extensions for SMO
 $typeData = Get-TypeData -TypeName 'Microsoft.SqlServer.Management.Smo.Database'

internal/functions/Get-VariableTokens.ps1 renamed to internal/functions/Get-VariableToken.ps1

@@ -1,19 +1,20 @@
-Function Get-VariableTokens {
+Function Get-VariableToken {
     <#
     .SYNOPSIS
     Get a list of #{tokens} from the string
-    
+
     .DESCRIPTION
     Returns an array of tokens that matches token regex #{token}
-    
+
     .PARAMETER InputString
     String to run regex against
-    
+
     .EXAMPLE
     Get-VariableTokens '#{foo} myString #{bar}' # returns @('foo','bar')
     #>
     Param (
-        [string]$InputString
+        [string]$InputString,
+        [string]$RegexString
     )
-    [regex]::matches($InputString, "\#\{([a-zA-Z0-9.]*)\}") | ForEach-Object { $_.Groups[1].Value }
+    [regex]::matches($InputString, $RegexString) | ForEach-Object { $_.Groups[1].Value }
 }

internal/functions/Resolve-VariableToken.ps1

@@ -18,20 +18,21 @@
     [CmdletBinding()]
     Param (
         [object[]]$InputObject,
-        [object]$Runtime
+        [object]$Runtime,
+        [string]$TokenRegex = (Get-DBODefaultSetting -Name config.variabletoken -Value)
     )
     foreach ($obj in $InputObject) {
         if ($obj -is [string]) {
             $output = $obj
-            foreach ($token in (Get-VariableTokens $obj)) {
+            foreach ($token in (Get-VariableToken -InputString $obj -RegexString $TokenRegex.Replace('token', '[a-zA-Z0-9\.]+'))) {
                 #Replace variables found in the config
-                $tokenRegEx = "\#\{$token\}"
+                $tokenRegExString = $TokenRegex.Replace('token', [Regex]::Escape($token))
                 if ($Runtime) {
                     if ($Runtime -is [hashtable]) { $variableList = $Runtime.Keys }
                     else { $variableList = $Runtime.psobject.Properties.Name }
                     if ($variableList -contains $token) {
                         Write-PSFMessage -Level Debug -Message "Replacing token $token"
-                        $output = $output -replace $tokenRegEx, $Runtime.$token
+                        $output = $output -replace $tokenRegExString, $Runtime.$token
                     }
                 }
             }

internal/json/dbops.json

@@ -50,7 +50,7 @@
     "Internal": [
         "internal\\classes\\DBOps.enums.ps1",
         "internal\\functions\\Get-DbopsFile.ps1",
-        "internal\\functions\\Get-VariableTokens.ps1",
+        "internal\\functions\\Get-VariableToken.ps1",
         "internal\\functions\\Resolve-VariableToken.ps1",
         "internal\\functions\\Get-NewBuildNumber.ps1",
         "internal\\functions\\Get-ExternalLibrary.ps1",

tests/Invoke-DBOQuery.Tests.ps1

@@ -134,10 +134,18 @@ Describe "Invoke-DBOQuery tests" -Tag $commandName, IntegrationTests {
         }
         It "should run the query with custom variables" {
             $query = "SELECT '#{Test}' AS A, '#{Test2}' AS B UNION ALL SELECT '3' AS A, '4' AS B"
-            $result = Invoke-DBOQuery -Query $query -SqlInstance $script:mssqlInstance -Credential $script:mssqlCredential -As DataTable -Variables @{ Test = '1'; Test2 = '2'}
+            $result = Invoke-DBOQuery -Query $query -SqlInstance $script:mssqlInstance -Credential $script:mssqlCredential -As DataTable -Variables @{ Test = '1'; Test2 = '2' }
             $result.A | Should -Be '1', '3'
             $result.B | Should -Be '2', '4'
         }
+        It "should run the query with custom variables and custom token template" {
+            Set-PSFConfig -FullName dbops.config.variabletoken -Value '\$(token)\$'
+            $query = "SELECT '`$Test`$' AS A, '`$Test2`$' AS B UNION ALL SELECT '3' AS A, '4' AS B"
+            $result = Invoke-DBOQuery -Query $query -SqlInstance $script:mssqlInstance -Credential $script:mssqlCredential -As DataTable -Variables @{ Test = '1'; Test2 = '2' }
+            $result.A | Should -Be '1', '3'
+            $result.B | Should -Be '2', '4'
+            (Get-PSFConfig -FullName dbops.config.variabletoken).ResetValue()
+        }
         It "should connect to the server from a custom variable" {
             $query = "SELECT 1 AS A, 2 AS B UNION ALL SELECT 3 AS A, 4 AS B"
             $result = Invoke-DBOQuery -Query $query -SqlInstance '#{srv}' -Credential $script:mssqlCredential -As DataTable -Variables @{ Srv = $script:mssqlInstance }
@@ -146,7 +154,7 @@ Describe "Invoke-DBOQuery tests" -Tag $commandName, IntegrationTests {
         }
         It "should run the query with custom parameters" {
             $query = "SELECT @p1 AS A, @p2 AS B"
-            $result = Invoke-DBOQuery -Query $query -SqlInstance $script:mssqlInstance -Credential $script:mssqlCredential -Parameter @{ p1 = '1'; p2 = 'string'}
+            $result = Invoke-DBOQuery -Query $query -SqlInstance $script:mssqlInstance -Credential $script:mssqlCredential -Parameter @{ p1 = '1'; p2 = 'string' }
             $result.A | Should -Be 1
             $result.B | Should -Be string
         }
@@ -192,7 +200,7 @@ Describe "Invoke-DBOQuery tests" -Tag $commandName, IntegrationTests {
         }
         It "should throw a connection timeout error" {
             $query = "SELECT 1/0"
-            { $result = Invoke-DBOQuery -Query $query -SqlInstance localhost:6493 -Credential $script:mssqlCredential -ConnectionTimeout 1} | Should throw "The server was not found or was not accessible"
+            { $result = Invoke-DBOQuery -Query $query -SqlInstance localhost:6493 -Credential $script:mssqlCredential -ConnectionTimeout 2 } | Should throw "The server was not found or was not accessible"
         }
         It "should fail when parameters are of a wrong type" {
             { Invoke-DBOQuery -Query 'SELECT 1/@foo' -SqlInstance $script:mssqlInstance -Credential $script:mssqlCredential -Parameter @{ foo = 'bar' } -Silent } | Should throw 'Conversion failed'