feat: Remove Selendroid driver (appium#12964)

Author: imurchie

.gitignore

@@ -25,7 +25,6 @@ lib/devices/android/bootstrap/target/
 .*~
 *~
 org.eclipse.ltk.core.refactoring.prefs
-/selendroid
 .appiumconfig*
 build/
 .idea

README.md

@@ -30,7 +30,6 @@ specific information about how that driver works and how to set it up:
     * (BETA) The [Espresso Driver](/docs/en/drivers/android-espresso.md)
     * The [UiAutomator2 Driver](/docs/en/drivers/android-uiautomator2.md)
     * (DEPRECATED) The [UiAutomator Driver](/docs/en/drivers/android-uiautomator.md)
-    * (DEPRECATED) The [Selendroid Driver](/docs/en/drivers/android-selendroid.md)
 * The [Windows Driver](/docs/en/drivers/windows.md) (for Windows Desktop apps)
 * The [Mac Driver](/docs/en/drivers/mac.md) (for Mac Desktop apps)
 

docs/en/about-appium/intro.md

@@ -43,7 +43,6 @@ shipping**. The vendor-provided frameworks we use are:
 * iOS 9.3 and above: Apple's [XCUITest](https://developer.apple.com/reference/xctest)
 * iOS 9.3 and lower: Apple's [UIAutomation](https://web.archive.org/web/20160904214108/https://developer.apple.com/library/ios/documentation/DeveloperTools/Reference/UIAutomationRef/)
 * Android 4.2+: Google's [UiAutomator/UiAutomator2](https://developer.android.com/training/testing/ui-automator)
-* Android 2.3+: Google's [Instrumentation](http://developer.android.com/reference/android/app/Instrumentation.html). (Instrumentation support is provided by bundling a separate project, [Selendroid](http://selendroid.io))
 * Windows: Microsoft's [WinAppDriver](http://github.com/microsoft/winappdriver)
 
 We meet requirement #2 by wrapping the vendor-provided frameworks in one API,

docs/en/about-appium/platform-support.md

@@ -38,34 +38,29 @@ Android automation is supported with two drivers:
 
 * The [UiAutomator2 Driver](/docs/en/drivers/android-uiautomator2.md)
 * The (deprecated) [UiAutomator Driver](/docs/en/drivers/android-uiautomator.md)
-* The (deprecated) [Selendroid Driver](/docs/en/drivers/android-selendroid.md)
 
 Please refer to these driver docs for setup instructions.
 
-* Versions: 2.3 and up
-  * Versions 2.3 through 4.2 are supported via Appium's [Selendroid Driver](/docs/en/drivers/android-selendroid.md)
+* Versions: 4.2 and up
   * Versions 4.2 and up are supported via Appium's [UiAutomator and UiAutomator2](http://developer.android.com/tools/testing-support-library/index.html#UIAutomator)
       libraries. UiAutomator is the default driver.
 * Devices: Android emulators and real Android devices
 * Native app support: Yes
-* Mobile web support: Yes (but not when using Selendroid backend). Automation
+* Mobile web support: Yes. Automation
   is effected using a bundled [Chromedriver](https://code.google.com/p/selenium/wiki/ChromeDriver)
   server as a proxy. With 4.2 and 4.3, automation works on official Chrome
   browser or Chromium only. With 4.4+, automation also works on the built-in
   "Browser" app. Chrome/Chromium/Browser must already be installed on the
   device under test. See the [mobile web doc](/docs/en/writing-running-appium/web/mobile-web.md) for instructions.
 * Hybrid support: Yes. See the [hybrid doc](/docs/en/writing-running-appium/web/hybrid.md) for instructions.
   * With default Appium automation backend: versions 4.4 and up
-  * With Selendroid automation backend: versions 2.3 and up
-* Support for automating multiple apps in one session: Yes (but not when
-  using the Selendroid backend)
+* Support for automating multiple apps in one session: Yes
 * Support for automating multiple devices simultaneously: Yes,
   though Appium must be started using different ports for the server
-   parameters `--port`, `--bootstrap-port` (or `--selendroid-port`) and/or
+   parameters `--port`, `--bootstrap-port` and/or
   `--chromedriver-port`. See the [server args doc](/docs/en/writing-running-appium/server-args.md) for more
   information on these parameters.
-* Support for automating vendor-provided or third-party apps: Yes (but not
-  when using the Selendroid backend)
+* Support for automating vendor-provided or third-party apps: Yes
 * Support for automating custom, non-standard UI controls: No
 
 ### Windows Desktop Support

docs/en/contributing-to-appium/appium-from-source.md

@@ -91,7 +91,7 @@ Now your Appium instance is ready to go. Run `node .` to kick up the Appium serv
 
 To work on Android, make sure you have `ant`, `maven`, and `adb` installed
 and added to system `PATH` environment variable. Also you would need the
-android-16 sdk (for `Selendroid`) and android-19+ sdk installed.
+android-19+ sdk installed.
 From your local repo's command prompt, install/run the following:
 
 Set up Appium by running:

docs/en/contributing-to-appium/appium-packages.md

@@ -11,7 +11,7 @@
 - put logging together
   - mixture out of npmlog, winston and a custom logger
 - initiates AppiumDriver (extends Basedriver)
-  - assigns iOS/Android/Selendroid/Fake driver to session
+  - assigns iOS/Android/Fake driver to session
   - creates/deletes Appium session
 - starts baseServer (appium-express)
   - passes routes given by driver
@@ -144,7 +144,7 @@
 - allows to send json wire protocol commands to a server that understands it (browser drivers)
 - parses response into json
 - allows to proxy requests to a proxied server
-- used for communication in appium-chromedriver and appium-selendroid-driver
+- used for communication in appium-chromedriver
 
 ## appium-android-driver
 - similar to appium-ios-driver it can run as standalone server
@@ -183,26 +183,10 @@
 - command flow is like
   - appium-android-bootstrap:start -> appium-uiautomator:start -> appium-adb:install bootstrap
 
-## appium-selendroid-driver
-- similar to appium-android-driver it can run as standalone server
-- downloads and installs Selendroid using appium-selendroid-installer
-- contains several Selendroid specific logic to ensure a seamless integration
-- contains a more specific set of capability constraints
-- uses jsonwp-proxy to talk to the server
-- used appium-adb to enable commands not implemented in Selendroid
-
-## appium-selendroid-installer
-- contains and exports a setup logic to
-  - download Selendroid
-  - determine AndroidManifest location
-  - determine Server APK location
-  - extracting both files
-  - copying and cleaning files
-
 ## appium-android-ime
 - allows to send and receive unicode characters from/to the Android device
 - encodes text into UTF-7 sends it to the device and recodes it as Unicode
-- used by appium-android-driver and appium-selendroid-driver
+- used by appium-android-driver
 
 ## appium-doctor
 - diagnoses, reports and fixes common Node, iOS and Android configuration issues before starting Appium

docs/en/drivers/android-selendroid.md

@@ -12,7 +12,6 @@ repo.
 
 Older Android-based drivers include:
 * The [UiAutomator Driver](/docs/en/drivers/android-uiautomator.md)
-* The [Selendroid Driver](/docs/en/drivers/android-selendroid.md)
 
 ### Requirements and Support
 

docs/en/drivers/android-uiautomator2.md

@@ -38,7 +38,7 @@ These Capabilities span multiple drivers.
 
 |Capability|Description|Values|
 |----|-----------|-------|
-|`automationName`|Which automation engine to use|`Appium` (default) or `Selendroid` or `UiAutomator2` or `Espresso` for Android or `XCUITest` for iOS or `YouiEngine` for application built with You.i Engine|
+|`automationName`|Which automation engine to use|`Appium` (default) or `UiAutomator2` or `Espresso` for Android or `XCUITest` for iOS or `YouiEngine` for application built with You.i Engine|
 |`platformName`|Which mobile OS platform to use|`iOS`, `Android`, or `FirefoxOS`|
 |`platformVersion`|Mobile OS version|e.g., `7.1`, `4.4`|
 |`deviceName`|The kind of mobile device or emulator to use|`iPhone Simulator`, `iPad Simulator`, `iPhone Retina 4-inch`, `Android Emulator`, `Galaxy S4`, etc.... On iOS, this should be one of the valid devices returned by instruments with `instruments -s devices`. On Android this capability is currently ignored, though it remains required.|
@@ -105,9 +105,9 @@ These Capabilities are available only on Android-based drivers (like
 |`dontStopAppOnReset`| Doesn't stop the process of the app under test, before starting the app using adb. If the app under test is created by another anchor app, setting this false, allows the process of the anchor app to be still alive, during the start of the test app using adb. In other words, with `dontStopAppOnReset` set to `true`, we will not include the `-S` flag in the `adb shell am start` call. With this capability omitted or set to `false`, we include the `-S` flag. Default `false`| `true` or `false`|
 |`unicodeKeyboard`| Enable Unicode input, default `false`| `true` or `false`|
 |`resetKeyboard`| Reset keyboard to its original state, after running Unicode tests with `unicodeKeyboard` capability. Ignored if used alone. Default `false`| `true` or `false`|
-|`noSign`| Skip checking and signing of app with debug keys, will work only with UiAutomator and not with selendroid, default `false`| `true` or `false`|
+|`noSign`| Skip checking and signing of app with debug keys, will work only with UiAutomator, default `false`| `true` or `false`|
 |`ignoreUnimportantViews`| Calls the `setCompressedLayoutHierarchy()` uiautomator function. This capability can speed up test execution, since Accessibility commands will run faster ignoring some elements. The ignored elements will not be findable, which is why this capability has also been implemented as a toggle-able *setting* as well as a capability. Defaults to `false` | `true` or `false`
-|`disableAndroidWatchers`| Disables android watchers that watch for application not responding and application crash, this will reduce cpu usage on android device/emulator. This capability will work only with UiAutomator and not with selendroid, default `false`| `true` or `false`|
+|`disableAndroidWatchers`| Disables android watchers that watch for application not responding and application crash, this will reduce cpu usage on android device/emulator. This capability will work only with UiAutomator, default `false`| `true` or `false`|
 |`chromeOptions`| Allows passing chromeOptions capability for ChromeDriver. For more information see [chromeOptions](https://sites.google.com/a/chromium.org/chromedriver/capabilities) | `chromeOptions: {args: ['--disable-popup-blocking']}` |
 |`recreateChromeDriverSessions`| Kill ChromeDriver session when moving to a non-ChromeDriver webview. Defaults to `false` | `true` or `false`|
 |`nativeWebScreenshot`| In a web context, use native (adb) method for taking a screenshot, rather than proxying to ChromeDriver. Defaults to `false` | `true` or `false`|

docs/en/writing-running-appium/caps.md

@@ -193,81 +193,6 @@ capabilities and connect to the server running at port 4723 of localhost (or
 whatever host and port you specified when you started Appium). You should be
 all set now!
 
-### Running your test app with Appium (Android devices < 4.2, and hybrid tests)
-
-Android devices before version 4.2 (API Level 17) do not have Google's
-[UiAutomator framework](http://developer.android.com/tools/testing-support-library/index.html#UIAutomator)
-installed. This is what Appium uses to perform the automation behaviors on
-the device. For earlier devices or tests of hybrid (webview-based) apps,
-Appium comes bundled with another automation backend called [Selendroid]
-(http://selendroid.io/).
-
-To use Selendroid, all that is required is to slightly change the set of
-desired capabilities mentioned above, by adding the `automationName` capability
-and specifying the Selendroid automation backend. It is usually the case that you
-also need to use a `.` before your activity name (e.g., `.MainActivity` instead
-of `MainActivity` for your `appActivity` capability).
-
-```javascript
-// javascript
-{
-    automationName: 'Selendroid',
-    platformName: 'Android',
-    platformVersion: '2.3',
-    deviceName: 'Android Emulator',
-    app: myApp,
-    appPackage: 'com.mycompany.package',
-    appActivity: '.MainActivity'
-}
-```
-
-```python
-# python
-{
-    'automationName': 'Selendroid',
-    'platformName': 'Android',
-    'platformVersion': '2.3',
-    'deviceName': 'Android Emulator',
-    'app': myApp,
-    'appPackage': 'com.mycompany.package',
-    'appActivity': '.MainActivity'
-}
-```
-
-```php
-// php
-public static $browsers = array(
-    array(
-        'desiredCapabilities' => array(
-            'automationName' => 'Selendroid',
-            'platformName' => 'Android',
-            'platformVersion' => '2.3',
-            'deviceName' => 'Android Emulator',
-            'app' => $myApp,
-            'appPackage' => 'com.mycompany.package',
-            'appActivity'=> '.MainActivity'
-        )
-    )
-);
-```
-
-```java
-// java
-DesiredCapabilities capabilities = new DesiredCapabilities();
-capabilities.setCapability(MobileCapabilityType.AUTOMATION_NAME, "Selendroid");
-capabilities.setCapability(MobileCapabilityType.PLATFORM_NAME, "Android");
-capabilities.setCapability(MobileCapabilityType.PLATFORM_VERSION, "2.3");
-capabilities.setCapability(MobileCapabilityType.DEVICE_NAME, "Android Emulator");
-capabilities.setCapability(MobileCapabilityType.APP, myApp);
-capabilities.setCapability(MobileCapabilityType.APP_PACKAGE: "com.mycompany.package");
-capabilities.setCapability(MobileCapabilityType.APP_ACTIVITY: ".MainActivity");
-```
-
-Now Appium will start up a Selendroid test session instead of the default test
-session. One of the downsides to using Selendroid is that its API differs
-sometimes significantly with Appium's. Therefore we recommend you thoroughly
-read [Selendroid's documentation](http://selendroid.io/native.html) before
-writing your scripts for older devices or hybrid apps.
 
 ### Running your test app with Appium (Windows)
 

docs/en/writing-running-appium/running-tests.md

@@ -39,7 +39,6 @@ All flags are optional, but some are required in conjunction with certain others
 |`--nodeconfig`|null|Configuration JSON file to register appium with selenium grid|`--nodeconfig /abs/path/to/nodeconfig.json`|
 |`-ra`, `--robot-address`|0.0.0.0|IP Address of robot|`--robot-address 0.0.0.0`|
 |`-rp`, `--robot-port`|-1|port for robot|`--robot-port 4242`|
-|`--selendroid-port`|8080|Local port used for communication with Selendroid|`--selendroid-port 8080`|
 |`--chromedriver-port`|9515|Port upon which ChromeDriver will run|`--chromedriver-port 9515`|
 |`--chromedriver-executable`|null|ChromeDriver executable full path||
 |`--show-config`|false|Show info about the appium server configuration and exit||
@@ -58,7 +57,7 @@ All flags are optional, but some are required in conjunction with certain others
 |`-k`, `--keep-artifacts`|false|[DEPRECATED] - no effect, trace is now in tmp dir by default and is cleared before each run. Please also refer to the --trace-dir flag.||
 |`--platform-name`|null|[DEPRECATED] - Name of the mobile platform: iOS, Android, or FirefoxOS|`--platform-name iOS`|
 |`--platform-version`|null|[DEPRECATED] - Version of the mobile platform|`--platform-version 7.1`|
-|`--automation-name`|null|[DEPRECATED] - Name of the automation tool: Appium or Selendroid|`--automation-name Appium`|
+|`--automation-name`|null|[DEPRECATED] - Name of the automation tool: Appium, XCUITest, etc.|`--automation-name Appium`|
 |`--device-name`|null|[DEPRECATED] - Name of the mobile device to use|`--device-name iPhone Retina (4-inch), Android Emulator`|
 |`--browser-name`|null|[DEPRECATED] - Name of the mobile browser: Safari or Chrome|`--browser-name Safari`|
 |`--app`|null|[DEPRECATED] - IOS: abs path to simulator-compiled .app file or the bundle_id of the desired target on device; Android: abs path to .apk file|`--app /abs/path/to/my.app`|

docs/en/writing-running-appium/server-args.md

@@ -159,10 +159,7 @@ public function testThings()
 ### Automating hybrid Android apps
 
 Appium comes with [built-in hybrid support via Chromedriver](/docs/en/writing-running-appium/web/chromedriver.md),
-which allow the automation of any Chrome-backed Android web views. Appium also
-uses [Selendroid](http://selendroid.io/) under the hood for webview support on
-devices older than 4.4. (in which case you will need to specify
-`"automationName": "selendroid"` as a desired capability).
+which allow the automation of any Chrome-backed Android web views.
 
 There is an additional step necessary within your app build, unfortunately. As
 described in the Android [remote debugging docs](https://developers.google.com/web/tools/chrome-devtools/remote-debugging/webviews)

docs/en/writing-running-appium/web/hybrid.md

@@ -16,7 +16,6 @@ module.exports = {
       ['UIAutomator (Android)', 'android-uiautomator.md'],
       ['UIAutomator2 (Android)', 'android-uiautomator2.md'],
       ['Espresso (Android)', 'android-espresso.md'],
-      ['Selendroid (Android)', 'android-selendroid.md'],
       ['Windows', 'windows.md'],
       ['Mac', 'mac.md'],
     ]],
@@ -296,7 +295,6 @@ module.exports = {
       ['UIAutomator (Android)', 'android-uiautomator.md'],
       ['UIAutomator2 (Android)', 'android-uiautomator2.md'],
       ['Espresso (Android)', 'android-espresso.md'],
-      ['Selendroid (Android)', 'android-selendroid.md'],
       ['Windows', 'windows.md'],
       ['Mac', 'mac.md'],
     ]],

docs/toc.js

@@ -24,7 +24,6 @@ const PLATFORMS = {
 
 const AUTOMATION_NAMES = {
   APPIUM: 'Appium',
-  SELENDROID: 'Selendroid',
   UIAUTOMATOR2: 'UiAutomator2',
   UIAUTOMATOR1: 'UiAutomator1',
   XCUITEST: 'XCUITest',
@@ -37,10 +36,6 @@ const AUTOMATION_NAMES = {
   MAC: 'Mac',
 };
 const DRIVER_MAP = {
-  [AUTOMATION_NAMES.SELENDROID.toLowerCase()]: {
-    driverClassName: 'SelendroidDriver',
-    driverPackage: 'appium-selendroid-driver',
-  },
   [AUTOMATION_NAMES.UIAUTOMATOR2.toLowerCase()]: {
     driverClassName: 'AndroidUiautomator2Driver',
     driverPackage: 'appium-uiautomator2-driver',

lib/appium.js

@@ -197,7 +197,6 @@ function validateServerArgs (parser, args) {
     port: checkValidPort,
     callbackPort: checkValidPort,
     bootstrapPort: checkValidPort,
-    selendroidPort: checkValidPort,
     chromedriverPort: checkValidPort,
     robotPort: checkValidPort,
     backendRetries: (r) => { return r >= 0; }