salesforce-utam-e2e-testing

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

salesforce-utam-e2e-testing

(★ 20)

🧪 SFDX template for using UTAM to establish Salesforce E2E UI test automation in your project

salesforce-utam-e2e-testing Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🧪 Salesforce UTAM E2E Testing

[![Validation](https://github.com/svierk/salesforce-utam-e2e-testing/actions/workflows/ci.yml/badge.svg?branch=main&event=push)](https://github.com/svierk/salesforce-utam-e2e-testing/actions/workflows/ci.yml)

## About the project

This repository provides a template for setting up E2E UI test automation with [UTAM](https://developer.salesforce.com/docs/platform/utam) (UI Test Automation Model) in Salesforce DX projects.
In addition to the basic test setup configuration, a number of sample test cases are included to help you get started with UTAM. The configuration shown here was set up based on the contents of the following two repositories:

- [UTAM JavaScript Recipes](https://github.com/salesforce/utam-js-recipes) | Various examples of how to test the Salesforce UI with UTAM
- [Salesforce E-Bikes App](https://github.com/trailheadapps/ebikes-lwc) | LWC sample application with UTAM UI tests

## Prerequisites

To use this template, the [Node](https://nodejs.org/en/) version specified in the _package.json_ and the latest version of the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli) should already be installed.

## Getting started

Follow the steps below to get the template running and manually execute the sample tests already included. The sample tests should be generic enough to run in any Salesforce Org without specific configuration, such as a Trailhead Playground.

1. First clone the repository and open it with VS Code, install all the recommended extensions and run the following command to install all required dependencies:

```
   npm install
   ```

2. Next you need to authorize an org for which you want to run the tests. In VS Code this can be done by pressing **Command + Shift + P**, enter "sfdx", and select **SFDX: Authorize an Org**. Alternatively you can also run the following command from the command line:

```
   sf org login web
   ```

3. Compile all UTAM page objects:

```
   npm run test:ui:compile
   ```

4. Prepare the Salesforce login information:

```
   npm run test:ui:generate:login
   ```

5. Finally, execute all existing UI tests:

```
   npm run test:ui
   ```

**Note:** By default, the tests are executed in headless mode with the given configuration, i.e. the browser does not open visibly but runs tests in the background. This configuration is primarily intended for automatic execution in CI/CD pipelines. To deactivate the headless mode for local development and testing purposes, please comment out the following line in _wdio.conf.js_:

```
args: ['--headless']
```

## How to write your own tests

Creating UTAM tests is not trivial and the setup may involve one or two hurdles. Fortunately, there is a handy [UTAM Chrome Browser Extension](https://developer.salesforce.com/docs/platform/utam/guide/browser-extension.html) to help with writing the tests. This extension helps to identify the page objects of interest directly in the Salesforce org and generates the corresponding test code in the selected language:

## Automated test execution with GitHub Actions

UTAM tests can also be executed automatically in headless mode within a pipeline. The following Medium article describes how to an automated UTAM test execution in detail:

[Automate Salesforce E2E Testing using UTAM & GitHub Actions](https://medium.com/capgemini-salesforce-architects/automate-salesforce-e2e-testing-using-utam-github-actions-b11906fefc85)

Below is an example with GitHub Actions, which is also used in this repository and can be found in the _.github_ directory:

```yaml
# least-privilege token: the workflow only reads the repository
permissions:
  contents: read

jobs:
  tests:
    name: E2E UI Tests
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7.0.1
        with:
          persist-credentials: false # the GITHUB_TOKEN is not needed after the checkout
      - name: Select Node Version
        uses: svierk/get-node-version@v1.5.1
      - name: Install Dependencies
        run: npm ci
      - name: Install SF CLI
        uses: svierk/sfdx-cli-setup@v1.1.2
      - name: Salesforce Org Login
        uses: svierk/sfdx-login@v1.4.2
        with:
          client-id: ${{ secrets.SFDX_CONSUMER_KEY }}
          jwt-secret-key: ${{ secrets.SFDX_JWT_SECRET_KEY }}
          username: ${{ vars.SFDX_USERNAME }}
      - name: Compile UTAM Page Objects
        run: npm run test:ui:compile
      - name: Prepare Login Details
        run: npm run test:ui:generate:login
      - name: UTAM E2E Tests
        run: npm run test:ui
```

A few conventions worth copying along with the snippet:

- **Pin every action to an exact release tag** (`@v7.0.1`, not `@main` or `@v7`). A floating branch or major-version tag silently changes what runs in your pipeline; an exact tag makes every update a reviewable commit. [Dependabot](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference) keeps the pins current - see _.github/dependabot.yml_ for the `github-actions` ecosystem configuration used here.
- **Keep the org username in a repository variable, not a secret.** Only the connected app's consumer key (`SFDX_CONSUMER_KEY`) and the JWT private key (`SFDX_JWT_SECRET_KEY`) are confidential; `vars.SFDX_USERNAME` documents itself in the run log and keeps the secret list to what actually needs masking.
- **Never interpolate a secret into a `run:` script.** Pass it as an action input as shown above, or expose it through `env:` - inlining `${{ secrets.* }}` into a shell command puts it into the command line and, with the wrong quoting, into the log.
- **Grant the workflow only `contents: read`** and add further permissions per job, where they are needed.
- **Guard secret-dependent jobs against fork pull requests.** Those runs get no secrets by design, so an org login would fail for reasons unrelated to the change. In this repository the E2E job carries `if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository`.

## References

### Documentation

- [UTAM Developer Guide](https://developer.salesforce.com/docs/platform/utam) | Official UTAM documentation on Salesforce Developers
- [Run End-to-End Tests with the UI Test Automation Model (UTAM)](https://developer.salesforce.com/blogs/2022/05/run-end-to-end-tests-with-the-ui-test-automation-model-utam) | Post in Salesforce Developers' Blog

### Articles

- [Streamline E2E Testing with UTAM: Salesforce's UI Test Automation Model](https://medium.com/capgemini-salesforce-architects/streamline-e2e-testing-with-utam-salesforces-ui-test-automation-model-51c0effb1e67) | Medium post
- [Automate Salesforce E2E Testing using UTAM & GitHub Actions](https://medium.com/capgemini-salesforce-architects/automate-salesforce-e2e-testing-using-utam-github-actions-b11906fefc85) | Medium post
- [From a Jira Ticket to a Running Salesforce UI Test Written by an AI](https://medium.com/capgemini-salesforce-architects/from-a-jira-ticket-to-a-running-salesforce-ui-test-written-by-an-ai-f18be3108130) | Medium post

### Videos & Talks

- [Run End-to-End Tests With UTAM](https://www.youtube.com/watch?v=rxZfsjIwWeU) | YouTube video, 15min UTAM overview
- [Getting Started with UTAM](https://www.youtube.com/watch?v=YMxeCJexgMY) | YouTube video, 1h step by step guide for writing a UTAM test
- [Streamline Salesforce E2E UI Testing with UTAM](https://www.youtube.com/watch?v=xnoZ2Lc_WnQ) | Apex Hours session, August 2025 ([slides](https://svierk.github.io/slides/apex-hours-25-utam.pdf))
- [Automate UI Testing with AI and UTAM](https://www.youtube.com/watch?v=-PaSb-zWjbQ) | Apex Hours session, August 2026 ([slides](https://svierk.github.io/slides/apex-hours-26-utam-ai.pdf))

salesforce-utam-e2e-testing

salesforce-utam-e2e-testing Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

salesforce-utam-e2e-testing

salesforce-utam-e2e-testing Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README