feat: Add doctor checks (#711)

.github/workflows/functional-test.yml

@@ -66,6 +66,7 @@ jobs:
         pushd "$cwd"
         cd ~
         CHROMEDRIVER_VERSION="${{ matrix.chromedriverVersion }}" appium driver install --source=local "$cwd"
+        appium driver doctor uiautomator2
         nohup appium server \
           --port=$APPIUM_TEST_SERVER_PORT \
           --address=$APPIUM_TEST_SERVER_HOST \

README.md

@@ -28,6 +28,11 @@ On top of standard Appium requirements UiAutomator2 driver also expects the foll
 - Real Android devices must have [USB debugging enabled](https://developer.android.com/studio/debug/dev-options) and should be visible as `online` in `adb devices -l` output.
 - The minimum version of Android API must be 5.0 (API level 21) (6.0 is recommended as version 5 has some known compatibility issues).
 
+### Doctor
+
+Since driver version 2.39.0 you can automate the validation for the most of the above
+requirements as well as various optional ones needed by driver extensions by running the
+`appium driver doctor uiatomator2` server command.
 
 ## Capabilities
 

lib/doctor/optional-checks.js

@@ -0,0 +1,5 @@
+import { doctor } from 'appium-android-driver';
+
+export const optionalBundletoolCheck = doctor.optionalBundletoolCheck;
+export const optionalGstreamerCheck = doctor.optionalGstreamerCheck;
+export const optionalFfmpegCheck = doctor.optionalFfmpegCheck;

lib/doctor/required-checks.js

@@ -0,0 +1,6 @@
+import { doctor } from 'appium-android-driver';
+
+export const androidHomeCheck = doctor.androidHomeCheck;
+export const javaHomeCheck = doctor.javaHomeCheck;
+export const javaHomeValueCheck = doctor.javaHomeValueCheck;
+export const androidSdkCheck = doctor.androidSdkCheck;

package.json

@@ -63,7 +63,7 @@
   },
   "dependencies": {
     "appium-adb": "^11.0.1",
-    "appium-android-driver": "^7.4.0",
+    "appium-android-driver": "^7.5.1",
     "appium-chromedriver": "^5.6.5",
     "appium-uiautomator2-server": "^6.0.0",
     "asyncbox": "^3.0.0",
@@ -80,7 +80,7 @@
     "@appium/docutils": "^1.0.1",
     "@appium/eslint-config-appium": "^8.0.3",
     "@appium/eslint-config-appium-ts": "^0.x",
-    "@appium/support": "^4.0.1",
+    "@appium/support": "^4.2.0",
     "@appium/test-support": "^3.0.0",
     "@appium/tsconfig": "^0.x",
     "@appium/types": "^0.x",
@@ -132,7 +132,7 @@
     "xpath": "^0.x"
   },
   "peerDependencies": {
-    "appium": "^2.0.0"
+    "appium": "^2.4.1"
   },
   "engines": {
     "node": ">=14",
@@ -147,6 +147,12 @@
     "mainClass": "AndroidUiautomator2Driver",
     "scripts": {
       "reset": "scripts/reset.js"
+    },
+    "doctor": {
+      "checks": [
+        "./build/lib/doctor/required-checks.js",
+        "./build/lib/doctor/optional-checks.js"
+      ]
     }
   },
   "typedoc": {