py/test/pytests/buzzer.py

# Copyright 2013 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""This is a buzzer test."""

import random
import time
import unittest

import factory_common  # pylint: disable=unused-import
from cros.factory.test.i18n import test_ui as i18n_test_ui
from cros.factory.test import test_ui
from cros.factory.test import ui_templates
from cros.factory.utils.arg_utils import Arg
from cros.factory.utils import process_utils

_MSG_BUZZER_INFO = i18n_test_ui.MakeI18nLabelWithClass(
    'How many beeps do you hear? <br>'
    'Press space to start.',
    'buzzer-test-info')

_MSG_BUZZER_TEST = i18n_test_ui.MakeI18nLabelWithClass(
    'How many beeps do you hear? <br>'
    'Press the number you hear to pass the test.<br>'
    "Press 'r' to play again.",
    'buzzer-test-info')

_HTML_BUZZER = """
<table style="width: 70%%; margin: auto;">
  <tr>
    <td align="center"><div id="buzzer_title"></div></td>
  </tr>
</table>
"""

_CSS_BUZZER = """
  .buzzer-test-info { font-size: 2em; }
"""


class BuzzerTest(unittest.TestCase):
  """Tests buzzer."""
  ARGS = [
      # Common arguments
      Arg('init_commands', list, 'Setup buzzer commands', optional=True),
      Arg('start_command', list, 'Start beep command', optional=True),
      Arg('stop_command', list, 'Stop beep command', optional=True),
      Arg('beep_duration_secs', float, 'How long for one beep', 0.3),
      Arg('mute_duration_secs', float, 'Mute duration between two beeps', 0.5),
  ]

  def setUp(self):
    self._pass_digit = random.randint(1, 5)
    self.ui = test_ui.UI()
    self.template = ui_templates.OneSection(self.ui)
    self.ui.AppendCSS(_CSS_BUZZER)
    self.template.SetState(_HTML_BUZZER)
    self.ui.BindKey(test_ui.SPACE_KEY, self.StartTest)
    self.ui.BindKey('R', self.StartTest)
    for num in xrange(10):
      self.ui.BindKey(str(num), self.CheckResult, num)
    self.ui.SetHTML(_MSG_BUZZER_INFO, id='buzzer_title')
    if self.args.init_commands:
      self.InitialBuzzer(self.args.init_commands)

  def InitialBuzzer(self, commands):
    for command in commands:
      process_utils.Spawn(command, check_call=True)

  def BeepOne(self, start_cmd, stop_cmd):
    if start_cmd:
      process_utils.Spawn(start_cmd, check_call=True)
    time.sleep(self.args.beep_duration_secs)
    if stop_cmd:
      process_utils.Spawn(stop_cmd, check_call=True)

  def StartTest(self, event):
    del event  # Unused.
    self.ui.SetHTML(_MSG_BUZZER_TEST, id='buzzer_title')
    for unused_i in xrange(self._pass_digit):
      self.BeepOne(self.args.start_command, self.args.stop_command)
      time.sleep(self.args.mute_duration_secs)

  def CheckResult(self, event):
    if event.data != self._pass_digit:
      self.ui.Fail('Wrong number to press.')
    else:
      self.ui.Pass()

  def runTest(self):
    self.ui.Run()