Skip to main content

Integration of Pega scenario tests with CI/CD

The Pega scenario testing framework helps you create UI-based end-to-end functional tests without writing a script or code. You can manually run the test cases created using this framework by logging into the application or by using the REST service provided by the framework.
This REST service allows you to run scenario test cases on any one of the following third-party tools/service providers:

  • Cross-Browser Testing
  • BrowserStack
  • Sauce Labs
  • Selenium Standalone/Grid

The scenario test REST service can be integrated with any CI/CD pipeline.

If the DevOps pipeline is a Deployment Manager pipeline, you can run the following tasks that correspond to the four different third-party tools and service providers:

  • Run Pega scenario tests (CBT)
  • Run Pega scenario tests (Browser stack)
  • Run Pega scenario tests (Sauce labs) 
  • Run Pega scenario tests (Standalone selenium)

Details of the REST service

The details of the REST service such as path, method, and input parameters are described in the following table:

Path: /prweb/api/v1/scenariotests/execute
Method: POST

Input parameters

Parameter Required/Optional Description Parameter Type Data Type
JobID Required The Unique Job ID/Run ID/Build number that is used for the invocation of the REST service. 
The Deployment Manager (DM) uses the Job ID to separate runs across deployments. The Job ID is also passed as the Run ID to cloud providers for tracking the history of runs.
Query String
Required Test service provider to use for running the scenario tests. The Provider can have one of the following four values: STANDALONE, CBT, BROWSERSTACK, or SAUCELABS. Query String
ProviderAuthName Required
You must provide the authentication name for the test service account. Query String
Required You must provide the authentication key for the test service account. Query String
Optional This is generally used for selenium standalone or grid. Query String
Browser Required
The browser that you use to run the UI tests. Query String
Required The version of the browser that you use to run the UI tests. Query String
Platform Required The name of the operating system (for example, linux/ Windows10/XP). Query String
PlatformVersion Optional If you enter a platform version, the specified OS platform version runs the scenario tests. Query String

Required The resolution of the test system screen on which to run the scenario tests. Query String

Required The URL of the system under test (SUT). Query String

Required The test user ID in the SUT. Query String

Required The password of the test user ID in the SUT. Query String
TestSuiteID Optional The pxInsname of the test suite to be run. If you do not provide the pxInsname, then the scenario test framework runs all the test cases in the application. Query String

Check your knowledge with the following interaction:

This Topic is available in the following Module:

If you are having problems with your training, please review the Pega Academy Support FAQs.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega Academy has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice