Tutorial: 1 - Install

1 - Install

Help installing this tool for the first time.

Before you start:

  • Get server-side access to tealium-solutions/test-example (for the integration test).

  • Ensure Alex Sandrey has added you to our Saucelabs account, and you have your API key.

  • Request access to the tealium/customer-success-testing-platform GitHub repo.

  • If you're on a Mac, make sure you have Xcode and the Command Line tools installed. If you’re not on a Mac, you’re on your own - we have no experience or testing so far - Windows test contributors are welcome!

  • Install VSCode (optional, but these docs use VSCode).

  • Install Docker Desktop.

  • To ensure that Java is installed (for the local Selenium server, if you want to run locally), follow any instructions after running this command:

    $ java -version

Installation Steps

1. Install homebrew

Use the latest instructions from https://brew.sh, currently:

$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

2. Update Homebrew

After installing homebrew (or especially if you skipped that step), it’s a good idea to make sure homebrew is up-to-date:

$ brew update

3. Install node with Homebrew

Includes npm:

$ brew install node

4. Clone repo

cd to your preferred path for Git repos (like ~/.git), and run:

git clone https://github.com/tealium/customer-success-testing-platform.git

5. Open that folder in VSCode.

6. Install dependencies

In the terminal of your local machine (or within VSCode itself if you prefer, the terminal is available from the ‘View’ menu), navigate to the path of your folder from above, then use the command install the relevant packages

$ npm install

8. Add .env file

In the root of the repo folder, create a file with the name .env (using example.env as a foundation).

  • TEALIUM_EMAIL (your Tealium email)

  • TEALIUM_PASS (your Tealium password) - used instead of an API key, better for internal APIs

  • SAUCE_USERNAME (your Sauce Labs User Name)

  • SAUCE_ACCESS_KEY (your Sauce Labs Access Key found under the Account > User Setting menu in Sauce Labs)

  • SAUCE_REGION ('eu' or 'us')

This file will be updated by the testing tool as well - only the above-listed values need to be set by the user.

9. Run an integration test

Make sure everything installed correctly by running unit and integration tests (takes a few minutes to run):

$ npm test

If that passes, you're ready to run your own tests!