Overview of test suites

In Opkey, a suite is a collection of test cases for execution. There may be one or more than one test cases/gherkin files for execution. Each test case in a suite should be complete in itself and independent of other test cases. You can add, remove, move up/down test cases and rearrange them as per their order of execution.

Accessing suites

After successfully logging into Opkey Web, select the appropriate project in which you want to create a suite. You will be navigated to the screen as shown.

You can mark the “Don’t show me again” checkbox as checked if you do not wish to view this notification again. Click “End Tour” to proceed with the process of creating a Suite file. 

You can create a suite file using three different methods.

Method 1

After clicking on “End Tour” , you may select Suite from the dial. 

A pop-up window will get open as shown.

The fields marked with * are mandatory. Enter a name for your suite. You can also enter the description. Click OK.

Method 2

Go to Project Workspace > Select the root folder > Click Create New file icon  > Select Suite.

A suite file will be created in the root folder of the project Workspace. You may rename the suite accordingly.

Method 3

Right click on root folder > select Create New > select Suite.

A suite  file will be created in the root folder of the project Workspace.

The suite window will open up as shown.

Adding Multiple Test Cases/Gherkin Files to Suite

To add test cases/gherkin files in your suite, go to the right pane, scroll down your project files, select and double click on desired test case/gherkin file.

You can also add multiple test cases and gherkin files by selecting all the required test case/gherkin files and clicking on ‘Add Available test cases/gherkin features’ icon.

Only test case(s) & gherkin file(s) can be added to the Suite.

List of actions that can be performed on Suite

Run Now

Click on ‘Run Now’ button to start execution. You need to select session name, choose or create a build, select the plugin used, execution agent and generic plugin to proceed execution process.

Debug Now 

Debug now helps you execute saved test cases in debug mode during execution. It has features like play, pause, stop, step info, step over, step out, show call stack, etc. to debug each step individually. The execution process will run in small popup window in the right side of your browser at the bottom.

Run on Cloud 

To execute your Suite, click on 'Run on Cloud', a login popup window for Opkey Cloud opens. Enter your UserName & Password and click on Sign in.

  • Next, on Execution wizard window, enter batch name, choose or create build, select execution agent and choose generic plugin. (You can check 'Show Advanced Settings' for advanced features regarding the configuration of Snapshot of steps (along with quality and step timeout), session tags and global variables. Click on 'Next' to proceed.

  • Choose required cloud OS(s) and Bowser(s) to perform execution on Opkey cloud. Click on 'Next' to proceed. A popup box displays the message 'Execution Started Successfully!'


The selected test case/gherkin file(s) can be deleted from the Suite.

  • Select a test case to delete.

  • Clicking on ‘Delete’ will prompt an alert message of delete confirmation.

  • Click on ‘OK’ button to confirm the deletion. An alternative way of deleting a step is to right-click on any of the available step and select Delete option as well.

Move Up Step 

Select a test case and click on ‘Move Up Step’ to move selected test case up and this test case will be executed accordingly.

Move Down Step 

Select a test case and click on ‘Move Down Step’ to move the selected test case down and this test case will be executed accordingly.


Once all the required changes are done, save the Suite to prevent data loss & save test case.


Refreshing will reflect all made changes to the Suite.

Right-clicking on the added test case allows you to perform other similar actions as shown below.

You can also execute your Suite on Opkey Cloud and pCloudy. It handles the test lab setup and maintenance for you and enables parallel test executions over more than 100 web browsers along with different OS combinations. Over pCloudy, you can execute your Suite (Mobile Flow) parallelly over various devices (along with different mobile OS).

Advantages of using Opkey Cloud

  • Maximum utilization of the available shared resources (virtual servers and other resources)

  • The flexible, scalable environment helps you to utilize and pay for the resources as per the demand

  • Low operational cost & high ROI

  • Accessible from anywhere

Considering these advantages of a cloud environment, we have integrated Opkey with an advanced feature – Run on Cloud, which provides the end-user the capability to execute the created test scripts on a cloud environment remotely.

To work with Opkey Cloud, you just need to follow few simple steps as described further.

Send Execution report at Suite level:

With the help of MailTo feature, you have the privilege of sending execution report in emails to the specified people for a particular Suite. Now whenever this suite will be executed, its execution report will automatically be sent to the selected email IDs. To do so, follow the below-given steps:

  • Go to the Suite window and click on MailTo of the dockable panel.

  • Click on Add button to add new email ids.

  • Once the email ids are added, email for Suite Execution Result will be sent only to the selected email ids.

  • In case you wish to delete any email id, select it and click Delete.

If the specified email ID in "MailTo" has also been added in the SMTP settings then only a single mail of execution report will be sent to the specified email ID.

Executing a Suite 

You can execute a Suite in different ways: By using Run Now, Debug Now button & on Opkey Cloud & pCloudy cloud platform.

(A) Executing Suite on Opkey Cloud 

(B) Executing Suite on pCloudy 

Go to your Suite > Click on Run on pCloudy

Before executing your Suite, make sure that it contains 'Mobile Flows' only i.e. Test Case & Gherkin files must be Mobile Flows. Otherwise, Suite will get failed during execution.

To execute your mobile flow Suite over Opkey web, click on 'Run on pCloudy'. A new window opens which asks you to enter your pCloudy credentials (along with API Access Key).

After successful login over pCloudy, you come to the pCloudy execution wizard where you need select 'Plugin' for execution.

You can check 'Show Advanced Settings' option which helps you configure Snapshot of steps (along with quality and step timeout), session tags and global variables. Fill all fields and click on 'Next' to proceed.

In the next step, you need to select particular device(s) from the given list of devices. Device list contains a number of android and iOS devices.

In this step, you can review your selected device and mobile OS version. Click on 'Complete' to proceed.

When you click on 'Complete', your execution gets starts. Just after completing the execution process, you can analyze your execution result on Execution dashboard.

Learn more about Suite execution here.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article