My previous post, ‘Automating User Journey Tests‘, talked about the need for accessibility of user journey tests for each team member and how we chose Gauge as our framework of choice. I also introduced our open source steps library to make this possible for everybody in the team, irrespective of their programming background, to be able to contribute to user journey tests. In this post, I will expand on how to get started with the framework.

Please note that we expect the first few steps of this setup to be done by team members with a programming background and offer a fully configured workspace to the rest of the team members. Refer your colleagues with devops, development or automation skills to this repo that offers a fully setup workspace as well if your teams use container based workspaces.

Install Dependencies

These instructions are good for installing Gauge on MacOS. Please refer to Gauge docs for installing on Windows or Linux environments.

Before we begin, you must have Nodejs installed. You may install with homebrew or use appropriate installation package from Nodejs downloads page.

// Install Nodejs
brew install node

// Install Gauge
brew install gauge

// Alternately, you may also use NPM to install Gauge
// npm install -g @getgauge/cli

While not mandatory, we strongly recommend using VSCode as code editor or integrated development environment, as Gauge comes with a great extension for VSCode that makes working with user journey tests a breeze.

Setting up a new project

Start by creating a new folder for the user journey automation project and go inside the new folder created. If you would like to add user journey automation to an existing project, go to the respective folder and follow the command prompts below to proceed further.

// Create a new folder
mkdir gauge-taiko-demo

// go inside the folder
cd gauge-taiko-demo

// initialize a new Gauge project, that uses javascript and Taiko driver/test runner.
gauge init js

// Run default tests generated to verify everything is successful
npm test

Using Gauge Taiko Steps

In the next couple of steps, we will install Gauge Taiko Steps that will help build user journey tests for a majority of common scenarios without developing any code. Please refer to documentation at https://github.com/softrams/gauge-taiko-steps for more details.

// Install Gauge Taiko Steps
npm i @softrams/gauge-taiko-steps

// To include Gauge Taiko Steps to your project, update STEP_IMPL_DIR variable in./env/default/js.properties from: STEP_IMPL_DIR = tests to
STEP_IMPL_DIR = node_modules/@softrams/gauge-taiko-steps/lib, \
                tests

// Delete the default files generated during project setup
rm specs/example.spec
rm tests/step_implementation.js

That’s all! This setup is everything you need to build your first user journey test.

Creating Your First User Journey Test

Create a new file inside specs folder. For this demo, this file will be called, navigation.spec. Open the file in an editor and start creating your first step.

In the first step, we will just open cdc.gov website and check if text “About CDC” exists.

# Navigation User Journey Test
You may optionally add any notes in Markdown format

## Open CDC.gov website and check for text "About CDC" exists
* Goto "https://www.cdc.gov"
* Check text "About CDC" exists 

That’s it! Go ahead and run tests now. If everything is setup properly, you should see test executed successfully.

// Run tests
npm test

// You should see an output like this, if everything goes well

> gauge-taiko-template@ test /demos/gauge-taiko-demo
> gauge run specs/

# Navigation User Journey Test
  ## Open the CDC.gov website	 ✔ ✔

Successfully generated html-report to => /demos/gauge-taiko-demo/reports/html-report/index.html

Specifications:	1 executed	1 passed	0 failed	0 skipped
Scenarios:	1 executed	1 passed	0 failed	0 skipped

Total time taken: 3.512s

You may now open the test report in HTML file to easily review tests.

open ./reports/html-report/index.html

Here is a sample screenshot of the HTML report

In the upcoming posts, I will cover various capabilities and build a variety of user journey tests including accessibility audits without any additional programming. Please let me know if you have any questions or feedback by leaving a comment.

We are honored to have these awards

Tech Industry
Disruptive Tech Fast 50 Award
Inc 5000 Award
75 WD

At Softrams, we believe building great software solutions require a diverse, cross functional team with all hands on deck. One of the most important aspects the team focuses on is to automate end to end user journey tests and acceptance tests to enable continuous delivery of value. To make sure everybody in the team will be able to review and actively contribute to building user journey tests, we need a testing framework that is accessible to everyone, irrespective of programming background.

After evaluating a few options, we chose Gauge, which allows writing tests in plain language that every member of the team can understand. When needed, it allows enriching with additional contextual documentation and links with simple markdown semantics. However, every step in a test scenario needs to be translated to an action that can be executed by a test runner in the context of a browser. This is almost always left to test automation engineers and developers. We chose to bridge that gap as well by completely eliminating programming or development for each step.

Introducing Gauge Taiko Steps, an open sourced and free to use implementation of most of the common actions a typical user will rely on to interact with a web application. This repository implements common gauge steps for Taiko API, so that tests can be created in plain language without having to programmatically implement steps for most common scenarios. This means, anybody in the team can write fully executable and verifiable test specifications, in plain language, without any additional programming or development needed.

Check out https://github.com/softrams/gauge-taiko-steps for more

Softrams Gauge Taiko Steps

We have also created a fully browser based environment for non-programmers to easily access test projects and environments to review, contribute and run tests (without having to install and setup locally). This provides a docker container based environment with all test tooling setup and opens VS Code inside browser. You may provision and run workspaces using these containers to offer a fully automated browser based test environments.

Check out https://github.com/softrams/automation-toolset for more.

Softrams Automation Toolset

In a follow up post, I will share more details on the framework and step by step instructions to get started and how all team members can contribute to building great experiences.

We are honored to have these awards

Tech Industry
Disruptive Tech Fast 50 Award
Inc 5000 Award
75 WD