appium-webdriveragent 16.3.0 → 16.5.0

package/lib/xcodebuild.ts

@@ -15,12 +15,17 @@ import type {
   XcodeBuildSettings,
   XcodeShowBuildSettingsEntry,
 } from './types.js';
-import {getWDAUpgradeTimestamp, isTvOS, setRealDeviceSecurity, setXctestrunFile} from './utils/index.js';
+import {
+  getPlatformSchemeSuffix,
+  getWDAUpgradeTimestamp,
+  isTvOS,
+  isWatchOS,
+  setRealDeviceSecurity,
+  setXctestrunFile,
+} from './utils/index.js';
 
 const DEFAULT_SIGNING_ID = 'iPhone Developer';
 const PREBUILD_DELAY = 0;
-const RUNNER_SCHEME_IOS = 'WebDriverAgentRunner';
-const LIB_SCHEME_IOS = 'WebDriverAgentLib';
 
 const ERROR_WRITING_ATTACHMENT = 'Error writing attachment data to file';
 const ERROR_COPYING_ATTACHMENT = 'Error copying testing attachment';
@@ -29,9 +34,6 @@ const IGNORED_ERRORS_PATTERN = new RegExp(
   '(' + IGNORED_ERRORS.map((errStr) => util.escapeRegExp(errStr)).join('|') + ')',
 );
 
-const RUNNER_SCHEME_TV = 'WebDriverAgentRunner_tvOS';
-const LIB_SCHEME_TV = 'WebDriverAgentLib_tvOS';
-
 const REAL_DEVICES_CONFIG_DOCS_LINK =
   'https://appium.github.io/appium-xcuitest-driver/latest/preparation/real-device-config/';
 
