blob: 0fbe90d53a41dabd1b0a3c20bbc7235d86ccac4b [file] [log] [blame]
Hung-Te Linf2f78f72012-02-08 19:27:11 +08001#!/usr/bin/python -u
Hung-Te Linf2f78f72012-02-08 19:27:11 +08002# -*- coding: utf-8 -*-
3#
Jon Salz37eccbd2012-05-25 16:06:52 +08004# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
Hung-Te Linf2f78f72012-02-08 19:27:11 +08005# Use of this source code is governed by a BSD-style license that can be
6# found in the LICENSE file.
7
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08008"""The main factory flow that runs the factory test and finalizes a device."""
Hung-Te Linf2f78f72012-02-08 19:27:11 +08009
Joel Kitchingb85ed7f2014-10-08 18:24:39 +080010from __future__ import print_function
11
Jon Salze12c2b32013-06-25 16:24:34 +080012import glob
Wei-Han Chenc17b4112016-11-22 14:56:51 +080013import itertools
Jon Salz0405ab52012-03-16 15:26:52 +080014import logging
Wei-Han Chenc17b4112016-11-22 14:56:51 +080015from optparse import OptionParser
Jon Salz0405ab52012-03-16 15:26:52 +080016import os
Jon Salze12c2b32013-06-25 16:24:34 +080017import shutil
Jon Salz77c151e2012-08-28 07:20:37 +080018import signal
Jon Salz0405ab52012-03-16 15:26:52 +080019import sys
Jon Salzeff94182013-06-19 15:06:28 +080020import syslog
Jon Salz0405ab52012-03-16 15:26:52 +080021import threading
22import time
23import traceback
Jon Salz258a40c2012-04-19 12:34:01 +080024import uuid
Jon Salzb10cf512012-08-09 17:29:21 +080025from xmlrpclib import Binary
Hung-Te Linf2f78f72012-02-08 19:27:11 +080026
Jon Salz0697cbf2012-07-04 15:14:04 +080027import factory_common # pylint: disable=W0611
Hung-Te Linb6287242016-05-18 14:39:05 +080028from cros.factory.device import device_utils
Vic Yangd80ea752014-09-24 16:07:14 +080029from cros.factory.goofy.goofy_base import GoofyBase
30from cros.factory.goofy.goofy_rpc import GoofyRPC
Earl Ouacbe99c2017-02-21 16:04:19 +080031from cros.factory.goofy import goofy_server
Vic Yangd80ea752014-09-24 16:07:14 +080032from cros.factory.goofy.invocation import TestInvocation
33from cros.factory.goofy.link_manager import PresenterLinkManager
Earl Oua3bca122016-10-21 16:00:30 +080034from cros.factory.goofy.plugins import plugin_controller
Vic Yange2c76a82014-10-30 12:48:19 -070035from cros.factory.goofy import prespawner
Wei-Ning Huang38b75f02015-02-25 18:25:14 +080036from cros.factory.goofy.terminal_manager import TerminalManager
Earl Oua3bca122016-10-21 16:00:30 +080037from cros.factory.goofy import test_environment
Wei-Han Chenc17b4112016-11-22 14:56:51 +080038from cros.factory.goofy.test_list_iterator import TestListIterator
Earl Oua3bca122016-10-21 16:00:30 +080039from cros.factory.goofy import updater
Vic Yangd80ea752014-09-24 16:07:14 +080040from cros.factory.goofy.web_socket_manager import WebSocketManager
Hung-Te Linb6287242016-05-18 14:39:05 +080041from cros.factory.test.e2e_test.common import AutomationMode
42from cros.factory.test.e2e_test.common import AutomationModePrompt
43from cros.factory.test.e2e_test.common import ParseAutomationMode
Earl Ouacbe99c2017-02-21 16:04:19 +080044from cros.factory.test.env import goofy_proxy
Hung-Te Linb6287242016-05-18 14:39:05 +080045from cros.factory.test.env import paths
Jon Salz83591782012-06-26 11:09:58 +080046from cros.factory.test.event import Event
47from cros.factory.test.event import EventClient
48from cros.factory.test.event import EventServer
Hung-Te Linb6287242016-05-18 14:39:05 +080049from cros.factory.test import event_log
50from cros.factory.test.event_log import EventLog
Hung-Te Linb6287242016-05-18 14:39:05 +080051from cros.factory.test.event_log import GetBootSequence
Hung-Te Lin91492a12014-11-25 18:56:30 +080052from cros.factory.test.event_log_watcher import EventLogWatcher
Earl Oua3bca122016-10-21 16:00:30 +080053from cros.factory.test import factory
jcliangcd688182012-08-20 21:01:26 +080054from cros.factory.test.factory import TestState
Peter Shihce03c2e2017-03-21 17:36:10 +080055from cros.factory.test.i18n import html_translator
Peter Shih80e78b42017-03-10 17:00:56 +080056from cros.factory.test.i18n import translation
Hung-Te Lin3f096842016-01-13 17:37:06 +080057from cros.factory.test.rules import phase
Earl Oua3bca122016-10-21 16:00:30 +080058from cros.factory.test import shopfloor
59from cros.factory.test import state
Wei-Han Chen2ebb92d2016-01-12 14:51:41 +080060from cros.factory.test.test_lists import test_lists
Earl Oua3bca122016-10-21 16:00:30 +080061from cros.factory.test import testlog
62from cros.factory.test import testlog_goofy
Hung-Te Linb6287242016-05-18 14:39:05 +080063from cros.factory.tools.key_filter import KeyFilter
Wei-Han Chen78f35f62017-03-06 20:11:20 +080064from cros.factory.utils import config_utils
Hung-Te Linf707b242016-01-08 23:11:42 +080065from cros.factory.utils import debug_utils
Jon Salz2af235d2013-06-24 14:47:21 +080066from cros.factory.utils import file_utils
Joel Kitchingb85ed7f2014-10-08 18:24:39 +080067from cros.factory.utils import net_utils
Hung-Te Lin4e6357c2016-01-08 14:32:00 +080068from cros.factory.utils import process_utils
69from cros.factory.utils import sys_utils
70from cros.factory.utils import time_utils
Hung-Te Linf707b242016-01-08 23:11:42 +080071from cros.factory.utils import type_utils
Hung-Te Linf2f78f72012-02-08 19:27:11 +080072
73
Hung-Te Linf2f78f72012-02-08 19:27:11 +080074HWID_CFG_PATH = '/usr/local/share/chromeos-hwid/cfg'
Joel Kitching625ff0f2016-05-16 14:59:40 -070075CACHES_DIR = os.path.join(paths.GetStateRoot(), 'caches')
Hung-Te Linf2f78f72012-02-08 19:27:11 +080076
Cheng-Yi Chiang39d32ad2013-07-23 15:02:38 +080077CLEANUP_LOGS_PAUSED = '/var/lib/cleanup_logs_paused'
78
Jon Salz5c344f62012-07-13 14:31:16 +080079# Value for tests_after_shutdown that forces auto-run (e.g., after
80# a factory update, when the available set of tests might change).
81FORCE_AUTO_RUN = 'force_auto_run'
82
Wei-Han Chenc17b4112016-11-22 14:56:51 +080083# Key to load the test list iterator after shutdown test
84TESTS_AFTER_SHUTDOWN = 'tests_after_shutdown'
85
Justin Chuang83813982013-05-13 01:26:32 +080086
Ricky Liang45c73e72015-01-15 15:00:30 +080087MAX_CRASH_FILE_SIZE = 64 * 1024
Jon Salze12c2b32013-06-25 16:24:34 +080088
Hung-Te Linf707b242016-01-08 23:11:42 +080089Status = type_utils.Enum(['UNINITIALIZED', 'INITIALIZING', 'RUNNING',
Wei-Han Chen2ebb92d2016-01-12 14:51:41 +080090 'TERMINATING', 'TERMINATED'])
Jon Salzd7550792013-07-12 05:49:27 +080091
Hung-Te Linf2f78f72012-02-08 19:27:11 +080092def get_hwid_cfg():
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +080093 """Returns the HWID config tag, or an empty string if none can be found."""
Jon Salz0697cbf2012-07-04 15:14:04 +080094 if 'CROS_HWID' in os.environ:
95 return os.environ['CROS_HWID']
96 if os.path.exists(HWID_CFG_PATH):
Ricky Liang45c73e72015-01-15 15:00:30 +080097 with open(HWID_CFG_PATH, 'r') as hwid_cfg_handle:
Jon Salz0697cbf2012-07-04 15:14:04 +080098 return hwid_cfg_handle.read().strip()
99 return ''
Hung-Te Linf2f78f72012-02-08 19:27:11 +0800100
Jon Salz73e0fd02012-04-04 11:46:38 +0800101_inited_logging = False
Hung-Te Linf2f78f72012-02-08 19:27:11 +0800102
Ricky Liang45c73e72015-01-15 15:00:30 +0800103
Peter Ammon1e1ec572014-06-26 17:56:32 -0700104class Goofy(GoofyBase):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800105 """The main factory flow.
Jon Salz0697cbf2012-07-04 15:14:04 +0800106
107 Note that all methods in this class must be invoked from the main
108 (event) thread. Other threads, such as callbacks and TestInvocation
109 methods, should instead post events on the run queue.
110
111 TODO: Unit tests. (chrome-os-partner:7409)
112
113 Properties:
114 uuid: A unique UUID for this invocation of Goofy.
115 state_instance: An instance of FactoryState.
116 state_server: The FactoryState XML/RPC server.
117 state_server_thread: A thread running state_server.
118 event_server: The EventServer socket server.
119 event_server_thread: A thread running event_server.
120 event_client: A client to the event server.
Earl Oua3bca122016-10-21 16:00:30 +0800121 plugin_controller: The PluginController object.
Jon Salz0697cbf2012-07-04 15:14:04 +0800122 invocations: A map from FactoryTest objects to the corresponding
123 TestInvocations objects representing active tests.
Jon Salz0697cbf2012-07-04 15:14:04 +0800124 options: Command-line options.
125 args: Command-line args.
126 test_list: The test list.
Jon Salz128b0932013-07-03 16:55:26 +0800127 test_lists: All new-style test lists.
Ricky Liang4bff3e32014-02-20 18:46:11 +0800128 run_id: The identifier for latest test run.
129 scheduled_run_tests: The list of tests scheduled for latest test run.
Jon Salz0697cbf2012-07-04 15:14:04 +0800130 event_handlers: Map of Event.Type to the method used to handle that
131 event. If the method has an 'event' argument, the event is passed
132 to the handler.
Jon Salz416f9cc2013-05-10 18:32:50 +0800133 hooks: A Hooks object containing hooks for various Goofy actions.
Jon Salzd7550792013-07-12 05:49:27 +0800134 status: The current Goofy status (a member of the Status enum).
Peter Ammon948b7172014-07-15 12:43:06 -0700135 link_manager: Instance of PresenterLinkManager for communicating
136 with GoofyPresenter
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800137 """
Ricky Liang45c73e72015-01-15 15:00:30 +0800138
Jon Salz0697cbf2012-07-04 15:14:04 +0800139 def __init__(self):
Peter Ammon1e1ec572014-06-26 17:56:32 -0700140 super(Goofy, self).__init__()
Jon Salz0697cbf2012-07-04 15:14:04 +0800141 self.uuid = str(uuid.uuid4())
142 self.state_instance = None
Earl Ouacbe99c2017-02-21 16:04:19 +0800143 self.goofy_server = None
144 self.goofy_server_thread = None
Jon Salz16d10542012-07-23 12:18:45 +0800145 self.goofy_rpc = None
Jon Salz0697cbf2012-07-04 15:14:04 +0800146 self.event_server = None
147 self.event_server_thread = None
148 self.event_client = None
Jon Salz0697cbf2012-07-04 15:14:04 +0800149 self.log_watcher = None
Jon Salz0697cbf2012-07-04 15:14:04 +0800150 self.event_log = None
Chun-Ta Lin53cbbd52016-06-08 21:42:19 +0800151 self.testlog = None
Earl Oua3bca122016-10-21 16:00:30 +0800152 self.plugin_controller = None
Vic Yange2c76a82014-10-30 12:48:19 -0700153 self.pytest_prespawner = None
Vic Yanga3cecf82014-12-26 00:44:21 -0800154 self._ui_initialized = False
Jon Salzc79a9982012-08-30 04:42:01 +0800155 self.dummy_shopfloor = None
Jon Salz0697cbf2012-07-04 15:14:04 +0800156 self.invocations = {}
Jon Salz0697cbf2012-07-04 15:14:04 +0800157 self.visible_test = None
158 self.chrome = None
Jon Salz416f9cc2013-05-10 18:32:50 +0800159 self.hooks = None
Jon Salz0697cbf2012-07-04 15:14:04 +0800160
161 self.options = None
162 self.args = None
163 self.test_list = None
Jon Salz128b0932013-07-03 16:55:26 +0800164 self.test_lists = None
Ricky Liang4bff3e32014-02-20 18:46:11 +0800165 self.run_id = None
166 self.scheduled_run_tests = None
Jon Salz0697cbf2012-07-04 15:14:04 +0800167 self.env = None
Jon Salzb22d1172012-08-06 10:38:57 +0800168 self.last_idle = None
Jon Salz0697cbf2012-07-04 15:14:04 +0800169 self.last_shutdown_time = None
cychiang21886742012-07-05 15:16:32 +0800170 self.last_update_check = None
Cheng-Yi Chiang194d3c02015-03-16 14:37:15 +0800171 self._suppress_periodic_update_messages = False
Cheng-Yi Chiangf5b21012015-03-17 15:37:14 +0800172 self._suppress_event_log_error_messages = False
Earl Ouab979142016-10-25 16:48:06 +0800173 self.exclusive_resources = set()
Dean Liao592e4d52013-01-10 20:06:39 +0800174 self.key_filter = None
Jon Salzd7550792013-07-12 05:49:27 +0800175 self.status = Status.UNINITIALIZED
Ricky Liang36512a32014-07-25 11:47:04 +0800176 self.ready_for_ui_connection = False
Peter Ammon1e1ec572014-06-26 17:56:32 -0700177 self.link_manager = None
Hung-Te Linef7f2be2015-07-20 20:38:51 +0800178 self.is_restart_requested = False
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800179 self.test_list_iterator = None
Jon Salz0697cbf2012-07-04 15:14:04 +0800180
Hung-Te Lin6a72c642015-12-13 22:09:09 +0800181 # TODO(hungte) Support controlling remote DUT.
Hung-Te Linb6287242016-05-18 14:39:05 +0800182 self.dut = device_utils.CreateDUTInterface()
Hung-Te Lin6a72c642015-12-13 22:09:09 +0800183
Jon Salz85a39882012-07-05 16:45:04 +0800184 def test_or_root(event, parent_or_group=True):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800185 """Returns the test affected by a particular event.
Jon Salz85a39882012-07-05 16:45:04 +0800186
187 Args:
188 event: The event containing an optional 'path' attribute.
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800189 parent_or_group: If True, returns the top-level parent for a test (the
Jon Salz85a39882012-07-05 16:45:04 +0800190 root node of the tests that need to be run together if the given test
191 path is to be run).
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800192 """
Jon Salz0697cbf2012-07-04 15:14:04 +0800193 try:
194 path = event.path
195 except AttributeError:
196 path = None
197
198 if path:
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800199 test = self.test_list.LookupPath(path)
Jon Salz85a39882012-07-05 16:45:04 +0800200 if parent_or_group:
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800201 test = test.GetTopLevelParentOrGroup()
Jon Salz85a39882012-07-05 16:45:04 +0800202 return test
Jon Salz0697cbf2012-07-04 15:14:04 +0800203 else:
204 return self.test_list
205
206 self.event_handlers = {
Ricky Liang45c73e72015-01-15 15:00:30 +0800207 Event.Type.SWITCH_TEST: self.handle_switch_test,
Ricky Liang45c73e72015-01-15 15:00:30 +0800208 Event.Type.RESTART_TESTS:
209 lambda event: self.restart_tests(root=test_or_root(event)),
210 Event.Type.AUTO_RUN:
211 lambda event: self.auto_run(root=test_or_root(event)),
Ricky Liang45c73e72015-01-15 15:00:30 +0800212 Event.Type.RUN_TESTS_WITH_STATUS:
213 lambda event: self.run_tests_with_status(
214 event.status,
215 root=test_or_root(event)),
Ricky Liang45c73e72015-01-15 15:00:30 +0800216 Event.Type.UPDATE_SYSTEM_INFO:
217 lambda event: self.update_system_info(),
218 Event.Type.STOP:
219 lambda event: self.stop(root=test_or_root(event, False),
220 fail=getattr(event, 'fail', False),
221 reason=getattr(event, 'reason', None)),
222 Event.Type.SET_VISIBLE_TEST:
223 lambda event: self.set_visible_test(
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800224 self.test_list.LookupPath(event.path)),
Ricky Liang45c73e72015-01-15 15:00:30 +0800225 Event.Type.CLEAR_STATE:
226 lambda event: self.clear_state(
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800227 self.test_list.LookupPath(event.path)),
Wei-Ning Huang38b75f02015-02-25 18:25:14 +0800228 Event.Type.KEY_FILTER_MODE: self.handle_key_filter_mode,
Jon Salz0697cbf2012-07-04 15:14:04 +0800229 }
230
Jon Salz0697cbf2012-07-04 15:14:04 +0800231 self.web_socket_manager = None
Wei-Ning Huang38b75f02015-02-25 18:25:14 +0800232 self.terminal_manager = None
Jon Salz0697cbf2012-07-04 15:14:04 +0800233
234 def destroy(self):
Ricky Liang74237a02014-09-18 15:11:23 +0800235 """Performs any shutdown tasks. Overrides base class method."""
Jon Salzd7550792013-07-12 05:49:27 +0800236 self.status = Status.TERMINATING
Jon Salz0697cbf2012-07-04 15:14:04 +0800237 if self.chrome:
238 self.chrome.kill()
239 self.chrome = None
Jon Salzc79a9982012-08-30 04:42:01 +0800240 if self.dummy_shopfloor:
241 self.dummy_shopfloor.kill()
242 self.dummy_shopfloor = None
Jon Salz0697cbf2012-07-04 15:14:04 +0800243 if self.web_socket_manager:
244 logging.info('Stopping web sockets')
245 self.web_socket_manager.close()
246 self.web_socket_manager = None
Earl Ouacbe99c2017-02-21 16:04:19 +0800247 if self.goofy_server_thread:
248 logging.info('Stopping goofy server')
249 self.goofy_server.shutdown()
250 self.goofy_server_thread.join()
251 self.goofy_server.server_close()
252 self.goofy_server_thread = None
Jon Salz0697cbf2012-07-04 15:14:04 +0800253 if self.state_instance:
254 self.state_instance.close()
255 if self.event_server_thread:
256 logging.info('Stopping event server')
257 self.event_server.shutdown() # pylint: disable=E1101
258 self.event_server_thread.join()
259 self.event_server.server_close()
260 self.event_server_thread = None
261 if self.log_watcher:
262 if self.log_watcher.IsThreadStarted():
263 self.log_watcher.StopWatchThread()
264 self.log_watcher = None
Vic Yange2c76a82014-10-30 12:48:19 -0700265 if self.pytest_prespawner:
266 logging.info('Stopping pytest prespawner')
267 self.pytest_prespawner.stop()
268 self.pytest_prespawner = None
Jon Salz0697cbf2012-07-04 15:14:04 +0800269 if self.event_client:
270 logging.info('Closing event client')
271 self.event_client.close()
272 self.event_client = None
273 if self.event_log:
274 self.event_log.Close()
275 self.event_log = None
Chun-Ta Lin53cbbd52016-06-08 21:42:19 +0800276 if self.testlog:
277 self.testlog.Close()
278 self.testlog = None
Dean Liao592e4d52013-01-10 20:06:39 +0800279 if self.key_filter:
280 self.key_filter.Stop()
Peter Ammon1e1ec572014-06-26 17:56:32 -0700281 if self.link_manager:
282 self.link_manager.Stop()
283 self.link_manager = None
Earl Oua3bca122016-10-21 16:00:30 +0800284 if self.plugin_controller:
285 self.plugin_controller.StopAndDestroyAllPlugins()
286 self.plugin_controller = None
Dean Liao592e4d52013-01-10 20:06:39 +0800287
Peter Ammon1e1ec572014-06-26 17:56:32 -0700288 super(Goofy, self).destroy()
Jon Salz0697cbf2012-07-04 15:14:04 +0800289 logging.info('Done destroying Goofy')
Jon Salzd7550792013-07-12 05:49:27 +0800290 self.status = Status.TERMINATED
Jon Salz0697cbf2012-07-04 15:14:04 +0800291
Earl Ouacbe99c2017-02-21 16:04:19 +0800292 def start_goofy_server(self):
293 self.goofy_server = goofy_server.GoofyServer(
294 (goofy_proxy.DEFAULT_GOOFY_ADDRESS, goofy_proxy.DEFAULT_GOOFY_PORT))
295 logging.info('Starting goofy server')
296 self.goofy_server_thread = threading.Thread(
297 target=self.goofy_server.serve_forever,
298 name='GoofyServer')
299 self.goofy_server_thread.start()
300
301 # Setup static file path
302 self.goofy_server.RegisterPath(
303 '/', os.path.join(paths.FACTORY_PACKAGE_PATH, 'goofy/static'))
Peter Shihce03c2e2017-03-21 17:36:10 +0800304 # index.html needs to be preprocessed.
305 index_path = os.path.join(paths.FACTORY_PACKAGE_PATH,
306 'goofy/static/index.html')
307 index_html = html_translator.TranslateHTML(file_utils.ReadFile(index_path))
308 self.goofy_server.RegisterData('/index.html', 'text/html', index_html)
Earl Ouacbe99c2017-02-21 16:04:19 +0800309
310 def init_state_instance(self):
Jon Salz2af235d2013-06-24 14:47:21 +0800311 # Before starting state server, remount stateful partitions with
312 # no commit flag. The default commit time (commit=600) makes corruption
313 # too likely.
Hung-Te Lin1968d9c2016-01-08 22:55:46 +0800314 sys_utils.ResetCommitTime()
Earl Ouacbe99c2017-02-21 16:04:19 +0800315 self.state_instance = state.FactoryState()
316 self.goofy_server.AddRPCInstance(goofy_proxy.STATE_URL, self.state_instance)
Jon Salz2af235d2013-06-24 14:47:21 +0800317
Earl Ouacbe99c2017-02-21 16:04:19 +0800318 # Setup Goofy RPC.
319 # TODO(shunhsingou): separate goofy_rpc and state server instead of
320 # injecting goofy_rpc functions into state.
Jon Salz16d10542012-07-23 12:18:45 +0800321 self.goofy_rpc = GoofyRPC(self)
322 self.goofy_rpc.RegisterMethods(self.state_instance)
Jon Salz0697cbf2012-07-04 15:14:04 +0800323
Peter Shih80e78b42017-03-10 17:00:56 +0800324 def init_i18n(self):
325 js_data = 'var goofy_i18n_data = %s;' % translation.GetAllI18nDataJS()
Peter Shihce03c2e2017-03-21 17:36:10 +0800326 self.goofy_server.RegisterData('/js/goofy-translations.js',
327 'application/javascript', js_data)
Peter Shih80e78b42017-03-10 17:00:56 +0800328
Jon Salz0697cbf2012-07-04 15:14:04 +0800329 def start_event_server(self):
330 self.event_server = EventServer()
331 logging.info('Starting factory event server')
332 self.event_server_thread = threading.Thread(
Ricky Liang45c73e72015-01-15 15:00:30 +0800333 target=self.event_server.serve_forever,
334 name='EventServer') # pylint: disable=E1101
Jon Salz0697cbf2012-07-04 15:14:04 +0800335 self.event_server_thread.start()
336
337 self.event_client = EventClient(
Ricky Liang45c73e72015-01-15 15:00:30 +0800338 callback=self.handle_event, event_loop=self.run_queue)
Jon Salz0697cbf2012-07-04 15:14:04 +0800339
340 self.web_socket_manager = WebSocketManager(self.uuid)
Earl Ouacbe99c2017-02-21 16:04:19 +0800341 self.goofy_server.AddHTTPGetHandler(
342 '/event', self.web_socket_manager.handle_web_socket)
Jon Salz0697cbf2012-07-04 15:14:04 +0800343
Wei-Ning Huang38b75f02015-02-25 18:25:14 +0800344 def start_terminal_server(self):
345 self.terminal_manager = TerminalManager()
Earl Ouacbe99c2017-02-21 16:04:19 +0800346 self.goofy_server.AddHTTPGetHandler(
347 '/pty', self.terminal_manager.handle_web_socket)
Wei-Ning Huang38b75f02015-02-25 18:25:14 +0800348
Jon Salz0697cbf2012-07-04 15:14:04 +0800349 def set_visible_test(self, test):
350 if self.visible_test == test:
351 return
Jon Salz2f2d42c2012-07-30 12:30:34 +0800352 if test and not test.has_ui:
353 return
Jon Salz0697cbf2012-07-04 15:14:04 +0800354
355 if test:
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800356 test.UpdateState(visible=True)
Jon Salz0697cbf2012-07-04 15:14:04 +0800357 if self.visible_test:
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800358 self.visible_test.UpdateState(visible=False)
Jon Salz0697cbf2012-07-04 15:14:04 +0800359 self.visible_test = test
360
Ricky Liang48e47f92014-02-26 19:31:51 +0800361 def shutdown(self, operation):
362 """Starts shutdown procedure.
363
364 Args:
Vic (Chun-Ju) Yang05b0d952014-04-28 17:39:09 +0800365 operation: The shutdown operation (reboot, full_reboot, or halt).
Ricky Liang48e47f92014-02-26 19:31:51 +0800366 """
367 active_tests = []
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800368 for test in self.test_list.Walk():
369 if not test.IsLeaf():
Ricky Liang48e47f92014-02-26 19:31:51 +0800370 continue
371
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800372 test_state = test.GetState()
Ricky Liang48e47f92014-02-26 19:31:51 +0800373 if test_state.status == TestState.ACTIVE:
374 active_tests.append(test)
375
Ricky Liang48e47f92014-02-26 19:31:51 +0800376 if not (len(active_tests) == 1 and
377 isinstance(active_tests[0], factory.ShutdownStep)):
378 logging.error(
379 'Calling Goofy shutdown outside of the shutdown factory test')
380 return
381
382 logging.info('Start Goofy shutdown (%s)', operation)
383 # Save pending test list in the state server
384 self.state_instance.set_shared_data(
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800385 TESTS_AFTER_SHUTDOWN, self.test_list_iterator)
Ricky Liang48e47f92014-02-26 19:31:51 +0800386 # Save shutdown time
387 self.state_instance.set_shared_data('shutdown_time', time.time())
388
389 with self.env.lock:
390 self.event_log.Log('shutdown', operation=operation)
391 shutdown_result = self.env.shutdown(operation)
392 if shutdown_result:
393 # That's all, folks!
Peter Ammon1e1ec572014-06-26 17:56:32 -0700394 self.run_enqueue(None)
Ricky Liang48e47f92014-02-26 19:31:51 +0800395 else:
396 # Just pass (e.g., in the chroot).
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800397 self.state_instance.set_shared_data(TESTS_AFTER_SHUTDOWN, None)
Ricky Liang48e47f92014-02-26 19:31:51 +0800398 # Send event with no fields to indicate that there is no
399 # longer a pending shutdown.
400 self.event_client.post_event(Event(Event.Type.PENDING_SHUTDOWN))
401
402 def handle_shutdown_complete(self, test):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800403 """Handles the case where a shutdown was detected during a shutdown step.
Hung-Te Linf2f78f72012-02-08 19:27:11 +0800404
Ricky Liang6fe218c2013-12-27 15:17:17 +0800405 Args:
406 test: The ShutdownStep.
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800407 """
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800408 test_state = test.UpdateState(increment_shutdown_count=1)
Jon Salz0697cbf2012-07-04 15:14:04 +0800409 logging.info('Detected shutdown (%d of %d)',
Ricky Liang48e47f92014-02-26 19:31:51 +0800410 test_state.shutdown_count, test.iterations)
Hung-Te Linf2f78f72012-02-08 19:27:11 +0800411
Ricky Liang48e47f92014-02-26 19:31:51 +0800412 tests_after_shutdown = self.state_instance.get_shared_data(
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800413 TESTS_AFTER_SHUTDOWN, optional=True)
414
415 # Make this shutdown test the next test to run. This is to continue on
416 # post-shutdown verification in the shutdown step.
Ricky Liang48e47f92014-02-26 19:31:51 +0800417 if not tests_after_shutdown:
Ricky Liang48e47f92014-02-26 19:31:51 +0800418 self.state_instance.set_shared_data(
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800419 TESTS_AFTER_SHUTDOWN, TestListIterator(test))
420 else:
421 # unset inited, so we will start from the reboot test.
422 tests_after_shutdown.inited = False
423 self.state_instance.set_shared_data(
424 TESTS_AFTER_SHUTDOWN, tests_after_shutdown)
Hung-Te Linf2f78f72012-02-08 19:27:11 +0800425
Ricky Liang48e47f92014-02-26 19:31:51 +0800426 # Set 'post_shutdown' to inform shutdown test that a shutdown just occurred.
Ricky Liangb7eb8772014-09-15 18:05:22 +0800427 self.state_instance.set_shared_data(
428 state.POST_SHUTDOWN_TAG % test.path,
429 self.state_instance.get_test_state(test.path).invocation)
Jon Salz258a40c2012-04-19 12:34:01 +0800430
Jon Salz0697cbf2012-07-04 15:14:04 +0800431 def init_states(self):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800432 """Initializes all states on startup."""
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800433 for test in self.test_list.GetAllTests():
Jon Salz0697cbf2012-07-04 15:14:04 +0800434 # Make sure the state server knows about all the tests,
435 # defaulting to an untested state.
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800436 test.UpdateState(update_parent=False, visible=False)
Hung-Te Linf2f78f72012-02-08 19:27:11 +0800437
Earl Ouf76e55c2017-03-07 11:48:34 +0800438 is_unexpected_shutdown = False
Hung-Te Linf2f78f72012-02-08 19:27:11 +0800439
Jon Salz0697cbf2012-07-04 15:14:04 +0800440 # Any 'active' tests should be marked as failed now.
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800441 for test in self.test_list.Walk():
442 if not test.IsLeaf():
Jon Salza6711d72012-07-18 14:33:03 +0800443 # Don't bother with parents; they will be updated when their
444 # children are updated.
445 continue
446
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800447 test_state = test.GetState()
Jon Salz0697cbf2012-07-04 15:14:04 +0800448 if test_state.status != TestState.ACTIVE:
449 continue
450 if isinstance(test, factory.ShutdownStep):
451 # Shutdown while the test was active - that's good.
Ricky Liang48e47f92014-02-26 19:31:51 +0800452 self.handle_shutdown_complete(test)
Jon Salz0697cbf2012-07-04 15:14:04 +0800453 else:
Earl Ouf76e55c2017-03-07 11:48:34 +0800454 is_unexpected_shutdown = True
Jon Salz0697cbf2012-07-04 15:14:04 +0800455 error_msg = 'Unexpected shutdown while test was running'
Chun-Ta Lin53cbbd52016-06-08 21:42:19 +0800456 # TODO(itspeter): Add testlog to collect expired session infos.
Jon Salz0697cbf2012-07-04 15:14:04 +0800457 self.event_log.Log('end_test',
Ricky Liang45c73e72015-01-15 15:00:30 +0800458 path=test.path,
459 status=TestState.FAILED,
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800460 invocation=test.GetState().invocation,
Earl Ouf76e55c2017-03-07 11:48:34 +0800461 error_msg=error_msg)
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800462 test.UpdateState(
Ricky Liang45c73e72015-01-15 15:00:30 +0800463 status=TestState.FAILED,
464 error_msg=error_msg)
Chun-Ta Lin87c2dac2015-05-02 01:35:01 -0700465 # Trigger the OnTestFailure callback.
Claire Changd1961a22015-08-05 16:15:55 +0800466 self.run_queue.put(lambda: self.test_fail(test))
Hung-Te Linf2f78f72012-02-08 19:27:11 +0800467
Jon Salz50efe942012-07-26 11:54:10 +0800468 if not test.never_fails:
469 # For "never_fails" tests (such as "Start"), don't cancel
470 # pending tests, since reboot is expected.
471 factory.console.info('Unexpected shutdown while test %s '
472 'running; cancelling any pending tests',
473 test.path)
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800474 # cancel pending tests by replace the iterator with an empty one
475 self.state_instance.set_shared_data(
476 TESTS_AFTER_SHUTDOWN,
477 TestListIterator(None))
Jon Salz008f4ea2012-08-28 05:39:45 +0800478
Earl Ouf76e55c2017-03-07 11:48:34 +0800479 if is_unexpected_shutdown:
480 logging.warning("Unexpected shutdown.")
481 self.dut.hooks.OnUnexpectedReboot()
482
Jon Salz0697cbf2012-07-04 15:14:04 +0800483 def handle_event(self, event):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800484 """Handles an event from the event server."""
Jon Salz0697cbf2012-07-04 15:14:04 +0800485 handler = self.event_handlers.get(event.type)
486 if handler:
487 handler(event)
488 else:
489 # We don't register handlers for all event types - just ignore
490 # this event.
491 logging.debug('Unbound event type %s', event.type)
Jon Salz4f6c7172012-06-11 20:45:36 +0800492
Vic Yangaabf9fd2013-04-09 18:56:13 +0800493 def check_critical_factory_note(self):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800494 """Returns True if the last factory note is critical."""
Vic Yangaabf9fd2013-04-09 18:56:13 +0800495 notes = self.state_instance.get_shared_data('factory_note', True)
496 return notes and notes[-1]['level'] == 'CRITICAL'
497
Hung-Te Linef7f2be2015-07-20 20:38:51 +0800498 def schedule_restart(self):
499 """Schedules a restart event when any invocation is completed."""
500 self.is_restart_requested = True
501
502 def invocation_completion(self):
503 """Callback when an invocation is completed."""
504 if self.is_restart_requested:
505 logging.info('Restart by scheduled event.')
506 self.is_restart_requested = False
507 self.restart_tests()
508 else:
509 self.run_next_test()
510
Jon Salz0697cbf2012-07-04 15:14:04 +0800511 def run_next_test(self):
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800512 """Runs the next eligible test.
henryhsu4cc6b022014-04-22 17:12:42 +0800513
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800514 self.test_list_iterator (a TestListIterator object) will determine which
515 test should be run.
henryhsu4cc6b022014-04-22 17:12:42 +0800516 """
Jon Salz0697cbf2012-07-04 15:14:04 +0800517 self.reap_completed_tests()
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800518
519 if self.invocations:
520 # there are tests still running, we cannot start new tests
Vic Yangaabf9fd2013-04-09 18:56:13 +0800521 return
Jon Salz94eb56f2012-06-12 18:01:12 +0800522
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800523 if self.check_critical_factory_note():
524 logging.info('has critical factory note, stop running')
525 self.test_list_iterator.stop()
526 return
Jon Salz94eb56f2012-06-12 18:01:12 +0800527
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800528 while True:
529 try:
530 path = self.test_list_iterator.next()
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800531 test = self.test_list.LookupPath(path)
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800532 except StopIteration:
533 logging.info('no next test, stop running')
Jon Salz0697cbf2012-07-04 15:14:04 +0800534 return
Jon Salz94eb56f2012-06-12 18:01:12 +0800535
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800536 # check if we have run all required tests
Jon Salz304a75d2012-07-06 11:14:15 +0800537 untested = set()
Jon Salza1412922012-07-23 16:04:17 +0800538 for requirement in test.require_run:
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800539 for i in requirement.test.Walk():
Jon Salza1412922012-07-23 16:04:17 +0800540 if i == test:
Jon Salz304a75d2012-07-06 11:14:15 +0800541 # We've hit this test itself; stop checking
542 break
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800543 if ((i.GetState().status == TestState.UNTESTED) or
544 (requirement.passed and i.GetState().status !=
Jon Salza1412922012-07-23 16:04:17 +0800545 TestState.PASSED)):
Jon Salz304a75d2012-07-06 11:14:15 +0800546 # Found an untested test; move on to the next
547 # element in require_run.
Jon Salza1412922012-07-23 16:04:17 +0800548 untested.add(i)
Jon Salz304a75d2012-07-06 11:14:15 +0800549 break
550
551 if untested:
552 untested_paths = ', '.join(sorted([x.path for x in untested]))
553 if self.state_instance.get_shared_data('engineering_mode',
554 optional=True):
555 # In engineering mode, we'll let it go.
556 factory.console.warn('In engineering mode; running '
557 '%s even though required tests '
558 '[%s] have not completed',
559 test.path, untested_paths)
560 else:
561 # Not in engineering mode; mark it failed.
562 error_msg = ('Required tests [%s] have not been run yet'
563 % untested_paths)
564 factory.console.error('Not running %s: %s',
565 test.path, error_msg)
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800566 test.UpdateState(status=TestState.FAILED,
567 error_msg=error_msg)
Jon Salz304a75d2012-07-06 11:14:15 +0800568 continue
569
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800570 # okay, let's run the test
Ricky Liang48e47f92014-02-26 19:31:51 +0800571 if (isinstance(test, factory.ShutdownStep) and
Ricky Liangb7eb8772014-09-15 18:05:22 +0800572 self.state_instance.get_shared_data(
573 state.POST_SHUTDOWN_TAG % test.path, optional=True)):
Ricky Liang48e47f92014-02-26 19:31:51 +0800574 # Invoking post shutdown method of shutdown test. We should retain the
575 # iterations_left and retries_left of the original test state.
576 test_state = self.state_instance.get_test_state(test.path)
577 self._run_test(test, test_state.iterations_left,
578 test_state.retries_left)
579 else:
580 # Starts a new test run; reset iterations and retries.
581 self._run_test(test, test.iterations, test.retries)
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800582 return # to leave while
Jon Salz1acc8742012-07-17 17:45:55 +0800583
Cheng-Yi Chiangce05c002013-04-04 02:13:17 +0800584 def _run_test(self, test, iterations_left=None, retries_left=None):
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800585 """Invokes the test.
586
587 The argument `test` should be either a leaf test (no subtests) or a parallel
588 test (all subtests should be run in parallel).
589 """
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800590 if not self._ui_initialized and not test.IsNoHost():
Vic Yanga3cecf82014-12-26 00:44:21 -0800591 self.init_ui()
Jon Salz1acc8742012-07-17 17:45:55 +0800592
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800593 if test.IsLeaf():
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800594 invoc = TestInvocation(
595 self, test, on_completion=self.invocation_completion,
596 on_test_failure=lambda: self.test_fail(test))
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800597 new_state = test.UpdateState(
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800598 status=TestState.ACTIVE, increment_count=1, error_msg='',
599 invocation=invoc.uuid, iterations_left=iterations_left,
600 retries_left=retries_left,
601 visible=(self.visible_test == test))
602 invoc.count = new_state.count
603 self.invocations[test] = invoc
604 if self.visible_test is None and test.has_ui:
605 self.set_visible_test(test)
606 self.check_plugins()
607 invoc.start()
608 else:
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800609 assert test.IsParallel()
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800610 for subtest in test.subtests:
611 # TODO(stimim): what if the subtests *must* be run in parallel?
612 # for example, stressapptest and countdown test.
613
614 # Make sure we don't need to skip it:
615 if not self.test_list_iterator.check_skip(subtest):
616 self._run_test(subtest, subtest.iterations, subtest.retries)
Jon Salz5f2a0672012-05-22 17:14:06 +0800617
Earl Oua3bca122016-10-21 16:00:30 +0800618 def check_plugins(self):
619 """Check plugins to be paused or resumed."""
620 exclusive_resources = set()
621 for test in self.invocations:
622 exclusive_resources = exclusive_resources.union(
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800623 test.GetExclusiveResources())
Earl Oua3bca122016-10-21 16:00:30 +0800624 self.plugin_controller.PauseAndResumePluginByResource(exclusive_resources)
625
cychiang21886742012-07-05 15:16:32 +0800626 def check_for_updates(self):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800627 """Schedules an asynchronous check for updates if necessary."""
cychiang21886742012-07-05 15:16:32 +0800628 if not self.test_list.options.update_period_secs:
629 # Not enabled.
630 return
631
632 now = time.time()
633 if self.last_update_check and (
634 now - self.last_update_check <
635 self.test_list.options.update_period_secs):
636 # Not yet time for another check.
637 return
638
639 self.last_update_check = now
640
641 def handle_check_for_update(reached_shopfloor, md5sum, needs_update):
642 if reached_shopfloor:
643 new_update_md5sum = md5sum if needs_update else None
Hung-Te Line594e5d2015-12-16 02:36:05 +0800644 if self.dut.info.update_md5sum != new_update_md5sum:
cychiang21886742012-07-05 15:16:32 +0800645 logging.info('Received new update MD5SUM: %s', new_update_md5sum)
Hung-Te Line594e5d2015-12-16 02:36:05 +0800646 self.dut.info.Overrides('update_md5sum', new_update_md5sum)
Peter Ammon1e1ec572014-06-26 17:56:32 -0700647 self.run_enqueue(self.update_system_info)
Cheng-Yi Chiang194d3c02015-03-16 14:37:15 +0800648 else:
649 if not self._suppress_periodic_update_messages:
650 logging.warning('Suppress error messages for periodic update checking'
651 ' after the first one.')
652 self._suppress_periodic_update_messages = True
cychiang21886742012-07-05 15:16:32 +0800653
654 updater.CheckForUpdateAsync(
Ricky Liang45c73e72015-01-15 15:00:30 +0800655 handle_check_for_update,
Cheng-Yi Chiang194d3c02015-03-16 14:37:15 +0800656 self.test_list.options.shopfloor_timeout_secs,
657 self._suppress_periodic_update_messages)
cychiang21886742012-07-05 15:16:32 +0800658
Jon Salza6711d72012-07-18 14:33:03 +0800659 def cancel_pending_tests(self):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800660 """Cancels any tests in the run queue."""
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800661 self.run_tests(None)
Jon Salza6711d72012-07-18 14:33:03 +0800662
Ricky Liang4bff3e32014-02-20 18:46:11 +0800663 def restore_active_run_state(self):
664 """Restores active run id and the list of scheduled tests."""
665 self.run_id = self.state_instance.get_shared_data('run_id', optional=True)
666 self.scheduled_run_tests = self.state_instance.get_shared_data(
667 'scheduled_run_tests', optional=True)
668
669 def set_active_run_state(self):
670 """Sets active run id and the list of scheduled tests."""
671 self.run_id = str(uuid.uuid4())
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800672 # try our best to predict which tests will be run.
673 self.scheduled_run_tests = self.test_list_iterator.get_pending_tests()
Ricky Liang4bff3e32014-02-20 18:46:11 +0800674 self.state_instance.set_shared_data('run_id', self.run_id)
675 self.state_instance.set_shared_data('scheduled_run_tests',
676 self.scheduled_run_tests)
677
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800678 def run_tests(self, subtree, status_filter=None):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800679 """Runs tests under subtree.
Jon Salz258a40c2012-04-19 12:34:01 +0800680
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800681 Run tests under a given subtree.
Jon Salzb1b39092012-05-03 02:05:09 +0800682
Ricky Liang6fe218c2013-12-27 15:17:17 +0800683 Args:
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800684 subtree: root of subtree to run or None to run nothing.
Chih-Yu Huang85dc63c2015-08-12 15:21:28 +0800685 status_filter: List of available test states. Only run the tests which
686 states are in the list. Set to None if all test states are available.
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800687 """
Hung-Te Lin410f70a2015-12-15 14:53:42 +0800688 self.dut.hooks.OnTestStart()
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800689 self.test_list_iterator = TestListIterator(
690 subtree, status_filter, self.test_list)
691 if subtree is not None:
Ricky Liang4bff3e32014-02-20 18:46:11 +0800692 self.set_active_run_state()
Jon Salz0697cbf2012-07-04 15:14:04 +0800693 self.run_next_test()
Hung-Te Linf2f78f72012-02-08 19:27:11 +0800694
Jon Salz0697cbf2012-07-04 15:14:04 +0800695 def reap_completed_tests(self):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800696 """Removes completed tests from the set of active tests.
Jon Salz0697cbf2012-07-04 15:14:04 +0800697
698 Also updates the visible test if it was reaped.
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800699 """
Cheng-Yi Chiang5ac22ca2013-04-12 17:45:26 +0800700 test_completed = False
Jon Salz0697cbf2012-07-04 15:14:04 +0800701 for t, v in dict(self.invocations).iteritems():
702 if v.is_completed():
Cheng-Yi Chiang5ac22ca2013-04-12 17:45:26 +0800703 test_completed = True
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800704 new_state = t.UpdateState(**v.update_state_on_completion)
Jon Salz0697cbf2012-07-04 15:14:04 +0800705 del self.invocations[t]
706
Johny Lin62ed2a32015-05-13 11:57:12 +0800707 # Stop on failure if flag is true and there is no retry chances.
Chun-Ta Lin54e17e42012-09-06 22:05:13 +0800708 if (self.test_list.options.stop_on_failure and
Johny Lin62ed2a32015-05-13 11:57:12 +0800709 new_state.retries_left < 0 and
Chun-Ta Lin54e17e42012-09-06 22:05:13 +0800710 new_state.status == TestState.FAILED):
711 # Clean all the tests to cause goofy to stop.
Ricky Liang45c73e72015-01-15 15:00:30 +0800712 factory.console.info('Stop on failure triggered. Empty the queue.')
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800713 self.cancel_pending_tests()
Chun-Ta Lin54e17e42012-09-06 22:05:13 +0800714
Jon Salz1acc8742012-07-17 17:45:55 +0800715 if new_state.iterations_left and new_state.status == TestState.PASSED:
716 # Play it again, Sam!
717 self._run_test(t)
Cheng-Yi Chiangce05c002013-04-04 02:13:17 +0800718 # new_state.retries_left is obtained after update.
719 # For retries_left == 0, test can still be run for the last time.
720 elif (new_state.retries_left >= 0 and
721 new_state.status == TestState.FAILED):
722 # Still have to retry, Sam!
723 self._run_test(t)
Jon Salz1acc8742012-07-17 17:45:55 +0800724
Cheng-Yi Chiang5ac22ca2013-04-12 17:45:26 +0800725 if test_completed:
Vic Yangf01c59f2013-04-19 17:37:56 +0800726 self.log_watcher.KickWatchThread()
Cheng-Yi Chiang5ac22ca2013-04-12 17:45:26 +0800727
Jon Salz0697cbf2012-07-04 15:14:04 +0800728 if (self.visible_test is None or
Jon Salz85a39882012-07-05 16:45:04 +0800729 self.visible_test not in self.invocations):
Jon Salz0697cbf2012-07-04 15:14:04 +0800730 self.set_visible_test(None)
731 # Make the first running test, if any, the visible test
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800732 for t in self.test_list.Walk():
Jon Salz0697cbf2012-07-04 15:14:04 +0800733 if t in self.invocations:
734 self.set_visible_test(t)
735 break
736
Jon Salz6dc031d2013-06-19 13:06:23 +0800737 def kill_active_tests(self, abort, root=None, reason=None):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800738 """Kills and waits for all active tests.
Jon Salz0697cbf2012-07-04 15:14:04 +0800739
Jon Salz85a39882012-07-05 16:45:04 +0800740 Args:
741 abort: True to change state of killed tests to FAILED, False for
Jon Salz0697cbf2012-07-04 15:14:04 +0800742 UNTESTED.
Jon Salz85a39882012-07-05 16:45:04 +0800743 root: If set, only kills tests with root as an ancestor.
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800744 reason: If set, the abort reason.
745 """
Jon Salz0697cbf2012-07-04 15:14:04 +0800746 self.reap_completed_tests()
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800747 # since we remove objects while iterating, make a copy
748 for test, invoc in dict(self.invocations).iteritems():
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800749 if root and not test.HasAncestor(root):
Jon Salz85a39882012-07-05 16:45:04 +0800750 continue
751
Ricky Liang45c73e72015-01-15 15:00:30 +0800752 factory.console.info('Killing active test %s...', test.path)
Jon Salz6dc031d2013-06-19 13:06:23 +0800753 invoc.abort_and_join(reason)
Ricky Liang45c73e72015-01-15 15:00:30 +0800754 factory.console.info('Killed %s', test.path)
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800755 test.UpdateState(**invoc.update_state_on_completion)
Jon Salz0697cbf2012-07-04 15:14:04 +0800756 del self.invocations[test]
Jon Salz1acc8742012-07-17 17:45:55 +0800757
Jon Salz0697cbf2012-07-04 15:14:04 +0800758 if not abort:
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800759 test.UpdateState(status=TestState.UNTESTED)
Jon Salz0697cbf2012-07-04 15:14:04 +0800760 self.reap_completed_tests()
761
Jon Salz6dc031d2013-06-19 13:06:23 +0800762 def stop(self, root=None, fail=False, reason=None):
763 self.kill_active_tests(fail, root, reason)
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800764
765 if not root:
766 self.test_list_iterator.stop()
767 else:
768 # only skip tests under `root`
769 self.test_list_iterator = itertools.dropwhile(
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800770 lambda path: self.test_list.LookupPath(path).HasAncestor(root),
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800771 self.test_list_iterator)
Jon Salz85a39882012-07-05 16:45:04 +0800772 self.run_next_test()
Jon Salz0697cbf2012-07-04 15:14:04 +0800773
Jon Salz4712ac72013-02-07 17:12:05 +0800774 def clear_state(self, root=None):
Jon Salzd7550792013-07-12 05:49:27 +0800775 if root is None:
776 root = self.test_list
Jon Salz6dc031d2013-06-19 13:06:23 +0800777 self.stop(root, reason='Clearing test state')
Wei-Han Chen3ae204c2017-04-28 19:36:55 +0800778 for f in root.Walk():
779 if f.IsLeaf():
780 f.UpdateState(status=TestState.UNTESTED)
Jon Salz4712ac72013-02-07 17:12:05 +0800781
Jon Salz6dc031d2013-06-19 13:06:23 +0800782 def abort_active_tests(self, reason=None):
783 self.kill_active_tests(True, reason=reason)
Jon Salz0697cbf2012-07-04 15:14:04 +0800784
785 def main(self):
Jon Salzeff94182013-06-19 15:06:28 +0800786 syslog.openlog('goofy')
787
Jon Salz0697cbf2012-07-04 15:14:04 +0800788 try:
Jon Salzd7550792013-07-12 05:49:27 +0800789 self.status = Status.INITIALIZING
Jon Salz0697cbf2012-07-04 15:14:04 +0800790 self.init()
791 self.event_log.Log('goofy_init',
Ricky Liang45c73e72015-01-15 15:00:30 +0800792 success=True)
Chun-Ta Lin53cbbd52016-06-08 21:42:19 +0800793 testlog.Log(
Joel Kitching9eb203a2016-04-21 15:36:30 +0800794 testlog.StationInit({
Chun-Ta Lin53cbbd52016-06-08 21:42:19 +0800795 'stationDeviceId': testlog_goofy.GetDeviceID(),
Joel Kitching21bc69b2016-07-13 08:29:52 -0700796 'stationInstallationId': testlog_goofy.GetInstallationID(),
Chun-Ta Lin53cbbd52016-06-08 21:42:19 +0800797 'count': testlog_goofy.GetInitCount(),
Joel Kitching9eb203a2016-04-21 15:36:30 +0800798 'success': True}))
Jon Salz0697cbf2012-07-04 15:14:04 +0800799 except:
Joel Kitching9eb203a2016-04-21 15:36:30 +0800800 try:
801 if self.event_log:
Jon Salz0697cbf2012-07-04 15:14:04 +0800802 self.event_log.Log('goofy_init',
Ricky Liang45c73e72015-01-15 15:00:30 +0800803 success=False,
804 trace=traceback.format_exc())
Chun-Ta Lin53cbbd52016-06-08 21:42:19 +0800805 if self.testlog:
806 testlog.Log(
Joel Kitching9eb203a2016-04-21 15:36:30 +0800807 testlog.StationInit({
Chun-Ta Lin53cbbd52016-06-08 21:42:19 +0800808 'stationDeviceId': testlog_goofy.GetDeviceID(),
Joel Kitching21bc69b2016-07-13 08:29:52 -0700809 'stationInstallationId': testlog_goofy.GetInstallationID(),
Chun-Ta Lin53cbbd52016-06-08 21:42:19 +0800810 'count': testlog_goofy.GetInitCount(),
Joel Kitching9eb203a2016-04-21 15:36:30 +0800811 'success': False,
812 'failureMessage': traceback.format_exc()}))
813 except: # pylint: disable=W0702
814 pass
Jon Salz0697cbf2012-07-04 15:14:04 +0800815 raise
816
Jon Salzd7550792013-07-12 05:49:27 +0800817 self.status = Status.RUNNING
Jon Salzeff94182013-06-19 15:06:28 +0800818 syslog.syslog('Goofy (factory test harness) starting')
Chun-Ta Lin5d12b592015-06-30 00:54:23 -0700819 syslog.syslog('Boot sequence = %d' % GetBootSequence())
Chun-Ta Lin53cbbd52016-06-08 21:42:19 +0800820 syslog.syslog('Goofy init count = %d' % testlog_goofy.GetInitCount())
Jon Salz0697cbf2012-07-04 15:14:04 +0800821 self.run()
822
823 def update_system_info(self):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800824 """Updates system info."""
Hung-Te Line594e5d2015-12-16 02:36:05 +0800825 info = self.dut.info.GetAll()
826 self.state_instance.set_shared_data('system_info', info)
Jon Salz0697cbf2012-07-04 15:14:04 +0800827 self.event_client.post_event(Event(Event.Type.SYSTEM_INFO,
Hung-Te Line594e5d2015-12-16 02:36:05 +0800828 system_info=info))
829 logging.info('System info: %r', info)
Jon Salz0697cbf2012-07-04 15:14:04 +0800830
Jon Salzeb42f0d2012-07-27 19:14:04 +0800831 def update_factory(self, auto_run_on_restart=False, post_update_hook=None):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800832 """Commences updating factory software.
Jon Salzeb42f0d2012-07-27 19:14:04 +0800833
834 Args:
835 auto_run_on_restart: Auto-run when the machine comes back up.
836 post_update_hook: Code to call after update but immediately before
837 restart.
838
839 Returns:
840 Never if the update was successful (we just reboot).
841 False if the update was unnecessary (no update available).
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +0800842 """
Jon Salz6dc031d2013-06-19 13:06:23 +0800843 self.kill_active_tests(False, reason='Factory software update')
Jon Salza6711d72012-07-18 14:33:03 +0800844 self.cancel_pending_tests()
Jon Salz0697cbf2012-07-04 15:14:04 +0800845
Jon Salz5c344f62012-07-13 14:31:16 +0800846 def pre_update_hook():
847 if auto_run_on_restart:
Wei-Han Chenc17b4112016-11-22 14:56:51 +0800848 self.state_instance.set_shared_data(TESTS_AFTER_SHUTDOWN,
Jon Salz5c344f62012-07-13 14:31:16 +0800849 FORCE_AUTO_RUN)
850 self.state_instance.close()
851
Jon Salzeb42f0d2012-07-27 19:14:04 +0800852 if updater.TryUpdate(pre_update_hook=pre_update_hook):
853 if post_update_hook:
854 post_update_hook()
855 self.env.shutdown('reboot')
Jon Salz0697cbf2012-07-04 15:14:04 +0800856
Joel Kitching261e0422017-03-30 16:52:01 -0700857 def handle_signal(self, signum, frame):
858 del signum, frame
859 logging.error('Received SIGINT or SIGKILL')
Peter Ammon1e1ec572014-06-26 17:56:32 -0700860 self.run_enqueue(None)
Jon Salz77c151e2012-08-28 07:20:37 +0800861 raise KeyboardInterrupt()
862
Jon Salze12c2b32013-06-25 16:24:34 +0800863 def find_kcrashes(self):
864 """Finds kcrash files, logs them, and marks them as seen."""
865 seen_crashes = set(
866 self.state_instance.get_shared_data('seen_crashes', optional=True)
867 or [])
868
869 for path in glob.glob('/var/spool/crash/*'):
870 if not os.path.isfile(path):
871 continue
872 if path in seen_crashes:
873 continue
874 try:
875 stat = os.stat(path)
Hung-Te Lin4e6357c2016-01-08 14:32:00 +0800876 mtime = time_utils.TimeString(stat.st_mtime)
Jon Salze12c2b32013-06-25 16:24:34 +0800877 logging.info(
878 'Found new crash file %s (%d bytes at %s)',
879 path, stat.st_size, mtime)
880 extra_log_args = {}
881
882 try:
883 _, ext = os.path.splitext(path)
884 if ext in ['.kcrash', '.meta']:
885 ext = ext.replace('.', '')
886 with open(path) as f:
887 data = f.read(MAX_CRASH_FILE_SIZE)
888 tell = f.tell()
889 logging.info(
890 'Contents of %s%s:%s',
891 path,
892 ('' if tell == stat.st_size
893 else '(truncated to %d bytes)' % MAX_CRASH_FILE_SIZE),
894 ('\n' + data).replace('\n', '\n ' + ext + '> '))
895 extra_log_args['data'] = data
896
897 # Copy to /var/factory/kcrash for posterity
Joel Kitching625ff0f2016-05-16 14:59:40 -0700898 kcrash_dir = paths.GetFactoryRoot('kcrash')
Hung-Te Lin4e6357c2016-01-08 14:32:00 +0800899 file_utils.TryMakeDirs(kcrash_dir)
Jon Salze12c2b32013-06-25 16:24:34 +0800900 shutil.copy(path, kcrash_dir)
901 logging.info('Copied to %s',
902 os.path.join(kcrash_dir, os.path.basename(path)))
903 finally:
904 # Even if something goes wrong with the above, still try to
905 # log to event log
906 self.event_log.Log('crash_file',
907 path=path, size=stat.st_size, mtime=mtime,
908 **extra_log_args)
909 except: # pylint: disable=W0702
910 logging.exception('Unable to handle crash files %s', path)
911 seen_crashes.add(path)
912
913 self.state_instance.set_shared_data('seen_crashes', list(seen_crashes))
914
Jon Salz128b0932013-07-03 16:55:26 +0800915 def GetTestList(self, test_list_id):
916 """Returns the test list with the given ID.
917
918 Raises:
919 TestListError: The test list ID is not valid.
920 """
921 try:
922 return self.test_lists[test_list_id]
923 except KeyError:
924 raise test_lists.TestListError(
925 '%r is not a valid test list ID (available IDs are [%s])' % (
926 test_list_id, ', '.join(sorted(self.test_lists.keys()))))
927
Chih-Yu Huang1725d622017-03-24 16:08:35 +0800928 def _RecordStartError(self, error_message):
929 """Appends the startup error message into the shared data."""
930 KEY = 'startup_error'
931 data = self.state_instance.get_shared_data(KEY, optional=True)
932 new_data = '%s\n\n%s' % (data, error_message) if data else error_message
933 self.state_instance.set_shared_data(KEY, new_data)
934
Jon Salz128b0932013-07-03 16:55:26 +0800935 def InitTestLists(self):
Joel Kitching50a63ea2016-02-22 13:15:09 +0800936 """Reads in all test lists and sets the active test list.
937
938 Returns:
939 True if the active test list could be set, False if failed.
940 """
941 startup_errors = []
942 self.test_lists, failed_files = test_lists.BuildAllTestLists(
Ricky Liang27051552014-05-04 14:22:26 +0800943 force_generic=(self.options.automation_mode is not None))
Jon Salzd7550792013-07-12 05:49:27 +0800944 logging.info('Loaded test lists: [%s]',
945 test_lists.DescribeTestLists(self.test_lists))
Jon Salz128b0932013-07-03 16:55:26 +0800946
Joel Kitching50a63ea2016-02-22 13:15:09 +0800947 # Check for any syntax errors in test list files.
948 if failed_files:
949 logging.info('Failed test list files: [%s]',
950 ' '.join(failed_files.keys()))
951 for f, exc_info in failed_files.iteritems():
952 logging.error('Error in test list file: %s', f,
953 exc_info=exc_info)
954
955 # Limit the stack trace to the very last entry.
956 exc_type, exc_value, exc_traceback = exc_info
957 while exc_traceback and exc_traceback.tb_next:
958 exc_traceback = exc_traceback.tb_next
959
960 exc_string = ''.join(
961 traceback.format_exception(
962 exc_type, exc_value, exc_traceback)).rstrip()
963 startup_errors.append('Error in test list file (%s):\n%s'
964 % (f, exc_string))
965
Jon Salz128b0932013-07-03 16:55:26 +0800966 if not self.options.test_list:
967 self.options.test_list = test_lists.GetActiveTestListId()
968
Joel Kitching50a63ea2016-02-22 13:15:09 +0800969 # Check for a non-existent test list ID.
970 try:
Wei-Han Chen84fee7c2016-08-26 21:56:25 +0800971 self.test_list = self.GetTestList(self.options.test_list)
Joel Kitching50a63ea2016-02-22 13:15:09 +0800972 logging.info('Active test list: %s', self.test_list.test_list_id)
973 except test_lists.TestListError as e:
974 logging.exception('Invalid active test list: %s',
975 self.options.test_list)
976 startup_errors.append(e.message)
Jon Salz128b0932013-07-03 16:55:26 +0800977
Joel Kitching50a63ea2016-02-22 13:15:09 +0800978 # We may have failed loading the active test list.
979 if self.test_list:
Joel Kitching50a63ea2016-02-22 13:15:09 +0800980 self.test_list.state_instance = self.state_instance
Jon Salz128b0932013-07-03 16:55:26 +0800981
Joel Kitching50a63ea2016-02-22 13:15:09 +0800982 # Show all startup errors.
983 if startup_errors:
Chih-Yu Huang1725d622017-03-24 16:08:35 +0800984 self._RecordStartError('\n\n'.join(startup_errors))
Joel Kitching50a63ea2016-02-22 13:15:09 +0800985
986 # Only return False if failed to load the active test list.
987 return bool(self.test_list)
Jon Salz128b0932013-07-03 16:55:26 +0800988
Shuo-Peng Liao268b40b2013-07-01 15:58:59 +0800989 def init_hooks(self):
990 """Initializes hooks.
991
992 Must run after self.test_list ready.
993 """
Shuo-Peng Liao52b90da2013-06-30 17:00:06 +0800994 module, cls = self.test_list.options.hooks_class.rsplit('.', 1)
995 self.hooks = getattr(__import__(module, fromlist=[cls]), cls)()
996 assert isinstance(self.hooks, factory.Hooks), (
Ricky Liang45c73e72015-01-15 15:00:30 +0800997 'hooks should be of type Hooks but is %r' % type(self.hooks))
Shuo-Peng Liao52b90da2013-06-30 17:00:06 +0800998 self.hooks.test_list = self.test_list
Shuo-Peng Liao268b40b2013-07-01 15:58:59 +0800999 self.hooks.OnCreatedTestList()
Shuo-Peng Liao52b90da2013-06-30 17:00:06 +08001000
Vic Yanga3cecf82014-12-26 00:44:21 -08001001 def init_ui(self):
1002 """Initialize UI."""
1003 self._ui_initialized = True
1004 if self.options.ui == 'chrome':
Hung-Te Lin8f6a3782015-01-06 22:58:32 +08001005 if self.options.monolithic:
Hung-Te Lin7bd55312014-12-30 16:43:36 +08001006 self.env.launch_chrome()
1007 else:
1008 # The presenter is responsible for launching Chrome. Let's just
1009 # wait here.
1010 self.env.controller_ready_for_ui()
Vic Yanga3cecf82014-12-26 00:44:21 -08001011 logging.info('Waiting for a web socket connection')
1012 self.web_socket_manager.wait()
1013
Jon Salz0697cbf2012-07-04 15:14:04 +08001014 def init(self, args=None, env=None):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001015 """Initializes Goofy.
Jon Salz0697cbf2012-07-04 15:14:04 +08001016
1017 Args:
1018 args: A list of command-line arguments. Uses sys.argv if
1019 args is None.
1020 env: An Environment instance to use (or None to choose
1021 FakeChrootEnvironment or DUTEnvironment as appropriate).
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001022 """
Jon Salz0697cbf2012-07-04 15:14:04 +08001023 parser = OptionParser()
1024 parser.add_option('-v', '--verbose', dest='verbose',
Jon Salz8fa8e832012-07-13 19:04:09 +08001025 action='store_true',
1026 help='Enable debug logging')
Jon Salz0697cbf2012-07-04 15:14:04 +08001027 parser.add_option('--print_test_list', dest='print_test_list',
Wei-Han Chen84fee7c2016-08-26 21:56:25 +08001028 metavar='TEST_LIST_ID',
1029 help='Print the content of TEST_LIST_ID and exit')
Jon Salz0697cbf2012-07-04 15:14:04 +08001030 parser.add_option('--restart', dest='restart',
Jon Salz8fa8e832012-07-13 19:04:09 +08001031 action='store_true',
1032 help='Clear all test state')
Jon Salz0697cbf2012-07-04 15:14:04 +08001033 parser.add_option('--ui', dest='ui', type='choice',
Jon Salz7b5482e2014-08-04 17:48:41 +08001034 choices=['none', 'chrome'],
Jon Salz2f881df2013-02-01 17:00:35 +08001035 default='chrome',
Jon Salz8fa8e832012-07-13 19:04:09 +08001036 help='UI to use')
Jon Salz0697cbf2012-07-04 15:14:04 +08001037 parser.add_option('--test_list', dest='test_list',
Wei-Han Chen84fee7c2016-08-26 21:56:25 +08001038 metavar='TEST_LIST_ID',
1039 help='Use test list whose id is TEST_LIST_ID')
Jon Salzc79a9982012-08-30 04:42:01 +08001040 parser.add_option('--dummy_shopfloor', action='store_true',
1041 help='Use a dummy shopfloor server')
Ricky Liang6fe218c2013-12-27 15:17:17 +08001042 parser.add_option('--automation-mode',
1043 choices=[m.lower() for m in AutomationMode],
Ricky Liang45c73e72015-01-15 15:00:30 +08001044 default='none', help='Factory test automation mode.')
Ricky Liang117484a2014-04-14 11:14:41 +08001045 parser.add_option('--no-auto-run-on-start', dest='auto_run_on_start',
1046 action='store_false', default=True,
1047 help=('do not automatically run the test list on goofy '
1048 'start; this is only valid when factory test '
1049 'automation is enabled'))
Chun-Ta Lina8dd3172014-11-26 16:15:13 +08001050 parser.add_option('--handshake_timeout', dest='handshake_timeout',
1051 type='float', default=0.3,
1052 help=('RPC timeout when doing handshake between device '
1053 'and presenter.'))
Vic Yang7d693c42014-09-14 09:52:39 +08001054 parser.add_option('--standalone', dest='standalone',
1055 action='store_true', default=False,
1056 help=('Assume the presenter is running on the same '
1057 'machines.'))
Hung-Te Lin8f6a3782015-01-06 22:58:32 +08001058 parser.add_option('--monolithic', dest='monolithic',
1059 action='store_true', default=False,
1060 help='Run in monolithic mode (without presenter)')
Jon Salz0697cbf2012-07-04 15:14:04 +08001061 (self.options, self.args) = parser.parse_args(args)
1062
Joel Kitching261e0422017-03-30 16:52:01 -07001063 signal.signal(signal.SIGINT, self.handle_signal)
1064 signal.signal(signal.SIGTERM, self.handle_signal)
Hung-Te Lina846f602014-07-04 20:32:22 +08001065 # TODO(hungte) SIGTERM does not work properly without Telemetry and should
1066 # be fixed.
Hung-Te Lina846f602014-07-04 20:32:22 +08001067
Jon Salz46b89562012-07-05 11:49:22 +08001068 # Make sure factory directories exist.
Joel Kitching625ff0f2016-05-16 14:59:40 -07001069 paths.GetLogRoot()
1070 paths.GetStateRoot()
1071 paths.GetTestDataRoot()
Jon Salz46b89562012-07-05 11:49:22 +08001072
Jon Salz0697cbf2012-07-04 15:14:04 +08001073 global _inited_logging # pylint: disable=W0603
1074 if not _inited_logging:
1075 factory.init_logging('goofy', verbose=self.options.verbose)
1076 _inited_logging = True
Jon Salz8fa8e832012-07-13 19:04:09 +08001077
Wei-Han Chen78f35f62017-03-06 20:11:20 +08001078 try:
1079 goofy_default_options = config_utils.LoadConfig(validate_schema=False)
1080 for key, value in goofy_default_options.iteritems():
1081 if getattr(self.options, key, None) is None:
1082 logging.info('self.options.%s = %r', key, value)
1083 setattr(self.options, key, value)
1084 except Exception:
1085 logging.exception('failed to load goofy overriding options')
1086
Jon Salz0f996602012-10-03 15:26:48 +08001087 if self.options.print_test_list:
Wei-Han Chen84fee7c2016-08-26 21:56:25 +08001088 test_list = test_lists.BuildTestList(self.options.print_test_list)
1089 print(test_list.__repr__(recursive=True))
Jon Salz0f996602012-10-03 15:26:48 +08001090 sys.exit(0)
1091
Jon Salzee85d522012-07-17 14:34:46 +08001092 event_log.IncrementBootSequence()
Chun-Ta Lin53cbbd52016-06-08 21:42:19 +08001093 testlog_goofy.IncrementInitCount()
1094
Jon Salzd15bbcf2013-05-21 17:33:57 +08001095 # Don't defer logging the initial event, so we can make sure
1096 # that device_id, reimage_id, etc. are all set up.
1097 self.event_log = EventLog('goofy', defer=False)
Chun-Ta Lin53cbbd52016-06-08 21:42:19 +08001098 self.testlog = testlog.Testlog(
Joel Kitchingfa847512017-03-31 02:26:14 +08001099 log_root=paths.GetLogRoot(), uuid=self.uuid,
1100 stationDeviceId=testlog_goofy.GetDeviceID(),
1101 stationInstallationId=testlog_goofy.GetInstallationID())
Jon Salz0697cbf2012-07-04 15:14:04 +08001102
Jon Salz0697cbf2012-07-04 15:14:04 +08001103 if env:
1104 self.env = env
Hung-Te Linf5f2d7f2016-01-08 17:12:46 +08001105 elif sys_utils.InChroot():
Jon Salz0697cbf2012-07-04 15:14:04 +08001106 self.env = test_environment.FakeChrootEnvironment()
Hung-Te Lina846f602014-07-04 20:32:22 +08001107 elif self.options.ui == 'chrome':
Ricky Liang09d66d82014-09-25 11:20:54 +08001108 self.env = test_environment.DUTEnvironment()
Jon Salz0697cbf2012-07-04 15:14:04 +08001109 self.env.goofy = self
Vic Yanga4931152014-08-11 16:36:24 -07001110 # web_socket_manager will be initialized later
1111 # pylint: disable=W0108
1112 self.env.has_sockets = lambda: self.web_socket_manager.has_sockets()
Jon Salz0697cbf2012-07-04 15:14:04 +08001113
1114 if self.options.restart:
1115 state.clear_state()
1116
Jon Salz0697cbf2012-07-04 15:14:04 +08001117 logging.info('Started')
1118
Hung-Te Lin8f6a3782015-01-06 22:58:32 +08001119 if not self.options.monolithic:
Hung-Te Lin7bd55312014-12-30 16:43:36 +08001120 self.link_manager = PresenterLinkManager(
1121 check_interval=1,
1122 handshake_timeout=self.options.handshake_timeout,
1123 standalone=self.options.standalone)
Peter Ammon1e1ec572014-06-26 17:56:32 -07001124
Earl Ouacbe99c2017-02-21 16:04:19 +08001125 self.start_goofy_server()
1126 self.init_state_instance()
Peter Shih80e78b42017-03-10 17:00:56 +08001127 self.init_i18n()
Jon Salz0697cbf2012-07-04 15:14:04 +08001128 self.state_instance.set_shared_data('hwid_cfg', get_hwid_cfg())
Jon Salz0697cbf2012-07-04 15:14:04 +08001129 self.last_shutdown_time = (
Ricky Liang45c73e72015-01-15 15:00:30 +08001130 self.state_instance.get_shared_data('shutdown_time', optional=True))
Jon Salz0697cbf2012-07-04 15:14:04 +08001131 self.state_instance.del_shared_data('shutdown_time', optional=True)
Jon Salzb19ea072013-02-07 16:35:00 +08001132 self.state_instance.del_shared_data('startup_error', optional=True)
Jon Salz0697cbf2012-07-04 15:14:04 +08001133
Ricky Liang6fe218c2013-12-27 15:17:17 +08001134 self.options.automation_mode = ParseAutomationMode(
1135 self.options.automation_mode)
1136 self.state_instance.set_shared_data('automation_mode',
1137 self.options.automation_mode)
1138 self.state_instance.set_shared_data(
1139 'automation_mode_prompt',
1140 AutomationModePrompt[self.options.automation_mode])
1141
Joel Kitching50a63ea2016-02-22 13:15:09 +08001142 success = False
1143 exc_info = None
Jon Salz128b0932013-07-03 16:55:26 +08001144 try:
Joel Kitching50a63ea2016-02-22 13:15:09 +08001145 success = self.InitTestLists()
Jon Salz128b0932013-07-03 16:55:26 +08001146 except: # pylint: disable=W0702
Joel Kitching50a63ea2016-02-22 13:15:09 +08001147 exc_info = sys.exc_info()
1148
1149 if not success:
1150 if exc_info:
1151 logging.exception('Unable to initialize test lists')
Chih-Yu Huang1725d622017-03-24 16:08:35 +08001152 self._RecordStartError(
1153 'Unable to initialize test lists\n%s' % traceback.format_exc())
Jon Salzb19ea072013-02-07 16:35:00 +08001154 if self.options.ui == 'chrome':
1155 # Create an empty test list with default options so that the rest of
1156 # startup can proceed.
1157 self.test_list = factory.FactoryTestList(
1158 [], self.state_instance, factory.Options())
1159 else:
1160 # Bail with an error; no point in starting up.
1161 sys.exit('No valid test list; exiting.')
1162
Shuo-Peng Liao268b40b2013-07-01 15:58:59 +08001163 self.init_hooks()
1164
Jon Salz822838b2013-03-25 17:32:33 +08001165 if self.test_list.options.clear_state_on_start:
1166 self.state_instance.clear_test_state()
1167
Jon Salz670ce062014-05-16 15:53:50 +08001168 # If the phase is invalid, this will raise a ValueError.
1169 phase.SetPersistentPhase(self.test_list.options.phase)
1170
Dean Liao85ca86f2014-11-03 12:28:08 +08001171 # For netboot firmware, mainfw_type should be 'netboot'.
Hung-Te Line594e5d2015-12-16 02:36:05 +08001172 if (self.dut.info.mainfw_type != 'nonchrome' and
1173 self.dut.info.firmware_version is None):
Chih-Yu Huang1725d622017-03-24 16:08:35 +08001174 self._RecordStartError(
Vic Yang9bd4f772013-06-04 17:34:00 +08001175 'Netboot firmware detected\n'
1176 'Connect Ethernet and reboot to re-image.\n'
1177 u'侦测到网路开机固件\n'
1178 u'请连接乙太网并重启')
1179
Peter Shih3b0bb9f2017-03-21 16:23:32 +08001180 if not self.state_instance.has_shared_data('ui_locale'):
1181 if self.test_list.options.ui_lang is not None:
1182 # For backward compatibility
1183 ui_locale = ('en-US'
1184 if self.test_list.options.ui_lang == 'en' else 'zh-CN')
1185 else:
1186 ui_locale = self.test_list.options.ui_locale
1187 self.state_instance.set_shared_data('ui_locale', ui_locale)
Jon Salz0697cbf2012-07-04 15:14:04 +08001188 self.state_instance.set_shared_data(
Ricky Liang45c73e72015-01-15 15:00:30 +08001189 'test_list_options',
1190 self.test_list.options.__dict__)
Jon Salz0697cbf2012-07-04 15:14:04 +08001191 self.state_instance.test_list = self.test_list
1192
Cheng-Yi Chiang39d32ad2013-07-23 15:02:38 +08001193 self.check_log_rotation()
Jon Salz83ef34b2012-11-01 19:46:35 +08001194
Jon Salz23926422012-09-01 03:38:13 +08001195 if self.options.dummy_shopfloor:
Ricky Liang45c73e72015-01-15 15:00:30 +08001196 os.environ[shopfloor.SHOPFLOOR_SERVER_ENV_VAR_NAME] = (
1197 'http://%s:%d/' %
Joel Kitchingb85ed7f2014-10-08 18:24:39 +08001198 (net_utils.LOCALHOST, shopfloor.DEFAULT_SERVER_PORT))
Hung-Te Lin4e6357c2016-01-08 14:32:00 +08001199 self.dummy_shopfloor = process_utils.Spawn(
Wei-Han Chen2ebb92d2016-01-12 14:51:41 +08001200 [os.path.join(paths.FACTORY_PATH, 'bin', 'shopfloor_server'),
Jon Salz23926422012-09-01 03:38:13 +08001201 '--dummy'])
1202 elif self.test_list.options.shopfloor_server_url:
1203 shopfloor.set_server_url(self.test_list.options.shopfloor_server_url)
Jon Salz2bf2f6b2013-03-28 18:49:26 +08001204 shopfloor.set_enabled(True)
Jon Salz23926422012-09-01 03:38:13 +08001205
Jon Salz0697cbf2012-07-04 15:14:04 +08001206 self.init_states()
1207 self.start_event_server()
Wei-Ning Huang38b75f02015-02-25 18:25:14 +08001208 self.start_terminal_server()
Hung-Te Lincc41d2a2014-10-29 13:35:20 +08001209
Earl Oua3bca122016-10-21 16:00:30 +08001210 # Load and run Goofy plugins.
1211 self.plugin_controller = plugin_controller.PluginController(
1212 self.test_list.options.plugin_config_name, self)
1213 self.plugin_controller.StartAllPlugins()
Earl Ou5b619cc2017-03-30 15:20:13 +08001214 self.plugin_controller.RegisterRPC(self.goofy_server)
Earl Oua3bca122016-10-21 16:00:30 +08001215
Chih-Yu Huang97103ae2017-03-20 18:22:54 +08001216 # TODO(akahuang): Move this part into a pytest.
1217 # Prepare DUT link after the plugins start running, because the link might
1218 # need the network connection.
1219 if success:
1220 try:
1221 if self.test_list.options.dut_options:
1222 logging.info('dut_options set by %s: %r', self.test_list.test_list_id,
1223 self.test_list.options.dut_options)
1224 device_utils.PrepareDUTLink(**self.test_list.options.dut_options)
1225 except Exception:
1226 logging.exception('Unable to prepare DUT link.')
Chih-Yu Huang1725d622017-03-24 16:08:35 +08001227 self._RecordStartError(
Chih-Yu Huang97103ae2017-03-20 18:22:54 +08001228 'Unable to prepare DUT link.\n%s' % traceback.format_exc())
1229
Joel Kitchingd28fbda2016-11-25 16:58:26 +08001230 # Set reference to the Instalog plugin.
1231 self.testlog.SetInstalogPlugin(
1232 self.plugin_controller.GetPluginInstance('instalog'))
1233
Jon Salz0697cbf2012-07-04 15:14:04 +08001234 # Note that we create a log watcher even if
1235 # sync_event_log_period_secs isn't set (no background
1236 # syncing), since we may use it to flush event logs as well.
1237 self.log_watcher = EventLogWatcher(
Ricky Liang45c73e72015-01-15 15:00:30 +08001238 self.test_list.options.sync_event_log_period_secs,
1239 event_log_db_file=None,
1240 handle_event_logs_callback=self.handle_event_logs)
Jon Salz0697cbf2012-07-04 15:14:04 +08001241 if self.test_list.options.sync_event_log_period_secs:
1242 self.log_watcher.StartWatchThread()
1243
1244 self.update_system_info()
1245
1246 os.environ['CROS_FACTORY'] = '1'
1247 os.environ['CROS_DISABLE_SITE_SYSINFO'] = '1'
1248
Jon Salze12c2b32013-06-25 16:24:34 +08001249 self.find_kcrashes()
1250
Shuo-Peng Liao268b40b2013-07-01 15:58:59 +08001251 # Should not move earlier.
1252 self.hooks.OnStartup()
1253
Ricky Liang36512a32014-07-25 11:47:04 +08001254 # Only after this point the Goofy backend is ready for UI connection.
1255 self.ready_for_ui_connection = True
1256
Jon Salz0697cbf2012-07-04 15:14:04 +08001257 def state_change_callback(test, test_state):
1258 self.event_client.post_event(
Ricky Liang4bff3e32014-02-20 18:46:11 +08001259 Event(Event.Type.STATE_CHANGE, path=test.path, state=test_state))
Jon Salz0697cbf2012-07-04 15:14:04 +08001260 self.test_list.state_change_callback = state_change_callback
Jon Salz73e0fd02012-04-04 11:46:38 +08001261
Vic Yange2c76a82014-10-30 12:48:19 -07001262 self.pytest_prespawner = prespawner.PytestPrespawner()
1263 self.pytest_prespawner.start()
Jon Salza6711d72012-07-18 14:33:03 +08001264
Ricky Liang48e47f92014-02-26 19:31:51 +08001265 tests_after_shutdown = self.state_instance.get_shared_data(
Wei-Han Chenc17b4112016-11-22 14:56:51 +08001266 TESTS_AFTER_SHUTDOWN, optional=True)
Jon Salz5c344f62012-07-13 14:31:16 +08001267 force_auto_run = (tests_after_shutdown == FORCE_AUTO_RUN)
Wei-Han Chenc17b4112016-11-22 14:56:51 +08001268
Jon Salz5c344f62012-07-13 14:31:16 +08001269 if not force_auto_run and tests_after_shutdown is not None:
Wei-Han Chenc17b4112016-11-22 14:56:51 +08001270 logging.info('Resuming tests after shutdown: %r', tests_after_shutdown)
1271 self.test_list_iterator = tests_after_shutdown
1272 self.test_list_iterator.set_test_list(self.test_list)
Peter Ammon1e1ec572014-06-26 17:56:32 -07001273 self.run_enqueue(self.run_next_test)
Wei-Han Chenc17b4112016-11-22 14:56:51 +08001274 elif force_auto_run or self.test_list.options.auto_run_on_start:
1275 # If automation mode is enabled, allow suppress auto_run_on_start.
1276 if (self.options.automation_mode == 'NONE' or
1277 self.options.auto_run_on_start):
1278 status_filter = [TestState.UNTESTED]
1279 if self.test_list.options.retry_failed_on_start:
1280 status_filter.append(TestState.FAILED)
1281 self.run_enqueue(lambda: self.run_tests(self.test_list, status_filter))
1282 self.state_instance.set_shared_data(TESTS_AFTER_SHUTDOWN, None)
Ricky Liang4bff3e32014-02-20 18:46:11 +08001283 self.restore_active_run_state()
Hung-Te Linf2f78f72012-02-08 19:27:11 +08001284
Hung-Te Lin410f70a2015-12-15 14:53:42 +08001285 self.dut.hooks.OnTestStart()
Vic Yang08505c72015-01-06 17:01:53 -08001286
Dean Liao592e4d52013-01-10 20:06:39 +08001287 self.may_disable_cros_shortcut_keys()
1288
1289 def may_disable_cros_shortcut_keys(self):
1290 test_options = self.test_list.options
1291 if test_options.disable_cros_shortcut_keys:
1292 logging.info('Filter ChromeOS shortcut keys.')
1293 self.key_filter = KeyFilter(
1294 unmap_caps_lock=test_options.disable_caps_lock,
1295 caps_lock_keycode=test_options.caps_lock_keycode)
1296 self.key_filter.Start()
1297
Cheng-Yi Chiang39d32ad2013-07-23 15:02:38 +08001298 def check_log_rotation(self):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001299 """Checks log rotation file presence/absence according to test_list option.
Cheng-Yi Chiang39d32ad2013-07-23 15:02:38 +08001300
1301 Touch /var/lib/cleanup_logs_paused if test_list.options.disable_log_rotation
Yilun Linb10e8cf2017-03-20 15:16:11 +08001302 is True, delete it otherwise.
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001303 """
Hung-Te Linf5f2d7f2016-01-08 17:12:46 +08001304 if sys_utils.InChroot():
Cheng-Yi Chiang39d32ad2013-07-23 15:02:38 +08001305 return
1306 try:
1307 if self.test_list.options.disable_log_rotation:
1308 open(CLEANUP_LOGS_PAUSED, 'w').close()
1309 else:
1310 file_utils.TryUnlink(CLEANUP_LOGS_PAUSED)
1311 except: # pylint: disable=W0702
1312 # Oh well. Logs an error (but no trace)
1313 logging.info(
1314 'Unable to %s %s: %s',
1315 'touch' if self.test_list.options.disable_log_rotation else 'delete',
Hung-Te Linf707b242016-01-08 23:11:42 +08001316 CLEANUP_LOGS_PAUSED, debug_utils.FormatExceptionOnly())
Cheng-Yi Chiang39d32ad2013-07-23 15:02:38 +08001317
Peter Ammon1e1ec572014-06-26 17:56:32 -07001318 def perform_periodic_tasks(self):
1319 """Override of base method to perform periodic work.
Vic Yang4953fc12012-07-26 16:19:53 +08001320
Peter Ammon1e1ec572014-06-26 17:56:32 -07001321 This method must not raise exceptions.
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001322 """
Peter Ammon1e1ec572014-06-26 17:56:32 -07001323 super(Goofy, self).perform_periodic_tasks()
Jon Salzb22d1172012-08-06 10:38:57 +08001324
Earl Oua3bca122016-10-21 16:00:30 +08001325 self.check_plugins()
cychiang21886742012-07-05 15:16:32 +08001326 self.check_for_updates()
Cheng-Yi Chiang39d32ad2013-07-23 15:02:38 +08001327 self.check_log_rotation()
Jon Salz57717ca2012-04-04 16:47:25 +08001328
Cheng-Yi Chiangf5b21012015-03-17 15:37:14 +08001329 def handle_event_logs(self, chunks, periodic=False):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001330 """Callback for event watcher.
Jon Salz258a40c2012-04-19 12:34:01 +08001331
Jon Salz0697cbf2012-07-04 15:14:04 +08001332 Attempts to upload the event logs to the shopfloor server.
Vic Yang93027612013-05-06 02:42:49 +08001333
1334 Args:
Jon Salzd15bbcf2013-05-21 17:33:57 +08001335 chunks: A list of Chunk objects.
Cheng-Yi Chiangf5b21012015-03-17 15:37:14 +08001336 periodic: This event log handling is periodic. Error messages
1337 will only be shown for the first time.
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001338 """
Vic Yang93027612013-05-06 02:42:49 +08001339 first_exception = None
1340 exception_count = 0
Cheng-Yi Chiangf5b21012015-03-17 15:37:14 +08001341 # Suppress error messages for periodic event syncing except for the
1342 # first time. If event syncing is not periodic, always show the error
1343 # messages.
1344 quiet = self._suppress_event_log_error_messages if periodic else False
Vic Yang93027612013-05-06 02:42:49 +08001345
Jon Salzd15bbcf2013-05-21 17:33:57 +08001346 for chunk in chunks:
Vic Yang93027612013-05-06 02:42:49 +08001347 try:
Jon Salzcddb6402013-05-23 12:56:42 +08001348 description = 'event logs (%s)' % str(chunk)
Vic Yang93027612013-05-06 02:42:49 +08001349 start_time = time.time()
1350 shopfloor_client = shopfloor.get_instance(
Ricky Liang45c73e72015-01-15 15:00:30 +08001351 detect=True,
Cheng-Yi Chiangf5b21012015-03-17 15:37:14 +08001352 timeout=self.test_list.options.shopfloor_timeout_secs,
1353 quiet=quiet)
Ricky Liang45c73e72015-01-15 15:00:30 +08001354 shopfloor_client.UploadEvent(chunk.log_name + '.' +
Jon Salzd15bbcf2013-05-21 17:33:57 +08001355 event_log.GetReimageId(),
1356 Binary(chunk.chunk))
Vic Yang93027612013-05-06 02:42:49 +08001357 logging.info(
Ricky Liang45c73e72015-01-15 15:00:30 +08001358 'Successfully synced %s in %.03f s',
1359 description, time.time() - start_time)
1360 except: # pylint: disable=W0702
Hung-Te Linf707b242016-01-08 23:11:42 +08001361 first_exception = (first_exception or
1362 (chunk.log_name + ': ' +
1363 debug_utils.FormatExceptionOnly()))
Vic Yang93027612013-05-06 02:42:49 +08001364 exception_count += 1
1365
1366 if exception_count:
1367 if exception_count == 1:
1368 msg = 'Log upload failed: %s' % first_exception
1369 else:
1370 msg = '%d log upload failed; first is: %s' % (
1371 exception_count, first_exception)
Cheng-Yi Chiangf5b21012015-03-17 15:37:14 +08001372 # For periodic event log syncing, only show the first error messages.
1373 if periodic:
1374 if not self._suppress_event_log_error_messages:
1375 self._suppress_event_log_error_messages = True
1376 logging.warning('Suppress periodic shopfloor error messages for '
1377 'event log syncing after the first one.')
1378 raise Exception(msg)
1379 # For event log syncing by request, show the error messages.
1380 else:
1381 raise Exception(msg)
Vic Yang93027612013-05-06 02:42:49 +08001382
Wei-Han Chenc17b4112016-11-22 14:56:51 +08001383 def run_tests_with_status(self, statuses_to_run, root=None):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001384 """Runs all top-level tests with a particular status.
Jon Salz0405ab52012-03-16 15:26:52 +08001385
Jon Salz0697cbf2012-07-04 15:14:04 +08001386 All active tests, plus any tests to re-run, are reset.
Jon Salz57717ca2012-04-04 16:47:25 +08001387
Jon Salz0697cbf2012-07-04 15:14:04 +08001388 Args:
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001389 statuses_to_run: The particular status that caller wants to run.
Jon Salz0697cbf2012-07-04 15:14:04 +08001390 starting_at: If provided, only auto-runs tests beginning with
1391 this test.
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001392 root: The root of tests to run. If not provided, it will be
1393 the root of all tests.
1394 """
Jon Salz0697cbf2012-07-04 15:14:04 +08001395 root = root or self.test_list
Jon Salz6dc031d2013-06-19 13:06:23 +08001396 self.abort_active_tests('Operator requested run/re-run of certain tests')
Wei-Han Chenc17b4112016-11-22 14:56:51 +08001397 self.run_tests(root, status_filter=statuses_to_run)
Jon Salz0405ab52012-03-16 15:26:52 +08001398
Jon Salz0697cbf2012-07-04 15:14:04 +08001399 def restart_tests(self, root=None):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001400 """Restarts all tests."""
Jon Salz0697cbf2012-07-04 15:14:04 +08001401 root = root or self.test_list
Jon Salz0405ab52012-03-16 15:26:52 +08001402
Jon Salz6dc031d2013-06-19 13:06:23 +08001403 self.abort_active_tests('Operator requested restart of certain tests')
Wei-Han Chen3ae204c2017-04-28 19:36:55 +08001404 for test in root.Walk():
1405 test.UpdateState(status=TestState.UNTESTED)
Jon Salz0697cbf2012-07-04 15:14:04 +08001406 self.run_tests(root)
Hung-Te Lin96632362012-03-20 21:14:18 +08001407
Wei-Han Chenc17b4112016-11-22 14:56:51 +08001408 def auto_run(self, root=None):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001409 """"Auto-runs" tests that have not been run yet.
Hung-Te Lin96632362012-03-20 21:14:18 +08001410
Jon Salz0697cbf2012-07-04 15:14:04 +08001411 Args:
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001412 root: If provided, the root of tests to run. If not provided, the root
1413 will be test_list (root of all tests).
1414 """
Jon Salz0697cbf2012-07-04 15:14:04 +08001415 root = root or self.test_list
1416 self.run_tests_with_status([TestState.UNTESTED, TestState.ACTIVE],
Ricky Liang45c73e72015-01-15 15:00:30 +08001417 root=root)
Jon Salz968e90b2012-03-18 16:12:43 +08001418
Jon Salz0697cbf2012-07-04 15:14:04 +08001419 def handle_switch_test(self, event):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001420 """Switches to a particular test.
Jon Salz0405ab52012-03-16 15:26:52 +08001421
Ricky Liang6fe218c2013-12-27 15:17:17 +08001422 Args:
1423 event: The SWITCH_TEST event.
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001424 """
Wei-Han Chen3ae204c2017-04-28 19:36:55 +08001425 test = self.test_list.LookupPath(event.path)
Jon Salz0697cbf2012-07-04 15:14:04 +08001426 if not test:
1427 logging.error('Unknown test %r', event.key)
1428 return
Jon Salz73e0fd02012-04-04 11:46:38 +08001429
Jon Salz0697cbf2012-07-04 15:14:04 +08001430 invoc = self.invocations.get(test)
Wei-Han Chenc17b4112016-11-22 14:56:51 +08001431 if invoc:
Jon Salz0697cbf2012-07-04 15:14:04 +08001432 # Already running: just bring to the front if it
1433 # has a UI.
1434 logging.info('Setting visible test to %s', test.path)
Jon Salz36fbbb52012-07-05 13:45:06 +08001435 self.set_visible_test(test)
Jon Salz0697cbf2012-07-04 15:14:04 +08001436 return
Jon Salz73e0fd02012-04-04 11:46:38 +08001437
Jon Salz6dc031d2013-06-19 13:06:23 +08001438 self.abort_active_tests('Operator requested abort (switch_test)')
Wei-Han Chen3ae204c2017-04-28 19:36:55 +08001439 for t in test.Walk():
1440 t.UpdateState(status=TestState.UNTESTED)
Jon Salz73e0fd02012-04-04 11:46:38 +08001441
Wei-Han Chenc17b4112016-11-22 14:56:51 +08001442 self.run_tests(test)
Jon Salz73e0fd02012-04-04 11:46:38 +08001443
Wei-Ning Huang38b75f02015-02-25 18:25:14 +08001444 def handle_key_filter_mode(self, event):
1445 if self.key_filter:
1446 if getattr(event, 'enabled'):
1447 self.key_filter.Start()
1448 else:
1449 self.key_filter.Stop()
1450
Jon Salz0697cbf2012-07-04 15:14:04 +08001451 def wait(self):
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001452 """Waits for all pending invocations.
Jon Salz0697cbf2012-07-04 15:14:04 +08001453
1454 Useful for testing.
Cheng-Yi Chiang1e3e2692013-12-24 18:02:36 +08001455 """
Jon Salz1acc8742012-07-17 17:45:55 +08001456 while self.invocations:
1457 for k, v in self.invocations.iteritems():
1458 logging.info('Waiting for %s to complete...', k)
1459 v.thread.join()
1460 self.reap_completed_tests()
Jon Salz0697cbf2012-07-04 15:14:04 +08001461
Claire Changd1961a22015-08-05 16:15:55 +08001462 def test_fail(self, test):
Hung-Te Lin410f70a2015-12-15 14:53:42 +08001463 self.dut.hooks.OnTestFailure(test)
Claire Changd1961a22015-08-05 16:15:55 +08001464 if self.link_manager:
1465 self.link_manager.UpdateStatus(False)
1466
Wei-Han Chenced08ef2016-11-08 09:40:02 +08001467
Hung-Te Linf2f78f72012-02-08 19:27:11 +08001468if __name__ == '__main__':
Peter Ammona3d298c2014-09-23 10:11:02 -07001469 Goofy.run_main_and_exit()