alert.py

Go to the documentation of this file.

# Copyright 2008-2011 Nokia Networks
# Copyright 2011-2016 Ryan Tomac, Ed Manlove and contributors
# Copyright 2016-     Robot Framework Foundation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
 
from selenium.common.exceptions import WebDriverException
from selenium.webdriver.support import expected_conditions as EC
from selenium.webdriver.support.ui import WebDriverWait
 
from SeleniumLibrary.base import keyword, LibraryComponent
from SeleniumLibrary.utils import is_truthy, secs_to_timestr
 
 
class AlertKeywords(LibraryComponent):
    ACCEPT = 'ACCEPT'
    DISMISS = 'DISMISS'
    LEAVE = 'LEAVE'
    
    _next_alert_action = ACCEPT
 
    @keyword
    
    def input_text_into_alert(self, text, action=ACCEPT, timeout=None):
        alert = self._wait_alert_wait_alert(timeout)
        alert.send_keys(text)
        self._handle_alert_handle_alert(alert, action)
 
    @keyword
    
    def alert_should_be_present(self, text='', action=ACCEPT, timeout=None):
        message = self.handle_alerthandle_alert(action, timeout)
        if text and text != message:
            raise AssertionError("Alert message should have been '%s' but it "
                                 "was '%s'." % (text, message))
 
    @keyword
    
    def alert_should_not_be_present(self, action=ACCEPT, timeout=0):
        try:
            alert = self._wait_alert_wait_alert(timeout)
        except AssertionError:
            return
        text = self._handle_alert_handle_alert(alert, action)
        raise AssertionError("Alert with message '%s' present." % text)
 
    @keyword
    
    def handle_alert(self, action=ACCEPT, timeout=None):
        alert = self._wait_alert_wait_alert(timeout)
        return self._handle_alert_handle_alert(alert, action)
 
    def _handle_alert(self, alert, action):
        action = action.upper()
        text = ' '.join(alert.text.splitlines())
        if action == self.ACCEPTACCEPT:
            alert.accept()
        elif action == self.DISMISSDISMISS:
            alert.dismiss()
        elif action != self.LEAVELEAVE:
            raise ValueError("Invalid alert action '%s'." % action)
        return text
 
    def _wait_alert(self, timeout=None):
        timeout = self.get_timeoutget_timeout(timeout)
        wait = WebDriverWait(self.driverdriverdriver, timeout)
        try:
            return wait.until(EC.alert_is_present())
        except WebDriverException:
            raise AssertionError('Alert not found in %s.'
                                 % secs_to_timestr(timeout))