javascript.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.
 
import os
from collections import namedtuple
 
from robot.utils import plural_or_not, seq2str
 
from SeleniumLibrary.base import LibraryComponent, keyword
 
 
class JavaScriptKeywords(LibraryComponent):
 
    js_marker = 'JAVASCRIPT'
    arg_marker = 'ARGUMENTS'
 
    @keyword
    
    def execute_javascript(self, *code):
        js_code, js_args = self._get_javascript_to_execute_get_javascript_to_execute(code)
        self._js_logger_js_logger('Executing JavaScript', js_code, js_args)
        return self.driverdriverdriver.execute_script(js_code, *js_args)
 
    @keyword
    
    def execute_async_javascript(self, *code):
        js_code, js_args = self._get_javascript_to_execute_get_javascript_to_execute(code)
        self._js_logger_js_logger('Executing Asynchronous JavaScript', js_code, js_args)
        return self.driverdriverdriver.execute_async_script(js_code, *js_args)
 
    def _js_logger(self, base, code, args):
        message = '%s:\n%s\n' % (base, code)
        if args:
            message = ('%sBy using argument%s:\n%s'
                       % (message, plural_or_not(args), seq2str(args)))
        else:
            message = '%sWithout any arguments.' % message
        self.infoinfo(message)
 
    def _get_javascript_to_execute(self, code):
        js_code, js_args = self._separate_code_and_args_separate_code_and_args(code)
        if not js_code:
            raise ValueError('JavaScript code was not found from code argument.')
        js_code = ''.join(js_code)
        path = js_code.replace('/', os.sep)
        if os.path.isfile(path):
            js_code = self._read_javascript_from_file_read_javascript_from_file(path)
        return js_code, js_args
 
    def _separate_code_and_args(self, code):
        code = list(code)
        self._check_marker_error_check_marker_error(code)
        index = self._get_marker_index_get_marker_index(code)
        if self.arg_markerarg_marker not in code:
            return code[index.js + 1:], []
        if self.js_markerjs_marker not in code:
            return code[0:index.arg], code[index.arg + 1:]
        else:
            if index.js == 0:
                return code[index.js + 1:index.arg], code[index.arg + 1:]
            else:
                return code[index.js + 1:], code[index.arg + 1:index.js]
 
    def _check_marker_error(self, code):
        if not code:
            raise ValueError('There must be at least one argument defined.')
        message = None
        template = '%s marker was found two times in the code.'
        if code.count(self.js_markerjs_marker) > 1:
            message = template % self.js_markerjs_marker
        if code.count(self.arg_markerarg_marker) > 1:
            message = template % self.arg_markerarg_marker
        index = self._get_marker_index_get_marker_index(code)
        if index.js > 0 and index.arg != 0:
            message = template % self.js_markerjs_marker
        if message:
            raise ValueError(message)
 
    def _get_marker_index(self, code):
        Index = namedtuple('Index', 'js arg')
        if self.js_markerjs_marker in code:
            js = code.index(self.js_markerjs_marker)
        else:
            js = -1
        if self.arg_markerarg_marker in code:
            arg = code.index(self.arg_markerarg_marker)
        else:
            arg = -1
        return Index(js=js, arg=arg)
 
    def _read_javascript_from_file(self, path):
        self.infoinfo('Reading JavaScript from file <a href="file://%s">%s</a>.'
                  % (path.replace(os.sep, '/'), path), html=True)
        with open(path) as file:
            return file.read().strip()