-
Notifications
You must be signed in to change notification settings - Fork 22
Expand file tree
/
Copy pathlocal_binary.py
More file actions
189 lines (157 loc) · 6.11 KB
/
local_binary.py
File metadata and controls
189 lines (157 loc) · 6.11 KB
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
import platform, os, sys, stat, tempfile, re, subprocess
from browserstack.bserrors import BrowserStackLocalError
import gzip
import json
try:
from urllib.request import urlopen, Request
except ImportError:
from urllib2 import urlopen, Request
class LocalBinary:
_version = None
def __init__(self, key, error_object=None):
self.key = key
self.error_object = error_object
is_64bits = sys.maxsize > 2**32
self.is_windows = False
osname = platform.system()
source_url = self.fetch_source_url() + '/'
if osname == 'Darwin':
self.http_path = source_url + "BrowserStackLocal-darwin-x64"
elif osname == 'Linux':
if self.is_alpine():
self.http_path = source_url + "BrowserStackLocal-alpine"
elif platform.machine() == 'aarch64':
self.http_path = source_url + "BrowserStackLocal-linux-arm64"
else:
if is_64bits:
self.http_path = source_url + "BrowserStackLocal-linux-x64"
else:
self.http_path = source_url + "BrowserStackLocal-linux-ia32"
else:
self.is_windows = True
self.http_path = source_url + "BrowserStackLocal.exe"
self.ordered_paths = [
os.path.join(os.path.expanduser('~'), '.browserstack'),
os.getcwd(),
tempfile.gettempdir()
]
self.path_index = 0
def fetch_source_url(self):
url = "https://local.browserstack.com/binary/api/v1/endpoint"
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"User-Agent": '/'.join(('browserstack-local-python', LocalBinary._version))
}
data = {"auth_token": self.key}
if self.error_object is not None:
data["error_message"] = str(self.error_object)
headers["X-Local-Fallback-Cloudflare"] = "true"
req = Request(url, data=json.dumps(data).encode("utf-8"))
for key, value in headers.items():
req.add_header(key, value)
try:
with urlopen(req) as response:
resp_bytes = response.read()
resp_str = resp_bytes.decode('utf-8')
resp_json = json.loads(resp_str)
return resp_json["data"]["endpoint"]
except Exception as e:
raise BrowserStackLocalError('Error trying to fetch the source url for downloading the binary: {}'.format(e))
@staticmethod
def set_version(version):
LocalBinary._version = version
def is_alpine(self):
response = subprocess.check_output(["grep", "-w", "NAME", "/etc/os-release"])
return response.decode('utf-8').find('Alpine') > -1
def __make_path(self, dest_path):
try:
if not os.path.exists(dest_path):
os.makedirs(dest_path)
return True
except:
return False
def __available_dir(self):
while self.path_index < len(self.ordered_paths):
if self.__make_path(self.ordered_paths[self.path_index]):
final_path = self.ordered_paths[self.path_index]
self.path_index += 1
return final_path
else:
self.path_index += 1
raise BrowserStackLocalError('Error trying to download BrowserStack Local binary, exhausted user directories to download to.')
def download(self, chunk_size=8192, progress_hook=None):
headers = {
'User-Agent': '/'.join(('browserstack-local-python', LocalBinary._version)),
'Accept-Encoding': 'gzip, *',
}
if sys.version_info < (3, 2):
# lack of support for gzip decoding for stream, response is expected to have a tell() method
headers.pop('Accept-Encoding', None)
response = urlopen(Request(self.http_path, headers=headers))
try:
total_size = int(response.info().get('Content-Length', '').strip() or '0')
except:
total_size = int(response.info().get_all('Content-Length')[0].strip() or '0')
bytes_so_far = 0
# Limits retries to the number of directories
dest_parent_dir = self.__available_dir()
dest_binary_name = 'BrowserStackLocal'
if self.is_windows:
dest_binary_name += '.exe'
content_encoding = response.info().get('Content-Encoding', '')
gzip_file = gzip.GzipFile(fileobj=response, mode='rb') if content_encoding.lower() == 'gzip' else None
if os.getenv('BROWSERSTACK_LOCAL_DEBUG_GZIP') and gzip_file:
print('using gzip in ' + headers['User-Agent'])
def read_chunk(chunk_size):
if gzip_file:
return gzip_file.read(chunk_size)
else:
return response.read(chunk_size)
with open(os.path.join(dest_parent_dir, dest_binary_name), 'wb') as local_file:
while True:
chunk = read_chunk(chunk_size)
bytes_so_far += len(chunk)
if not chunk:
break
if total_size > 0 and progress_hook:
progress_hook(bytes_so_far, chunk_size, total_size)
try:
local_file.write(chunk)
except:
return self.download(chunk_size, progress_hook)
if gzip_file:
gzip_file.close()
if callable(getattr(response, 'close', None)):
response.close()
final_path = os.path.join(dest_parent_dir, dest_binary_name)
st = os.stat(final_path)
os.chmod(final_path, st.st_mode | stat.S_IXUSR)
return final_path
def __verify_binary(self,path):
try:
binary_response = subprocess.check_output([path,"--version"]).decode("utf-8")
pattern = re.compile("BrowserStack Local version \d+\.\d+")
return bool(pattern.match(binary_response))
except:
return False
def get_binary(self):
dest_parent_dir = os.path.join(os.path.expanduser('~'), '.browserstack')
if not os.path.exists(dest_parent_dir):
os.makedirs(dest_parent_dir)
binary_name = 'BrowserStackLocal.exe' if self.is_windows else 'BrowserStackLocal'
bsfiles = [f for f in os.listdir(dest_parent_dir) if f == binary_name]
if len(bsfiles) == 0:
binary_path = self.download()
else:
binary_path = os.path.join(dest_parent_dir, bsfiles[0])
valid_binary = self.__verify_binary(binary_path)
if valid_binary:
return binary_path
else:
binary_path = self.download()
valid_binary = self.__verify_binary(binary_path)
if valid_binary:
return binary_path
else:
raise BrowserStackLocalError('BrowserStack Local binary is corrupt')