appium-webdriveragent 4.2.0 → 4.4.0

package/lib/xcodebuild.js

@@ -1,7 +1,7 @@
 import { retryInterval } from 'asyncbox';
 import { SubProcess, exec } from 'teen_process';
 import { fs, logger, timing } from '@appium/support';
-import log from './logger';
+import defaultLogger from './logger';
 import B from 'bluebird';
 import {
   setRealDeviceSecurity, generateXcodeConfigFile, setXctestrunFile,
@@ -33,10 +33,11 @@ const xcodeLog = logger.getLogger('Xcode');
 
 
 class XcodeBuild {
-  constructor (xcodeVersion, device, args = {}) {
+  constructor (xcodeVersion, device, args = {}, log = null) {
     this.xcodeVersion = xcodeVersion;
 
     this.device = device;
+    this.log = log ?? defaultLogger;
 
     this.realDevice = args.realDevice;
 
@@ -121,20 +122,20 @@ class XcodeBuild {
       try {
         ({stdout} = await exec('xcodebuild', ['-project', this.agentPath, '-showBuildSettings']));
       } catch (err) {
-        log.warn(`Cannot retrieve WDA build settings. Original error: ${err.message}`);
+        this.log.warn(`Cannot retrieve WDA build settings. Original error: ${err.message}`);
         return;
       }
 
       const pattern = /^\s*BUILD_DIR\s+=\s+(\/.*)/m;
       const match = pattern.exec(stdout);
       if (!match) {
-        log.warn(`Cannot parse WDA build dir from ${_.truncate(stdout, {length: 300})}`);
+        this.log.warn(`Cannot parse WDA build dir from ${_.truncate(stdout, {length: 300})}`);
         return;
       }
-      log.debug(`Parsed BUILD_DIR configuration value: '${match[1]}'`);
+      this.log.debug(`Parsed BUILD_DIR configuration value: '${match[1]}'`);
       // Derived data root is two levels higher over the build dir
       this.derivedDataPath = path.dirname(path.dirname(path.normalize(match[1])));
-      log.debug(`Got derived data root: '${this.derivedDataPath}'`);
+      this.log.debug(`Got derived data root: '${this.derivedDataPath}'`);
       return this.derivedDataPath;
     })();
     return await this._derivedDataPathPromise;
@@ -149,7 +150,7 @@ class XcodeBuild {
 
   async prebuild () {
     // first do a build phase
-    log.debug('Pre-building WDA before launching test');
+    this.log.debug('Pre-building WDA before launching test');
     this.usePrebuiltWDA = true;
     await this.start(true);
 
@@ -165,7 +166,7 @@ class XcodeBuild {
     const runnerScheme = tmpIsTvOS ? RUNNER_SCHEME_TV : RUNNER_SCHEME_IOS;
 
     for (const scheme of [libScheme, runnerScheme]) {
-      log.debug(`Cleaning the project scheme '${scheme}' to make sure there are no leftovers from previous installs`);
+      this.log.debug(`Cleaning the project scheme '${scheme}' to make sure there are no leftovers from previous installs`);
       await exec('xcodebuild', [
         'clean',
         '-project', this.agentPath,
@@ -216,12 +217,12 @@ class XcodeBuild {
     if (versionMatch) {
       args.push(`IPHONEOS_DEPLOYMENT_TARGET=${versionMatch[1]}.${versionMatch[2]}`);
     } else {
-      log.warn(`Cannot parse major and minor version numbers from platformVersion "${this.platformVersion}". ` +
+      this.log.warn(`Cannot parse major and minor version numbers from platformVersion "${this.platformVersion}". ` +
         'Will build for the default platform instead');
     }
 
     if (this.realDevice && this.xcodeConfigFile) {
-      log.debug(`Using Xcode configuration file: '${this.xcodeConfigFile}'`);
+      this.log.debug(`Using Xcode configuration file: '${this.xcodeConfigFile}'`);
       args.push('-xcconfig', this.xcodeConfigFile);
     }
 
@@ -248,8 +249,8 @@ class XcodeBuild {
     }
 
     const {cmd, args} = this.getCommand(buildOnly);
-    log.debug(`Beginning ${buildOnly ? 'build' : 'test'} with command '${cmd} ${args.join(' ')}' ` +
-              `in directory '${this.bootstrapPath}'`);
+    this.log.debug(`Beginning ${buildOnly ? 'build' : 'test'} with command '${cmd} ${args.join(' ')}' ` +
+      `in directory '${this.bootstrapPath}'`);
     const env = Object.assign({}, process.env, {
       USE_PORT: this.wdaRemotePort,
       WDA_PRODUCT_BUNDLE_IDENTIFIER: this.updatedWDABundleId || WDA_RUNNER_BUNDLE_ID,
@@ -273,7 +274,7 @@ class XcodeBuild {
     const logMsg = _.isBoolean(this.showXcodeLog)
       ? `Output from xcodebuild ${this.showXcodeLog ? 'will' : 'will not'} be logged`
       : 'Output from xcodebuild will only be logged if any errors are present there';
-    log.debug(`${logMsg}. To change this, use 'showXcodeLog' desired capability`);
+    this.log.debug(`${logMsg}. To change this, use 'showXcodeLog' desired capability`);
     xcodebuild.on('output', (stdout, stderr) => {
       let out = stdout || stderr;
       // we want to pull out the log file that is created, and highlight it
@@ -282,7 +283,7 @@ class XcodeBuild {
         // pull out the first line that begins with the path separator
         // which *should* be the line indicating the log file generated
         xcodebuild.logLocation = _.first(_.remove(out.trim().split('\n'), (v) => v.startsWith(path.sep)));
-        log.debug(`Log file for xcodebuild test: ${xcodebuild.logLocation}`);
+        xcodeLog.debug(`Log file for xcodebuild test: ${xcodebuild.logLocation}`);
       }
 
       // if we have an error we want to output the logs
@@ -319,7 +320,7 @@ class XcodeBuild {
     // any startup errors that are thrown as events
     return await new B((resolve, reject) => {
       this.xcodebuild.on('exit', async (code, signal) => {
-        log.error(`xcodebuild exited with code '${code}' and signal '${signal}'`);
+        xcodeLog.error(`xcodebuild exited with code '${code}' and signal '${signal}'`);
         // print out the xcodebuild file if users have asked for it
         if (this.showXcodeLog && this.xcodebuild.logLocation) {
           xcodeLog.error(`Contents of xcodebuild log file '${this.xcodebuild.logLocation}':`);
@@ -329,7 +330,7 @@ class XcodeBuild {
               xcodeLog.error(line);
             }
           } catch (err) {
-            log.error(`Unable to access xcodebuild log file: '${err.message}'`);
+            xcodeLog.error(`Unable to access xcodebuild log file: '${err.message}'`);
           }
         }
         this.xcodebuild.processExited = true;
@@ -353,7 +354,7 @@ class XcodeBuild {
           }
         } catch (err) {
           let msg = `Unable to start WebDriverAgent: ${err}`;
-          log.error(msg);
+          this.log.error(msg);
           reject(new Error(msg));
         }
       })();
@@ -362,7 +363,7 @@ class XcodeBuild {
 
   async waitForStart (timer) {
     // try to connect once every 0.5 seconds, until `launchTimeout` is up
-    log.debug(`Waiting up to ${this.launchTimeout}ms for WebDriverAgent to start`);
+    this.log.debug(`Waiting up to ${this.launchTimeout}ms for WebDriverAgent to start`);
     let currentStatus = null;
     try {
       let retries = parseInt(this.launchTimeout / 500, 10);
@@ -378,8 +379,8 @@ class XcodeBuild {
           if (currentStatus && currentStatus.ios && currentStatus.ios.ip) {
             this.agentUrl = currentStatus.ios.ip;
           }
-          log.debug(`WebDriverAgent information:`);
-          log.debug(JSON.stringify(currentStatus, null, 2));
+          this.log.debug(`WebDriverAgent information:`);
+          this.log.debug(JSON.stringify(currentStatus, null, 2));
         } catch (err) {
           throw new Error(`Unable to connect to running WebDriverAgent: ${err.message}`);
         } finally {
@@ -392,12 +393,12 @@ class XcodeBuild {
         return currentStatus;
       }
 
-      log.debug(`WebDriverAgent successfully started after ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`);
+      this.log.debug(`WebDriverAgent successfully started after ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`);
     } catch (err) {
       // at this point, if we have not had any errors from xcode itself (reported
       // elsewhere), we can let this go through and try to create the session
-      log.debug(err.message);
-      log.warn(`Getting status of WebDriverAgent on device timed out. Continuing`);
+      this.log.debug(err.message);
+      this.log.warn(`Getting status of WebDriverAgent on device timed out. Continuing`);
     }
     return currentStatus;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "4.2.0",
+  "version": "4.4.0",
   "description": "Package bundling WebDriverAgent",
   "main": "build/index.js",
   "scripts": {
@@ -59,7 +59,7 @@
     "sinon": "^13.0.0"
   },
   "dependencies": {
-    "@appium/base-driver": "^8.0.0",
+    "@appium/base-driver": "^8.3.0",
     "@appium/support": "^2.55.3",
     "@babel/runtime": "^7.0.0",
     "appium-ios-simulator": "^4.0.0",