appium-webdriveragent 16.1.3 → 16.1.5

package/WebDriverAgentTests/IntegrationApp_tvOS/ViewController.m

@@ -0,0 +1,79 @@
+/**
+ * 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 "ViewController.h"
+
+static NSInteger const FBGridSize = 3;
+static CGFloat const FBCellSide = 200;
+static CGFloat const FBCellSpacing = 60;
+
+@interface ViewController ()
+@property (nonatomic, strong) UILabel *lastSelectedLabel;
+@end
+
+@implementation ViewController
+
+- (void)viewDidLoad
+{
+  [super viewDidLoad];
+  self.view.backgroundColor = UIColor.whiteColor;
+
+  UIStackView *rows = [UIStackView new];
+  rows.axis = UILayoutConstraintAxisVertical;
+  rows.spacing = FBCellSpacing;
+  rows.alignment = UIStackViewAlignmentCenter;
+  rows.translatesAutoresizingMaskIntoConstraints = NO;
+  [self.view addSubview:rows];
+
+  for (NSInteger row = 0; row < FBGridSize; row++) {
+    UIStackView *columns = [UIStackView new];
+    columns.axis = UILayoutConstraintAxisHorizontal;
+    columns.spacing = FBCellSpacing;
+    for (NSInteger column = 0; column < FBGridSize; column++) {
+      UIButton *cell = [self newCellWithIdentifier:[NSString stringWithFormat:@"cell_%ld_%ld", (long)row, (long)column]];
+      [columns addArrangedSubview:cell];
+    }
+    [rows addArrangedSubview:columns];
+  }
+
+  UIButton *disabledButton = [self newCellWithIdentifier:@"disabledButton"];
+  disabledButton.enabled = NO;
+  [rows addArrangedSubview:disabledButton];
+
+  self.lastSelectedLabel = [UILabel new];
+  self.lastSelectedLabel.accessibilityIdentifier = @"lastSelectedLabel";
+  self.lastSelectedLabel.text = @"none";
+  self.lastSelectedLabel.translatesAutoresizingMaskIntoConstraints = NO;
+  [self.view addSubview:self.lastSelectedLabel];
+
+  [NSLayoutConstraint activateConstraints:@[
+    [rows.centerXAnchor constraintEqualToAnchor:self.view.centerXAnchor],
+    [rows.centerYAnchor constraintEqualToAnchor:self.view.centerYAnchor],
+    [self.lastSelectedLabel.centerXAnchor constraintEqualToAnchor:self.view.centerXAnchor],
+    [self.lastSelectedLabel.bottomAnchor constraintEqualToAnchor:self.view.bottomAnchor constant:-FBCellSpacing],
+  ]];
+}
+
+- (UIButton *)newCellWithIdentifier:(NSString *)identifier
+{
+  UIButton *cell = [UIButton buttonWithType:UIButtonTypeSystem];
+  cell.accessibilityIdentifier = identifier;
+  [cell setTitle:identifier forState:UIControlStateNormal];
+  cell.translatesAutoresizingMaskIntoConstraints = NO;
+  [cell.widthAnchor constraintEqualToConstant:FBCellSide].active = YES;
+  [cell.heightAnchor constraintEqualToConstant:FBCellSide].active = YES;
+  [cell addTarget:self action:@selector(didSelectCell:) forControlEvents:UIControlEventPrimaryActionTriggered];
+  return cell;
+}
+
+- (void)didSelectCell:(UIButton *)cell
+{
+  self.lastSelectedLabel.text = cell.accessibilityIdentifier;
+}
+
+@end

package/WebDriverAgentTests/IntegrationApp_tvOS/main.m

@@ -0,0 +1,17 @@
+/**
+ * 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 <UIKit/UIKit.h>
+
+#import "AppDelegate.h"
+
+int main(int argc, char * argv[]) {
+  @autoreleasepool {
+      return UIApplicationMain(argc, argv, nil, NSStringFromClass(AppDelegate.class));
+  }
+}

package/WebDriverAgentTests/IntegrationTests_tvOS/FBTVFocusIntegrationTests.m

@@ -0,0 +1,84 @@
+/**
+ * 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/XCTest.h>
+
+#if TARGET_OS_TV
+
+// `XCUIElement+FBTVFocuse` is a project-internal category (not exposed as a
+// Public framework header), so its two entry points are forward-declared
+// here rather than imported. The real implementation - the one this suite
+// exercises end to end against a live tvOS Simulator - is still the one
+// linked in from WebDriverAgentLib_tvOS.framework.
+@interface XCUIElement (FBTVFocuseForTesting)
+- (BOOL)fb_setFocusWithError:(NSError **)error;
+- (BOOL)fb_selectWithError:(NSError **)error;
+@end
+
+@interface FBTVFocusIntegrationTests : XCTestCase
+@property (nonatomic, strong) XCUIApplication *app;
+@end
+
+@implementation FBTVFocusIntegrationTests
+
+- (void)setUp
+{
+  [super setUp];
+  self.continueAfterFailure = NO;
+  self.app = [XCUIApplication new];
+  [self.app launch];
+  XCTAssertTrue([self.app.buttons[@"cell_0_0"] waitForExistenceWithTimeout:15]);
+}
+
+- (void)testSetFocusMovesFocusToADistantElement
+{
+  XCUIElement *target = self.app.buttons[@"cell_2_2"];
+  XCTAssertTrue(target.exists);
+  XCTAssertFalse(target.hasFocus);
+
+  NSError *error;
+  BOOL result = [target fb_setFocusWithError:&error];
+
+  XCTAssertTrue(result);
+  XCTAssertNil(error);
+  XCTAssertTrue(target.hasFocus);
+}
+
+- (void)testSelectMovesFocusAndTriggersTheElementsAction
+{
+  XCUIElement *target = self.app.buttons[@"cell_1_2"];
+  XCUIElement *statusLabel = self.app.staticTexts[@"lastSelectedLabel"];
+
+  NSError *error;
+  BOOL result = [target fb_selectWithError:&error];
+
+  XCTAssertTrue(result);
+  XCTAssertNil(error);
+  XCTAssertTrue(target.hasFocus);
+
+  NSPredicate *labelUpdated = [NSPredicate predicateWithFormat:@"label == %@", @"cell_1_2"];
+  XCTNSPredicateExpectation *expectation = [[XCTNSPredicateExpectation alloc] initWithPredicate:labelUpdated object:statusLabel];
+  [self waitForExpectations:@[expectation] timeout:5];
+}
+
+- (void)testSetFocusOnADisabledElementFails
+{
+  XCUIElement *disabled = self.app.buttons[@"disabledButton"];
+  XCTAssertTrue(disabled.exists);
+
+  NSError *error;
+  BOOL result = [disabled fb_setFocusWithError:&error];
+
+  XCTAssertFalse(result);
+  XCTAssertNotNil(error);
+  XCTAssertFalse(disabled.hasFocus);
+}
+
+@end
+
+#endif

package/WebDriverAgentTests/IntegrationTests_tvOS/Info.plist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>en</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>com.facebook.wda.integrationTests.tvOS</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>BNDL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+</dict>
+</plist>

package/WebDriverAgentTests/UnitTests_tvOS/Doubles/FBXCAccessibilityElementDouble.h

@@ -0,0 +1,27 @@
+/**
+ * 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/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ Minimal fake of the private `id<FBXCAccessibilityElement>` handle every
+ real snapshot carries, just enough for `FBElementUtils uidWithAccessibilityElement:`
+ to derive a stable, distinct `wdUID` per fake element id.
+ */
+@interface FBXCAccessibilityElementDouble : NSObject
+
+@property (nonatomic, readonly) id payload;
+@property (nonatomic, readonly) int processIdentifier;
+
+- (instancetype)initWithElementId:(unsigned long long)elementId;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/WebDriverAgentTests/UnitTests_tvOS/Doubles/FBXCAccessibilityElementDouble.m

