Screenshot.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  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
import subprocess
import sys
 
try:
    import wx
except ImportError:
    wx = None
try:
    from gtk import gdk
except ImportError:
    gdk = None
try:
    from PIL import ImageGrab  # apparently available only on Windows
except ImportError:
    ImageGrab = None
 
from robot.api import logger
from robot.libraries.BuiltIn import BuiltIn
from robot.version import get_version
from robot.utils import abspath, get_error_message, get_link_path
 
 
 
class Screenshot:
 
    ROBOT_LIBRARY_SCOPE = 'TEST SUITE'
    ROBOT_LIBRARY_VERSION = get_version()
 
    
    def __init__(self, screenshot_directory=None, screenshot_module=None):
        self._given_screenshot_dir_given_screenshot_dir = self._norm_path_norm_path(screenshot_directory)
        self._screenshot_taker_screenshot_taker = ScreenshotTaker(screenshot_module)
 
    def _norm_path(self, path):
        if not path:
            return path
        elif isinstance(path, os.PathLike):
            path = str(path)
        else:
            path = path.replace('/', os.sep)
        return os.path.normpath(path)
 
    @property
    _screenshot_dir = property
    
    def _screenshot_dir(self):
        return self._given_screenshot_dir_given_screenshot_dir or self._log_dir_log_dir_log_dir
 
    @property
    _log_dir = property
    
    def _log_dir(self):
        variables = BuiltIn().get_variables()
        outdir = variables['${OUTPUTDIR}']
        log = variables['${LOGFILE}']
        log = os.path.dirname(log) if log != 'NONE' else '.'
        return self._norm_path_norm_path(os.path.join(outdir, log))
 
    
    def set_screenshot_directory(self, path):
        path = self._norm_path_norm_path(path)
        if not os.path.isdir(path):
            raise RuntimeError("Directory '%s' does not exist." % path)
        old = self._screenshot_dir_screenshot_dir_screenshot_dir
        self._given_screenshot_dir_given_screenshot_dir = path
        return old
 
    
    def take_screenshot(self, name="screenshot", width="800px"):
        path = self._save_screenshot_save_screenshot(name)
        self._embed_screenshot_embed_screenshot(path, width)
        return path
 
    
    def take_screenshot_without_embedding(self, name="screenshot"):
        path = self._save_screenshot_save_screenshot(name)
        self._link_screenshot_link_screenshot(path)
        return path
 
    def _save_screenshot(self, name):
        name = str(name) if isinstance(name, os.PathLike) else name.replace('/', os.sep)
        path = self._get_screenshot_path_get_screenshot_path(name)
        return self._screenshot_to_file_screenshot_to_file(path)
 
    def _screenshot_to_file(self, path):
        path = self._validate_screenshot_path_validate_screenshot_path(path)
        logger.debug('Using %s module/tool for taking screenshot.'
                     % self._screenshot_taker_screenshot_taker.module)
        try:
            self._screenshot_taker_screenshot_taker(path)
        except:
            logger.warn('Taking screenshot failed: %s\n'
                        'Make sure tests are run with a physical or virtual '
                        'display.' % get_error_message())
        return path
 
    def _validate_screenshot_path(self, path):
        path = abspath(self._norm_path_norm_path(path))
        if not os.path.exists(os.path.dirname(path)):
            raise RuntimeError("Directory '%s' where to save the screenshot "
                               "does not exist" % os.path.dirname(path))
        return path
 
    def _get_screenshot_path(self, basename):
        if basename.lower().endswith(('.jpg', '.jpeg')):
            return os.path.join(self._screenshot_dir_screenshot_dir_screenshot_dir, basename)
        index = 0
        while True:
            index += 1
            path = os.path.join(self._screenshot_dir_screenshot_dir_screenshot_dir, "%s_%d.jpg" % (basename, index))
            if not os.path.exists(path):
                return path
 
    def _embed_screenshot(self, path, width):
        link = get_link_path(path, self._log_dir_log_dir_log_dir)
        logger.info('<a href="%s"><img src="%s" width="%s"></a>'
                    % (link, link, width), html=True)
 
    def _link_screenshot(self, path):
        link = get_link_path(path, self._log_dir_log_dir_log_dir)
        logger.info("Screenshot saved to '<a href=\"%s\">%s</a>'."
                    % (link, path), html=True)
 
 
