SentryOne Test Visual Studio Extension Wizards

EOL: SentryOne Test reached its end of life date on June 15, 2022. See the Solarwinds End of Life Policy for more information.

The wizards within SentryOne Test provide convenient ways to create tests. Each wizard contains common usage patterns for crafting the tests. There are several ways you can reach a wizard: 

Reach a wizard by :Image

Adding a new SentryOne Test group to a project by right clicking on the project node in solution explorer and then selecting Add > SentryOne Test Group.

SentryOne Test select Wizard by adding SentryOne Test Group
Adding new groups or tests within an existing SentryOne Test group.SentryOne Test select wizard by adding a new test within an existing group
Selecting the wizard from within the SentryOne Test Toolbox.SentryOne Test Toolbox

Note:  SentryOne Test walks you through the necessary steps to set up some wizards.

Data Validation

The Data Validation wizard allows you to build tests that validate specific query results. Using this wizard shortens the time it takes to build tests that help detect corrupt or inaccurate data.

Data Set Tab

When launched, the wizard presents an empty display. The data set window specifies the connection and query used within the data validation wizard.

SentryOne Test Data Validation Wizard

To begin, you must configure a connection for the Data Validation wizard. Configure a connection by completing the following steps:  

1. Select Configure to create a new connection and open the Choose Data Source window. Select the data source properties, and then select OK to open the Connection Properties window.
SentryOne Test Configure Connection for Data Validation Wizard

2. Enter the server name, select the authentication method, and then enter the name of the desired database for the connection.

3. Select Test Connection to verify that the connection with the server is successful. Select OK to finalize the connection.
SentryOne Test Connection Properties window

4. Select whether to use Low memory mode in your data validation wizard.

SentryOne Test Data Validation Wizard Low memory mode

Note:  Low memory mode specifies whether to store the results within a temporary file or in memory. This option is best used for larger data sets.

5. Type in, or copy a query to be used with the Data Validation wizard. Once satisfied with the query, select Next to continue on with the Configuration tab. The data set query uses the same advanced editor as the Query Asset.
SentryOne Test Data Validation Wizard configure query

Configuration Tab

The Configuration tab specifies the columns and aggregates to use within the data validation. Complete the configuration of the Data Validation wizard by completing the following steps: 

  1. Select Only pass validation if no rows are present if you expect the query to return no rows. Otherwise, select New to add the first column validation.
SentryOne Test Data Validation Wizard Only pass validation if no rows are present
SentryOne Test Data Validation Wizard New Validation Columns

2. Add as many validation columns as you wish. Validations can be aggregations or row-by-row comparisons. The choices for comparison types depend on the data type of the selected column. Once satisfied with the validation columns, select Finish to finalize the wizard.

SentryOne Test Data Validation Wizard select Finish

{{snippet.successicon}] The Data Validation Wizard is configured and is ready for testing!

SentryOne Test Configured Data Validation test example

Interactive Comparison

The Interactive Comparison wizard in SentryOne Test allows a data comparison to be built while inspecting the results that the comparison would produce. This allows you to tailor the comparison, and shortens the cycle between intent and results. 

When launched, the wizard presents an empty display.

SentryOne Test Interactive Comparison Wizard

To begin, select a connection or create a new connection for each side of the comparison. Create a new connection by selecting the button to the right of the connection selector. 

Note:  Once a connection is selected, the code completion becomes available in the editor if the connection is to a SQL Server instance.

Type in, or copy queries for the expected and actual sides of the comparison, and then select Compare to run a comparison and the display the data.

SentryOne Test Interactive Comparison Wizard select Compare

Note:  In the image above, all of the columns are faded out. A column is faded out when it's not part of the comparison.

To configure the Interactive Comparison, you must complete the following steps: 

Keys

In the Expected section, define the key that uniquely identifies rows in the comparison by selecting the column header of the desired column, and then selecting Set as key. If more than one column makes up the key, select on the column header of each key column, and then select Add to keys

SentryOne Test Interactive Comparison Set as key
Set as key

SentryOne Test Interactive Comparison Add to keys
Add to keys

Note:  Add keys manually by selecting Keys, and then selecting Add in the lower left panel.

SentryOne Test Interactive Comparison Add keys
Select Add

SentryOne Test Interactive Comparison Add Key Column
Add Key Column options

The display can then show us rows that exist only in the expected or actual result sets, and highlights the full row on each side.

SentryOne Test Interactive Comparison Key columns highlighted

Comparisons

Select Comparisons in the Expected section, and then select Auto map comparison columns to automatically map the comparison columns from the expected and actual sets. The interactive comparison auto maps columns by finding columns that have matching names and compatible types.

SentryOne Test Interactive Comparison Auto map comparison columns

Note:  Add comparisons manually by selecting Comparisons, and then selecting Add in the Expected section. Manually adding comparisons allows you to specify tolerances or match options for the comparison. For example, numerals within 2% tolerance or a string matching that ignores case.

