SQLServerCoverage

Code coverage for SQL Server T-SQL

Extended From SQLCover.

This project is based on SQLCover with additional features, bug fix and maintenances planned ahead.

SQLServerCoverage is a tool for checking code coverage (both line and branch) of tests executed in SQL sever 2008 and above.

Functionalities/Fixes added:

✅ Generate HTML Report Directly

✅ Branch Coverage

✅ CLI tools for different platforms

✅ Detailed documentation for setup

✅ Output SQL Server Generated Messages during Execution

✅ Generate latest Cobertura Report using 0.4 DTD

---

Index

• Download
• Build
• Installation
• Usage
  • 1. CLI
  • 2. Cover tSQLt Scripts
  • 3. Check Coverage Asynchronously
• Tidying up

Download

Download the latest release from the released packages.

Note: If you are unable to find a release compatible for your system, consider building it from the codebase using dotnet tool .

Read the build section for building the tool.

Build

Follow these steps to build the tool for your environment

• From the project root directory

  dotnet publish src/SQLServerCoverageCore/SQLServerCoverageCore.csproj  -c Release  -r <RUNTIME_IDENTIFIER> -o "releases/<RUNTIME_IDENTIFIER>" --self-contained true  -p:PublishSingleFile=true
  

  For RUNTIME_IDENTIFIER put the os version for your system.

  Check this source to choose a runtime

• Once finished, fetch the binary from /releases/<RUNTIME_IDENTIFIER> directory.

Installation

1. Put the tool in a directory of your preference.
2. Use the path to that directory as your environment variable

---

Usage

1. CLI

SQLServerCoverageCore

  -v, --verbose             Set output to verbose messages.

  -c, --command             Required. Choose command to run: Currently only Get-CoverTSql available

  -e, --exportType          Required. Choose export options : Export-OpenXml, Export-Html, Export-Cobertura

  -b, --debug               Prints out detailed output.

  -p, --requiredParams      Get required parameters for a command

  -k, --connectionString    Connection String to the SQL server

  -d, --databaseName        Default Database

  -q, --query               Sql Query, Ex. tSQLt.runAll OR your custom test executor

  -o, --outputPath          Output Path of The Export Result

  -t, --timeout             Wait time in Seconds before terminating the attempt to execute test SQL command

  -i, --ignore              Space separated list of database objects to ignore. Regex Accepted. Case 
                            sensitive depending on collation. Ex."sp_dummy_proc* sp_test_proc"

  --help                    Display this help screen.

  --version                 Display version information.

Example:

1. OpenCover Format

Generate the coverage report as xml

SQLServerCoverageCore -v true -c Get-CoverTSql -e Export-OpenXml -d <DATABASE_NAME> -q <Query> -o <OUTPUT_PATH> -k <CONNECTION_STRING> -t <connection_timeout> -i <ignore_sql_objects>

This will generate the OpenCover xml report in OUTPUT_PATH along with the source files in the database it is executed.

2. HTML Format

Generate the coverage report as html. It leverages ReportGenerator to Generate Inline HTML Report of Coverage.

SQLServerCoverageCore -v true -c Get-CoverTSql -e Export-Html -d <DATABASE_NAME> -q <Query> -o <OUTPUT_PATH> -k <CONNECTION_STRING> -t <connection_timeout> -i <ignore_sql_objects>

---

2. Cover tSQLt Script

tSQLt is a unit testing framework for Microsoft SQL Server.

It can be used with tSQLt framework to check the coverage.

If you have a script you want to cover then you can call:

SQLServerCoverageCore -v true -c Get-CoverTSql -e Export-OpenXml -d <DATABASE_NAME> -q "exec tSQLt.RunAll" -o <OUTPUT_PATH> -k <CONNECTION_STRING> -t <connection_timeout> -i <ignore_sql_objects>

This will generate a openxml coverage report where you can either examine the amount of statement covered or use the report to generate HTML report using ReportGenerator.

---

3. Check Coverage Asynchronously

🚧 This will soon be made available to be used from CLI. Now DLL need to be used.

If you want to have more control over what is covered, you can start a coverage session, run whatever queries you like from whatever application and then stop the coverage trace and get the CoverageResults which you can then use to generate a report.

$coverage = new-object SQLServerCoverage.CodeCoverage($connectionString, $database)
$coverage.Start()
#Execute The SQL scripts
$coverageResults = $coverage.Stop()

---

Tidying up

When we target local sql instances we delete the trace files but when targetting remote instances we are unable to delete the files as we do not (or potentially) do not have access. If this is the case keep an eye on the log directory and remove old "SQLServerCoverage-Trace-.xel" and "SQLServerCoverage-Trace-.xem" files.