@limrun/appium-xcuitest-driver 10.4.3-lim.1

package/lib/doctor/required-checks.ts

@@ -0,0 +1,120 @@
+import {fs, doctor} from 'appium/support';
+import {exec} from 'teen_process';
+import { getPath as getXcodePath } from '@limrun/appium-xcode';
+import type {IDoctorCheck, AppiumLogger, DoctorCheckResult} from '@appium/types';
+import '@colors/colors';
+
+
+export class XcodeCheck implements IDoctorCheck {
+  log!: AppiumLogger;
+
+  async diagnose(): Promise<DoctorCheckResult> {
+    try {
+      const xcodePath = await getXcodePath();
+      return doctor.ok(`Xcode is installed at '${xcodePath}'`);
+    } catch (err) {
+      return doctor.nok((err as Error).message);
+    }
+  }
+
+  async fix(): Promise<string> {
+    return `Install Xcode and make sure it is properly configured`;
+  }
+
+  hasAutofix(): boolean {
+    return false;
+  }
+
+  isOptional(): boolean {
+    return false;
+  }
+}
+export const xcodeCheck = new XcodeCheck();
+
+
+export class XcodeToolsCheck implements IDoctorCheck {
+  log!: AppiumLogger;
+
+  async diagnose(): Promise<DoctorCheckResult> {
+    const errPrefix = 'Xcode Command Line Tools are not installed or are improperly configured';
+    try {
+      await exec('xcodebuild', ['-version']);
+    } catch (err) {
+      return doctor.nok(`${errPrefix}. Cannot run 'xcodebuild': ${(err as any).stderr || (err as Error).message}`);
+    }
+    return doctor.ok(`Xcode Command Line Tools are installed and work properly`);
+  }
+
+  async fix(): Promise<string> {
+    return `Make sure to install Xcode Command Line Tools by running 'xcode-select --install'`;
+  }
+
+  hasAutofix(): boolean {
+    return false;
+  }
+
+  isOptional(): boolean {
+    return false;
+  }
+}
+export const xcodeToolsCheck = new XcodeToolsCheck();
+
+
+class EnvVarAndPathCheck implements IDoctorCheck {
+  log!: AppiumLogger;
+  static readonly ENVIRONMENT_VARS_TUTORIAL_URL = 'https://github.com/appium/java-client/blob/master/docs/environment.md';
+
+  constructor(
+    private readonly varName: string,
+    private readonly opts: EnvVarCheckOptions = {}
+  ) {}
+
+  async diagnose(): Promise<DoctorCheckResult> {
+    const varValue = process.env[this.varName];
+    if (!varValue) {
+      return doctor.nok(`${this.varName} environment variable is NOT set!`);
+    }
+
+    if (!await fs.exists(varValue)) {
+      const errMsg = `${this.varName} is set to '${varValue}' but this path does not exist!`;
+      return doctor.nok(errMsg);
+    }
+
+    const stat = await fs.stat(varValue);
+    if (this.opts.expectDir && !stat.isDirectory()) {
+      return doctor.nok(`${this.varName} is expected to be a valid folder, got a file path instead`);
+    }
+    if (this.opts.expectFile && stat.isDirectory()) {
+      return doctor.nok(`${this.varName} is expected to be a valid file, got a folder path instead`);
+    }
+
+    return doctor.ok(`${this.varName} is set to: ${varValue}`);
+  }
+
+  async fix(): Promise<string> {
+    return (
+      `Make sure the environment variable ${this.varName.bold} is properly configured for the Appium process. ` +
+      `Refer ${EnvVarAndPathCheck.ENVIRONMENT_VARS_TUTORIAL_URL} for more details.`
+    );
+  }
+
+  hasAutofix(): boolean {
+    return false;
+  }
+
+  isOptional(): boolean {
+    return false;
+  }
+}
+export const homeEnvVarCheck = new EnvVarAndPathCheck('HOME', {expectDir: true});
+
+export interface EnvVarCheckOptions {
+  /**
+   * If set to true then the path is expected to be a valid folder
+   */
+  expectDir?: boolean;
+  /**
+   * If set to true then the path is expected to be a valid file
+   */
+  expectFile?: boolean;
+}

package/lib/doctor/utils.ts

@@ -0,0 +1,18 @@
+import {fs} from 'appium/support';
+
+/**
+ * Return an executable path of cmd
+ *
+ * @param cmd Standard output by command
+ * @return The full path of cmd. `null` if the cmd is not found.
+ */
+export async function resolveExecutablePath(cmd: string): Promise<string | null> {
+  try {
+    const executablePath = await fs.which(cmd);
+    if (executablePath && (await fs.exists(executablePath))) {
+      return executablePath;
+    }
+  } catch {}
+  return null;
+}
+