feat: add updatedWDABundleIdSuffix to handle bundle id for updatedWDABundleId with usePreinstalledWDA

lib/webdriveragent.js

@@ -70,6 +70,7 @@ class WebDriverAgent {
     this.wdaLaunchTimeout = args.wdaLaunchTimeout || WDA_LAUNCH_TIMEOUT;
     this.usePreinstalledWDA = args.usePreinstalledWDA;
     this.xctestApiClient = null;
+    this.doNotAddXctrunnerSuffix = args.doNotAddXctrunnerSuffix;
 
     this.xcodebuild = this.canSkipXcodebuild
     ? null
@@ -111,11 +112,17 @@ class WebDriverAgent {
   }
 
   /**
+   * Return bundle id for WebDriverAgent to launch the WDA.
+   * The primary usage is with 'this.usePreinstalledWDA'.
+   * It adds `.xctrunner` as suffix by default but 'this.doNotAddXctrunnerSuffix'
+   * lets skip it.
    *
    * @returns {string} Bundle ID for Xctest.
    */
   get bundleIdForXctest () {
-    return this.updatedWDABundleId ? `${this.updatedWDABundleId}.xctrunner` : WDA_RUNNER_BUNDLE_ID_FOR_XCTEST;
+    return this.updatedWDABundleId ?
+      `${this.updatedWDABundleId}${this.doNotAddXctrunnerSuffix ? '' : '.xctrunner'}`
+      : `${this.doNotAddXctrunnerSuffix ? WDA_RUNNER_BUNDLE_ID : WDA_RUNNER_BUNDLE_ID_FOR_XCTEST}`;
   }
 
   setWDAPaths (bootstrapPath, agentPath) {
@@ -449,7 +456,7 @@ class WebDriverAgent {
     const {wdaBundleId, testBundleId} = await this.prepareWDA();
     const env = {
       USE_PORT: this.wdaRemotePort,
-      WDA_PRODUCT_BUNDLE_IDENTIFIER: this.updatedWDABundleId,
+      WDA_PRODUCT_BUNDLE_IDENTIFIER: this.bundleIdForXctest,
     };
     if (this.mjpegServerPort) {
       env.MJPEG_SERVER_PORT = this.mjpegServerPort;

test/unit/webdriveragent-specs.js

@@ -340,3 +340,36 @@ describe('setupCaching()', function () {
     });
   });
 });
+
+
+describe('usePreinstalledWDA related functions', function () {
+  describe('bundleIdForXctest', function () {
+    it('should have xctrunner automatically', function () {
+      const args = Object.assign({}, fakeConstructorArgs);
+      args.updatedWDABundleId = 'io.appium.wda';
+      const agent = new WebDriverAgent({}, args);
+      agent.bundleIdForXctest.should.equal('io.appium.wda.xctrunner');
+    });
+
+    it('should have xctrunner automatically with default bundle id', function () {
+      const args = Object.assign({}, fakeConstructorArgs);
+      const agent = new WebDriverAgent({}, args);
+      agent.bundleIdForXctest.should.equal('com.facebook.WebDriverAgentRunner.xctrunner');
+    });
+
+    it('should not have xctrunner suffix', function () {
+      const args = Object.assign({}, fakeConstructorArgs);
+      args.updatedWDABundleId = 'io.appium.wda';
+      args.doNotAddXctrunnerSuffix = true;
+      const agent = new WebDriverAgent({}, args);
+      agent.bundleIdForXctest.should.equal('io.appium.wda');
+    });
+
+    it('should have xctrunner automatically with default bundle id', function () {
+      const args = Object.assign({}, fakeConstructorArgs);
+      args.doNotAddXctrunnerSuffix = true;
+      const agent = new WebDriverAgent({}, args);
+      agent.bundleIdForXctest.should.equal('com.facebook.WebDriverAgentRunner');
+    });
+  });
+});