Search Documentation by Keyword

Search Documentation by Keyword

Getting Started

You are here:
← All Topics

There are five key steps to getting deltaTest up and running. The steps are the same, whether you are setting up a simple trial on your local machine, or rolling deltaTest out to a global organization:

  1. Clone the deltaTest code repository to a shared location.
  2. Create a shared configuration file.
  3. Create a new shared test repository.
  4. Install DB helper objects in your test environment databases.
  5. Install deltaTest on your local machine.
  6. Execute the Hello World test!

Cloning the Code Repository

The deltaTest code repository is located on GitHub. Clone the repo into a shared network location. Every user who needs to interact with deltaTest should have permissions to execute scripts in this location.

As an alternative to cloning the repo from the Enterprise Data Foundation account, you can fork the repo to your own account and clone it from there. You can also simply download the files to your shared location. The only advantage conferred by creating a Git clone is ease of updating: just connect your local repo to the new version and run git pull.

Creating a Shared Config File

The deltaTest code repo contains a file called shared_config_template.psd1. Make a copy of this file and name it shared_config.psd1. You will alter the copy to express your own implementation’s settings.

Note that your organization’s copy of the shared config template is excluded by .gitignore. If you are working on your own deltaTest fork, you never need to worry about pushing your private project configurations back up to GitHub.

Configure your shared config file for your organization. Assuming you are using deltaTest defaults, the most important configurations are those describing your test environments. See the comments in the config file for more information.

Creating a Test Repository

Your tests should also live in a shared location, but a separate one from the deltaTest code repository. To get started, copy the contents of STARTER TEST REPO from your Resources directory into your new test repository location.

DB Helper Objects

From the deltaTest shared repository, directory ./Resources/DB contains three SQL scripts:

  • 1 - tvf_Core_Rows.sql
  • 2 - tvf_Core_Split_Delimiter.sql
  • 3 - usp_Core_Query.sql

These objects help deltaTest extract test results from your database. Simply run the scripts, in order, in each test environment database.

Local Installation

The deltaTest local installation script makes the following changes to your machine:

  • It creates a local directory containing local configuration data and an initialization script.
  • It creates system environment variables pointing at the local and shared config directories.
  • If necessary, it installs the SqlServer PowerShell module and open-source text differencing engine WinMerge.

You need local admin privileges in order to install deltaTest on your machine. Even with elevated privileges, you may get an error indicating that the execution of scripts is disabled on your system. If this occurs, open a PowerShell command prompt as administrator and run the following command:

Set-ExecutionPolicy Unrestricted -Force

Note that the local installation process locks your machine to the code repo whose installer you ran. If you want to run deltaTest from a different code repository, run its installer first.

Run a Test

Did you use the deltaTest sample test repo to create your new test repository? Then find file HelloWorld.ps1 in its root directory, right-click, and select Run with PowerShell. A few seconds later, you should see this:

Hello, World!

If you do, then deltaTest is up and running in your shared code repository, in your shared test repo, and on your local machine!