Sahi Pro - Secondary Windows (Popup Windows)
Applications may open secondary windows as a new window or in a new tab.
This section shows how to automate secondary windows.
This section shows how to automate secondary windows.
"Popup" is a loose term used to describe any dialog or window that is opened outside of the base window.
In Sahi's case, we refer to secondary windows when we say "popup window".
In Sahi's case, we refer to secondary windows when we say "popup window".
We handle secondary windows using 2 APIs.
_selectWindow
Since Sahi Pro: 3.5Since Sahi OS: 3
_selectWindow([$windowIdentifier])Arguments
| $windowIdentifier | string optional | the windowIdentifier can be the window name, the window title, or the window URL, or a regular expression of any of these. To reference the base window, omit this parameter or use null. The windowIdentifier can also be the sahiWinId. |
Details
info
This is the recommended way of working with secondary windows.
This API allows selecting a window before performing further actions.// switch to popWin popup window
_selectWindow("popWin");
// perform actions on popWin
_assertEqual("Link Test", _getText(_link(0))); // no mention of popWin needed
var $href;
_set($href, _link(0).href); // no mention of popWin needed
...
// switch back to base window
_selectWindow();
// perform actions on base window_click(_link("Window Open Test"));
_wait(2000);
var $recentWindowId = _getRecentWindow().sahiWinId;
_selectWindow($recentWindowId);
// perform actions on popWin
_click(_link("Form Test"));
_click(_link("Close Self"));
// switch back to base window
_selectWindow();
// perform actions on base window_popup
Since Sahi Pro: 3.5Since Sahi OS: 2
_popup([$windowIdentifier])Arguments
| $windowIdentifier | string optional | the windowIdentifier can be the window name, the window title, or the window URL, or a regular expression of any of these. To reference the base window, omit this parameter or use null. The windowIdentifier can also be the sahiWinId. |
Details
This was the default way of accessing secondary windows. Any step to be executed on a particular secondary window
would be prefixed by
This was the default way of accessing secondary windows. Any step to be executed on a particular secondary window
would be prefixed by
_popup("windowIdentifier").
warning
_popup is ONLY used as a PREFIX to Sahi Action APIs
// clicks link on popup of name popupWindow
_popup("popupWindow")._click(_link(0));
// popup by name regular expression
_popup("/pop.*Win/")._click(_link(0));
// popup by title
_popup("Popup Title")._click(_link(0));
// popup by title regular expression
_popup("/pup Tit/")._click(_link(0));
// popup by URL
_popup("http://sahi.co.in")._click(_link(0));
// poppu by URL regular expression
_popup("/sahi[.]co[.]in/")._click(_link(0));warning
This API is confusing while fetching attribute values or using assertions.
To fetch a value or asserting. this needs to be used a particular way._popup("popWin")._assertEqual("Link Test", _getText(_link(0))); // CORRECT
_assertEqual("Link Test", _popup("popWin")._getText(_link(0))); // WRONG
var $href;
_popup("popWin")._set($href, _link(0).href); // CORRECT
_set($href, _popup("popWin")._link(0).href); // WRONG_getWindows
Since Sahi Pro: 5.1.0Since Sahi OS: NA
_getWindows([$activePeriod])Arguments
| $activePeriod | integer optional | time in milliseconds to return windows within the time. Default is 0, which returns all windows. |
Details
Returns an array of window-property objects.
A window-property is just an associative array with the following attributes:
Example:
Returns an array of window-property objects.
A window-property is just an associative array with the following attributes:
| windowName | window name |
| windowTitle | window title |
| windowURL | URL of top window |
| wasOpened | '0' or '1' as string. 0 means base window, 1 means popup window |
| domain | document.domain of window, if set |
| initialTime | Timestamp when window was opened |
| lastTime | Timestamp of last ping from that window |
| sahiWinId | sahiWinId for that window |
Example:
_navigateTo("http://sahi.co.in/demo/");
_click(_link("Window Open Test With Title"));
_wait(2000);
var $windows = _getWindows();
_assertEqual(2, $windows.length);
_assertEqual('With Title', $windows[1].windowTitle);
_assertEqual("1", $windows[1].wasOpened);_windowExists
Since Sahi Pro: 6.0.0Since Sahi OS: NA
_windowExists($windowIdentifier[, $activePeriod])Arguments
| $windowIdentifier | string | The windowIdentifier can be the window name, the window title, the window URL or the sahiWinId, or a regular expression of any of these. |
| $activePeriod | integer optional | Time interval in milliseconds within which the specified window is checked for activity. Default is -1, which means the specified window is checked amongst all windows opened during the session. |
Details
Returns true if the window exists.
Example:
Returns true if the window exists.
info
If you want to check that a window no longer exists after a particular step, do the following.
After the step, add a wait for 3000 milliseconds and then call _windowExists with activePeriod as 3000. _windowExists should return false for the window.
NOTE that if you pass a larger activePeriod, _windowExists would return true, because the window was active at that past time.
Please refer to the example below for usage.
After the step, add a wait for 3000 milliseconds and then call _windowExists with activePeriod as 3000. _windowExists should return false for the window.
NOTE that if you pass a larger activePeriod, _windowExists would return true, because the window was active at that past time.
Please refer to the example below for usage.
warning
If activePeriod is not passed, _windowExists will return true if the window was ever opened during the session, even if the window is no longer open.
Example:
_navigateTo("/demo/");
_click(_link("Window Open Test"));
_wait(3000);
var $exists = _windowExists("/demo/");
var $exists2 = _windowExists("popWin");
_assertTrue($exists);
_assertTrue($exists2);
var $recentWindowId = _getRecentWindow().sahiWinId;
var $exists3 = _windowExists($recentWindowId);
_assertTrue($exists3);
_selectWindow("popWin");
_closeWindow(); // Closes the popup window
_selectWindow();
_wait(3000); // Wait for 3 seconds
var $exists3 = _windowExists("popWin", 3000); // Now _windowExists returns false.
_assertFalse($exists3);_getRecentWindow
Since Sahi Pro: 6.0.0Since Sahi OS: NA
_getRecentWindow()Arguments
| None |
Details
Returns the most recent (last opened) window. Refer to _getWindows for all properties of window object returned.
Example:
Returns the most recent (last opened) window. Refer to _getWindows for all properties of window object returned.
info
NOTE: If you are checking for the recent window just after a step that opens the window, add an explicit wait of 2000 to 3000 milliseconds before the _getRecentWindow call.
info
This API is quite useful in the following scenario.
Sometimes, an application opens multiple popup windows with dynamic identifiers but with the same regular expression pattern in the identifier. The requirement is to identify the recently opened popup.
Since the identifier is dynamic, one cannot use it as is. Since all windows have the same regular expression pattern, one cannot use the regular expression pattern either.
In such a scenario, one can use _getRecentWindow to identify the most recently opened window.
Sometimes, an application opens multiple popup windows with dynamic identifiers but with the same regular expression pattern in the identifier. The requirement is to identify the recently opened popup.
Since the identifier is dynamic, one cannot use it as is. Since all windows have the same regular expression pattern, one cannot use the regular expression pattern either.
In such a scenario, one can use _getRecentWindow to identify the most recently opened window.
Example:
_navigateTo("/demo/");
_click(_link("Window Open Test"));
_click(_link("Window Open Test With Title"));
_wait(2000);
var $recentWindow = _getRecentWindow();
_assertEqual('With Title', $recentWindow.windowTitle); // This is the window opened by clicking the link "Window Open Test With Title".
_assertEqual("1", $recentWindow.wasOpened);