class ScreenshotTaker:
 
    def __init__(self, module_name=None):
        self._screenshot_screenshot = self._get_screenshot_taker_get_screenshot_taker(module_name)
        self.modulemodule = self._screenshot_screenshot.__name__.split('_')[1]
        self._wx_app_reference_wx_app_reference = None
 
    def __call__(self, path):
        self._screenshot_screenshot(path)
 
    def __bool__(self):
        return self.modulemodule != 'no'
 
    def test(self, path=None):
        if not self:
            print("Cannot take screenshots.")
            return False
        print("Using '%s' to take screenshot." % self.modulemodule)
        if not path:
            print("Not taking test screenshot.")
            return True
        print("Taking test screenshot to '%s'." % path)
        try:
            self(path)
        except:
            print("Failed: %s" % get_error_message())
            return False
        else:
            print("Success!")
            return True
 
    def _get_screenshot_taker(self, module_name=None):
        if sys.platform == 'darwin':
            return self._osx_screenshot_osx_screenshot
        if module_name:
            return self._get_named_screenshot_taker_get_named_screenshot_taker(module_name.lower())
        return self._get_default_screenshot_taker_get_default_screenshot_taker()
 
    def _get_named_screenshot_taker(self, name):
        screenshot_takers = {'wxpython': (wx, self._wx_screenshot_wx_screenshot),
                             'pygtk': (gdk, self._gtk_screenshot_gtk_screenshot),
                             'pil': (ImageGrab, self._pil_screenshot_pil_screenshot),
                             'scrot': (self._scrot_scrot_scrot, self._scrot_screenshot_scrot_screenshot)}
        if name not in screenshot_takers:
            raise RuntimeError("Invalid screenshot module or tool '%s'." % name)
        supported, screenshot_taker = screenshot_takers[name]
        if not supported:
            raise RuntimeError("Screenshot module or tool '%s' not installed."
                               % name)
        return screenshot_taker
 
    def _get_default_screenshot_taker(self):
        for module, screenshot_taker in [(wx, self._wx_screenshot_wx_screenshot),
                                         (gdk, self._gtk_screenshot_gtk_screenshot),
                                         (ImageGrab, self._pil_screenshot_pil_screenshot),
                                         (self._scrot_scrot_scrot, self._scrot_screenshot_scrot_screenshot),
                                         (True, self._no_screenshot_no_screenshot)]:
            if module:
                return screenshot_taker
 
    def _osx_screenshot(self, path):
        if self._call_call('screencapture', '-t', 'jpg', path) != 0:
            raise RuntimeError("Using 'screencapture' failed.")
 
    def _call(self, *command):
        try:
            return subprocess.call(command, stdout=subprocess.PIPE,
                                   stderr=subprocess.STDOUT)
        except OSError:
            return -1
 
    @property
    _scrot = property
    
    def _scrot(self):
        return os.sep == '/' and self._call_call('scrot', '--version') == 0
 
    def _scrot_screenshot(self, path):
        if not path.endswith(('.jpg', '.jpeg')):
            raise RuntimeError("Scrot requires extension to be '.jpg' or "
                               "'.jpeg', got '%s'." % os.path.splitext(path)[1])
        if os.path.exists(path):
            os.remove(path)
        if self._call_call('scrot', '--silent', path) != 0:
            raise RuntimeError("Using 'scrot' failed.")
 
    def _wx_screenshot(self, path):
        if not self._wx_app_reference_wx_app_reference:
            self._wx_app_reference_wx_app_reference = wx.App(False)
        context = wx.ScreenDC()
        width, height = context.GetSize()
        if wx.__version__ >= '4':
            bitmap = wx.Bitmap(width, height, -1)
        else:
            bitmap = wx.EmptyBitmap(width, height, -1)
        memory = wx.MemoryDC()
        memory.SelectObject(bitmap)
        memory.Blit(0, 0, width, height, context, -1, -1)
        memory.SelectObject(wx.NullBitmap)
        bitmap.SaveFile(path, wx.BITMAP_TYPE_JPEG)
 
    def _gtk_screenshot(self, path):
        window = gdk.get_default_root_window()
        if not window:
            raise RuntimeError('Taking screenshot failed.')
        width, height = window.get_size()
        pb = gdk.Pixbuf(gdk.COLORSPACE_RGB, False, 8, width, height)
        pb = pb.get_from_drawable(window, window.get_colormap(),
                                  0, 0, 0, 0, width, height)
        if not pb:
            raise RuntimeError('Taking screenshot failed.')
        pb.save(path, 'jpeg')
 
    def _pil_screenshot(self, path):
        ImageGrab.grab().save(path, 'JPEG')
 
    def _no_screenshot(self, path):
        raise RuntimeError('Taking screenshots is not supported on this platform '
                           'by default. See library documentation for details.')
 
 
if __name__ == "__main__":
    if len(sys.argv) not in [2, 3]:
        sys.exit("Usage: %s <path>|test [wxpython|pygtk|pil|scrot]"
                 % os.path.basename(sys.argv[0]))
    path = sys.argv[1] if sys.argv[1] != 'test' else None
    module = sys.argv[2] if len(sys.argv) > 2 else None
    ScreenshotTaker(module).test(path)