Skip to content

Commit ce780bf

Browse files
SvetoslavTsenovSvetoslavTsenov
authored
Tsenov/relaxed security (#126)
* feat: relaxedSecurity
1 parent 1fc4c1d commit ce780bf

14 files changed

+131
-61
lines changed

‎index.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ export { Point } from "./lib/point";
88
export { SearchOptions } from "./lib/search-options";
99
export { Locator } from "./lib/locators";
1010
export { Direction } from "./lib/direction";
11-
export { DeviceManger } from "./lib/device-controller";
11+
export { DeviceManager } from "./lib/device-manager";
1212
export { FrameComparer } from "./lib/frame-comparer";
1313
export { IRectangle } from "./lib/interfaces/rectangle";
1414
export { IDeviceManager } from "./lib/interfaces/device-manager";

‎index.ts‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import { IDeviceManager } from "./lib/interfaces/device-manager";
66
import { shutdown, findFreePort } from "./lib/utils";
77
import * as frameComparerHelper from "./lib/frame-comparer";
88
import { FrameComparer } from "./lib/frame-comparer";
9+
import { DeviceManager } from "./lib/device-manager";
910

1011
export { AppiumDriver } from "./lib/appium-driver";
1112
export { AppiumServer } from "./lib/appium-server";
@@ -15,7 +16,7 @@ export { Point } from "./lib/point";
1516
export { SearchOptions } from "./lib/search-options";
1617
export { Locator } from "./lib/locators";
1718
export { Direction } from "./lib/direction";
18-
export { DeviceManger } from "./lib/device-controller";
19+
export { DeviceManager } from "./lib/device-manager";
1920
export { FrameComparer } from "./lib/frame-comparer";
2021
export { IRectangle } from "./lib/interfaces/rectangle";
2122
export { IDeviceManager } from "./lib/interfaces/device-manager";
@@ -25,7 +26,7 @@ const appiumServer = new AppiumServer(nsCapabilities);
2526
let frameComparer: FrameComparer;
2627
let appiumDriver = null;
2728

28-
const attachToExitProcessHoockup = (processToExitFrom, processName ) => {
29+
const attachToExitProcessHoockup = (processToExitFrom, processName) => {
2930
const signals = ['SIGHUP', 'SIGINT', 'SIGQUIT', 'SIGILL', 'SIGTRAP', 'SIGABRT',
3031
'SIGBUS', 'SIGFPE', 'SIGUSR1', 'SIGSEGV', 'SIGUSR2', 'SIGTERM'];
3132
signals.forEach(function (sig) {
@@ -71,7 +72,7 @@ export async function createDriver() {
7172

7273
// Make sure to turn off "Don't keep activities"
7374
// in case of previous execution failure.
74-
await appiumDriver.setDontKeepActivities(false);
75+
await DeviceManager.setDontKeepActivities(nsCapabilities, appiumDriver, false);
7576

7677
return appiumDriver;
7778
}
@@ -98,4 +99,4 @@ const killProcesses = async (code) => {
9899

99100
process.once("exit", async (code) => await killProcesses(code));
100101

101-
attachToExitProcessHoockup(process,"main process");
102+
attachToExitProcessHoockup(process, "main process");

‎lib/appium-driver.d.ts‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ export declare class AppiumDriver {
5555
*/
5656
readonly storageByDeviceName: string;
5757
static createAppiumDriver(port: number, args: INsCapabilities): Promise<AppiumDriver>;
58-
private static applyDeviceAdditionsSettings;
5958
/**
6059
*
6160
* @param xPath
@@ -204,9 +203,5 @@ export declare class AppiumDriver {
204203
* @param waitForElement
205204
*/
206205
findElementByAccessibilityIdIfExists(id: string, waitForElement?: number): Promise<UIElement>;
207-
static executeShellCommand(driver: any, commandAndargs: {
208-
command: string;
209-
"args": Array<any>;
210-
}): Promise<any>;
211206
setDontKeepActivities(value: boolean): Promise<void>;
212207
}

‎lib/appium-driver.ts‎

Lines changed: 3 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ import { ImageHelper } from "./image-helper";
4141
import { ImageOptions } from "./image-options"
4242
import { unlinkSync, writeFileSync } from "fs";
4343
import * as webdriverio from "webdriverio";
44+
import { DeviceManager } from "../lib/device-manager";
4445

4546
export class AppiumDriver {
4647
private static pngFileExt = '.png';
@@ -187,7 +188,7 @@ export class AppiumDriver {
187188
try {
188189
const sessionIfno = await driver.init(args.appiumCaps);
189190
log(sessionIfno, args.verbose);
190-
await AppiumDriver.applyDeviceAdditionsSettings(driver, args, sessionIfno);
191+
await DeviceManager.applyDeviceAdditionsSettings(driver, args, sessionIfno);
191192

192193
hasStarted = true;
193194
} catch (error) {
@@ -209,34 +210,6 @@ export class AppiumDriver {
209210
return new AppiumDriver(driver, wd, webio, driverConfig, args);
210211
}
211212

212-
private static async applyDeviceAdditionsSettings(driver, args: INsCapabilities, sessionIfno: any) {
213-
if (!args.device.config || !args.device.config.density || !args.device.config.offset) {
214-
args.device.config = {};
215-
let density: number = sessionIfno[1].deviceScreenDensity / 100;
216-
console.log(`Get density from appium session: ${density}`);
217-
if (!density) {
218-
density = await AppiumDriver.executeShellCommand(driver, { command: "wm", args: ["density"] });
219-
console.log(`Device density recieved from adb shell command ${density}`);
220-
}
221-
args.device.config['density'] = density;
222-
223-
if (args.appiumCaps.platformName.toLowerCase() === "android") {
224-
args.device.config['offsetPixels'] = AndroidController.calculateScreenOffset(density);
225-
} else {
226-
IOSController.getDevicesScreenInfo().forEach((v, k, m) => {
227-
if (args.device.name.includes(k)) {
228-
args.device.config = {
229-
density: args.device.config['density'] || v.density,
230-
offsetPixels: v.actionBarHeight
231-
};
232-
}
233-
});
234-
}
235-
236-
console.log(`Device setting:`, args.device.config);
237-
}
238-
}
239-
240213
/**
241214
*
242215
* @param xPath
@@ -738,18 +711,9 @@ export class AppiumDriver {
738711
}
739712
}
740713

741-
public static async executeShellCommand(driver, commandAndargs: { command: string, "args": Array<any> }) {
742-
const output = await driver.execute("mobile: shell", commandAndargs);
743-
return output;
744-
}
745-
746714
public async setDontKeepActivities(value: boolean) {
747715
if (this._args.isAndroid) {
748-
const status = value ? 1 : 0;
749-
const output = await AppiumDriver.executeShellCommand(this._driver, { command: "settings", args: ['put', 'global', 'always_finish_activities', status] });
750-
//check if set
751-
const check = await AppiumDriver.executeShellCommand(this._driver, { command: "settings", args: ['get', 'global', 'always_finish_activities'] })
752-
console.info(`always_finish_activities: ${check}`)
716+
const output = await DeviceManager.setDontKeepActivities(this._args, this._driver, value);
753717
} else {
754718
// Do nothing for iOS ...
755719
}

‎lib/appium-server.ts‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import {
1212
} from "./utils";
1313
import { INsCapabilities } from "./interfaces/ns-capabilities";
1414
import { IDeviceManager } from "./interfaces/device-manager";
15-
import { DeviceManger } from "./device-controller";
15+
import { DeviceManager } from "./device-manager";
1616
import { AndroidController } from "mobile-devices-controller";
1717

1818
export class AppiumServer {
@@ -57,7 +57,7 @@ export class AppiumServer {
5757
this._hasStarted = hasStarted;
5858
}
5959

60-
public async start(port, deviceManager: IDeviceManager = new DeviceManger()) {
60+
public async start(port, deviceManager: IDeviceManager = new DeviceManager()) {
6161
await this.prepareDevice(deviceManager);
6262
await this.prepareApp();
6363

@@ -85,7 +85,9 @@ export class AppiumServer {
8585

8686
private startAppiumServer(logLevel: string, isSauceLab: boolean) {
8787
const startingServerArgs: Array<string> = isSauceLab ? ["--log-level", logLevel] : ["-p", this.port.toString(), "--log-level", logLevel];
88-
startingServerArgs.push("--relaxed-security");
88+
if(this._args.isAndroid && this._args.ignoreDeviceController && !this._args.isSauceLab){
89+
this._args.relaxedSecurity ? startingServerArgs.push("--relaxed-security") : console.log("'relaxedSecurity' is not enabled!\nTo enabled it use '--relaxedSecurity'!");
90+
}
8991
this._server = child_process.spawn(this._appium, startingServerArgs, {
9092
shell: true,
9193
detached: false

‎lib/device-controller.d.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,11 @@ export declare class DeviceManger implements IDeviceManager {
1111
static kill(device: IDevice): Promise<void>;
1212
private static getDefaultDevice;
1313
getPackageId(device: IDevice, appPath: string): string;
14+
static setDontKeepActivities(nsArgs: INsCapabilities, driver: any, value: boolean): Promise<void>;
15+
static executeShellCommand(driver: any, commandAndargs: {
16+
command: string;
17+
"args": Array<any>;
18+
includeStderr?: boolean;
19+
}): Promise<any>;
20+
static getDensity(nsArgs: any, driver: any): Promise<void>;
1421
}

‎lib/device-manager.d.ts‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import { INsCapabilities } from "./interfaces/ns-capabilities";
2+
import { IDeviceManager } from "./interfaces/device-manager";
3+
import { IDevice } from "mobile-devices-controller";
4+
export declare class DeviceManager implements IDeviceManager {
5+
private static _emulators;
6+
constructor();
7+
startDevice(args: INsCapabilities): Promise<IDevice>;
8+
stopDevice(args: INsCapabilities): Promise<any>;
9+
installApp(args: INsCapabilities): Promise<any>;
10+
uninstallApp(args: INsCapabilities): Promise<any>;
11+
static kill(device: IDevice): Promise<void>;
12+
private static getDefaultDevice;
13+
static setDontKeepActivities(args: INsCapabilities, driver: any, value: any): Promise<void>;
14+
static executeShellCommand(driver: IDevice, commandAndargs: {
15+
command: string;
16+
"args": Array<any>;
17+
}): Promise<any>;
18+
static getDensity(args: INsCapabilities, driver: any): Promise<void>;
19+
static applyDeviceAdditionsSettings(driver: any, args: INsCapabilities, sessionIfno: any): Promise<void>;
20+
getPackageId(device: IDevice, appPath: string): string;
21+
}

lib/device-controller.ts renamed to lib/device-manager.ts

Lines changed: 78 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ import {
2121
DeviceType
2222
} from "mobile-devices-controller";
2323

24-
export class DeviceManger implements IDeviceManager {
24+
export class DeviceManager implements IDeviceManager {
2525
private static _emulators: Map<string, IDevice> = new Map();
2626

2727
constructor() {
2828
}
2929

3030
public async startDevice(args: INsCapabilities): Promise<IDevice> {
3131
args.appiumCaps.platformName = args.appiumCaps.platformName.toLowerCase();
32-
let device: IDevice = DeviceManger.getDefaultDevice(args);
32+
let device: IDevice = DeviceManager.getDefaultDevice(args);
3333
if (process.env["DEVICE_TOKEN"]) {
3434
device.token = process.env["DEVICE_TOKEN"];
3535
device.name = process.env["DEVICE_NAME"] || device.name;
@@ -41,8 +41,8 @@ export class DeviceManger implements IDeviceManager {
4141

4242
// When isSauceLab specified we simply do nothing;
4343
if (args.isSauceLab || args.ignoreDeviceController) {
44-
args.ignoreDeviceController = true;
45-
DeviceManger._emulators.set(args.runType, device);
44+
args.ignoreDeviceController = true;
45+
DeviceManager._emulators.set(args.runType, device);
4646
return device;
4747
}
4848

@@ -89,18 +89,18 @@ export class DeviceManger implements IDeviceManager {
8989
}
9090
}
9191

92-
DeviceManger._emulators.set(args.runType, device);
92+
DeviceManager._emulators.set(args.runType, device);
9393

9494
return device;
9595
}
9696

9797
public async stopDevice(args: INsCapabilities): Promise<any> {
98-
if (DeviceManger._emulators.has(args.runType)
98+
if (DeviceManager._emulators.has(args.runType)
9999
&& !args.reuseDevice
100100
&& !args.isSauceLab
101101
&& !args.ignoreDeviceController) {
102-
const device = DeviceManger._emulators.get(args.runType);
103-
await DeviceManger.kill(device);
102+
const device = DeviceManager._emulators.get(args.runType);
103+
await DeviceManager.kill(device);
104104
}
105105
}
106106

@@ -133,6 +133,76 @@ export class DeviceManger implements IDeviceManager {
133133
return device;
134134
}
135135

136+
public static async setDontKeepActivities(args: INsCapabilities, driver, value) {
137+
if (args.isAndroid) {
138+
if (!args.ignoreDeviceController) {
139+
AndroidController.setDontKeepActivities(value, args.device);
140+
} else if (args.relaxedSecurity) {
141+
const status = value ? 1 : 0;
142+
const output = await DeviceManager.executeShellCommand(driver, { command: "settings", args: ['put', 'global', 'always_finish_activities', status] });
143+
//check if set
144+
const check = await DeviceManager.executeShellCommand(driver, { command: "settings", args: ['get', 'global', 'always_finish_activities'] });
145+
console.info(`always_finish_activities: ${check}`);
146+
}
147+
} else {
148+
// Do nothing for iOS ...
149+
}
150+
}
151+
152+
public static async executeShellCommand(driver: IDevice, commandAndargs: { command: string, "args": Array<any> }) {
153+
if (driver.platform.toLowerCase() === Platform.ANDROID) {
154+
const output = await driver.execute("mobile: shell", commandAndargs);
155+
return output;
156+
}
157+
return undefined;
158+
}
159+
160+
public static async getDensity(args: INsCapabilities, driver) {
161+
args.device.config = args.device.config || {};
162+
if (args.appiumCaps.platformName.toLowerCase() === "android") {
163+
if (!args.ignoreDeviceController) {
164+
args.device.config.density = await AndroidController.getPhysicalDensity(args.device);
165+
}
166+
167+
if (args.relaxedSecurity) {
168+
args.device.config.density = await DeviceManager.executeShellCommand(driver, { command: "wm", args: ["density"] });
169+
console.log(`Device density recieved from adb shell command ${args.device.config.density}`);
170+
}
171+
172+
if (args.device.config.density) {
173+
args.device.config['offsetPixels'] = AndroidController.calculateScreenOffset(args.device.config.density);
174+
}
175+
} else {
176+
IOSController.getDevicesScreenInfo().forEach((v, k, m) => {
177+
if (args.device.name.includes(k)) {
178+
args.device.config = {
179+
density: args.device.config['density'] || v.density,
180+
offsetPixels: v.actionBarHeight
181+
};
182+
}
183+
});
184+
}
185+
}
186+
187+
public static async applyDeviceAdditionsSettings(driver, args: INsCapabilities, sessionIfno: any) {
188+
if (!args.device.config || !args.device.config.offsetPixels) {
189+
args.device.config = {};
190+
let density: number = sessionIfno[1].deviceScreenDensity ? sessionIfno[1].deviceScreenDensity / 100 : undefined;
191+
192+
if (density) {
193+
console.log(`Get density from appium session: ${density}`);
194+
args.device.config['density'] = density;
195+
args.device.config['offsetPixels'] = AndroidController.calculateScreenOffset(args.device.config.density);
196+
}
197+
198+
if (!density) {
199+
await DeviceManager.getDensity(args, driver);
200+
}
201+
202+
density ? console.log(`Device setting:`, args.device.config) : console.log(`Could not resolve device density. Please provide offset in appium config`);
203+
}
204+
}
205+
136206
public getPackageId(device: IDevice, appPath: string): string {
137207
const appActivity = (device.type === DeviceType.EMULATOR || device.platform === Platform.ANDROID) ? AndroidController.getPackageId(appPath) : IOSController.getIOSPackageId(device.type, appPath);
138208
return appActivity;

‎lib/interfaces/ns-capabilities.d.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,5 @@ export interface INsCapabilities {
3030
wdaLocalPort: number;
3131
path: string;
3232
automationName: AutomationName;
33+
relaxedSecurity: boolean;
3334
}

‎lib/interfaces/ns-capabilities.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,5 @@ export interface INsCapabilities {
3232
wdaLocalPort: number;
3333
path: string;
3434
automationName: AutomationName;
35+
relaxedSecurity: boolean
3536
}

0 commit comments

Comments
 (0)