screenshot.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 robot.utils import get_link_path
 
from SeleniumLibrary.base import LibraryComponent, keyword
from SeleniumLibrary.utils import is_noney
 
 
class ScreenshotKeywords(LibraryComponent):
 
    @keyword
    
    def set_screenshot_directory(self, path):
        if is_noney(path):
            path = None
        else:
            path = os.path.abspath(path)
            self._create_directory_create_directory(path)
        previous = self.ctxctx.screenshot_root_directory
        self.ctxctx.screenshot_root_directory = path
        return previous
 
    @keyword
    
    def capture_page_screenshot(self, filename='selenium-screenshot-{index}.png'):
        if not self.driversdriversdrivers.current:
            self.infoinfo('Cannot capture screenshot because no browser is open.')
            return
        path = self._get_screenshot_path_get_screenshot_path(filename)
        self._create_directory_create_directory(path)
        if not self.driverdriverdriver.save_screenshot(path):
            raise RuntimeError("Failed to save screenshot '{}'.".format(path))
        self._embed_to_log_embed_to_log(path, 800)
        return path
 
    @keyword
    
    def capture_element_screenshot(self, locator, filename='selenium-element-screenshot-{index}.png'):
        if not self.driversdriversdrivers.current:
            self.infoinfo('Cannot capture screenshot from element because no browser is open.')
            return
        path = self._get_screenshot_path_get_screenshot_path(filename)
        self._create_directory_create_directory(path)
        element = self.find_elementfind_element(locator, required=True)
        if not element.screenshot(path):
            raise RuntimeError("Failed to save element screenshot '{}'.".format(path))
        self._embed_to_log_embed_to_log(path, 400)
        return path
 
    def _get_screenshot_path(self, filename):
        directory = self.ctxctx.screenshot_root_directory or self.log_dirlog_dirlog_dir
        filename = filename.replace('/', os.sep)
        index = 0
        while True:
            index += 1
            formatted = filename.format(index=index)
            path = os.path.join(directory, formatted)
            # filename didn't contain {index} or unique path was found
            if formatted == filename or not os.path.exists(path):
                return path
 
    def _create_directory(self, path):
        target_dir = os.path.dirname(path)
        if not os.path.exists(target_dir):
            os.makedirs(target_dir)
 
    def _embed_to_log(self, path, width):
        # Image is shown on its own row and thus previous row is closed on
        # purpose. Depending on Robot's log structure is a bit risky.
        self.infoinfo('</td></tr><tr><td colspan="3">'
                  '<a href="{src}"><img src="{src}" width="{width}px"></a>'
                  .format(src=get_link_path(path, self.log_dirlog_dirlog_dir), width=width), html=True)