forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
browsers.py
193 lines (153 loc) · 5.75 KB
/
browsers.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# Copyright 2021 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
import abc
import logging
import os
import plistlib
import subprocess
import time
import typing
import utils
class BrowserDriver(abc.ABC):
"""Abstract Base Class encapsulating browser setup and tear down.
"""
def __init__(self, browser_name: str, process_name: str):
self.name = browser_name
self.process_name = process_name
self.browser_process = None
# LaunchServices can get confused when an application is launched from
# more than one location and break AppleScript commands. Always launch
# browsers from /Applications to avoid such problems.
self.executable_path = (os.path.join("/Applications",
f"{self.process_name}.app"))
if not os.path.exists(self.executable_path):
raise ValueError(f"Application doesn't exist for {browser_name}.")
@abc.abstractmethod
def Launch(self):
"""Starts the browser and ensures it is started before returning.
"""
pass
def TearDown(self):
"""Terminates the browser and ensures it's cleaned up before returning.
"""
logging.debug(f"Tearing down {self.process_name}")
if self.browser_process:
utils.TerminateProcess(self.browser_process)
def GetApplicationInfo(self) -> typing.Dict:
""" Returns the Info.plist data in the application folder. """
plist_path = os.path.join(self.executable_path, "Contents", "Info.plist")
with open(plist_path, 'rb') as plist_file:
return plistlib.load(plist_file)
def Summary(self):
"""Returns a dictionary describing the browser.
"""
info = self.GetApplicationInfo()
return {
'name': self.name,
'version': info['CFBundleShortVersionString'],
'identifier': info['CFBundleIdentifier']
}
def _EnsureStarted(self):
"""Waits until a browser with the given `process_name` is running.
"""
while not self.browser_process:
self.browser_process = utils.FindProcess(self.process_name)
time.sleep(0.100)
logging.debug(f"Waiting for {self.process_name} to start")
logging.debug(f"{self.process_name} started")
class SafariDriver(BrowserDriver):
def __init__(self, extra_args=[]):
super().__init__("safari", "Safari")
self.extra_args = extra_args
def Launch(self):
subprocess.call(["open", "-a", "Safari"])
# Call prep_safari.scpt to make sure the run starts clean. See file
# comment for details.
subprocess.call([
"osascript",
os.path.join(os.path.dirname(__file__), "driver_scripts_templates",
"prep_safari.scpt")
])
subprocess.call(["open", "-a", "Safari", "--args"] + self.extra_args)
self._EnsureStarted()
class ChromiumDriver(BrowserDriver):
def __init__(self,
browser_name: str,
variation: str,
process_name: str,
extra_args=[]):
if variation != "":
browser_name += f"_{variation}"
super().__init__(browser_name, process_name)
self.extra_args = extra_args
def Launch(self):
open_args = ["-a", self.process_name]
subprocess.call(["open"] + open_args + ["--args"] +
["--enable-benchmarking", "--disable-stack-profiler"] +
self.extra_args)
self._EnsureStarted()
def Summary(self):
"""Returns a dictionary describing the browser.
"""
info = self.GetApplicationInfo()
return {
'name': self.name,
'identifier': info['CFBundleIdentifier'],
'version': info['CFBundleShortVersionString'],
'commit': info['SCMRevision'],
'extra_args': self.extra_args
}
# Helper functions to get default browser configurations.
def Safari():
return SafariDriver()
def Chrome(variation, extra_args=[]):
return ChromiumDriver("chrome",
variation,
"Google Chrome",
extra_args=extra_args)
def Canary(variation, extra_args=[]):
return ChromiumDriver("canary",
variation,
"Google Chrome Canary",
extra_args=extra_args)
def Chromium(variation, extra_args=[]):
return ChromiumDriver("chromium",
variation,
"Chromium",
extra_args=extra_args)
def Edge(variation, extra_args=[]):
return ChromiumDriver("edge",
variation,
"Microsoft Edge",
extra_args=extra_args)
PROCESS_NAMES = [
"Safari", "Google Chrome", "Google Chrome Canary", "Chromium",
"Microsoft Edge"
]
def MakeBrowserDriver(browser_name: str, variation: str,
chrome_user_dir=None) -> BrowserDriver:
"""Creates browser driver by name.
Args:
browser_name: Identifier for the browser to create. Supported browsers
are: safari, chrome and chromium.
chrome_user_dir: Optional user directory path to use for chrome.
"""
if "safari" == browser_name:
return Safari()
if browser_name in ["chrome", "chromium", "canary", "edge"]:
if chrome_user_dir:
chrome_extra_arg = [f"--user-data-dir={chrome_user_dir}"]
else:
chrome_extra_arg = ["--guest"]
if variation == 'AlignWakeUps':
chrome_extra_arg += ['--enable-features=AlignWakeUps']
if browser_name == "chrome":
return Chrome(variation, extra_args=chrome_extra_arg)
if browser_name == "canary":
return Canary(variation, extra_args=chrome_extra_arg)
elif browser_name == "chromium":
return Chromium(variation, extra_args=chrome_extra_arg)
elif browser_name == "edge":
return Edge(variation, extra_args=chrome_extra_arg)
return None