Only try to cleanup uiautomator process if instrumentation crashes #280
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,20 @@ | ||
| import _ from 'lodash'; | ||
| import { JWProxy } from 'appium-base-driver'; | ||
| import { waitForCondition } from 'asyncbox'; | ||
| import log from './logger'; | ||
| import { SERVER_APK_PATH as apkPath, TEST_APK_PATH as testApkPath, version as serverVersion } from 'appium-uiautomator2-server'; | ||
| import { util, logger } from 'appium-support'; | ||
| import B from 'bluebird'; | ||
|
|
||
|
|
||
| const REQD_PARAMS = ['adb', 'tmpDir', 'host', 'systemPort', 'devicePort', 'disableWindowAnimation']; | ||
| const SERVER_LAUNCH_TIMEOUT = 30000; | ||
| const SERVER_INSTALL_RETRIES = 20; | ||
| const SERVICES_LAUNCH_TIMEOUT = 30000; | ||
| const SERVER_PACKAGE_ID = 'io.appium.uiautomator2.server'; | ||
| const SERVER_TEST_PACKAGE_ID = `${SERVER_PACKAGE_ID}.test`; | ||
| const INSTRUMENTATION_TARGET = `${SERVER_TEST_PACKAGE_ID}/androidx.test.runner.AndroidJUnitRunner`; | ||
| const instrumentationLogger = logger.getLogger('Instrumentation'); | ||
|
|
||
| class UiAutomator2Server { | ||
| constructor (opts = {}) { | ||
|
|
@@ -26,11 +26,6 @@ class UiAutomator2Server { | |
| } | ||
| this.jwproxy = new JWProxy({server: this.host, port: this.systemPort}); | ||
| this.proxyReqRes = this.jwproxy.proxyReqRes.bind(this.jwproxy); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -64,7 +59,7 @@ class UiAutomator2Server { | |
| } | ||
|
|
||
| const appState = await this.adb.getApplicationInstallState(appPath, appId); | ||
| log.debug(`${appId} installation state: ${appState}`); | ||
| if (await this.adb.checkApkCert(appPath, appId)) { | ||
| shouldUninstallServerPackages = shouldUninstallServerPackages || [ | ||
| this.adb.APP_INSTALL_STATE.OLDER_VERSION_INSTALLED, | ||
|
|
@@ -80,16 +75,16 @@ class UiAutomator2Server { | |
| this.adb.APP_INSTALL_STATE.NOT_INSTALLED, | ||
| ].includes(appState); | ||
| } | ||
| log.info(`Server packages are ${shouldInstallServerPackages ? '' : 'not '}going to be (re)installed`); | ||
| if (shouldInstallServerPackages && shouldUninstallServerPackages) { | ||
| log.info('Full packages reinstall is going to be performed'); | ||
| } | ||
| for (const {appId, appPath} of packagesInfo) { | ||
| if (shouldUninstallServerPackages) { | ||
| try { | ||
| await this.adb.uninstallApk(appId); | ||
| } catch (err) { | ||
| log.warn(`Error uninstalling '${appId}': ${err.message}`); | ||
| } | ||
| } | ||
| if (shouldInstallServerPackages) { | ||
|
|
@@ -99,116 +94,181 @@ class UiAutomator2Server { | |
| }); | ||
| } | ||
| } | ||
|
|
||
| await this.verifyServicesAvailability(); | ||
| } | ||
|
|
||
| async verifyServicesAvailability () { | ||
| log.debug(`Waiting up to ${SERVICES_LAUNCH_TIMEOUT}ms for services to be available`); | ||
| let isPmServiceAvailable = false; | ||
| let isAmServiceAvailable = false; | ||
| let pmOutput = ''; | ||
| let pmError = null; | ||
| let amError = null; | ||
| try { | ||
| await waitForCondition(async () => { | ||
| if (!isPmServiceAvailable) { | ||
| pmError = null; | ||
| pmOutput = ''; | ||
| try { | ||
| pmOutput = await this.adb.shell(['pm', 'list', 'instrumentation']); | ||
| } catch (e) { | ||
| pmError = e; | ||
| } | ||
| if (pmOutput.includes('Could not access the Package Manager')) { | ||
| pmError = new Error(`Problem running Package Manager: ${pmOutput}`); | ||
| pmOutput = ''; // remove output, so it is not printed below | ||
| } else if (pmOutput.includes(INSTRUMENTATION_TARGET)) { | ||
| pmOutput = ''; // remove output, so it is not printed below | ||
| log.debug(`Instrumentation target '${INSTRUMENTATION_TARGET}' is available`); | ||
| isPmServiceAvailable = true; | ||
| } else if (!pmError) { | ||
| pmError = new Error('The instrumentation target is not listed by Package Manager'); | ||
| } | ||
| } | ||
| if (!isAmServiceAvailable) { | ||
| // https://travis-ci.org/appium/appium-uiautomator2-driver/jobs/478514097#L4806 | ||
| amError = null; | ||
| try { | ||
| await this.adb.shell(['am']); | ||
|
There was a problem hiding this comment. Is this command expected? I failed test cases in ruby_lib_core because of this line. The result of Should we ignore the error only the result is There was a problem hiding this comment. The result of command was: The exit status was |
||
| log.debug('Activity manager service is available'); | ||
| isAmServiceAvailable = true; | ||
| } catch (e) { | ||
| amError = e; | ||
| } | ||
| } | ||
| return isPmServiceAvailable && isAmServiceAvailable; | ||
| }, { | ||
| waitMs: SERVICES_LAUNCH_TIMEOUT, | ||
| intervalMs: 1000, | ||
| }); | ||
| } catch (err) { | ||
| if (!isPmServiceAvailable) { | ||
| log.error(`Unable to find instrumentation target '${INSTRUMENTATION_TARGET}': ${(pmError || {}).message}`); | ||
| if (pmOutput) { | ||
| log.debug('Available targets:'); | ||
| for (const line of pmOutput.split('\n')) { | ||
| log.debug(` ${line.replace('instrumentation:', '')}`); | ||
| } | ||
| } | ||
| } | ||
| if (!isAmServiceAvailable) { | ||
| log.error(`Activity manager service is not available`); | ||
| if (amError) { | ||
| log.debug(amError.message); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| async startSession (caps) { | ||
| await this.cleanupAutomationLeftovers(); | ||
| if (caps.skipServerInstallation) { | ||
| log.info(`'skipServerInstallation' is set. Attempting to use UIAutomator2 server from the device`); | ||
| } else { | ||
| log.info(`Starting UIAutomator2 server ${serverVersion}`); | ||
| log.info(`Using UIAutomator2 server from '${apkPath}' and test from '${testApkPath}'`); | ||
| } | ||
|
|
||
| const initStarted = process.hrtime(); | ||
| let retries = 0; | ||
| const maxRetries = 2; | ||
| const delayBetweenRetries = 3000; | ||
| while (retries < maxRetries) { | ||
| let didProcessExit = false; | ||
| await this.startInstrumentationProcess(() => { | ||
| didProcessExit = true; | ||
| }); | ||
| const timeout = caps.uiautomator2ServerLaunchTimeout || SERVER_LAUNCH_TIMEOUT; | ||
| log.info(`Waiting up to ${timeout}ms for UiAutomator2 to be online...`); | ||
| try { | ||
| await waitForCondition(async () => { | ||
| try { | ||
| await this.jwproxy.command('/status', 'GET'); | ||
| return true; | ||
| } catch (err) { | ||
| if (didProcessExit) { | ||
| // short circuit to retry or fail fast | ||
| return true; | ||
| } | ||
| return false; | ||
| } | ||
| }, { | ||
| waitMs: timeout, | ||
| intervalMs: 1000, | ||
| }); | ||
| } catch (err) { | ||
| log.errorAndThrow(`The instrumentation process cannot be initialized within ${timeout}ms timeout. ` | ||
| + 'Make sure the application under test does not crash and investigate the logcat output. ' | ||
| + `You could also try to increase the value of 'uiautomator2ServerLaunchTimeout' capability. `); | ||
| } | ||
| if (!didProcessExit) { | ||
| break; | ||
| } | ||
|
|
||
| retries++; | ||
| if (retries >= maxRetries) { | ||
| log.errorAndThrow('The instrumentation process cannot be initialized. ' | ||
| + 'Make sure the application under test does not crash and investigate the logcat output.'); | ||
| } | ||
| log.warn(`The instrumentation process has been unexpectedly terminated. ` | ||
| + `Retrying UiAutomator2 startup (#${retries} of ${maxRetries - 1})`); | ||
| await this.cleanupAutomationLeftovers(true); | ||
| await B.delay(delayBetweenRetries); | ||
| } | ||
|
|
||
| const [seconds, nanoseconds] = process.hrtime(initStarted); | ||
| log.debug(`The initialization of the instrumentation process took ` | ||
| + `${Math.ceil(seconds * 1000 + nanoseconds / 1000000)}ms`); | ||
| await this.jwproxy.command('/session', 'POST', {desiredCapabilities: caps}); | ||
| } | ||
|
|
||
| async startInstrumentationProcess (onExit = null) { | ||
| const cmd = ['am', 'instrument', '-w']; | ||
| if (this.disableWindowAnimation) { | ||
| cmd.push('--no-window-animation'); | ||
| } | ||
| cmd.push(INSTRUMENTATION_TARGET); | ||
| const instrumentationProcess = this.adb.createSubProcess(['shell', ...cmd]); | ||
| instrumentationProcess.on('output', (stdout, stderr) => { | ||
| const output = _.trim(stdout || stderr); | ||
| if (output) { | ||
| instrumentationLogger.debug(output); | ||
| } | ||
| }); | ||
| instrumentationProcess.on('exit', (code) => { | ||
| instrumentationLogger.debug(`The process has exited with code ${code}`); | ||
| if (_.isFunction(onExit)) { | ||
| onExit(); | ||
| } | ||
| }); | ||
| await instrumentationProcess.start(0); | ||
| } | ||
|
|
||
| async deleteSession () { | ||
| log.debug('Deleting UiAutomator2 server session'); | ||
| // rely on jwproxy's intelligence to know what we're talking about and | ||
| // delete the current session | ||
| try { | ||
| await this.jwproxy.command('/', 'DELETE'); | ||
| } catch (err) { | ||
| log.warn(`Did not get confirmation UiAutomator2 deleteSession worked; ` + | ||
| `Error was: ${err}`); | ||
| } | ||
| } | ||
|
|
||
| async cleanupAutomationLeftovers (strictCleanup = false) { | ||
| log.debug(`Performing ${strictCleanup ? 'strict' : 'shallow'} cleanup of automation leftovers`); | ||
| try { | ||
| await this.adb.forceStop(SERVER_TEST_PACKAGE_ID); | ||
| } catch (ignore) {} | ||
| if (!strictCleanup) { | ||
| return; | ||
| } | ||
| // https://github.com/appium/appium/issues/10749 | ||
| try { | ||
| await this.adb.killProcessesByName('uiautomator'); | ||
| } catch (ignore) {} | ||
| } | ||
| } | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