@@ -215,8 +217,9 @@ export class XcodeBuild {
    * Cleans both the library and runner schemes for the appropriate platform.
    */
   async cleanProject(): Promise<void> {
-    const libScheme = isTvOS(this.platformName || '') ? LIB_SCHEME_TV : LIB_SCHEME_IOS;
-    const runnerScheme = isTvOS(this.platformName || '') ? RUNNER_SCHEME_TV : RUNNER_SCHEME_IOS;
+    const schemeSuffix = getPlatformSchemeSuffix(this.platformName || '');
+    const libScheme = `WebDriverAgentLib${schemeSuffix}`;
+    const runnerScheme = `WebDriverAgentRunner${schemeSuffix}`;
 
     for (const scheme of [libScheme, runnerScheme]) {
       this.log.debug(
@@ -387,7 +390,7 @@ export class XcodeBuild {
     if (this.useXctestrunFile && this.xctestrunFilePath) {
       args.push('-xctestrun', this.xctestrunFilePath);
     } else {
-      const runnerScheme = isTvOS(this.platformName || '') ? RUNNER_SCHEME_TV : RUNNER_SCHEME_IOS;
+      const runnerScheme = `WebDriverAgentRunner${getPlatformSchemeSuffix(this.platformName || '')}`;
       args.push('-project', this.agentPath, '-scheme', runnerScheme);
       if (this.derivedDataPath) {
         args.push('-derivedDataPath', this.derivedDataPath);
@@ -397,9 +400,8 @@ export class XcodeBuild {
 
     const versionMatch = this.platformVersion ? new RegExp(/^(\d+)\.(\d+)/).exec(this.platformVersion) : null;
     if (versionMatch) {
-      args.push(
-        `${isTvOS(this.platformName || '') ? 'TV' : 'IPHONE'}OS_DEPLOYMENT_TARGET=${versionMatch[1]}.${versionMatch[2]}`,
-      );
+      const deploymentTargetPrefix = getDeploymentTargetPrefix(this.platformName || '');
+      args.push(`${deploymentTargetPrefix}OS_DEPLOYMENT_TARGET=${versionMatch[1]}.${versionMatch[2]}`);
     } else {
       this.log.warn(
         `Cannot parse major and minor version numbers from platformVersion "${this.platformVersion}". ` +
@@ -549,6 +551,19 @@ export class XcodeBuild {
   }
 }
 
+/**
+ * @returns The `xcodebuild` deployment target setting prefix for the given platform.
+ */
+function getDeploymentTargetPrefix(platformName: string): string {
+  if (isTvOS(platformName)) {
+    return 'TV';
+  }
+  if (isWatchOS(platformName)) {
+    return 'WATCH';
+  }
+  return 'IPHONE';
+}
+
 function buildSettingsArgsFromOptions(options?: RetrieveBuildSettingsOptions): string[] {
   const args: string[] = [];
   if (!options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "16.3.0",
+  "version": "16.5.0",
   "description": "Package bundling WebDriverAgent",
   "keywords": [
     "Appium",
@@ -56,9 +56,10 @@
     "version": "npm run sync-wda-version",
     "test": "node --enable-source-maps --experimental-test-module-mocks --test --test-timeout=60000 \"./build/test/unit/**/*.spec.js\"",
     "e2e-test": "node --enable-source-maps --test --test-force-exit --test-concurrency=1 --test-timeout=600000 \"./build/test/functional/**/*.spec.js\"",
-    "bundle": "npm run bundle:ios && npm run bundle:tv",
+    "bundle": "npm run bundle:ios && npm run bundle:tv && npm run bundle:watch",
     "bundle:ios": "TARGET=runner SDK=sim node ./Scripts/build-webdriveragent.mjs",
     "bundle:tv": "TARGET=tv_runner SDK=tv_sim node ./Scripts/build-webdriveragent.mjs",
+    "bundle:watch": "TARGET=watch_runner SDK=watch_sim node ./Scripts/build-webdriveragent.mjs",
     "fetch-prebuilt-wda": "node ./Scripts/fetch-prebuilt-wda.mjs",
     "sync-wda-version": "node ./Scripts/update-wda-version.mjs --package-version=${npm_package_version} && git add WebDriverAgentLib/Info.plist"
   },

package/WebDriverAgentTests/IntegrationTests_watchOS/WDASessionIntegrationTests.swift

@@ -1,72 +0,0 @@
-/**
- * Copyright (c) 2015-present, Facebook, Inc.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import XCTest
-
-/// Covers FBSessionCommands. Manages its own session lifecycle per test, since that's what's
-/// under test here, rather than using WDAWatchIntegrationTestCase.
-final class WDASessionIntegrationTests: XCTestCase {
-  let client = WDAWatchHTTPClient()
-
-  override func setUp() {
-    super.setUp()
-    continueAfterFailure = false
-  }
-
-  func testStatusIsReadyWithoutASession() throws {
-    let response = try client.get("/status")
-    XCTAssertEqual(response.statusCode, 200)
-    XCTAssertEqual(response.valueDict?["ready"] as? Bool, true)
-    XCTAssertEqual(response.valueDict?["state"] as? String, "success")
-  }
-
-  func testHealthCheck() throws {
-    let response = try client.get("/wda/healthcheck")
-    XCTAssertEqual(response.statusCode, 200)
-  }
-
-  func testCreateGetActiveAndDeleteSessionLifecycle() throws {
-    let createResponse = try client.post("/session", body: [
-      "capabilities": ["alwaysMatch": ["bundleId": WDAWatchIntegrationTestCase.integrationAppBundleId]]
-    ])
-    XCTAssertEqual(createResponse.statusCode, 200)
-    guard let sessionId = createResponse.valueDict?["sessionId"] as? String else {
-      return XCTFail("No sessionId in create-session response: \(String(describing: createResponse.json))")
-    }
-    XCTAssertFalse(sessionId.isEmpty)
-
-    let activeResponse = try client.get("/session/\(sessionId)")
-    XCTAssertEqual(activeResponse.statusCode, 200)
-    XCTAssertEqual(activeResponse.valueDict?["sessionId"] as? String, sessionId)
-
-    let deleteResponse = try client.delete("/session/\(sessionId)")
-    XCTAssertEqual(deleteResponse.statusCode, 200)
-  }
-
-  func testTimeoutsAndAppiumSettingsRoundTrip() throws {
-    let createResponse = try client.post("/session", body: [
-      "capabilities": ["alwaysMatch": ["bundleId": WDAWatchIntegrationTestCase.integrationAppBundleId]]
-    ])
-    guard let sessionId = createResponse.valueDict?["sessionId"] as? String else {
-      return XCTFail("No sessionId in create-session response")
-    }
-    defer { _ = try? client.delete("/session/\(sessionId)") }
-
-    let timeoutsResponse = try client.post("/session/\(sessionId)/timeouts", body: ["implicit": 500])
-    XCTAssertEqual(timeoutsResponse.statusCode, 200)
-
-    let getSettingsResponse = try client.get("/session/\(sessionId)/appium/settings")
-    XCTAssertEqual(getSettingsResponse.statusCode, 200)
-    XCTAssertNotNil(getSettingsResponse.valueDict)
-
-    let setSettingsResponse = try client.post("/session/\(sessionId)/appium/settings", body: [
-      "settings": ["shouldUseCompactResponses": false]
-    ])
-    XCTAssertEqual(setSettingsResponse.statusCode, 200)
-  }
-}

package/WebDriverAgentTests/IntegrationTests_watchOS/WDAUnknownCommandIntegrationTests.swift

@@ -1,24 +0,0 @@
-/**
- * Copyright (c) 2015-present, Facebook, Inc.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import XCTest
-
-/// Covers the catch-all 404 routes and the OPTIONS ping route - neither needs a session.
-final class WDAUnknownCommandIntegrationTests: XCTestCase {
-  let client = WDAWatchHTTPClient()
-
-  func testUnknownRouteReturnsAnError() throws {
-    let response = try client.get("/this/route/does/not/exist")
-    XCTAssertNotEqual(response.statusCode, 200)
-  }
-
-  func testPing() throws {
-    let response = try client.send("OPTIONS", "/anything")
-    XCTAssertEqual(response.statusCode, 200)
-  }
-}

package/WebDriverAgentTests/IntegrationTests_watchOS/WDAWatchHTTPClient.swift

@@ -1,95 +0,0 @@
-/**
- * Copyright (c) 2015-present, Facebook, Inc.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import Foundation
-
-/// Minimal synchronous JSON/HTTP client for driving the real WebDriverAgentRunner_watchOS
-/// server, the same way a real client (Appium, curl) would. Requires the server to already be
-/// running, e.g. via `xcodebuild test -scheme WebDriverAgentRunner_watchOS`.
-struct WDAWatchHTTPClient {
-  struct Response {
-    let statusCode: Int
-    let json: [String: Any]?
-
-    var value: Any? { json?["value"] }
-    var valueDict: [String: Any]? { value as? [String: Any] }
-    var valueString: String? { value as? String }
-  }
-
-  enum ClientError: Error, CustomStringConvertible {
-    case requestFailed(String)
-
-    var description: String {
-      switch self {
-      case .requestFailed(let message): return message
-      }
-    }
-  }
-
-  let baseURL: URL
-
-  init() {
-    let host = ProcessInfo.processInfo.environment["WDA_TEST_HOST"] ?? "127.0.0.1"
-    let port = ProcessInfo.processInfo.environment["WDA_TEST_PORT"] ?? "8100"
-    self.baseURL = URL(string: "http://\(host):\(port)")!
-  }
-
-  /// Splits path/query before resolving against baseURL - appendingPathComponent would
-  /// percent-encode a literal "?" instead of treating it as a query delimiter.
-  private func url(for path: String) -> URL {
-    let parts = path.split(separator: "?", maxSplits: 1)
-    var components = URLComponents(url: baseURL, resolvingAgainstBaseURL: false)!
-    components.path = components.path + parts[0]
-    if parts.count > 1 {
-      components.percentEncodedQuery = String(parts[1])
-    }
-    return components.url!
-  }
-
-  @discardableResult
-  func send(_ method: String, _ path: String, body: [String: Any]? = nil, timeout: TimeInterval = 20) throws -> Response {
-    var request = URLRequest(url: url(for: path))
-    request.httpMethod = method
-    request.timeoutInterval = timeout
-    if let body = body {
-      request.setValue("application/json", forHTTPHeaderField: "Content-Type")
-      request.httpBody = try JSONSerialization.data(withJSONObject: body)
-    }
-
-    let semaphore = DispatchSemaphore(value: 0)
-    var resultData: Data?
-    var resultResponse: URLResponse?
-    var resultError: Error?
-
-    URLSession.shared.dataTask(with: request) { data, response, error in
-      resultData = data
-      resultResponse = response
-      resultError = error
-      semaphore.signal()
-    }.resume()
-
-    if semaphore.wait(timeout: .now() + timeout + 5) == .timedOut {
-      throw ClientError.requestFailed("Request to \(method) \(path) timed out")
-    }
-    if let resultError = resultError {
-      throw ClientError.requestFailed("Request to \(method) \(path) failed: \(resultError)")
-    }
-    guard let httpResponse = resultResponse as? HTTPURLResponse else {
-      throw ClientError.requestFailed("Request to \(method) \(path) returned no HTTP response")
-    }
-    var json: [String: Any]?
-    if let resultData = resultData, !resultData.isEmpty {
-      json = try? JSONSerialization.jsonObject(with: resultData) as? [String: Any]
-    }
-    return Response(statusCode: httpResponse.statusCode, json: json)
-  }
-
-  func get(_ path: String) throws -> Response { try send("GET", path) }
-  func post(_ path: String, body: [String: Any] = [:]) throws -> Response { try send("POST", path, body: body) }
-  func delete(_ path: String) throws -> Response { try send("DELETE", path) }
-}

package/WebDriverAgentTests/IntegrationTests_watchOS/WDAWatchIntegrationTestCase.swift

@@ -1,61 +0,0 @@
-/**
- * Copyright (c) 2015-present, Facebook, Inc.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import XCTest
-
-/// Creates a fresh WDA session against IntegrationApp_watchOS per test, so each starts clean.
-class WDAWatchIntegrationTestCase: XCTestCase {
-  static let integrationAppBundleId = ProcessInfo.processInfo.environment["WDA_TEST_BUNDLE_ID"]
-    ?? "com.facebook.wda.IntegrationApp.watchOS"
-
-  let client = WDAWatchHTTPClient()
-  var sessionId: String!
-
-  override func setUp() {
-    super.setUp()
-    continueAfterFailure = false
-    do {
-      let response = try client.post("/session", body: [
-        "capabilities": ["alwaysMatch": ["bundleId": Self.integrationAppBundleId]]
-      ])
-      guard response.statusCode == 200, let sessionId = response.valueDict?["sessionId"] as? String else {
-        XCTFail("Failed to create session: \(String(describing: response.json))")
-        return
-      }
-      self.sessionId = sessionId
-    } catch {
-      XCTFail("Failed to create session: \(error)")
-    }
-  }
-
-  override func tearDown() {
-    if let sessionId = sessionId {
-      _ = try? client.delete("/session/\(sessionId)")
-    }
-    super.tearDown()
-  }
-
-  /// Finds an element by accessibility id and returns its WDA element UUID.
-  @discardableResult
-  func findElement(byAccessibilityId accessibilityId: String, file: StaticString = #filePath, line: UInt = #line) throws -> String {
-    let response = try client.post("/session/\(sessionId!)/element", body: [
-      "using": "accessibility id",
-      "value": accessibilityId,
-    ])
-    guard response.statusCode == 200, let elementId = response.valueDict?["ELEMENT"] as? String else {
-      XCTFail("Could not find element '\(accessibilityId)': \(String(describing: response.json))", file: file, line: line)
-      throw WDAWatchHTTPClient.ClientError.requestFailed("element not found")
-    }
-    return elementId
-  }
-
-  func attributeValue(_ elementId: String, _ name: String) throws -> String? {
-    let response = try client.get("/session/\(sessionId!)/element/\(elementId)/attribute/\(name)")
-    return response.valueString
-  }
-}