summaryrefslogtreecommitdiffstats
path: root/content/test/gpu/gpu_tests/pixel.py
blob: 64df73488f56610ebac0ffaaaa7f09ce340f592f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# Copyright (c) 2012 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
from datetime import datetime
import glob
import optparse
import os
import re

from telemetry import test
from telemetry.core.backends import png_bitmap
from telemetry.page import page_test

test_data_dir = os.path.abspath(os.path.join(
    os.path.dirname(__file__), '..', '..', 'data', 'gpu'))

default_generated_data_dir = os.path.join(test_data_dir, 'generated')
default_reference_image_dir = os.path.join(test_data_dir, 'gpu_reference')


class PixelTestFailure(Exception):
  pass

def _DidTestSucceed(tab):
  return tab.EvaluateJavaScript('domAutomationController._succeeded')

class PixelValidator(page_test.PageTest):
  def __init__(self):
    super(PixelValidator, self).__init__('ValidatePage')

  def CustomizeBrowserOptions(self, options):
    options.AppendExtraBrowserArgs('--enable-gpu-benchmarking')

  def InjectJavascript(self):
    return [os.path.join(os.path.dirname(__file__), 'pixel.js')]

  def ValidatePage(self, page, tab, results):
    if not _DidTestSucceed(tab):
      raise page_test.Failure('Page indicated a failure')

    if not tab.screenshot_supported:
      raise page_test.Failure('Browser does not support screenshot capture')

    screenshot = tab.Screenshot(5)

    if not screenshot:
      raise page_test.Failure('Could not capture screenshot')

    if hasattr(page, 'test_rect'):
      screenshot = screenshot.Crop(
          page.test_rect[0], page.test_rect[1],
          page.test_rect[2], page.test_rect[3])

    image_name = PixelValidator.UrlToImageName(page.display_name)

    ref_png = PixelValidator.GetReferenceImage(self.options.reference_dir,
        image_name, page.revision, screenshot)

    # Test new snapshot against existing reference image
    if not ref_png.IsEqual(screenshot, tolerance=2):
      PixelValidator.WriteErrorImages(self.options.generated_dir, image_name,
          self.options.build_revision, screenshot, ref_png)
      raise page_test.Failure('Reference image did not match captured screen')

  @staticmethod
  def UrlToImageName(url):
    image_name = re.sub(r'^(http|https|file)://(/*)', '', url)
    image_name = re.sub(r'\.\./', '', image_name)
    image_name = re.sub(r'(\.|/|-)', '_', image_name)
    return image_name

  @staticmethod
  def DeleteOldReferenceImages(ref_image_path, cur_revision):
    if not cur_revision:
      return

    old_revisions = glob.glob(ref_image_path + "_*.png")
    for rev_path in old_revisions:
      m = re.match(r'^.*_(\d+)\.png$', rev_path)
      if m and int(m.group(1)) < cur_revision:
        print 'Found deprecated reference image. Deleting rev ' + m.group(1)
        os.remove(rev_path)

  @staticmethod
  def GetReferenceImage(img_dir, img_name, cur_revision, screenshot):
    if not cur_revision:
      cur_revision = 0

    image_path = os.path.join(img_dir, img_name)

    PixelValidator.DeleteOldReferenceImages(image_path, cur_revision)

    image_path = image_path + '_' + str(cur_revision) + '.png'

    try:
      ref_png = png_bitmap.PngBitmap.FromFile(image_path)
    except IOError:
      ref_png = None

    if ref_png:
      return ref_png

    print 'Reference image not found. Writing tab contents as reference.'

    PixelValidator.WriteImage(image_path, screenshot)
    return screenshot

  @staticmethod
  def WriteErrorImages(img_dir, img_name, build_revision, screenshot, ref_png):
    full_image_name = img_name + '_' + str(build_revision)
    full_image_name = full_image_name + '.png'

    # Save the reference image
    # This ensures that we get the right revision number
    PixelValidator.WriteImage(
        os.path.join(img_dir, full_image_name), ref_png)

    PixelValidator.WriteImage(
        os.path.join(img_dir, 'FAIL_' + full_image_name), screenshot)

    diff_png = screenshot.Diff(ref_png)
    PixelValidator.WriteImage(
        os.path.join(img_dir, 'DIFF_' + full_image_name), diff_png)

  @staticmethod
  def WriteImage(image_path, png_image):
    output_dir = os.path.dirname(image_path)
    if not os.path.exists(output_dir):
      os.makedirs(output_dir)

    png_image.WriteFile(image_path)

class Pixel(test.Test):
  test = PixelValidator
  page_set = 'page_sets/pixel_tests.json'

  @staticmethod
  def AddTestCommandLineOptions(parser):
    group = optparse.OptionGroup(parser, 'Pixel test options')
    group.add_option('--generated-dir',
        help='Overrides the default location for generated test images that do '
        'not match reference images',
        default=default_generated_data_dir)
    group.add_option('--reference-dir',
        help='Overrides the default location for reference images',
        default=default_reference_image_dir)
    group.add_option('--build-revision',
        help='Chrome revision being tested.',
        default="unknownrev")
    parser.add_option_group(group)