How do I reset my app after each test?

[tking16]

Just updated my appium client from 2.2.2 to 2.4.1, my codebase has appium_extended.reset() (appium_extended is just a webdriver mixin I believe). After the update, the error I get is:

*** selenium.common.exceptions.WebDriverException: Message: An unknown server-side error occurred while processing the command. Original error: The reset API has been deprecated and is not supported anymore. Consider using corresponding 'mobile:' extensions to manage the state of the app under test.
Stacktrace:
UnknownError: An unknown server-side error occurred while processing the command. Original error: The reset API has been deprecated and is not supported anymore. Consider using corresponding 'mobile:' extensions to manage the state of the app under test.
    at getResponseForW3CError (/Users/theo.king/code/guacamole/testing/app-at/node_modules/@appium/base-driver/lib/protocol/errors.js:1118:9)
    at asyncHandler (/Users/theo.king/code/guacamole/testing/app-at/node_modules/@appium/base-driver/lib/protocol/protocol.js:491:57)

How do I reset the app now then? driver.execute_script("mobile:reset") doesn't seem to be a thing, as that's also giving an error:

NotImplementedError: Method is not implemented
    at XCUITestDriver.execute (/Users/theo.king/code/guacamole/testing/app-at/node_modules/appium-xcuitest-driver/lib/commands/execute.js:124:13)
    at commandExecutor (/Users/theo.king/code/guacamole/testing/app-at/node_modules/@appium/base-driver/lib/basedriver/driver.ts:106:18)
    at /Users/theo.king/code/guacamole/testing/app-at/node_modules/async-lock/lib/index.js:171:12
    at AsyncLock._promiseTry (/Users/theo.king/code/guacamole/testing/app-at/node_modules/async-lock/lib/index.js:306:31)
    at exec (/Users/theo.king/code/guacamole/testing/app-at/node_modules/async-lock/lib/index.js:170:9)
    at AsyncLock.acquire (/Users/theo.king/code/guacamole/testing/app-at/node_modules/async-lock/lib/index.js:189:3)
    at XCUITestDriver.executeCommand (/Users/theo.king/code/guacamole/testing/app-at/node_modules/@appium/base-driver/lib/basedriver/driver.ts:122:39)
    at processTicksAndRejections (node:internal/process/task_queues:95:5)
    at XCUITestDriver.executeCommand (/Users/theo.king/code/guacamole/testing/app-at/node_modules/appium-xcuitest-driver/lib/driver.js:1068:12)
    at defaultBehavior (/Users/theo.king/code/guacamole/testing/app-at/node_modules/appium/lib/appium.js:1109:14)
    at AppiumDriver.executeWrappedCommand (/Users/theo.king/code/guacamole/testing/app-at/node_modules/appium/lib/appium.js:1215:16)
    at AppiumDriver.executeCommand (/Users/theo.king/code/guacamole/testing/app-at/node_modules/appium/lib/appium.js:1121:17)
    at asyncHandler (/Users/theo.king/code/guacamole/testing/app-at/node_modules/@appium/base-driver/lib/protocol/protocol.js:393:19)

There must be a command to reset the app rather than using terminate_app and activate_app

[jlipps]

Use e.g. activateApp and terminateApp. Read through the docs for the driver you use to figure out which commands start and stop apps.

[KazuCocoa]

The "reset" could depend on the app under test, platform and what a test scenario wants to do. If you need to cleanup the app local data on Android, https://github.com/appium/appium-uiautomator2-driver?tab=readme-ov-file#mobile-clearapp would help. For iOS, the only way to remove the local data is to uninstall the app. activate/termina app as jlipps should work to reset the app process.

The previous reset in Appium was equivalent to re-create a session internally. So in case you'd like to keep the behavior, you can end the session and send a new session request.

[tking16]

Thanks @KazuCocoa, how is this function? Any improvements you can think of? I'll need to do an Android equivalent in the meantime

@pytest.fixture
def appium_extended_with_reset_at_test_end(appium_extended, is_last_test):
    yield appium_extended
    if not is_last_test:
        log.debug('Reset appium - as there is another test to perform')
        appium_extended.terminate_app('com.guacamole.development')
        appium_extended.remove_app('com.guacamole.development')
        appium_extended.install_app(appium_extended.capabilities['app'])
        appium_extended.activate_app('com.guacamole.development')

[KazuCocoa]

It looks good to me. The steps should work for both as same. For Android, instead of remove_app and install_app, you could replace them with mobile:cleanApp, which calls the pm clear command to remove the data local data. It is kind of optimization but I know of some devices reject the clear command itself by manufacture customization.

[kishore-89]

@KazuCocoa How can I use mobile:cleanApp in code? can you provide with example?

[KazuCocoa]

it depends on clients but all mobile: commands can be used like https://appium.io/docs/en/latest/guides/execute-methods/