Merge pull request #12 from Matticusau/SQL2017

Improved ErrorHandling, Assembly loading, support for up to SQL 2017

Author: Matticusau

CHANGELOG.md

@@ -0,0 +1,42 @@
+# Change log for SqlWorkloadGenerator
+
+## Unreleased
+
+* None
+
+### 1.1.0.0
+
+* Created version independant .sql files
+* Moved the Example_RunWorkload.ps1 to .\Examples
+* Renamed Example_RunWorkload.ps1 to AzureSQLDbExample.ps1
+* Created .\Examples\SQLServerExample.ps1
+* Created .\Examples\LoadTestExample.cmd
+* Improved error handling
+* SQL Assemblies are loaded by importing either SqlServer or SQLPS module
+
+### 0.1.2
+
+* Moved functions to a module for better code coverage
+* Improved test coverage through AppVeyor
+
+### 0.1.1
+
+* Added Duration parameter and better error verbatim (Issue4)
+
+### 0.1.0
+
+* Added functions Invoke-Workload, Invoke-WorkloadSetup, Invoke-WorkloadQuery (Issue6)
+
+### 0.0.3
+
+* Added ability to specify frequency for improved control over workload level
+
+### 0.0.2
+
+* Added minor fixes (issue #1) removal of Write-Host
+
+
+### 0.0.1
+
+* Initial release includes basic functionality and sample scripts
+

Example_RunWorkload.ps1 Examples/AzureSQLDbExample.ps1Example_RunWorkload.ps1 renamed to Examples/AzureSQLDbExample.ps1

@@ -1,7 +1,7 @@
 <#
     .NOTES
         
-        Script:     Example_RunWorkload.ps1
+        Script:     AzureSqlDbExample.ps1
         Author:     Matt Lavery (https://github.com/Matticusau/SqlWorkloadGenerator)
         Created:    29/05/2015
         Version:    0.0.1
@@ -10,6 +10,7 @@
         Version    Who          When           What
         --------------------------------------------------------------------------------------------------
         0.0.1      MLavery      29/05/2015     Initial Coding
+        0.0.2      MLavery      09/11/2017     Renamed from Example_RunWorkload.ps1 to AzureSQLDbExample.ps1
 
         DISCLAIMER
         This Sample Code is provided for the purpose of illustration only and is not intended to be 

Examples/LoadTestExample.cmd

@@ -0,0 +1,25 @@
+@echo off
+REM Script:     LoadTestExample.cmd
+REM Author:     Matt Lavery (https://github.com/Matticusau/SqlWorkloadGenerator)
+REM Created:    09/11/2017
+REM Version:    0.0.1
+REM 
+REM DISCLAIMER
+REM This Sample Code is provided for the purpose of illustration only and is not intended to be 
+REM used in a production environment.  THIS SAMPLE CODE AND ANY RELATED INFORMATION ARE PROVIDED 
+REM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED 
+REM TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.  We grant 
+REM You a nonexclusive, royalty-free right to use and modify the Sample Code and to reproduce and 
+REM distribute the object code form of the Sample Code, provided that You agree: (i) to not use 
+REM Our name, logo, or trademarks to market Your software product in which the Sample Code is 
+REM embedded; (ii) to include a valid copyright notice on Your software product in which the 
+REM Sample Code is embedded; and (iii) to indemnify, hold harmless, and defend Us and Our 
+REM suppliers from and against any claims or lawsuits, including attorneys’ fees, that arise 
+REM or result from the use or distribution of the Sample Code.
+
+Start PowerShell.exe -File "C:\Workload\RunWorkload.ps1" -SQLServer "SQLNode01\Prd01" -Database "AdventureWorks2014" -TSQLFile "C:\Workload\SqlScripts\AdventureWorksWorkload.sql" -Frequency "Fast"
+Start PowerShell.exe -File "C:\Workload\RunWorkload.ps1" -SQLServer "SQLNode01\Prd01" -Database "AdventureWorks2014" -TSQLFile "C:\Workload\SqlScripts\AdventureWorksWorkload.sql" -Frequency "Fast"
+Start PowerShell.exe -File "C:\Workload\RunWorkload.ps1" -SQLServer "SQLNode01\Prd01" -Database "AdventureWorks2014" -TSQLFile "C:\Workload\SqlScripts\AdventureWorksWorkload.sql" -Frequency "Normal"
+Start PowerShell.exe -File "C:\Workload\RunWorkload.ps1" -SQLServer "SQLNode01\Prd01" -Database "AdventureWorks2014" -TSQLFile "C:\Workload\SqlScripts\AdventureWorksWorkload.sql" -Frequency "Fast"
+Start PowerShell.exe -File "C:\Workload\RunWorkload.ps1" -SQLServer "SQLNode01\Prd01" -Database "AdventureWorks2014" -TSQLFile "C:\Workload\SqlScripts\AdventureWorksWorkload.sql" -Frequency "Fast"
+PAUSE

Examples/SQLServerExample.ps1

@@ -0,0 +1,30 @@
+<#
+    .NOTES
+        
+        Script:     SQLServerExample.ps1
+        Author:     Matt Lavery (https://github.com/Matticusau/SqlWorkloadGenerator)
+        Created:    09/11/2017
+        Version:    0.0.1
+    
+        Change History
+        Version    Who          When           What
+        --------------------------------------------------------------------------------------------------
+        0.0.1      MLavery      09/11/2017     Initial Coding
+        
+        DISCLAIMER
+        This Sample Code is provided for the purpose of illustration only and is not intended to be 
+        used in a production environment.  THIS SAMPLE CODE AND ANY RELATED INFORMATION ARE PROVIDED 
+        "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED 
+        TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.  We grant 
+        You a nonexclusive, royalty-free right to use and modify the Sample Code and to reproduce and 
+        distribute the object code form of the Sample Code, provided that You agree: (i) to not use 
+        Our name, logo, or trademarks to market Your software product in which the Sample Code is 
+        embedded; (ii) to include a valid copyright notice on Your software product in which the 
+        Sample Code is embedded; and (iii) to indemnify, hold harmless, and defend Us and Our 
+        suppliers from and against any claims or lawsuits, including attorneys’ fees, that arise 
+        or result from the use or distribution of the Sample Code.
+#>
+
+Set-Location C:\WorkLoad 
+
+.\RunWorkload.ps1 -SQLServer svrSqlDev01.contoso.com -Database AdventureWorks2017 -UserName DemoUsr -Password ?????? -TSQLFile C:\WorkLoad\SqlScripts\AdventureWorksWorkload.sql

SingleQuery01.sql Examples/SingleQuery01.sqlSingleQuery01.sql renamed to Examples/SingleQuery01.sql

@@ -9,9 +9,21 @@ Provides sample SQL Scripts and PowerShell scripts to automate the generation of
 Current supported versions are:
 - SQL 2008 / R2
 - SQL 2012
-- SQL 2014 (via 2012 script)
+- SQL 2014
+- SQL 2016
+- SQL 2017
 - SQL Azure
 
+This tool is currently only supported on Windows and PowerShell. It has not yet been tested on PowerShell Core. It will though work remotely against SQL Server on Linux.
+
+NOTE: For SQL Server 2014 and higher, use the non-version specific scripts.
+
+## Installation
+To install and use this toolset follow these steps.
+1. Create a folder *C:\Workload* or other suitable location
+2. Download the project source or one of the releases to that location you just created
+3. Create a wrapper script or start the RunWorkload.ps1 script from the console depending on your needs. Refer to the examples for various ways to execute this workload.
+
 ## Example
 
 This example runs a single workload session against a database running in SQL Azure with a fast frequency between batches
@@ -21,13 +33,17 @@ Set-Location C:\WorkLoad
 .\RunWorkload.ps1 -SQLServer myazuredb.database.windows.net -Database DemoDB01 -UserName DemoUsr -Password ?????? -TSQLFile C:\WorkLoad\AdventureWorksAzureBOLWorkload.sql -Frequency 'Fast'
 ```
 
+For further examples see the files provided in [.\Examples](Examples\) folder.
+
 ## Running Larger Workloads
 
 To run a larger workload you may need to execute this script multiple times. To achieve this create a .cmd file with multiple lines such as:
 ```
 Start PowerShell.exe -File "C:\Workload\RunWorkload.ps1" -SQLServer "SqlServer.contoso.com" -Database "DemoDB01" -TSQLFile "C:\Workload\AdventureWorks2012BOLWorkload.sql" -Frequency "Fast"
 ```
 
+For an example see the file [.\Examples\LoadTestExample.cmd](Examples\LoadTestExample.cmd)
+
 ## PowerShell Execution Policies
 
 As this workload is generated through a PowerShell script, it is not excempt from PowerShell Execution Policies. The default policy is Restricted which will stop you from executing the workload script. In production environments it is **not** recommended to set this to Unrestricted, instead you should use `RemoteSigned` or `AllSigned` and then code sign the script files with your organisations certificate.
@@ -67,32 +83,6 @@ The frequency of which to run the statements at (Fast, Normal, or Slow)
 ### Duration
 The duration to run the workload for (seconds). 0 is unlimited, otherwise maximum allowed is 172800 (48hrs) 
 
-## Versions
-
-### 0.1.2
-
-* Moved functions to a module for better code coverage
-* Improved test coverage through AppVeyor
-
-### 0.1.1
-
-* Added Duration parameter and better error verbatim (Issue4)
-
-### 0.1.0
-
-* Added functions Invoke-Workload, Invoke-WorkloadSetup, Invoke-WorkloadQuery (Issue6)
-
-### 0.0.3
-
-* Added ability to specify frequency for improved control over workload level
-
-### 0.0.2
-
-* Added minor fixes (issue #1) removal of Write-Host
-
-
-### 0.0.1
-
-* Initial release includes basic functionality and sample scripts
+## Change log
+A full list of changes in each version can be found in the [change log](CHANGELOG.md).
 
-    

README.md

@@ -4,7 +4,7 @@
         Script:     RunWorkload.ps1
         Author:     Matt Lavery (https://github.com/Matticusau/SqlWorkloadGenerator)
         Created:    29/05/2015
-        Version:    0.1.1
+        Version:    0.1.2
             
         Change History
         Version    Who          When           What

RunWorkload.ps1

@@ -12,7 +12,7 @@
 RootModule = 'RunWorkload.psm1'
 
 # Version number of this module.
-ModuleVersion = '1.0.0.0'
+ModuleVersion = '1.1.0.0'
 
 # ID used to uniquely identify this module
 GUID = 'cd04fe86-97b8-473b-b104-b8e8040df9fe'

RunWorkload/RunWorkload.psd1

@@ -2,12 +2,13 @@
         Script:     RunWorkload.psm1
         Author:     Matt Lavery (https://github.com/Matticusau/SqlWorkloadGenerator)
         Created:    05/05/2016
-        Version:    1.0.0.0
+        Version:    1.1.0.0
             
         Change History
         Version      Who          When           What
         --------------------------------------------------------------------------------------------------
         1.0.0.0      MLavery      05/05/2016     Initial Coding from existing scripts (Issue6)
+        1.1.0.0      MLavery      09/11/2017     Better error handling and uses the SQL modules to load assemblies
         
 
         DISCLAIMER
@@ -102,9 +103,9 @@ function Invoke-SqlWorkload
         catch
         {
             #Report the error
-            Write-Warning "Could not execute"
-            Write-Warning "$($_.Exception.Message)";
-            #throw $_;
+            Write-Warning "Could not execute via Invoke-SqlWorkloadQuery"
+            Write-Warning "$($PSItem.Exception.Message)";
+            #throw $PSItem;
         }
         finally
         {
@@ -171,13 +172,23 @@ function Invoke-SqlWorkloadQuery
         Write-Debug "`$Query = $($Query)";
 
     }
+    # SQL Exception
+    catch [System.Data.SqlClient.SqlException],[Microsoft.SqlServer.Management.Common.ExecutionFailureException]
+    {
+        # Use Verbose for troubleshooting
+        Write-Verbose "Failed to execute: $($Query)";
+        # we need to go a few levels deep to get the actual exception from sql
+        Write-Verbose "$($PSItem.Exception.InnerException.InnerException.Message)";
+        # throw $PSItem;
+    }
+    # All Other Exception
     catch
     {
-        #Use Verbose for troubleshooting
+        # Use Verbose for troubleshooting
         Write-Verbose "Failed to execute: $($Query)";
-        #we need to go a few levels deep to get the actual exception from sql
-        Write-Verbose "$($psitem.Exception.InnerException.InnerException.Message)";
-        #throw $_;
+        # General error so just use the exception
+        Write-Verbose "$($PSItem.Exception.Message)";
+        # throw $PSItem;
     }
     finally
     {
@@ -250,11 +261,26 @@ function Invoke-SqlWorkloadSetup
     {
         #Write an error
         Write-Error "Setup Script Failed"
-        #throw $_;
+        #throw $PSItem;
         Exit; # stop the script execution
     }
 }
 
 
 # Load the SMO assembly 
-[void][reflection.assembly]::LoadWithPartialName("Microsoft.SqlServer.Smo"); 
+# [void][reflection.assembly]::LoadWithPartialName("Microsoft.SqlServer.Smo"); 
+# Import the SQL Module to load the assemblies
+if (-not(Get-module -Name SqlServer -ListAvailable -ErrorAction SilentlyContinue))
+{
+    Import-Module -Name SqlServer;
+}
+elseif (-not(Get-module -Name SQLPS -ListAvailable -ErrorAction SilentlyContinue)) 
+{
+    Import-Module -Name SqlServer -DisableNameChecking;
+}
+else 
+{
+    Write-Error "Neither the SqlServer or SQLPS PowerShell Modules are installed"
+    #throw $PSItem;
+    Exit; # stop the script execution
+}