@@ -0,0 +1,23 @@
+/**
+ * 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 "FBXCAccessibilityElementDouble.h"
+
+@implementation FBXCAccessibilityElementDouble
+
+- (instancetype)initWithElementId:(unsigned long long)elementId
+{
+  self = [super init];
+  if (self) {
+    _payload = @{@"uid.elementID": @(elementId)};
+    _processIdentifier = 1;
+  }
+  return self;
+}
+
+@end

package/WebDriverAgentTests/UnitTests_tvOS/Doubles/FBXCElementSnapshotDouble.h

@@ -0,0 +1,43 @@
+/**
+ * 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/Foundation.h>
+
+#import "FBXCAccessibilityElementDouble.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ Fake `id<FBXCElementSnapshot>` leaf node. Deliberately does NOT declare
+ formal conformance to the (large, mostly-unrelated) `FBXCElementSnapshot`
+ protocol - it only implements the selectors
+ `FBTVNavigationTracker`'s `-directionTowardsTargetFromFocusedElementSnapshot:`
+ actually reads: `frame`, `hasFocus` and `accessibilityElement` (the latter
+ indirectly, via `FBXCElementSnapshotWrapper.wdUID`). Cast to
+ `id<FBXCElementSnapshot>` at the call site. Lets tests supply a fake focused
+ element snapshot without a live app/device.
+ */
+@interface FBXCElementSnapshotDouble : NSObject
+
+@property (nonatomic, assign) CGRect frame;
+@property (nonatomic, assign) BOOL hasFocus;
+@property (nonatomic, strong, nullable) FBXCAccessibilityElementDouble *accessibilityElement;
+
+/**
+ @param elementId Fake AX element id, used to derive a distinct `wdUID`
+ @param frame The snapshot's frame
+ @param hasFocus Whether this node should report `hasFocus == YES`
+ @return A snapshot double
+ */
++ (instancetype)snapshotWithElementId:(unsigned long long)elementId
+                                 frame:(CGRect)frame
+                              hasFocus:(BOOL)hasFocus;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/WebDriverAgentTests/UnitTests_tvOS/Doubles/FBXCElementSnapshotDouble.m

