Integrating Tricentis Tosca with Percy

Learn how to integrate Tricentis Tosca with Percy to run visual tests.

Percy now works directly with Tricentis Tosca, allowing you to add visual testing to your existing Tosca test cases without creating or maintaining separate test suites.

This integration currently supports Percy Web through the Percy Snapshot Special Execution Task, which lets you capture visual snapshots as part of your Tosca workflow.

Percy-Tosca integration workflow

The following diagram illustrates how Percy integrates with Tosca to capture and process visual snapshots during test execution.

Getting started

Percy’s Tosca integration is a DLL extension that allows users to call PercySnapshot method. Before you begin, ensure you have the following:

• Node 14 or later
• Tosca browser extension

Steps

Follow these steps to set up Percy Tosca integration:

Step 1: Install or update the @percy/cli development dependency using the following command:

npm install --save-dev @percy/cli

Step 2: Sign in to Percy and create a new Percy project. After the project is created, Percy generates a unique project token. Use this token and run the following commands to set the token and start the Percy CLI:

set PERCY_TOKEN=<YOUR PERCY PROJECT TOKEN>
percy exec:start

Step 3: Download the appropriate PercyTosca dll file, use this PercyTosca dll for Tosca v16 and this PercyTosca dll for Tosca v23 and above. Copy it to the following location:

C:\Program Files (x86)\TRICENTIS\Tosca Testsuite\Percy

Step 4: In Tosca Commander, navigate to:

Project settings → TBox → Extension loading → Extensions Folders

Add the previously copied path to the Extensions list.

Step 5: Create a new module in Tosca Commander and configure it by manually entering the following parameters:

• Engine → Percy
• SpecialExecutionTask → PercySnapshot

Step 6: Define the parameters for the PercySnapshot module. The SnapshotName parameter is required. All other parameters are optional. For each parameter you add, enter Parameter as the key and True as the value.

The PercySnapshot method supports the following parameters:

Step 7: Import the module into your Tosca test cases. After import, the module displays in Tosca as shown in this example.

Step 8: Restart Tosca Commander and run your tests.

Step 9: A build link will appear in the CLI output. Click the link to view your Percy snapshots.

When you run another build with visual changes to your application, Percy takes new snapshots. You can then see the comparisons between the two runs on the new build.

Step 10: Stop the Percy CLI using the following command:

percy exec:stop

Once set up, Tosca test cases that include the Percy Snapshot module will automatically capture and upload visual snapshots to Percy, allowing you to review visual changes alongside your functional tests in the Percy dashboard.