Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Bump Eslint #781

Merged
merged 4 commits into from
Jan 5, 2025
Merged

feat: Bump Eslint #781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fad352a
chore: Bump @appium/eslint-config-appium-ts from 0.3.3 to 1.0.1
dependabot[bot] Jan 3, 2025
2f99e6a
feat: Bump Eslint
mykola-mokhnach Jan 4, 2025
ffc38d4
Fix tests
mykola-mokhnach Jan 4, 2025
cac5181
Address comments
mykola-mokhnach Jan 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .eslintignore
View file
Open in desktop

This file was deleted.

11 changes: 0 additions & 11 deletions .eslintrc.json
View file
Open in desktop

This file was deleted.

10 changes: 10 additions & 0 deletions eslint.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import appiumConfig from '@appium/eslint-config-appium-ts';

export default [
...appiumConfig,
{
ignores: [
'keys/**',
],
},
];
21 changes: 17 additions & 4 deletions index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,24 @@
import {install} from 'source-map-support';
install();

import {ADB} from './lib/adb';

export * from './lib/adb';
export type * from './lib/mixins';
export type * from './lib/tools';
// eslint-disable-next-line import/export
export {getAndroidBinaryPath} from './lib/tools/system-calls';
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This export looks a bit out of place in this file; maybe it could be moved back to ./lib/adb?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to make it more explicit

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps export * from './lib/adb'; is also suboptimal. We need to be explicit about what we export

export {getSdkRootFromEnv} from './lib/helpers';
// TODO: move public typedefs into a separate file
export type * from './lib/logcat';
export type * from './lib/options';
export type * from './lib/tools/adb-commands';
// eslint-disable-next-line import/export
export type * from './lib/tools/system-calls';
export type * from './lib/tools/adb-emu-commands';
export type * from './lib/tools/apk-signing';
export type * from './lib/tools/apk-utils';
export type * from './lib/tools/apks-utils';
export type * from './lib/tools/aab-utils';
export type * from './lib/tools/android-manifest';
export type * from './lib/tools/keyboard-commands';
export type * from './lib/tools/lockmgmt';

import {ADB} from './lib/adb';
export default ADB;
286 changes: 277 additions & 9 deletions lib/adb.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,30 @@
import _ from 'lodash';
import os from 'node:os';
import methods, {getAndroidBinaryPath} from './tools';
import {DEFAULT_ADB_EXEC_TIMEOUT, requireSdkRoot, getSdkRootFromEnv} from './helpers';
import {
DEFAULT_ADB_EXEC_TIMEOUT,
requireSdkRoot,
getSdkRootFromEnv
} from './helpers';
import log from './logger';
import type {ADBOptions, ADBExecutable} from './options';
import type { LogcatOpts } from './logcat';
import type { LogcatOpts, Logcat } from './logcat';
import type { LRUCache } from 'lru-cache';
import type { ExecError } from 'teen_process';
import type { StringRecord } from '@appium/types';
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Won't this require changing @appium/types from a dev dependency to a production dependency?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved to depenncies


const DEFAULT_ADB_PORT = 5037;
import * as generalMethods from './tools/adb-commands';
import * as manifestMethods from './tools/android-manifest';
import * as systemCallMethods from './tools/system-calls';
import * as apkSigningMethods from './tools/apk-signing';
import * as apkUtilsMethods from './tools/apk-utils';
import * as apksUtilsMethods from './tools/apks-utils';
import * as aabUtilsMethods from './tools/aab-utils';
import * as emuMethods from './tools/adb-emu-commands';
import * as lockManagementCommands from './tools/lockmgmt';
import * as keyboardCommands from './tools/keyboard-commands';


