blob: c284d9ff8a576cb63bf1e2a55adbbf075a878970 [file] [log] [blame]
# Copyright (C) 2010, 2012 Google Inc. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following disclaimer
# in the documentation and/or other materials provided with the
# distribution.
# * Neither the name of Google Inc. nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""Unit tests for printing.py."""
import optparse
import StringIO
import sys
import unittest
from blinkpy.common.host_mock import MockHost
from blinkpy.web_tests.models import test_expectations
from blinkpy.web_tests.models import test_failures
from blinkpy.web_tests.models import test_results
from blinkpy.web_tests.models.typ_types import ResultType
from blinkpy.web_tests.views import printing
def get_options(args):
print_options = printing.print_options()
option_parser = optparse.OptionParser(option_list=print_options)
return option_parser.parse_args(args)
class TestUtilityFunctions(unittest.TestCase):
def test_print_options(self):
options, _ = get_options([])
self.assertIsNotNone(options)
class FakeRunResults(object):
def __init__(self, total=1, expected=1, unexpected=0, fake_results=None):
fake_results = fake_results or []
self.total = total
self.expected = expected
self.expected_failures = 0
self.expected_skips = 0
self.unexpected = unexpected
self.results_by_name = {}
self.unexpected_results_by_name = {}
for i in range(unexpected):
self.unexpected_results_by_name['test%d' % i] = None
total_run_time = 0
for result in fake_results:
self.results_by_name[result.shard_name] = result
total_run_time += result.total_run_time
self.run_time = total_run_time + 1
class FakeShard(object):
def __init__(self, shard_name, total_run_time):
self.shard_name = shard_name
self.total_run_time = total_run_time
class Testprinter(unittest.TestCase):
def assertNotEmpty(self, stream):
self.assertTrue(stream.getvalue())
def assertWritten(self, stream, contents):
self.assertEqual(stream.buflist, contents)
def reset(self, stream):
stream.buflist = []
stream.buf = ''
def get_printer(self, args=None):
args = args or []
printing_options = printing.print_options()
option_parser = optparse.OptionParser(option_list=printing_options)
options, args = option_parser.parse_args(args)
host = MockHost()
self._port = host.port_factory.get('test', options)
regular_output = StringIO.StringIO()
printer = printing.Printer(host, options, regular_output)
return printer, regular_output
def get_result(self, test_name, result_type=ResultType.Pass, run_time=0):
failures = []
if result_type == ResultType.Timeout:
failures = [test_failures.FailureTimeout()]
elif result_type == ResultType.Crash:
failures = [test_failures.FailureCrash()]
return test_results.TestResult(
test_name, failures=failures, test_run_time=run_time)
def test_configure_and_cleanup(self):
# This test verifies that calling cleanup repeatedly and deleting
# the object is safe.
printer, _ = self.get_printer()
printer.cleanup()
printer.cleanup()
printer = None
def test_print_config(self):
printer, err = self.get_printer()
# FIXME: Make it so these options don't have to be set directly.
# pylint: disable=protected-access
printer._options.time_out_ms = 6000
printer._options.slow_time_out_ms = 12000
printer._options.order = 'random'
printer._options.seed = 1234
printer.print_config(self._port)
self.assertIn("Using port 'test-mac-mac10.10'", err.getvalue())
self.assertIn('Test configuration: <mac10.10, x86, release>',
err.getvalue())
self.assertIn('View the test results at file:///tmp', err.getvalue())
self.assertIn(
'Baseline search path: test-mac-mac10.10 -> test-mac-mac10.11 -> generic',
err.getvalue())
self.assertIn('Using Release build', err.getvalue())
self.assertIn('Command line:', err.getvalue())
self.assertIn('Regular timeout: ', err.getvalue())
self.assertIn('Using random order with seed: 1234', err.getvalue())
self.reset(err)
printer._options.quiet = True
printer.print_config(self._port)
self.assertNotIn(
'Baseline search path: test-mac-mac10.10 -> test-mac-mac10.11 -> generic',
err.getvalue())
def test_print_summary(self):
def run_test(total, exp, unexp, shards, result):
printer, err = self.get_printer(['--timing'] if shards else None)
fake_results = FakeRunResults(total, exp, unexp, shards)
total_time = fake_results.run_time + 1
printer.print_summary(total_time, fake_results)
self.assertWritten(err, result)
# Without times:
run_test(1, 1, 0, [], ['The test ran as expected.\n'])
run_test(2, 1, 1, [],
['\n', "1 test ran as expected, 1 didn't:\n", ' test0\n'])
run_test(3, 2, 1, [],
['\n', "2 tests ran as expected, 1 didn't:\n", ' test0\n'])
run_test(3, 2, 0, [],
['\n', "2 tests ran as expected (1 didn't run).\n"])
# With times:
fake_shards = [FakeShard('foo', 1), FakeShard('bar', 2)]
run_test(1, 1, 0, fake_shards,
['The test ran as expected in 5.00s (2.00s in rwt, 1x).\n'])
run_test(2, 1, 1, fake_shards, [
'\n',
"1 test ran as expected, 1 didn't in 5.00s (2.00s in rwt, 1x):\n",
' test0\n'
])
run_test(3, 2, 1, fake_shards, [
'\n',
"2 tests ran as expected, 1 didn't in 5.00s (2.00s in rwt, 1x):\n",
' test0\n'
])
run_test(3, 2, 0, fake_shards, [
'\n',
"2 tests ran as expected (1 didn't run) in 5.00s (2.00s in rwt, 1x).\n"
])
def test_test_status_line(self):
printer, _ = self.get_printer()
printer._meter.number_of_columns = lambda: 80
actual = printer._test_status_line(
'fast/dom/HTMLFormElement/associated-elements-after-index-assertion-fail1.html',
' passed')
self.assertEqual(80, len(actual))
self.assertEqual(
actual,
'[0/0] fast/dom/HTMLFormElement/associa...after-index-assertion-fail1.html passed'
)
printer._meter.number_of_columns = lambda: 89
actual = printer._test_status_line(
'fast/dom/HTMLFormElement/associated-elements-after-index-assertion-fail1.html',
' passed')
self.assertEqual(89, len(actual))
self.assertEqual(
actual,
'[0/0] fast/dom/HTMLFormElement/associated-...ents-after-index-assertion-fail1.html passed'
)
printer._meter.number_of_columns = lambda: sys.maxsize
actual = printer._test_status_line(
'fast/dom/HTMLFormElement/associated-elements-after-index-assertion-fail1.html',
' passed')
self.assertEqual(90, len(actual))
self.assertEqual(
actual,
'[0/0] fast/dom/HTMLFormElement/associated-elements-after-index-assertion-fail1.html passed'
)
printer._meter.number_of_columns = lambda: 18
actual = printer._test_status_line(
'fast/dom/HTMLFormElement/associated-elements-after-index-assertion-fail1.html',
' passed')
self.assertEqual(18, len(actual))
self.assertEqual(actual, '[0/0] f...l passed')
printer._meter.number_of_columns = lambda: 10
actual = printer._test_status_line(
'fast/dom/HTMLFormElement/associated-elements-after-index-assertion-fail1.html',
' passed')
self.assertEqual(
actual,
'[0/0] associated-elements-after-index-assertion-fail1.html passed'
)
def test_details(self):
printer, err = self.get_printer(['--details'])
result = self.get_result('passes/image.html')
printer.print_started_test('passes/image.html')
printer.print_finished_test(
self._port, result, expected=False, exp_str='', got_str='')
self.assertNotEmpty(err)
def test_print_found(self):
printer, err = self.get_printer()
self.reset(err)
printer.print_found(100, 100, 10, 1, 1)
self.assertWritten(err,
['Found 100 tests; running 10, skipping 90.\n'])
self.reset(err)
printer.print_found(100, 20, 10, 1, 1)
self.assertWritten(
err, ['Found 20 tests (total 100); running 10, skipping 10.\n'])
self.reset(err)
printer.print_found(100, 100, 10, 2, 3)
self.assertWritten(err, [
'Found 100 tests; running 10 (6 times each: --repeat-each=2 --iterations=3), skipping 90.\n'
])
def test_debug_rwt_logging_is_throttled(self):
printer, err = self.get_printer(['--debug-rwt-logging'])
result = self.get_result('passes/image.html')
printer.print_started_test('passes/image.html')
printer.print_finished_test(
self._port, result, expected=True, exp_str='', got_str='')
printer.print_started_test('passes/text.html')
result = self.get_result('passes/text.html')
printer.print_finished_test(
self._port, result, expected=True, exp_str='', got_str='')
# Only the first test's start should be printed.
lines = err.buflist
self.assertEqual(len(lines), 1)
self.assertTrue(lines[0].endswith('passes/image.html\n'))