| Description | manuals and libraries |
Kernel::System::UnitTest::Selenium - run front end tests
This class inherits from Selenium::Remote::Driver. You can use its full API (see http://search.cpan.org/~aivaturi/Selenium-Remote-Driver-0.15/lib/Selenium/Remote/Driver.pm).
Every successful Selenium command will be logged as a successful unit test. In case of an error, an exception will be thrown that you can catch in your unit test file and handle with HandleError() in this class. It will output a failing test result and generate a screen shot for analysis.
create a selenium object to run front end tests.
To do this, you need a running selenium or phantomjs server.
Specify the connection details in Config.pm, like this:
# For testing with Firefox until v. 47 (testing with recent FF and marionette is currently not supported):
$Self->{'SeleniumTestsConfig'} = {
remote_server_addr => 'localhost',
port => '4444',
platform => 'ANY',
browser_name => 'firefox',
extra_capabilities => {
marionette => \0, # Required to run FF 47 or older on Selenium 3+.
},
};
# For testing with Chrome/Chromium (requires installed geckodriver):
$Self->{'SeleniumTestsConfig'} = {
remote_server_addr => 'localhost',
port => '4444',
platform => 'ANY',
browser_name => 'chrome',
extra_capabilities => {
chromeOptions => {
# disable-infobars makes sure window size calculations are ok
args => [ "disable-infobars" ],
},
},
};Then you can use the full API of Selenium::Remote::Driver on this object.
runs a selenium test if Selenium testing is configured.
$SeleniumObject->RunTest( sub { ... } );Override get method of base class to prepend the correct base URL.
$SeleniumObject->get(
$URL,
);Override get_alert_text() method of base class to return alert text as string.
my $AlertText = $SeleniumObject->get_alert_text();returns
my $AlertText = 'Some alert text!'perform a get() call, but wait for the page to be fully loaded (works only within OTRS). Will die() if the verification fails.
$SeleniumObject->VerifiedGet(
$URL,
);perform a refresh() call, but wait for the page to be fully loaded (works only within OTRS). Will die() if the verification fails.
$SeleniumObject->VerifiedRefresh();login to agent or customer interface
$SeleniumObject->Login(
Type => 'Agent', # Agent|Customer
User => 'someuser',
Password => 'somepassword',
);wait with increasing sleep intervals until the given condition is true or the wait time is over. Exactly one condition (JavaScript or WindowCount) must be specified.
my $Success = $SeleniumObject->WaitFor(
AlertPresent => 1, # Wait until an alert, confirm or prompt dialog is present
Callback => sub { ... } # Wait until function returns true
ElementExists => 'xpath-selector' # Wait until an element is present
ElementExists => ['css-selector', 'css'],
ElementMissing => 'xpath-selector', # Wait until an element is not present
ElementMissing => ['css-selector', 'css'],
JavaScript => 'return $(".someclass").length', # Javascript code that checks condition
WindowCount => 2, # Wait until this many windows are open
Time => 20, # optional, wait time in seconds (default 20)
);Change focus to another frame on the page. If WaitForLoad is passed, it will wait until the frame has loaded the page completely.
my $Success = $SeleniumObject->SwitchToFrame(
FrameSelector => '.Iframe', # (required) CSS selector of the frame element
WaitForLoad => 1, # (optional) Wait until the frame has loaded, if necessary
Time => 20, # (optional) Wait time in seconds (default 20)
);Drag and drop an element.
$SeleniumObject->DragAndDrop(
Element => '.Element', # (required) css selector of element which should be dragged
Target => '.Target', # (required) css selector of element on which the dragged element should be dropped
TargetOffset => { # (optional) Offset for target. If not specified, the mouse will move to the middle of the element.
X => 150,
Y => 100,
}
);use this method to handle any Selenium exceptions.
$SeleniumObject->HandleError($@);It will create a failing test result and store a screen shot of the page for analysis (in folder /var/otrs-unittest if it exists, in $Home/var/httpd/htdocs otherwise).
override DEMOLISH from Selenium::Remote::Driver (required because this class is managed by Moo). Performs proper error handling (calls HandleError() if needed). Adds a unit test result to indicate the shutdown, and performs some clean-ups.
waits until event handler is bound to the selected jQuery element. Deprecated - it will be removed in the future releases.
$SeleniumObject->WaitForjQueryEventBound(
CSSSelector => 'li > a#Test', # (required) css selector
Event => 'click', # (optional) Specify event name. Default 'click'.
);sets modernized input field value.
$SeleniumObject->InputFieldValueSet(
Element => 'css-selector', # (required) css selector
Value => 3, # (optional) Value
);This software is part of the OTRS project (https://otrs.org/).
This software comes with ABSOLUTELY NO WARRANTY. For details, see the enclosed file COPYING for license information (GPL). If you did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.