Integration of BrowserStack with Grid Execution is an advanced feature of OpKey 5.32. By using this feature, you can execute multiple parallel Suites on BrowserStack at a time. All the added sessions are first queued to the Queued Sessions list which are further executed through Agent as per the configuration.
There are few necessary settings which are required for Grid Execution. Let us apply those settings from OpKey Agent.
- Open OpKey Agent and switch to SaaS mode.
- Fill all required fields and login with valid credentials.
- Check Enable for Grid Execution checkbox.
- Click on Save to save made changes.
- A popup message appears to relaunch the Agent and reflect the changes.
There are some Project Level Settings for Grid Execution feature that can be applied as required from Project Management section in Admin.
Navigate to the Admin section and click on Project Management tab.
Click on Update Project icon to update the project for Grid Execution. Navigate to the Queued session settings and edit number of maximum parallel runs allowed and maximum parallel runs allowed on BrowserStack as per requirement. Maximum parallel runs allowed on BrowserStack should not be greater that the maximum parallel runs allowed.
- Max Parallel Run Allowed field specifies the maximum number of parallel runs allowed for Queued Sessions for a particular project. It’s value is 10, by Default.
- Max Parallel Run Allowed (BrowserStack) field specifies the number of parallel run allowed for Queued Sessions over BrowserStack. It’s value is 2, by Default.
Click on Home to go back to the SaaS dashboard.
To use this feature of Grid Execution in OpKey, follow the steps mentioned below:
- Go to Tools menu & click on Grid Execution.
The Grid Execution window will get opened. When the user initiates the execution for the first time in OpKey then blank values are being displayed in the Build Name and Session Name otherwise it is auto filled with the last Executed Build Name and Session Name.
Enter Session name, Build name and select BrowserStack as Execution Mode.
Sign in to BrowserStack with valid BrowserStack Username & Access Key. If you are already Logged In to BroserStack then this step will be skipped.
[Add] is used to add new session details.
[Delete] is used to delete/remove the selected session details.
To Add new Session Details:
- Click Add icon.
- Click on Suite dropdown. The dropdown will display all the available suites. You can select the desired Suite that you want to execute.
Once the Suite has been selected, the Plugin gets auto selected with the corresponding Plugin Name. You can also select any other Plugin from the dropdown.
Click on the Agent dropdown. The dropdown will get auto-populated with all the agents available for Grid Execution. You can select any agent on which you want to execute that particular session. In case, none of the agent is selected then, OpKey runs the execution randomly, on any available agent.
Click on the Browser/Devices to select the desired Browser/Devices. The dropdown will get auto populated with various options for the Browser added in agent from Grid Browser Settings and the Devices that are displayed in the dropdown are the ones which are configured with OpKey. Tick the checkbox(s) provided to choose the desired Browser/Devices Name.
SMTP Settings can also be configured from here, by clicking on the SMTP settings button placed at the bottom Left hand corner of the screen.
The Advanced-Settings for the session can either be default settings or custom settings. You can select the desired settings from the dropdown.
To configure the default settings for the grid execution, click on the Session Default Setting button available on the screen.
You can also click on [Settings] icon to configure the custom settings of that particular session.
Once you have entered the required Session details, the session is in the ready to go state.
It is mandatory to open and connect OpKey hub for the execution of Queued Sessions.
OpKey Hub is an OpKey utility which is used to execute Queued Sessions of OpKey. You need to install it as an standalone program setup, corresponding to the OpKey version.
For detailed information on OpKey Hub, please refer: OpKey Hub