SentryOne Test Interactive Comparison Add Comparison
Add Comparison

SentryOne Test Interactive Comparison Add Comparison Column options
Add Comparison Column

Aggregates

It's also possible to configure aggregates, so that you could, for example, ensure that the total of a column from the expected side is within 2% of the total from the actual side. Add aggregates by selecting Aggregates and then selecting Add in the Expected section.

SentryOne Test Interactive Comparison Aggregates
Add Aggregates

SentryOne Test Interactive Comparison Add Aggregate Comparison Column
Add Aggregate Comparison Column

View the results of aggregations by selecting Aggregation Results in the Actual section.

SentryOne Test Interactive Comparison Aggregation Results

Configuration

Change the configuration of the comparison by selecting Configuration in the Expected section. Configure whether to ignore certain categories of difference and whether disk based sets are used.

SentryOne Test Interactive Comparison Configuration

Note:  Use Disk based sets when you expect a large number of results from the server and want to keep the memory usage to a minimum. When using disk based sets your query must return the rows in the order specified by your keys because disk based sets cannot be sorted.

There are also configuration options in the Actual section. The configuration options in the Actual section only apply to the operation of the wizard and don't change how the actual generated tests execute. Here you can decide to show equal rows or not, automatically reload the comparison when you change things and set a limit on the number of rows.

SentryOne Test Interactive Comparison Actual section configuration options

Note:  If automatic reload is configured, queries are not re-run when changing the comparison configuration. They only run if:

  • A different connection has been selected
  • The query has changed
  • The Compare button is selected

Success: When you are happy with the comparison configuration, select Finish to generate the elements in your test.

SentryOne Test Interactive Comparison test example

Note:  Compare Grids and Comparison Manifest items have a quick action marker in the bottom right. Select the cog icon to access the interactive wizard and modify an existing comparison.

Extract query from trace

The Extract query from trace wizard builds a group of tests spanning an entire database. This shortens the time it takes to build tests, and helps detect corrupt or inaccurate data within an SSAS database.

SentryOne Test Extract query from trace wizard

Specify Database

When launched, the wizard presents an empty display. The database window specifies the server and database used within the validation testing wizard.

Select Items to Test

Once loading completes, select all items the user wishes to validate. The items available depends on whether the database model type and compatibility level. 

Multidimensional databases display the database's cubes.
Tabular databases with compatibility levels between 1100 and 1103 display the database's cubes.
Tabular databases with compatibility levels of 1200 or higher display the database's tables.

Once you're satisfied with the items to include within the validation testing, select Next.

Specify Options

On the specify options window, select the types of tests to generate.

Once you're satisfied with the options, select Finish. SentryOne Test builds several test groups and tests. The amount generated depends on the number of measures and attributes present. 

Due to the nature of the tests generated, you may need to correct validation errors. These errors typically occur within the Check if a specific attribute member exists tests.

To remove the validation errors, you need to specify the member. Replace <INSERTMEMBERHERE> with the desired member.

Execute Report Wizard

The SSRS Report Execution wizard tests report executions based on specific report parameters. This wizard ensures the report execution results are accurate given the specified parameters.

SentryOne Test Execute Report Wizard

Specify Server

When launched, the wizard presents an empty display. Specify the SSRS web service you wish to use.

SentryOne Test Execute Report Wizard Specify server

The web service can be either a native or SharePoint Web Service. When using a SharePoint Web Service, be sure to select Is SharePoint. Depending on the type of web service, the format for the web service and initial path are different.

Native Web Service

Service AddressInitial Path
http[s]://<ServerName>[:<Port>]/ReportServer
[_<InstanceName>]/ReportService2010.asmx
To specify the root folder of a native web service, use /. Otherwise, you can build the path to the starting folder.

Example initial paths:
  •    /
  •   /SharedDocuments/ReportFolder

SharePoint Web Service

Service AddressInitial Path
http[s]://<ServerName>[:<Port>]/_vti_bin
/ReportServer[_<InstanceName>]
/ReportService2010.asmx
To specify the root folder of a SharePoint web service, use http[s]://<ServerName>[:<Port>]/. Otherwise, you can build the path to the starting folder.

Example initial paths:
  • http[s]://<ServerName>[:<Port>]
  • http[s]://<ServerName>[:<Port>]/SharedDocuments/ReportFolder

Select Report

On the Select report window, navigate through the web service folders to the target report.

SentryOne Test Execute Report Wizard Select reportAfter selecting the report and selecting next, SentryOne Test quickly loads the report's parameters.

Enter Parameters

On the Enter parameters window, update the parameters to the report.

SentryOne Test Execute Report Wizard Enter parameters

Specify Tests

On the Specify tests window, select the types of tests to generate.

SentryOne Test Execute Report Wizard Specify testsOnce you're satisfied with the parameters and options, select Finish to build a test group for the report.