How to migrate your Visual Testing Project to Percy CLI

Regression examine ensures changes in the application don ’ t break any functionality. The package examination tool are generally focused on essay the functionality. Today, the web coating has been build, giving the same grandness to User Interface and Functionality. So both have adequate importance and anteriority. Testing the optical aspect of the website was hard in earlier days, as one had to liken two images manually, but today, there are a lot of tools that emerged in the market which make visual testing easier.

This clause will help you learn when to migrate, how to do it, and how to run Percy via CLI.

Percy for Visual Regression Testing

Percy is one such puppet dedicated to. It assist identify the visual changes of web applications such as styles, fonts, colors, etc. Percy is a SaaS-based product that provides many features such as multiple browser visual validations, side-by-side comparing, review, cull and accept changes from anywhere, etc.

Percy is typically desegregate with democratic exam automation tools such as,,, etc., to return the better possible outcome. Percy indorse integration with almost all test automation tools.

Earlier, Percy was shipped with the package@ percy/agent; using this package user was interacting with Percy and its base. Later Percy read the user requirement and decided to develop a next-generation user-friendly bundle which is now shipped as@ percy/cli.

Talk to an Expert

The @ percy/agentis now deprecated. No active growing is happen thither.

If you navigate to@ percy/agentnpm page you will see the message& # 8220; This package has been deprecated & # 8221;.

Considering the deprecation of@ percy/agentand the introduction of marque new next-generation SDK@ percy/cli, Percy suggestedmigratingall existing labor those are utilise@ percy/agentto the latest@ percy/cli.

Why should you transmigrate the visual testing project to Percy CLI?

The @ percy/agentis deprecated, there will not be active ontogeny in the future. This does your projection and tests flaky and undependable. Percy is actively releasing new features still, if you do not migrate your project to Percy CLI, you will not find any features or bug fixes. In the future, at some point in time, your visual fixation project will become obsolete. So it is important to migrate your visual fixation project to Percy CLI.

Pro tip: Tools like SUSA can handle this autonomously — upload your app and get results without writing a single test script.

How to transmigrate the visual testing project to Percy CLI?

The @ percy/clihas breaking changes, which means your project doesn & # 8217; t employment as is when you install@ percy/cli. So you need to migrate your undertaking. Percy understands user hurting, as migration requires some effort and learning new SDK configurations, so Percy is provide the dedicated npm package to transmigrate your project. The@ percy/migratecan be used for hassle-free migration of Percy to the latest version.

Let & # 8217; s understand what@ percy/migrate does

• Detects the SDK by analyze project dependencies
• If the project is using old SDK@ percy/agent, then it uninstalls
• Installs the latest Percy SDK@ percy/cli
• Migrates all Percy config files to match the latest version

Though all of the above steps can be performed manually the package create hassle-free migration by doing it in an automated way.

Step by Step guide to transmigrate visual regression test project to the latest Percy SDK

Step 1: Launch the Percy migration instrument

The @ percy/migratepuppet is utile in migrating your visual substantiation project to the latest Percy CLI. Use the below dictation to launch the migration tool.

npx @ percy/migrate

Step 2: Choose the better possible option in CLI

When you launch the CLI migration tool, it automatically detects the Percy SDK, which you are using, such as@ percy/cypress, @ percy/puppeteer, @ percy/webdriverio, etc. Typically below set of questions will be ask.

Are you presently using@ percy/cypress? Answer Yes

The next question will be

Install @ percy/cli(and remove@ percy/agent)? Answer Yes

This migrates your project to the modish Percy SDK and installs the Percy CLI.

Depending on your project, Percy might ask you a few more questions. For example, if you are using Cypress, it asks to alter the file. However, this differs from your test mechanization framework (Percy SDK).

Below is the example of an extra question asked by the migration creature in Cypress

Percy tasks were removed, update Cypress plugins register? AnswerY

Which files?cypress/plugins/index.js

By Pressing the[Enter]key, Percy update the needed files, this may take some time, hold until it finishes. In the end, you should see the message& # 8220; Migration complete! & # 8221;.

Now, you are all set to use the Percy CLI, which is the modish available version.

Step 3: Execute your Percy Tests

The Percy execution dictation are specific toPercy SDKyou are using. For example, if you are using the Cypress, you can use the below command to execute your examination.

Hotspur exec -- cypress run

Percy CLI is now supported for all availableautomation frameworks,So irrespective of the model you are using, you can transmigrate your SDK and Percy CLI to the latest variation.

Conclusion

is the best and well-nigh efficacious way to essay any UI features and regressions. Visual Regression can aid you to render quality UI in a fast speech cycle.

Percy makes visual fixation tests easier, whenever you choose a new tool most challenging job is learning or upgrade the skills, but Percy get it easier, and you can directly incorporate Percy with your test automation suite. You just have to spend a few hours learning the Percy commands and their options.

Related Guides