export const DEFAULT_ADB_PORT = 5037;
export const DEFAULT_OPTS = {
sdkRoot: getSdkRootFromEnv(),
executable: {path: 'adb', defaultArgs: []},
Expand All @@ -21,7 +37,7 @@ export const DEFAULT_OPTS = {
allowDelayAdb: true,
} as const;

export class ADB {
export class ADB implements ADBOptions {
adbHost?: string;
adbPort?: number;
_apiLevel: number|undefined;
Expand All @@ -35,7 +51,30 @@ export class ADB {
remoteAppsCache: LRUCache<string, string>|undefined;
_isLockManagementSupported: boolean|undefined;

sdkRoot?: string;
udid?: string;
appDeviceReadyTimeout?: number;
useKeystore?: boolean;
keystorePath?: string;
keystorePassword?: string;
keyAlias?: string;
keyPassword?: string;
executable: ADBExecutable;
tmpDir?: string;
curDeviceId?: string;
emulatorPort?: number;
logcat?: Logcat;
binaries?: StringRecord;
suppressKillServer?: boolean;
adbExecTimeout?: number;
remoteAppsCacheLimit?: number;
buildToolsVersion?: string;
allowOfflineDevices?: boolean;
allowDelayAdb?: boolean;
remoteAdbHost?: string;
remoteAdbPort?: number;
clearDeviceLogsOnStart?: boolean;

constructor(opts: ADBOptions = ({} as ADBOptions)) {
const options: ADBOptions = _.defaultsDeep(opts, _.cloneDeep(DEFAULT_OPTS));
_.defaultsDeep(this, options);
Expand Down Expand Up @@ -95,9 +134,238 @@ export class ADB {
}
return adb;
}
}

// add all the methods to the ADB prototype
Object.assign(ADB.prototype, methods);
// TODO: Group methods from general to corresponding modules
shellChunks = generalMethods.shellChunks;
getAdbWithCorrectAdbPath = generalMethods.getAdbWithCorrectAdbPath;
initAapt = generalMethods.initAapt;
initAapt2 = generalMethods.initAapt2;
initZipAlign = generalMethods.initZipAlign;
initBundletool = generalMethods.initBundletool;
getApiLevel = generalMethods.getApiLevel;
getPlatformVersion = generalMethods.getPlatformVersion;
isDeviceConnected = generalMethods.isDeviceConnected;
mkdir = generalMethods.mkdir;
isValidClass = generalMethods.isValidClass;
resolveLaunchableActivity = generalMethods.resolveLaunchableActivity;
forceStop = generalMethods.forceStop;
killPackage = generalMethods.killPackage;
clear = generalMethods.clear;
grantAllPermissions = generalMethods.grantAllPermissions;
grantPermissions = generalMethods.grantPermissions;
grantPermission = generalMethods.grantPermission;
revokePermission = generalMethods.revokePermission;
getGrantedPermissions = generalMethods.getGrantedPermissions;
getDeniedPermissions = generalMethods.getDeniedPermissions;
getReqPermissions = generalMethods.getReqPermissions;
getLocationProviders = generalMethods.getLocationProviders;
toggleGPSLocationProvider = generalMethods.toggleGPSLocationProvider;
setHiddenApiPolicy = generalMethods.setHiddenApiPolicy;
setDefaultHiddenApiPolicy = generalMethods.setDefaultHiddenApiPolicy;
stopAndClear = generalMethods.stopAndClear;
availableIMEs = generalMethods.availableIMEs;
enabledIMEs = generalMethods.enabledIMEs;
enableIME = generalMethods.enableIME;
disableIME = generalMethods.disableIME;
setIME = generalMethods.setIME;
defaultIME = generalMethods.defaultIME;
keyevent = generalMethods.keyevent;
inputText = generalMethods.inputText;
clearTextField = generalMethods.clearTextField;
lock = generalMethods.lock;
back = generalMethods.back;
goToHome = generalMethods.goToHome;
getAdbPath = generalMethods.getAdbPath;
getScreenOrientation = generalMethods.getScreenOrientation;
sendTelnetCommand = generalMethods.sendTelnetCommand;
isAirplaneModeOn = generalMethods.isAirplaneModeOn;
setAirplaneMode = generalMethods.setAirplaneMode;
setBluetoothOn = generalMethods.setBluetoothOn;
setNfcOn = generalMethods.setNfcOn;
broadcastAirplaneMode = generalMethods.broadcastAirplaneMode;
isWifiOn = generalMethods.isWifiOn;
isDataOn = generalMethods.isDataOn;
isAnimationOn = generalMethods.isAnimationOn;
setAnimationScale = generalMethods.setAnimationScale;
rimraf = generalMethods.rimraf;
push = generalMethods.push;
pull = generalMethods.pull;
processExists = generalMethods.processExists;
getForwardList = generalMethods.getForwardList;
forwardPort = generalMethods.forwardPort;
removePortForward = generalMethods.removePortForward;
getReverseList = generalMethods.getReverseList;
reversePort = generalMethods.reversePort;
removePortReverse = generalMethods.removePortReverse;
forwardAbstractPort = generalMethods.forwardAbstractPort;
ping = generalMethods.ping;
restart = generalMethods.restart;
startLogcat = generalMethods.startLogcat;
stopLogcat = generalMethods.stopLogcat;
getLogcatLogs = generalMethods.getLogcatLogs;
setLogcatListener = generalMethods.setLogcatListener;
removeLogcatListener = generalMethods.removeLogcatListener;
listProcessStatus = generalMethods.listProcessStatus;
getNameByPid = generalMethods.getNameByPid;
getPIDsByName = generalMethods.getPIDsByName;
killProcessesByName = generalMethods.killProcessesByName;
killProcessByPID = generalMethods.killProcessByPID;
broadcastProcessEnd = generalMethods.broadcastProcessEnd;
broadcast = generalMethods.broadcast;
getDeviceProperty = generalMethods.getDeviceProperty;
setDeviceProperty = generalMethods.setDeviceProperty;
getDeviceSysLanguage = generalMethods.getDeviceSysLanguage;
getDeviceSysCountry = generalMethods.getDeviceSysCountry;
getDeviceSysLocale = generalMethods.getDeviceSysLocale;
getDeviceProductLanguage = generalMethods.getDeviceProductLanguage;
getDeviceProductCountry = generalMethods.getDeviceProductCountry;
getDeviceProductLocale = generalMethods.getDeviceProductLocale;
getModel = generalMethods.getModel;
getManufacturer = generalMethods.getManufacturer;
getScreenSize = generalMethods.getScreenSize;
getScreenDensity = generalMethods.getScreenDensity;
setHttpProxy = generalMethods.setHttpProxy;
deleteHttpProxy = generalMethods.deleteHttpProxy;
setSetting = generalMethods.setSetting;
getSetting = generalMethods.getSetting;
bugreport = generalMethods.bugreport;
screenrecord = generalMethods.screenrecord;
runInImeContext = generalMethods.runInImeContext;
getTimeZone = generalMethods.getTimeZone;
listFeatures = generalMethods.listFeatures;
isStreamedInstallSupported = generalMethods.isStreamedInstallSupported;
isIncrementalInstallSupported = generalMethods.isIncrementalInstallSupported;
getDeviceIdleWhitelist = generalMethods.getDeviceIdleWhitelist;
addToDeviceIdleWhitelist = generalMethods.addToDeviceIdleWhitelist;
takeScreenshot = generalMethods.takeScreenshot;
setWifiState = generalMethods.setWifiState;
setDataState = generalMethods.setDataState;
listPorts = generalMethods.listPorts;

executeApksigner = apkSigningMethods.executeApksigner;
signWithDefaultCert = apkSigningMethods.signWithDefaultCert;
signWithCustomCert = apkSigningMethods.signWithCustomCert;
sign = apkSigningMethods.sign;
zipAlignApk = apkSigningMethods.zipAlignApk;
checkApkCert = apkSigningMethods.checkApkCert;
getKeystoreHash = apkSigningMethods.getKeystoreHash;

APP_INSTALL_STATE = apkUtilsMethods.APP_INSTALL_STATE;
isAppInstalled = apkUtilsMethods.isAppInstalled;
startUri = apkUtilsMethods.startUri;
startApp = apkUtilsMethods.startApp;
dumpWindows = apkUtilsMethods.dumpWindows;
getFocusedPackageAndActivity = apkUtilsMethods.getFocusedPackageAndActivity;
waitForActivityOrNot = apkUtilsMethods.waitForActivityOrNot;
waitForActivity = apkUtilsMethods.waitForActivity;
waitForNotActivity = apkUtilsMethods.waitForNotActivity;
uninstallApk = apkUtilsMethods.uninstallApk;
installFromDevicePath = apkUtilsMethods.installFromDevicePath;
cacheApk = apkUtilsMethods.cacheApk;
install = apkUtilsMethods.install;
getApplicationInstallState = apkUtilsMethods.getApplicationInstallState;
installOrUpgrade = apkUtilsMethods.installOrUpgrade;
extractStringsFromApk = apkUtilsMethods.extractStringsFromApk;
getDeviceLanguage = apkUtilsMethods.getDeviceLanguage;
getDeviceCountry = apkUtilsMethods.getDeviceCountry;
getDeviceLocale = apkUtilsMethods.getDeviceLocale;
ensureCurrentLocale = apkUtilsMethods.ensureCurrentLocale;
getApkInfo = apkUtilsMethods.getApkInfo;
getPackageInfo = apkUtilsMethods.getPackageInfo;
pullApk = apkUtilsMethods.pullApk;
activateApp = apkUtilsMethods.activateApp;

hideKeyboard = keyboardCommands.hideKeyboard;
isSoftKeyboardPresent = keyboardCommands.isSoftKeyboardPresent;

export {DEFAULT_ADB_PORT, getAndroidBinaryPath, getSdkRootFromEnv};
isLockManagementSupported = lockManagementCommands.isLockManagementSupported;
verifyLockCredential = lockManagementCommands.verifyLockCredential;
clearLockCredential = lockManagementCommands.clearLockCredential;
isLockEnabled = lockManagementCommands.isLockEnabled;
setLockCredential = lockManagementCommands.setLockCredential;
isScreenLocked = lockManagementCommands.isScreenLocked;
dismissKeyguard = lockManagementCommands.dismissKeyguard;
cycleWakeUp = lockManagementCommands.cycleWakeUp;

getSdkBinaryPath = systemCallMethods.getSdkBinaryPath;
getBinaryNameForOS = systemCallMethods.getBinaryNameForOS;
getBinaryFromSdkRoot = systemCallMethods.getBinaryFromSdkRoot;
getBinaryFromPath = systemCallMethods.getBinaryFromPath;
getConnectedDevices = systemCallMethods.getConnectedDevices;
getDevicesWithRetry = systemCallMethods.getDevicesWithRetry;
reconnect = systemCallMethods.reconnect;
restartAdb = systemCallMethods.restartAdb;
killServer = systemCallMethods.killServer;
resetTelnetAuthToken = systemCallMethods.resetTelnetAuthToken;
adbExecEmu = systemCallMethods.adbExecEmu;
EXEC_OUTPUT_FORMAT = systemCallMethods.EXEC_OUTPUT_FORMAT;
adbExec = systemCallMethods.adbExec;
shell = systemCallMethods.shell;
createSubProcess = systemCallMethods.createSubProcess;
getAdbServerPort = systemCallMethods.getAdbServerPort;
getEmulatorPort = systemCallMethods.getEmulatorPort;
getPortFromEmulatorString = systemCallMethods.getPortFromEmulatorString;
getConnectedEmulators = systemCallMethods.getConnectedEmulators;
setEmulatorPort = systemCallMethods.setEmulatorPort;
setDeviceId = systemCallMethods.setDeviceId;
setDevice = systemCallMethods.setDevice;
getRunningAVD = systemCallMethods.getRunningAVD;
getRunningAVDWithRetry = systemCallMethods.getRunningAVDWithRetry;
killAllEmulators = systemCallMethods.killAllEmulators;
killEmulator = systemCallMethods.killEmulator;
launchAVD = systemCallMethods.launchAVD;
getVersion = systemCallMethods.getVersion;
waitForEmulatorReady = systemCallMethods.waitForEmulatorReady;
waitForDevice = systemCallMethods.waitForDevice;
reboot = systemCallMethods.reboot;
changeUserPrivileges = systemCallMethods.changeUserPrivileges;
root = systemCallMethods.root;
unroot = systemCallMethods.unroot;
isRoot = systemCallMethods.isRoot;
fileExists = systemCallMethods.fileExists;
ls = systemCallMethods.ls;
fileSize = systemCallMethods.fileSize;
installMitmCertificate = systemCallMethods.installMitmCertificate;
isMitmCertificateInstalled = systemCallMethods.isMitmCertificateInstalled;

execBundletool = apksUtilsMethods.execBundletool;
getDeviceSpec = apksUtilsMethods.getDeviceSpec;
installMultipleApks = apksUtilsMethods.installMultipleApks;
installApks = apksUtilsMethods.installApks;
extractBaseApk = apksUtilsMethods.extractBaseApk;
extractLanguageApk = apksUtilsMethods.extractLanguageApk;
isTestPackageOnlyError = apksUtilsMethods.isTestPackageOnlyError;

packageAndLaunchActivityFromManifest = manifestMethods.packageAndLaunchActivityFromManifest;
targetSdkVersionFromManifest = manifestMethods.targetSdkVersionFromManifest;
targetSdkVersionUsingPKG = manifestMethods.targetSdkVersionUsingPKG;
compileManifest = manifestMethods.compileManifest;
insertManifest = manifestMethods.insertManifest;
hasInternetPermissionFromManifest = manifestMethods.hasInternetPermissionFromManifest;

extractUniversalApk = aabUtilsMethods.extractUniversalApk;

isEmulatorConnected = emuMethods.isEmulatorConnected;
verifyEmulatorConnected = emuMethods.verifyEmulatorConnected;
fingerprint = emuMethods.fingerprint;
rotate = emuMethods.rotate;
powerAC = emuMethods.powerAC;
sensorSet = emuMethods.sensorSet;
powerCapacity = emuMethods.powerCapacity;
powerOFF = emuMethods.powerOFF;
sendSMS = emuMethods.sendSMS;
gsmCall = emuMethods.gsmCall;
gsmSignal = emuMethods.gsmSignal;
gsmVoice = emuMethods.gsmVoice;
networkSpeed = emuMethods.networkSpeed;
execEmuConsoleCommand = emuMethods.execEmuConsoleCommand;
getEmuVersionInfo = emuMethods.getEmuVersionInfo;
getEmuImageProperties = emuMethods.getEmuImageProperties;
checkAvdExist = emuMethods.checkAvdExist;
POWER_AC_STATES = emuMethods.POWER_AC_STATES;
GSM_CALL_ACTIONS = emuMethods.GSM_CALL_ACTIONS;
GSM_VOICE_STATES = emuMethods.GSM_VOICE_STATES;
GSM_SIGNAL_STRENGTHS = emuMethods.GSM_SIGNAL_STRENGTHS;
NETWORK_SPEED = emuMethods.NETWORK_SPEED;
SENSORS = emuMethods.SENSORS;
}
Loading
Loading