@@ -0,0 +1,24 @@
+/**
+ * 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 "FBXCElementSnapshotDouble.h"
+
+@implementation FBXCElementSnapshotDouble
+
++ (instancetype)snapshotWithElementId:(unsigned long long)elementId
+                                 frame:(CGRect)frame
+                              hasFocus:(BOOL)hasFocus
+{
+  FBXCElementSnapshotDouble *snapshot = [self new];
+  snapshot.accessibilityElement = [[FBXCAccessibilityElementDouble alloc] initWithElementId:elementId];
+  snapshot.frame = frame;
+  snapshot.hasFocus = hasFocus;
+  return snapshot;
+}
+
+@end

package/WebDriverAgentTests/UnitTests_tvOS/FBTVNavigationTrackerTests.m

@@ -7,8 +7,10 @@
  */
 
 #import <XCTest/XCTest.h>
+#import <WebDriverAgentLib/FBXCElementSnapshot.h>
 
 #import "XCUIElementDouble.h"
+#import "FBXCElementSnapshotDouble.h"
 #import "FBTVNavigationTracker.h"
 #import "FBTVNavigationTracker-Private.h"
 
@@ -83,4 +85,50 @@
   XCTAssertEqual(FBTVDirectionNone, direction);
 }
 
+#pragma mark - directionTowardsTargetFromFocusedElementSnapshot:
+
+- (FBTVNavigationTracker *)trackerWithTargetFrame:(CGRect)targetFrame
+{
+  XCUIElementDouble *targetElement = XCUIElementDouble.new;
+  targetElement.wdFrame = targetFrame;
+  return [FBTVNavigationTracker trackerWithTargetElement:(XCUIElement *)targetElement];
+}
+
+- (void)testDirectionTowardsTargetFromFocusedElementSnapshotShouldPointRight
+{
+  // Target sits to the right of the currently focused element.
+  FBTVNavigationTracker *tracker = [self trackerWithTargetFrame:CGRectMake(100, 0, 0, 0)];
+  FBXCElementSnapshotDouble *focusedSnapshot = [FBXCElementSnapshotDouble snapshotWithElementId:1 frame:CGRectMake(0, 0, 0, 0) hasFocus:YES];
+
+  FBTVDirection direction = [tracker directionTowardsTargetFromFocusedElementSnapshot:(id<FBXCElementSnapshot>)focusedSnapshot];
+
+  XCTAssertEqual(FBTVDirectionRight, direction);
+}
+
+- (void)testDirectionTowardsTargetFromFocusedElementSnapshotShouldPointUp
+{
+  // Target sits above the currently focused element.
+  FBTVNavigationTracker *tracker = [self trackerWithTargetFrame:CGRectMake(0, -100, 0, 0)];
+  FBXCElementSnapshotDouble *focusedSnapshot = [FBXCElementSnapshotDouble snapshotWithElementId:1 frame:CGRectMake(0, 0, 0, 0) hasFocus:YES];
+
+  FBTVDirection direction = [tracker directionTowardsTargetFromFocusedElementSnapshot:(id<FBXCElementSnapshot>)focusedSnapshot];
+
+  XCTAssertEqual(FBTVDirectionUp, direction);
+}
+
+- (void)testDirectionTowardsTargetFromFocusedElementSnapshotShouldNotSuggestTheSameDirectionTwiceInARow
+{
+  // Same (unmoved) focused snapshot polled twice: the horizontal move gets
+  // suggested once, then withheld on the next call, per the "don't repeat a
+  // direction" bookkeeping in -directionWithItem:delta:positiveDirection:negativeDirection:.
+  FBTVNavigationTracker *tracker = [self trackerWithTargetFrame:CGRectMake(100, 0, 0, 0)];
+  FBXCElementSnapshotDouble *focusedSnapshot = [FBXCElementSnapshotDouble snapshotWithElementId:1 frame:CGRectMake(0, 0, 0, 0) hasFocus:YES];
+
+  FBTVDirection firstDirection = [tracker directionTowardsTargetFromFocusedElementSnapshot:(id<FBXCElementSnapshot>)focusedSnapshot];
+  XCTAssertEqual(FBTVDirectionRight, firstDirection);
+
+  FBTVDirection secondDirection = [tracker directionTowardsTargetFromFocusedElementSnapshot:(id<FBXCElementSnapshot>)focusedSnapshot];
+  XCTAssertEqual(FBTVDirectionNone, secondDirection);
+}
+
 @end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "16.1.3",
+  "version": "16.1.5",
   "description": "Package bundling WebDriverAgent",
   "keywords": [
     "Appium",