Skip to content

Commit 175a6be

Browse files
SvetoslavTsenovSvetoslavTsenov
authored
Tsenov/3.2.0 (#59)
feat: device management, crop-images, exclude action-bar
1 parent 2f369e1 commit 175a6be

15 files changed

+146
-135
lines changed

‎e2e/config/appium.capabilities.json‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,18 @@
7979
"fullReset": false,
8080
"app": ""
8181
},
82-
"sim.iPhone7.iOS110": {
82+
"sim.iPhone8.iOS110": {
8383
"platformName": "iOS",
8484
"platformVersion": "11.0",
85-
"deviceName": "iPhone 7 110",
85+
"deviceName": "iPhone 8 110",
86+
"noReset": true,
87+
"fullReset": false,
88+
"app": ""
89+
},
90+
"sim.iPhoneX.iOS110": {
91+
"platformName": "iOS",
92+
"platformVersion": "11.0",
93+
"deviceName": "iPhone X",
8694
"noReset": true,
8795
"fullReset": false,
8896
"app": ""

‎index.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ export { Point } from "./lib/point";
55
export { SearchOptions } from "./lib/search-options";
66
export { Locator } from "./lib/locators";
77
export { Direction } from "./lib/direction";
8-
export { DeviceController } from "./lib/device-controller";
8+
export { DeviceManger } from "./lib/device-controller";
99
export declare function startServer(port?: number): Promise<void>;
1010
export declare function stopServer(): Promise<void>;
1111
export declare function createDriver(): Promise<any>;

‎index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export { Point } from "./lib/point";
1212
export { SearchOptions } from "./lib/search-options";
1313
export { Locator } from "./lib/locators";
1414
export { Direction } from "./lib/direction";
15-
export { DeviceController } from "./lib/device-controller";
15+
export { DeviceManger } from "./lib/device-controller";
1616

1717
const nsCapabilities = new NsCapabilities();
1818
const appiumServer = new AppiumServer(nsCapabilities);

‎lib/appium-driver.d.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import { Direction } from "./direction";
66
import { Locator } from "./locators";
77
import { INsCapabilities } from "./ins-capabilities";
88
import { Point } from "./point";
9+
import { ImageHelper } from "./image-helper";
910
export declare class AppiumDriver {
1011
private _driver;
1112
private _wd;
@@ -22,6 +23,7 @@ export declare class AppiumDriver {
2223
private _logPath;
2324
private _storage;
2425
private constructor();
26+
readonly imageHelper: ImageHelper;
2527
defaultWaitTime: number;
2628
readonly capabilities: any;
2729
readonly platformName: any;

‎lib/appium-driver.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,10 @@ export class AppiumDriver {
4848
this._webio.requestHandler.sessionID = this._driver.sessionID;
4949
}
5050

51+
get imageHelper() {
52+
return this._imageHelper;
53+
}
54+
5155
get defaultWaitTime(): number {
5256
return this._defaultWaitTime;
5357
}

‎lib/appium-server.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as child_process from "child_process";
22
import { log, resolve, waitForOutput, shutdown, fileExists, isWin, executeCommand } from "./utils";
33
import { INsCapabilities } from "./ins-capabilities";
4-
import { DeviceController } from "./device-controller";
4+
import { DeviceManger } from "./device-controller";
55

66
export class AppiumServer {
77
private _server: child_process.ChildProcess;
@@ -45,7 +45,7 @@ export class AppiumServer {
4545
}
4646

4747
public async start() {
48-
const device = await DeviceController.startDevice(this._args);
48+
const device = await DeviceManger.startDevice(this._args);
4949
log("Starting server...", this._args.verbose);
5050
this._args.device = device;
5151
const logLevel = this._args.verbose === true ? "debug" : "info";
@@ -60,7 +60,7 @@ export class AppiumServer {
6060
}
6161

6262
public async stop() {
63-
await DeviceController.stop(this._args);
63+
await DeviceManger.stop(this._args);
6464
return new Promise((resolve, reject) => {
6565
this._server.on("close", (code, signal) => {
6666
log(`Appium terminated due signal: ${signal} and code: ${code}`, this._args.verbose);
@@ -84,7 +84,7 @@ export class AppiumServer {
8484

8585
log("Stopping server...", this._args.verbose);
8686
try {
87-
if (isWin) {
87+
if (isWin()) {
8888
shutdown(this._server, this._args.verbose);
8989
this._server.kill("SIGINT");
9090
this._server.kill("SIGINT");

‎lib/device-controller.d.ts‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
import { INsCapabilities } from "./ins-capabilities";
2-
import { IDevice, Device } from "mobile-devices-controller";
3-
export declare class DeviceController {
2+
import { IDevice } from "mobile-devices-controller";
3+
export declare class DeviceManger {
44
private static _emulators;
5-
static startDevice(args: INsCapabilities): Promise<IDevice | Device>;
5+
static startDevice(args: INsCapabilities): Promise<IDevice>;
66
static stop(args: INsCapabilities): Promise<void>;
77
static kill(device: IDevice): Promise<void>;
88
private static getDefaultDevice(args);
99
private static device(runType);
10-
private static getDevicesByStatus(devices, status);
1110
}

‎lib/device-controller.ts‎

Lines changed: 32 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -5,82 +5,78 @@ import { INsCapabilities } from "./ins-capabilities";
55
import {
66
IDevice,
77
Device,
8-
DeviceManager,
8+
DeviceController,
99
Platform,
1010
Status,
1111
DeviceType
1212
} from "mobile-devices-controller";
1313

1414

15-
export class DeviceController {
15+
export class DeviceManger {
1616
private static _emulators: Map<string, IDevice> = new Map();
1717

1818
public static async startDevice(args: INsCapabilities) {
19+
let device: IDevice = DeviceManger.getDefaultDevice(args);
1920
if (args.isSauceLab || args.ignoreDeviceController) {
20-
return DeviceController.getDefaultDevice(args);
21+
return device;
2122
}
2223

23-
const allDevices = (await DeviceManager.getAllDevices(args.appiumCaps.platformName.toLowerCase()));
24-
if (!allDevices || allDevices === null || allDevices.size === 0) {
25-
console.log("We couldn't find any devices. We will try to prossede to appium! Maybe avd manager is missing")
24+
const allDevices = (await DeviceController.getDivices({ platform: args.appiumCaps.platformName }));
25+
if (!allDevices || allDevices === null || allDevices.length === 0) {
26+
console.log("We couldn't find any devices. We will try to proceed to appium! Maybe avd manager is missing")
2627
console.log("Available devices:\n", allDevices);
2728
}
2829

29-
let searchedDevices = allDevices.get(args.appiumCaps.deviceName);
30+
let searchedDevices = DeviceController.filter(allDevices, { name: args.appiumCaps.deviceName, apiLevel: args.appiumCaps.platformVersion });
3031
if (!searchedDevices || searchedDevices.length === 0) {
3132
console.log(`No such device ${args.appiumCaps.deviceName}!!!\n Check your device name!!!`);
3233
console.log("Available devices:\n", allDevices);
3334
}
3435

35-
let device: IDevice;
36-
3736
if (searchedDevices && searchedDevices.length > 0) {
3837

3938
// Should find new device
4039
if (!args.reuseDevice) {
41-
device = DeviceController.getDevicesByStatus(searchedDevices, Status.SHUTDOWN);
40+
device = DeviceController.filter(searchedDevices, { status: Status.SHUTDOWN })[0];
4241
}
4342

4443
// If there is no shutdown device
45-
if (!device || device === null) {
46-
device = DeviceController.getDevicesByStatus(searchedDevices, Status.BOOTED);
44+
if (!device || device === null || !device.status) {
45+
device = DeviceController.filter(searchedDevices, { status: Status.BOOTED })[0];
4746
}
4847

4948
// In case reuse device is true but there weren't any booted devices. We need to fall back and boot new one.
5049
if (!device || device === null && args.reuseDevice) {
51-
device = DeviceController.getDevicesByStatus(searchedDevices, Status.SHUTDOWN);
50+
device = DeviceController.filter(searchedDevices, { status: Status.SHUTDOWN })[0];
5251
}
5352

5453
if (device.status === Status.SHUTDOWN) {
55-
await DeviceManager.startDevice(device);
54+
await DeviceController.startDevice(device);
5655
console.log("Started device: ", device);
5756
} else {
5857
console.log("Device is already started", device);
59-
if (!args.reuseDevice) {
58+
if (!args.reuseDevice && device.type !== DeviceType.EMULATOR && device.type !== DeviceType.SIMULATOR) {
59+
console.log("Since is it specified without reusing, the device would be shut down and restart!");
6060
DeviceController.kill(device);
61-
await DeviceManager.startDevice(device);
61+
await DeviceController.startDevice(device);
6262
}
6363
}
6464
}
6565

66-
if (!device || device === null) {
67-
device = DeviceController.getDefaultDevice(args);
68-
}
69-
70-
DeviceController._emulators.set(args.runType, device);
66+
DeviceManger._emulators.set(args.runType, device);
7167

7268
return device;
7369
}
7470

7571
public static async stop(args: INsCapabilities) {
76-
if (DeviceController._emulators.has(args.runType) && !args.reuseDevice && !args.isSauceLab && !args.ignoreDeviceController) {
77-
const device = DeviceController._emulators.get(args.runType);
78-
await DeviceManager.kill(device);
72+
if (DeviceManger._emulators.has(args.runType) && !args.reuseDevice && !args.isSauceLab && !args.ignoreDeviceController) {
73+
const device = DeviceManger._emulators.get(args.runType);
74+
await DeviceManger.kill(device);
7975
}
8076
}
8177

8278
public static async kill(device: IDevice) {
83-
await DeviceManager.kill(device);
79+
await DeviceController.kill(device);
8480
}
8581

8682

@@ -89,19 +85,19 @@ export class DeviceController {
8985
}
9086

9187
private static device(runType) {
92-
return DeviceController._emulators.get(runType);
88+
return DeviceManger._emulators.get(runType);
9389
}
9490

95-
private static getDevicesByStatus(devices: Array<IDevice>, status) {
96-
let device: IDevice;
97-
const shutdownDeivces = devices.filter(dev => {
98-
return dev.status === status;
99-
});
91+
// private static getDevicesByStatus(devices: Array<IDevice>, status) {
92+
// let device: IDevice;
93+
// const shutdownDeivces = devices.filter(dev => {
94+
// return dev.status === status;
95+
// });
10096

101-
if (shutdownDeivces && shutdownDeivces !== null && shutdownDeivces.length > 0) {
102-
device = shutdownDeivces[0];
103-
}
97+
// if (shutdownDeivces && shutdownDeivces !== null && shutdownDeivces.length > 0) {
98+
// device = shutdownDeivces[0];
99+
// }
104100

105-
return device;
106-
}
101+
// return device;
102+
// }
107103
}

‎lib/image-helper.ts‎

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,17 @@ import { INsCapabilities } from "./ins-capabilities";
44

55
export class ImageHelper {
66

7+
private _cropImageRec: { x: number, y: number, width: number, height: number };
8+
79
constructor(private _args: INsCapabilities) {
810
}
911

10-
private getOffsetPixels() {
11-
return this._args.device.config ? this._args.device.config.offsetPixels : 40; // TODO: iOS = 40
12+
get cropImageRec() {
13+
return this._cropImageRec;
14+
}
15+
16+
set cropImageRec(rect: { x: number, y: number, width: number, height: number }) {
17+
this._cropImageRec = rect;
1218
}
1319

1420
public imageOutputLimit() {
@@ -27,16 +33,12 @@ export class ImageHelper {
2733
return 20;
2834
}
2935

30-
public cropImageA() {
31-
return { x: 0, y: this.getOffsetPixels() };
32-
}
33-
34-
public cropImageB() {
35-
return { x: 0, y: this.getOffsetPixels() };
36+
private static getOffsetPixels(args: INsCapabilities) {
37+
return args.device.config ? args.device.config.offsetPixels : 0
3638
}
3739

38-
public verbose() {
39-
return false;
40+
public static cropImageDefaultParams(_args: INsCapabilities) {
41+
return { x: 0, y: ImageHelper.getOffsetPixels(_args)};
4042
}
4143

4244
private runDiff(diffOptions: blinkDiff, diffImage: string) {
@@ -65,17 +67,20 @@ export class ImageHelper {
6567
}
6668

6769
public compareImages(actual: string, expected: string, output: string, valueThreshold: number = this.threshold(), typeThreshold: any = ImageOptions.pixel) {
70+
const rectToCrop = this._cropImageRec || ImageHelper.cropImageDefaultParams(this._args);
6871
let diff = new blinkDiff({
72+
6973
imageAPath: actual,
7074
imageBPath: expected,
7175
imageOutputPath: output,
7276
imageOutputLimit: this.imageOutputLimit(),
7377
thresholdType: typeThreshold,
7478
threshold: valueThreshold,
7579
delta: this.delta(),
76-
cropImageA: this.cropImageA(),
77-
cropImageB: this.cropImageB(),
78-
verbose: this.verbose(),
80+
81+
cropImageA: rectToCrop,
82+
cropImageB: rectToCrop,
83+
verbose: this._args.verbose,
7984
});
8085

8186
return this.runDiff(diff, output);

‎lib/ns-capabilities.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@ export class NsCapabilities implements INsCapabilities {
6969
get emulatorOptions() { return (this._emulatorOptions || "-wipe-data -gpu on") }
7070

7171
private resolveAppPath() {
72-
7372
if (this._appPath) {
7473
this._appiumCaps.app = this._appPath;
7574
}

0 commit comments

Comments
 (0)