blob: 87e71e165b05b15a1cdb09bae048f290ad91e4b2 [file] [log] [blame]
Dennis Jeffreydffc0bd2013-05-03 13:24:31 -07001# Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
2# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
Achuith Bhandarkara2bceaf2014-11-14 12:10:16 -08005import logging, os
Achuith Bhandarkara2df47b2013-10-09 21:23:15 -07006
Don Garrett11b13972015-09-11 17:37:53 +00007from autotest_lib.client.cros import constants
Achuith Bhandarkar88a2bab2015-07-09 17:36:25 -07008from autotest_lib.client.bin import utils
Prathmesh Prabhuc3961df2015-07-21 10:44:54 -07009from telemetry.core import cros_interface, exceptions, util
Achuith Bhandarkarb058a8f2015-07-02 01:29:05 -070010from telemetry.internal.browser import browser_finder, browser_options
11from telemetry.internal.browser import extension_to_load
Achuith Bhandarkar704134d2015-03-05 17:31:57 -080012
13Error = exceptions.Error
Dennis Jeffreydffc0bd2013-05-03 13:24:31 -070014
15
Achuith Bhandarkared498932013-07-16 17:01:40 -070016class Chrome(object):
17 """Wrapper for creating a telemetry browser instance with extensions."""
Achuith Bhandarkar86c46812013-07-15 17:13:39 -070018
19
Chung-yih Wang8988eb22016-03-16 16:16:10 +080020 CHEETS = '-cheets'
Achuith Bhandarkared498932013-07-16 17:01:40 -070021 BROWSER_TYPE_LOGIN = 'system'
22 BROWSER_TYPE_GUEST = 'system-guest'
Achuith Bhandarkar86c46812013-07-15 17:13:39 -070023
24
Achuith Bhandarkarb0e99072013-11-18 16:15:03 -080025 def __init__(self, logged_in=True, extension_paths=[], autotest_ext=False,
Achuith Bhandarkarb7ef5e52014-03-20 14:18:45 -070026 is_component=True, num_tries=3, extra_browser_args=None,
Achuith Bhandarkar882a8ab2014-08-26 15:51:20 -070027 clear_enterprise_policy=True, dont_override_profile=False,
Achuith Bhandarkara2bceaf2014-11-14 12:10:16 -080028 disable_gaia_services=True, disable_default_apps = True,
29 auto_login=True, gaia_login=False,
Alexander Alekseevd9682862015-10-01 22:42:49 -070030 username=None, password=None, gaia_id=None):
Dean Liaob12e2ee2013-11-19 16:49:12 +080031 """
Achuith Bhandarkar944405a2013-11-21 14:47:48 -080032 Constructor of telemetry wrapper.
33
34 @param logged_in: Regular user (True) or guest user (False).
35 @param extension_paths: path of unpacked extension to install.
36 @param autotest_ext: Load a component extension with privileges to
37 invoke chrome.autotestPrivate.
38 @param is_component: Whether extensions should be loaded as component
39 extensions.
Achuith Bhandarkarb7ef5e52014-03-20 14:18:45 -070040 @param num_tries: Number of attempts to log in.
Dean Liaob12e2ee2013-11-19 16:49:12 +080041 @param extra_browser_args: Additional argument(s) to pass to the
Achuith Bhandarkar3875e0c2014-03-20 14:17:31 -070042 browser. It can be a string or a list.
Achuith Bhandarkar5d6c26c2014-04-25 11:19:38 -070043 @param clear_enterprise_policy: Clear enterprise policy before
44 logging in.
Achuith Bhandarkar882a8ab2014-08-26 15:51:20 -070045 @param dont_override_profile: Don't delete cryptohome before login.
46 Telemetry will output a warning with this
47 option.
Achuith Bhandarkar3c654f32014-09-29 06:33:35 -070048 @param disable_gaia_services: For enterprise autotests, this option may
49 be used to enable policy fetch.
Achuith Bhandarkara2bceaf2014-11-14 12:10:16 -080050 @param disable_default_apps: For tests that exercise default apps.
Achuith Bhandarkar1cce9dc2014-02-05 14:23:34 -080051 @param auto_login: Does not login automatically if this is False.
Achuith Bhandarkar3875e0c2014-03-20 14:17:31 -070052 Useful if you need to examine oobe.
53 @param gaia_login: Logs in to real gaia.
Achuith Bhandarkar1cce9dc2014-02-05 14:23:34 -080054 @param username: Log in using this username instead of the default.
Alexander Alekseevd9682862015-10-01 22:42:49 -070055 @param password: Log in using this password instead of the default.
56 @param gaia_id: Log in using this gaia_id instead of the default.
Dean Liaob12e2ee2013-11-19 16:49:12 +080057 """
Achuith Bhandarkara2df47b2013-10-09 21:23:15 -070058 self._autotest_ext_path = None
59 if autotest_ext:
60 self._autotest_ext_path = os.path.join(os.path.dirname(__file__),
61 'autotest_private_ext')
62 extension_paths.append(self._autotest_ext_path)
63
Achuith Bhandarkar7fb57f72013-08-29 15:29:06 -070064 finder_options = browser_options.BrowserFinderOptions()
Chung-yih Wang8988eb22016-03-16 16:16:10 +080065 # Append cheets specific browser args
66 is_cheets_platform = utils.get_current_board().endswith(self.CHEETS)
67 if is_cheets_platform:
68 from autotest_lib.client.common_lib.cros import cheets
69 extra_browser_args = cheets.append_extra_args(extra_browser_args)
70 logged_in = True
Achuith Bhandarkared498932013-07-16 17:01:40 -070071 self._browser_type = (self.BROWSER_TYPE_LOGIN
72 if logged_in else self.BROWSER_TYPE_GUEST)
Achuith Bhandarkarf130c402013-09-11 14:39:22 -070073 finder_options.browser_type = self.browser_type
Dean Liaob12e2ee2013-11-19 16:49:12 +080074 if extra_browser_args:
75 finder_options.browser_options.AppendExtraBrowserArgs(
76 extra_browser_args)
Achuith Bhandarkarf130c402013-09-11 14:39:22 -070077
Achuith Bhandarkared498932013-07-16 17:01:40 -070078 if logged_in:
Achuith Bhandarkara2df47b2013-10-09 21:23:15 -070079 extensions_to_load = finder_options.extensions_to_load
Achuith Bhandarkared498932013-07-16 17:01:40 -070080 for path in extension_paths:
81 extension = extension_to_load.ExtensionToLoad(
Achuith Bhandarkar944405a2013-11-21 14:47:48 -080082 path, self.browser_type, is_component=is_component)
Achuith Bhandarkara2df47b2013-10-09 21:23:15 -070083 extensions_to_load.append(extension)
84 self._extensions_to_load = extensions_to_load
Achuith Bhandarkared498932013-07-16 17:01:40 -070085
Achuith Bhandarkar3e5051d2013-10-15 15:20:12 -070086 # finder options must be set before parse_args(), browser options must
87 # be set before Create().
Todd Brocheb6f4812014-04-29 16:04:28 -070088 # TODO(crbug.com/360890) Below MUST be '2' so that it doesn't inhibit
89 # autotest debug logs
90 finder_options.verbosity = 2
Achuith Bhandarkardafc9a52013-09-24 15:26:33 +020091 finder_options.CreateParser().parse_args(args=[])
Achuith Bhandarkara2df47b2013-10-09 21:23:15 -070092 b_options = finder_options.browser_options
93 b_options.disable_component_extensions_with_background_pages = False
94 b_options.create_browser_with_oobe = True
Achuith Bhandarkar5d6c26c2014-04-25 11:19:38 -070095 b_options.clear_enterprise_policy = clear_enterprise_policy
Achuith Bhandarkar882a8ab2014-08-26 15:51:20 -070096 b_options.dont_override_profile = dont_override_profile
Achuith Bhandarkar3c654f32014-09-29 06:33:35 -070097 b_options.disable_gaia_services = disable_gaia_services
Achuith Bhandarkara2bceaf2014-11-14 12:10:16 -080098 b_options.disable_default_apps = disable_default_apps
99 b_options.disable_component_extensions_with_background_pages = disable_default_apps
Achuith Bhandarkar1cce9dc2014-02-05 14:23:34 -0800100
101 b_options.auto_login = auto_login
Achuith Bhandarkar3875e0c2014-03-20 14:17:31 -0700102 b_options.gaia_login = gaia_login
Achuith Bhandarkar1cce9dc2014-02-05 14:23:34 -0800103 self.username = b_options.username if username is None else username
104 self.password = b_options.password if password is None else password
105 b_options.username = self.username
106 b_options.password = self.password
Alexander Alekseevd9682862015-10-01 22:42:49 -0700107 # gaia_id will be added to telemetry code in chromium repository later
108 try:
109 self.gaia_id = b_options.gaia_id if gaia_id is None else gaia_id
110 b_options.gaia_id = self.gaia_id
111 except AttributeError:
112 pass
Achuith Bhandarkara2df47b2013-10-09 21:23:15 -0700113
David James54a830e2015-05-06 17:21:47 -0700114 # Turn on collection of Chrome coredumps via creation of a magic file.
115 # (Without this, Chrome coredumps are trashed.)
Don Garrett11b13972015-09-11 17:37:53 +0000116 open(constants.CHROME_CORE_MAGIC_FILE, 'w').close()
David James54a830e2015-05-06 17:21:47 -0700117
Achuith Bhandarkarb0e99072013-11-18 16:15:03 -0800118 for i in range(num_tries):
119 try:
120 browser_to_create = browser_finder.FindBrowser(finder_options)
Achuith Bhandarkara2bceaf2014-11-14 12:10:16 -0800121 self._browser = browser_to_create.Create(finder_options)
Chung-yih Wang8988eb22016-03-16 16:16:10 +0800122 if is_cheets_platform:
123 cheets.post_processing_after_browser()
Achuith Bhandarkarb0e99072013-11-18 16:15:03 -0800124 break
Achuith Bhandarkarfab82d12015-02-26 11:05:35 -0800125 except (exceptions.LoginException) as e:
Achuith Bhandarkarf800edf2013-12-06 13:37:52 -0800126 logging.error('Timed out logging in, tries=%d, error=%s',
127 i, repr(e))
Achuith Bhandarkarb0e99072013-11-18 16:15:03 -0800128 if i == num_tries-1:
129 raise
Achuith Bhandarkared498932013-07-16 17:01:40 -0700130
131
132 def __enter__(self):
133 return self
134
135
136 def __exit__(self, *args):
Derek Basehore41acbf82014-07-11 18:34:30 -0700137 self.close()
Achuith Bhandarkared498932013-07-16 17:01:40 -0700138
139
140 @property
141 def browser(self):
142 """Returns a telemetry browser instance."""
143 return self._browser
144
145
146 def get_extension(self, extension_path):
147 """Fetches a telemetry extension instance given the extension path."""
148 for ext in self._extensions_to_load:
149 if extension_path == ext.path:
150 return self.browser.extensions[ext]
151 return None
152
153
154 @property
Achuith Bhandarkara2df47b2013-10-09 21:23:15 -0700155 def autotest_ext(self):
156 """Returns the autotest extension."""
157 return self.get_extension(self._autotest_ext_path)
158
159
160 @property
161 def login_status(self):
162 """Returns login status."""
163 ext = self.autotest_ext
164 if not ext:
165 return None
166
167 ext.ExecuteJavaScript('''
168 window.__login_status = null;
169 chrome.autotestPrivate.loginStatus(function(s) {
170 window.__login_status = s;
171 });
172 ''')
173 return ext.EvaluateJavaScript('window.__login_status')
174
175
176 @property
Achuith Bhandarkared498932013-07-16 17:01:40 -0700177 def browser_type(self):
178 """Returns the browser_type."""
179 return self._browser_type
Achuith Bhandarkar49c72d92013-07-25 11:10:10 -0700180
181
Achuith Bhandarkar16ee9772015-01-23 17:18:18 -0800182 @staticmethod
183 def did_browser_crash(func):
Achuith Bhandarkar7fb57f72013-08-29 15:29:06 -0700184 """Runs func, returns True if the browser crashed, False otherwise.
185
186 @param func: function to run.
187
188 """
Achuith Bhandarkar5abf60b2013-08-01 12:35:53 -0700189 try:
190 func()
Achuith Bhandarkar704134d2015-03-05 17:31:57 -0800191 except (Error):
Achuith Bhandarkar5abf60b2013-08-01 12:35:53 -0700192 return True
193 return False
Derek Basehore41acbf82014-07-11 18:34:30 -0700194
195
Achuith Bhandarkar88a2bab2015-07-09 17:36:25 -0700196 @staticmethod
197 def wait_for_browser_restart(func):
198 """Runs func, and waits for a browser restart.
199
200 @param func: function to run.
201
202 """
203 _cri = cros_interface.CrOSInterface()
204 pid = _cri.GetChromePid()
205 Chrome.did_browser_crash(func)
206 utils.poll_for_condition(lambda: pid != _cri.GetChromePid(), timeout=60)
207
208
Achuith Bhandarkar16ee9772015-01-23 17:18:18 -0800209 def wait_for_browser_to_come_up(self):
210 """Waits for the browser to come up. This should only be called after a
211 browser crash.
212 """
213 def _BrowserReady(cr):
214 tabs = [] # Wrapper for pass by reference.
215 if self.did_browser_crash(
216 lambda: tabs.append(cr.browser.tabs.New())):
217 return False
218 try:
219 tabs[0].Close()
Achuith Bhandarkarfab82d12015-02-26 11:05:35 -0800220 except:
Achuith Bhandarkar16ee9772015-01-23 17:18:18 -0800221 # crbug.com/350941
222 logging.error('Timed out closing tab')
223 return True
224 util.WaitFor(lambda: _BrowserReady(self), timeout=10)
225
226
Derek Basehore41acbf82014-07-11 18:34:30 -0700227 def close(self):
228 """Closes the browser."""
229 self._browser.Close()