appium-ios-simulator
Version:
iOS Simulator interface for Appium.
732 lines (731 loc) • 24.4 kB
HTML
<html lang="en">
<head>
<title>Code coverage report for lib/settings.js</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="../prettify.css" />
<link rel="stylesheet" href="../base.css" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(../sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1>
<a href="../index.html">All files</a> / <a href="index.html">lib</a> settings.js
</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">86.42% </span>
<span class="quiet">Statements</span>
<span class='fraction'>70/81</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">69.7% </span>
<span class="quiet">Branches</span>
<span class='fraction'>46/66</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">88.89% </span>
<span class="quiet">Functions</span>
<span class='fraction'>8/9</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">85.9% </span>
<span class="quiet">Lines</span>
<span class='fraction'>67/78</span>
</div>
</div>
</div>
<div class='status-line high'></div>
<pre><table class="coverage">
<tr><td class="line-count quiet">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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223</td><td class="line-coverage quiet"><span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">9x</span>
<span class="cline-any cline-yes">9x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">21x</span>
<span class="cline-any cline-yes">21x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">9x</span>
<span class="cline-any cline-yes">9x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">6x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">6x</span>
<span class="cline-any cline-yes">6x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">6x</span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">6x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">5x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span></td><td class="text"><pre class="prettyprint lang-js">import _ from 'lodash';
import { plist } from 'appium-support';
import path from 'path';
import log from './logger';
import compare from 'semver-compare';
// returns path to plist based on id for plist.
// these ids are appium terms
async function plistPaths (sim, identifier) {
let paths = [];
let simDirectory = sim.getDir();
switch (identifier) {
case 'webInspector'<span class="branch-0 cbranch-no" title="branch not covered" >:</span>
<span class="cstat-no" title="statement not covered" > paths.push(path.resolve(simDirectory, 'Library', 'Preferences', 'com.apple.webInspector.plist'));</span>
break;
case 'mobileSafari'<span class="branch-0 cbranch-no" title="branch not covered" >:</span>
paths.push(path.resolve(await sim.getAppDir('com.apple.mobilesafari'), 'Library', 'Preferences', 'com.apple.mobilesafari.plist'));
break;
case 'webUI'<span class="branch-0 cbranch-no" title="branch not covered" >:</span>
<span class="cstat-no" title="statement not covered" > paths.push(path.resolve(simDirectory, 'Library', 'Preferences', 'com.apple.WebUI.plist'));</span>
break;
case 'webFoundation'<span class="branch-0 cbranch-no" title="branch not covered" >:</span>
<span class="cstat-no" title="statement not covered" > paths.push(path.resolve(simDirectory, 'Library', 'Preferences', 'com.apple.WebFoundation.plist'));</span>
break;
case 'preferences'<span class="branch-0 cbranch-no" title="branch not covered" >:</span>
<span class="cstat-no" title="statement not covered" > paths.push(path.resolve(simDirectory, 'Library', 'Preferences', 'com.apple.Preferences.plist'));</span>
break;
case 'locationServices'<span class="branch-0 cbranch-no" title="branch not covered" >:</span>
<span class="cstat-no" title="statement not covered" > paths.push(path.resolve(simDirectory, 'Library', 'Preferences', 'com.apple.locationd.plist'));</span>
break;
case 'locationClients':
paths.push(path.resolve(simDirectory, 'Library', 'Caches', 'locationd', 'clients.plist'));
break;
case 'locationCache':
paths.push(path.resolve(simDirectory, 'Library', 'Caches', 'locationd', 'cache.plist'));
paths.push(path.resolve(simDirectory, 'Library', 'Preferences', 'com.apple.locationd.plist'));
break;
case 'userSettings'<span class="branch-1 cbranch-no" title="branch not covered" >:</span>
<span class="missing-if-branch" title="else path not taken" >E</span>if (compare(sim.xcodeVersion.versionString, '7.3') < 0) {
paths.push(path.resolve(simDirectory, 'Library', 'ConfigurationProfiles', 'UserSettings.plist'));
paths.push(path.resolve(simDirectory, 'Library', 'ConfigurationProfiles', 'EffectiveUserSettings.plist'));
paths.push(path.resolve(simDirectory, 'Library', 'ConfigurationProfiles', 'PublicInfo', 'PublicEffectiveUserSettings.plist'));
} else {
<span class="cstat-no" title="statement not covered" > paths.push(path.resolve(simDirectory, 'Library', 'UserConfigurationProfiles', 'UserSettings.plist'));</span>
<span class="cstat-no" title="statement not covered" > paths.push(path.resolve(simDirectory, 'Library', 'UserConfigurationProfiles', 'EffectiveUserSettings.plist'));</span>
<span class="cstat-no" title="statement not covered" > paths.push(path.resolve(simDirectory, 'Library', 'UserConfigurationProfiles', 'PublicInfo', 'PublicEffectiveUserSettings.plist'));</span>
}
break;
case 'effectiveUserSettings':
<span class="cstat-no" title="statement not covered" > paths.push(path.resolve(simDirectory, 'Library', 'ConfigurationProfiles', 'EffectiveUserSettings.plist'));</span>
<span class="cstat-no" title="statement not covered" > paths.push(path.resolve(simDirectory, 'Library', 'ConfigurationProfiles', 'PublicInfo', 'PublicEffectiveUserSettings.plist'));</span>
break;
}
return paths;
}
async function updateSettings (sim, plist, updates) {
let paths = await plistPaths(sim, plist);
for (let path of paths) {
await update(path, updates);
}
}
// update a plist file, located at pathToPlist
// pass in an object, all settings specified in the object will be
// updated on the plist, all others left as-is
async function update (pathToPlist, updates) {
let currentSettings = await read(pathToPlist);
let newSettings = _.merge(currentSettings, updates);
await plist.updatePlistFile(pathToPlist, newSettings, true, false);
return newSettings;
}
async function readSettings (sim, plist) {
let settings = {};
let paths = await plistPaths(sim, plist);
for (let path of paths) {
settings[path] = await read(path);
}
return settings;
}
async function read (pathToPlist) {
return await plist.parsePlistFile(pathToPlist, false);
}
async function updateLocationSettings (sim, bundleId, authorized) {
// update location cache
let newCachePrefs = {
LastFenceActivityTimestamp: 412122103.232983,
CleanShutdown: true
};
await updateSettings(sim, 'locationCache', {[bundleId]: newCachePrefs});
// update location clients
let newClientPrefs = {
BundleId: bundleId,
Authorized: !!authorized,
Whitelisted: false,
};
for (let file of await plistPaths(sim, 'locationClients')) {
log.debug(`Updating location client file: ${file}`);
let updates = {};
// see if the bundle is already there
let plist = await read(file);
// random data that always seems to be in the clients.plist
let weirdLocKey = 'com.apple.locationd.bundle-/System/Library/' +
'PrivateFrameworks/AOSNotification.framework';
<span class="missing-if-branch" title="else path not taken" >E</span>if (!_.has(plist, weirdLocKey)) {
updates[weirdLocKey] = {
BundlePath: '/System/Library/PrivateFrameworks/AOSNotification.framework',
Whitelisted: false,
Executable: '',
Registered: ''
};
}
// create the update, and make sure it has sensible values
let baseSetting = _.has(plist, bundleId) ? plist[bundleId] : {};
updates[bundleId] = _.defaults(newClientPrefs, baseSetting);
updates[bundleId].Executable = updates[bundleId].Executable || '';
updates[bundleId].Registered = updates[bundleId].Registered || '';
await update(file, updates);
}
}
async function updateSafariUserSettings (sim, settingSet) {
// add extra stuff to UserSettings.plist and EffectiveUserSettings.plist
let newUserSettings = {};
<span class="missing-if-branch" title="else path not taken" >E</span>if (_.has(settingSet, 'WebKitJavaScriptEnabled')) {
newUserSettings.safariAllowJavaScript = settingSet.WebKitJavaScriptEnabled;
}
<span class="missing-if-branch" title="else path not taken" >E</span>if (_.has(settingSet, 'WebKitJavaScriptCanOpenWindowsAutomatically')) {
newUserSettings.safariAllowPopups = settingSet.WebKitJavaScriptCanOpenWindowsAutomatically;
}
<span class="missing-if-branch" title="else path not taken" >E</span>if (_.has(settingSet, 'WarnAboutFraudulentWebsites')) {
newUserSettings.safariForceFraudWarning = !settingSet.WarnAboutFraudulentWebsites;
}
if (_.size(newUserSettings) > 0) {
log.debug('Updating Safari user settings');
let curUserSettings = await readSettings(sim, 'userSettings');
for (let [file, userSettingSet] of _.toPairs(curUserSettings)) {
// the user settings plist has two buckets, one for
// boolean settings (`restrictedBool`) and one for
// other value settings (`restrictedValue`). In each, the value
// is in a `value` sub-field.
<span class="missing-if-branch" title="if path not taken" >I</span>if (!_.has(userSettingSet, 'restrictedBool')) {
<span class="cstat-no" title="statement not covered" > userSettingSet.restrictedBool = {};</span>
}
for (let [key, value] of _.toPairs(newUserSettings)) {
userSettingSet.restrictedBool[key] = {value};
}
// actually do the update
await update(file, userSettingSet);
}
}
}
async function updateLocale (sim, language, locale, calendarFormat) {
let globalPrefs = path.resolve(sim.getDir(), 'Library', 'Preferences',
'.GlobalPreferences.plist');
// get the current data
let data = await read(globalPrefs);
let updates = {};
// if we are setting the language, add it to the beginning of the list of languages
if (language) {
log.debug(`New language: ${language}`);
let supportedLangs = data.AppleLanguages || <span class="branch-1 cbranch-no" title="branch not covered" >[];</span>
// if the language is first, we don't need to do anything
if (supportedLangs.indexOf(language) !== 0) {
updates.AppleLanguages = [language].concat(_.without(supportedLangs, language));
}
}
// if we are setting the locale or calendar format, set them as appropriate
if (locale || calendarFormat) {
let calSplit = '@calendar=';
let curLocaleAndCal = data.AppleLocale || <span class="branch-1 cbranch-no" title="branch not covered" >language </span>|| <span class="branch-2 cbranch-no" title="branch not covered" >'en';</span>
let split = curLocaleAndCal.split(calSplit);
let curLoc = split[0];
if (calendarFormat || split[1]) {
calendarFormat = `${calSplit}${calendarFormat || split[1] || <span class="branch-2 cbranch-no" title="branch not covered" >''}</span>`;
}
calendarFormat = calendarFormat || '';
let newLocaleAndCal = locale ? locale : curLoc;
if (calendarFormat) {
newLocaleAndCal = `${newLocaleAndCal}${calendarFormat}`;
}
// only need to update if it has changed
<span class="missing-if-branch" title="else path not taken" >E</span>if (newLocaleAndCal !== curLocaleAndCal) {
log.debug(`New locale: ${newLocaleAndCal}`);
updates.AppleLocale = newLocaleAndCal;
}
}
if (_.size(updates) === 0) {
log.debug('No locale updates necessary.');
return false;
}
log.debug('Writing new locale plist data');
await update(globalPrefs, updates);
return true;
}
async function <span class="fstat-no" title="function not covered" >stub </span>() {
return await plistPaths;
}
export { update, updateSettings, updateLocationSettings,
updateSafariUserSettings, updateLocale, read, readSettings, stub };
</pre></td></tr>
</table></pre>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage
generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Fri Aug 11 2017 08:34:01 GMT-0400 (EDT)
</div>
</div>
<script src="../prettify.js"></script>
<script>
window.onload = function () {
if (typeof prettyPrint === 'function') {
prettyPrint();
}
};
</script>
<script src="../sorter.js"></script>
</body>
</html>