main_test.dart 24.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:async';
import 'dart:convert';

import 'package:android_semantics_testing/android_semantics_testing.dart';
import 'package:android_semantics_testing/main.dart' as app;
import 'package:android_semantics_testing/test_constants.dart';
import 'package:flutter/scheduler.dart';
import 'package:flutter/services.dart';
import 'package:flutter/widgets.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:integration_test/integration_test.dart';

// The accessibility focus actions are added when a semantics node receives or
// lose accessibility focus. This test ignores these actions since it is hard to
// predict which node has the accessibility focus after a screen changes.
const List<AndroidSemanticsAction> ignoredAccessibilityFocusActions = <AndroidSemanticsAction>[
  AndroidSemanticsAction.accessibilityFocus,
  AndroidSemanticsAction.clearAccessibilityFocus,
];

const MethodChannel kSemanticsChannel = MethodChannel('semantics');

Future<void> setClipboard(String message) async {
  final Completer<void> completer = Completer<void>();
  Future<void> completeSetClipboard([Object? _]) async {
    await kSemanticsChannel.invokeMethod<dynamic>('setClipboard', <String, dynamic>{
      'message': message,
    });
    completer.complete();
  }
  if (SchedulerBinding.instance.hasScheduledFrame) {
    SchedulerBinding.instance.addPostFrameCallback(completeSetClipboard);
  } else {
    completeSetClipboard();
  }
  await completer.future;
}

Future<AndroidSemanticsNode> getSemantics(Finder finder, WidgetTester tester) async {
  final int id = tester.getSemantics(finder).id;
  final Completer<String> completer = Completer<String>();
  Future<void> completeSemantics([Object? _]) async {
    final dynamic result = await kSemanticsChannel.invokeMethod<dynamic>('getSemanticsNode', <String, dynamic>{
      'id': id,
    });
    completer.complete(json.encode(result));
  }
  if (SchedulerBinding.instance.hasScheduledFrame) {
    SchedulerBinding.instance.addPostFrameCallback(completeSemantics);
  } else {
    completeSemantics();
  }
  return AndroidSemanticsNode.deserialize(await completer.future);
}

Future<void> main() async {
  IntegrationTestWidgetsFlutterBinding.ensureInitialized();

  group('AccessibilityBridge', () {
    group('TextField', () {
      Future<void> prepareTextField(WidgetTester tester) async {
        app.main();
        await tester.pumpAndSettle();
        await tester.tap(find.text(textFieldRoute));
        await tester.pumpAndSettle();

        // The text selection menu and related semantics vary depending on if
        // the clipboard contents are pasteable. Copy some text into the
        // clipboard to make sure these tests always run with pasteable content
        // in the clipboard.
        // Ideally this should test the case where there is nothing on the
        // clipboard as well, but there is no reliable way to clear the
        // clipboard on Android devices.
        await setClipboard('Hello World');
        await tester.pumpAndSettle();
      }

      testWidgets('TextField has correct Android semantics', (WidgetTester tester) async {
        final Finder normalTextField = find.descendant(
          of: find.byKey(const ValueKey<String>(normalTextFieldKeyValue)),
          matching: find.byType(EditableText),
        );

        await prepareTextField(tester);
        expect(
          await getSemantics(normalTextField, tester),
          hasAndroidSemantics(
            className: AndroidClassName.editText,
            isEditable: true,
            isFocusable: true,
            isFocused: false,
            isPassword: false,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
            ],
            // We can't predict the a11y focus when the screen changes.
            ignoredActions: ignoredAccessibilityFocusActions,
          ),
        );
        await tester.tap(normalTextField);
        await tester.pumpAndSettle();

        expect(
          await getSemantics(normalTextField, tester),
          hasAndroidSemantics(
            className: AndroidClassName.editText,
            isFocusable: true,
            isFocused: true,
            isEditable: true,
            isPassword: false,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
              AndroidSemanticsAction.paste,
              AndroidSemanticsAction.setSelection,
              AndroidSemanticsAction.setText,
            ],
            // We can't predict the a11y focus when the screen changes.
            ignoredActions: ignoredAccessibilityFocusActions,
          ),
        );

        await tester.enterText(normalTextField, 'hello world');
        await tester.pumpAndSettle();

        expect(
          await getSemantics(normalTextField, tester),
          hasAndroidSemantics(
            text: 'hello world',
            className: AndroidClassName.editText,
            isFocusable: true,
            isFocused: true,
            isEditable: true,
            isPassword: false,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
              AndroidSemanticsAction.paste,
              AndroidSemanticsAction.setSelection,
              AndroidSemanticsAction.setText,
              AndroidSemanticsAction.previousAtMovementGranularity,
            ],
            // We can't predict the a11y focus when the screen changes.
            ignoredActions: ignoredAccessibilityFocusActions,
          ),
        );
      }, timeout: Timeout.none);

      testWidgets('password TextField has correct Android semantics', (WidgetTester tester) async {
        final Finder passwordTextField = find.descendant(
          of: find.byKey(const ValueKey<String>(passwordTextFieldKeyValue)),
          matching: find.byType(EditableText),
        );

        await prepareTextField(tester);
        expect(
          await getSemantics(passwordTextField, tester),
          hasAndroidSemantics(
            className: AndroidClassName.editText,
            isEditable: true,
            isFocusable: true,
            isFocused: false,
            isPassword: true,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
            ],
            // We can't predict the a11y focus when the screen changes.
            ignoredActions: ignoredAccessibilityFocusActions,
          ),
        );

        await tester.tap(passwordTextField);
        await tester.pumpAndSettle();

        expect(
          await getSemantics(passwordTextField, tester),
          hasAndroidSemantics(
            className: AndroidClassName.editText,
            isFocusable: true,
            isFocused: true,
            isEditable: true,
            isPassword: true,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
              AndroidSemanticsAction.paste,
              AndroidSemanticsAction.setSelection,
              AndroidSemanticsAction.setText,
            ],
            // We can't predict the a11y focus when the screen changes.
            ignoredActions: ignoredAccessibilityFocusActions,
          ),
        );

        await tester.enterText(passwordTextField, 'hello world');
        await tester.pumpAndSettle();

        expect(
          await getSemantics(passwordTextField, tester),
          hasAndroidSemantics(
            text: '\u{2022}' * ('hello world'.length),
            className: AndroidClassName.editText,
            isFocusable: true,
            isFocused: true,
            isEditable: true,
            isPassword: true,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
              AndroidSemanticsAction.paste,
              AndroidSemanticsAction.setSelection,
              AndroidSemanticsAction.setText,
              AndroidSemanticsAction.previousAtMovementGranularity,
            ],
            // We can't predict the a11y focus when the screen changes.
            ignoredActions: ignoredAccessibilityFocusActions,
          ),
        );
      }, timeout: Timeout.none);
    });

    group('SelectionControls', () {
      Future<void> prepareSelectionControls(WidgetTester tester) async {
        app.main();
        await tester.pumpAndSettle();
        await tester.tap(find.text(selectionControlsRoute));
        await tester.pumpAndSettle();
      }

      testWidgets('Checkbox has correct Android semantics', (WidgetTester tester) async {
        final Finder checkbox = find.byKey(const ValueKey<String>(checkboxKeyValue));
        final Finder disabledCheckbox = find.byKey(const ValueKey<String>(disabledCheckboxKeyValue));

        await prepareSelectionControls(tester);
        expect(
          await getSemantics(checkbox, tester),
          hasAndroidSemantics(
            className: AndroidClassName.checkBox,
            isChecked: false,
            isCheckable: true,
            isEnabled: true,
            isFocusable: true,
            ignoredActions: ignoredAccessibilityFocusActions,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
            ],
          ),
        );

        await tester.tap(checkbox);
        await tester.pumpAndSettle();

        expect(
          await getSemantics(checkbox, tester),
          hasAndroidSemantics(
            className: AndroidClassName.checkBox,
            isChecked: true,
            isCheckable: true,
            isEnabled: true,
            isFocusable: true,
            ignoredActions: ignoredAccessibilityFocusActions,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
            ],
          ),
        );
        expect(
          await getSemantics(disabledCheckbox, tester),
          hasAndroidSemantics(
            className: AndroidClassName.checkBox,
            isCheckable: true,
            isEnabled: false,
            ignoredActions: ignoredAccessibilityFocusActions,
            actions: const <AndroidSemanticsAction>[],
          ),
        );
      }, timeout: Timeout.none);

      testWidgets('Radio has correct Android semantics', (WidgetTester tester) async {
        final Finder radio = find.byKey(const ValueKey<String>(radio2KeyValue));

        await prepareSelectionControls(tester);
        expect(
          await getSemantics(radio, tester),
          hasAndroidSemantics(
            className: AndroidClassName.radio,
            isChecked: false,
            isCheckable: true,
            isEnabled: true,
            isFocusable: true,
            ignoredActions: ignoredAccessibilityFocusActions,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
            ],
          ),
        );

        await tester.tap(radio);
        await tester.pumpAndSettle();

        expect(
          await getSemantics(radio, tester),
          hasAndroidSemantics(
            className: AndroidClassName.radio,
            isChecked: true,
            isCheckable: true,
            isEnabled: true,
            isFocusable: true,
            ignoredActions: ignoredAccessibilityFocusActions,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
            ],
          ),
        );
      }, timeout: Timeout.none);

      testWidgets('Switch has correct Android semantics', (WidgetTester tester) async {
        final Finder switchFinder = find.byKey(const ValueKey<String>(switchKeyValue));

        await prepareSelectionControls(tester);
        expect(
          await getSemantics(switchFinder, tester),
          hasAndroidSemantics(
            className: AndroidClassName.toggleSwitch,
            isChecked: false,
            isCheckable: true,
            isEnabled: true,
            isFocusable: true,
            ignoredActions: ignoredAccessibilityFocusActions,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
            ],
          ),
        );

        await tester.tap(switchFinder);
        await tester.pumpAndSettle();

        expect(
          await getSemantics(switchFinder, tester),
          hasAndroidSemantics(
            className: AndroidClassName.toggleSwitch,
            isChecked: true,
            isCheckable: true,
            isEnabled: true,
            isFocusable: true,
            ignoredActions: ignoredAccessibilityFocusActions,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
            ],
          ),
        );
      }, timeout: Timeout.none);

      // Regression test for https://github.com/flutter/flutter/issues/20820.
      testWidgets('Switch can be labeled', (WidgetTester tester) async {
        final Finder switchFinder = find.byKey(const ValueKey<String>(labeledSwitchKeyValue));

        await prepareSelectionControls(tester);
        expect(
          await getSemantics(switchFinder, tester),
          hasAndroidSemantics(
            className: AndroidClassName.toggleSwitch,
            isChecked: false,
            isCheckable: true,
            isEnabled: true,
            isFocusable: true,
            contentDescription: switchLabel,
            ignoredActions: ignoredAccessibilityFocusActions,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
            ],
          ),
        );
      }, timeout: Timeout.none);
    });

    group('Popup Controls', () {
      Future<void> preparePopupControls(WidgetTester tester) async {
        app.main();
        await tester.pumpAndSettle();
        await tester.tap(find.text(popupControlsRoute));
        await tester.pumpAndSettle();
      }

      testWidgets('Popup Menu has correct Android semantics', (WidgetTester tester) async {
        final Finder popupButton = find.byKey(const ValueKey<String>(popupButtonKeyValue));

        await preparePopupControls(tester);
        expect(
          await getSemantics(popupButton, tester),
          hasAndroidSemantics(
            className: AndroidClassName.button,
            isChecked: false,
            isCheckable: false,
            isEnabled: true,
            isFocusable: true,
            ignoredActions: ignoredAccessibilityFocusActions,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
            ],
          ),
        );

        await tester.tap(popupButton);
        await tester.pumpAndSettle();

        try {
          for (final String item in popupItems) {
            expect(
              await getSemantics(find.byKey(ValueKey<String>('$popupKeyValue.$item')), tester),
              hasAndroidSemantics(
                className: AndroidClassName.button,
                isChecked: false,
                isCheckable: false,
                isEnabled: true,
                isFocusable: true,
                ignoredActions: ignoredAccessibilityFocusActions,
                actions: <AndroidSemanticsAction>[
                  AndroidSemanticsAction.click,
                ],
              ),
              reason: "Popup $item doesn't have the right semantics",
            );
          }
          await tester.tap(find.byKey(ValueKey<String>('$popupKeyValue.${popupItems.first}')));
          await tester.pumpAndSettle();

          // Pop up the menu again, to verify that TalkBack gets the right answer
          // more than just the first time.
          await tester.tap(popupButton);
          await tester.pumpAndSettle();

          for (final String item in popupItems) {
            expect(
              await getSemantics(find.byKey(ValueKey<String>('$popupKeyValue.$item')), tester),
              hasAndroidSemantics(
                className: AndroidClassName.button,
                isChecked: false,
                isCheckable: false,
                isEnabled: true,
                isFocusable: true,
                ignoredActions: ignoredAccessibilityFocusActions,
                actions: <AndroidSemanticsAction>[
                  AndroidSemanticsAction.click,
                ],
              ),
              reason: "Popup $item doesn't have the right semantics the second time",
            );
          }
        } finally {
          await tester.tap(find.byKey(ValueKey<String>('$popupKeyValue.${popupItems.first}')));
        }
      }, timeout: Timeout.none);

      testWidgets('Dropdown Menu has correct Android semantics', (WidgetTester tester) async {
        final Finder dropdownButton = find.byKey(const ValueKey<String>(dropdownButtonKeyValue));

        await preparePopupControls(tester);
        expect(
          await getSemantics(dropdownButton, tester),
          hasAndroidSemantics(
            className: AndroidClassName.button,
            isChecked: false,
            isCheckable: false,
            isEnabled: true,
            isFocusable: true,
            ignoredActions: ignoredAccessibilityFocusActions,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
            ],
          ),
        );

        await tester.tap(dropdownButton);
        await tester.pumpAndSettle();

        try {
          for (final String item in popupItems) {
            // There are two copies of each item, so we want to find the version
            // that is in the overlay, not the one in the dropdown.
            expect(
              await getSemantics(
                find.descendant(
                  of: find.byType(Scrollable),
                  matching: find.byKey(ValueKey<String>('$dropdownKeyValue.$item')),
                ),
                tester,
              ),
              hasAndroidSemantics(
                className: AndroidClassName.view,
                isChecked: false,
                isCheckable: false,
                isEnabled: true,
                isFocusable: true,
                ignoredActions: ignoredAccessibilityFocusActions,
                actions: <AndroidSemanticsAction>[
                  AndroidSemanticsAction.click,
                ],
              ),
              reason: "Dropdown $item doesn't have the right semantics",
            );
          }
          await tester.tap(
            find.descendant(
              of: find.byType(Scrollable),
              matching: find.byKey(ValueKey<String>('$dropdownKeyValue.${popupItems.first}')),
            ),
          );
          await tester.pumpAndSettle();

          // Pop up the dropdown again, to verify that TalkBack gets the right answer
          // more than just the first time.
          await tester.tap(dropdownButton);
          await tester.pumpAndSettle();

          for (final String item in popupItems) {
            // There are two copies of each item, so we want to find the version
            // that is in the overlay, not the one in the dropdown.
            expect(
              await getSemantics(
                find.descendant(
                  of: find.byType(Scrollable),
                  matching: find.byKey(ValueKey<String>('$dropdownKeyValue.$item')),
                ),
                tester,
              ),
              hasAndroidSemantics(
                className: AndroidClassName.view,
                isChecked: false,
                isCheckable: false,
                isEnabled: true,
                isFocusable: true,
                ignoredActions: ignoredAccessibilityFocusActions,
                actions: <AndroidSemanticsAction>[
                  AndroidSemanticsAction.click,
                ],
              ),
              reason: "Dropdown $item doesn't have the right semantics the second time.",
            );
          }
        } finally {
          await tester.tap(
            find.descendant(
              of: find.byType(Scrollable),
              matching: find.byKey(ValueKey<String>('$dropdownKeyValue.${popupItems.first}')),
            ),
          );
        }
      }, timeout: Timeout.none);

      testWidgets('Modal alert dialog has correct Android semantics', (WidgetTester tester) async {
        final Finder alertButton = find.byKey(const ValueKey<String>(alertButtonKeyValue));

        await preparePopupControls(tester);
        expect(
          await getSemantics(alertButton, tester),
          hasAndroidSemantics(
            className: AndroidClassName.button,
            isChecked: false,
            isCheckable: false,
            isEnabled: true,
            isFocusable: true,
            ignoredActions: ignoredAccessibilityFocusActions,
            actions: <AndroidSemanticsAction>[
              AndroidSemanticsAction.click,
            ],
          ),
        );

        await tester.tap(alertButton);
        await tester.pumpAndSettle();

        try {
          expect(
            await getSemantics(find.byKey(const ValueKey<String>('$alertKeyValue.OK')), tester),
            hasAndroidSemantics(
              className: AndroidClassName.button,
              isChecked: false,
              isCheckable: false,
              isEnabled: true,
              isFocusable: true,
              ignoredActions: ignoredAccessibilityFocusActions,
              actions: <AndroidSemanticsAction>[
                AndroidSemanticsAction.click,
              ],
            ),
            reason: "Alert OK button doesn't have the right semantics",
          );

          for (final String item in <String>['Title', 'Body1', 'Body2']) {
            expect(
              await getSemantics(find.byKey(ValueKey<String>('$alertKeyValue.$item')), tester),
              hasAndroidSemantics(
                className: AndroidClassName.view,
                isChecked: false,
                isCheckable: false,
                isEnabled: true,
                isFocusable: true,
                ignoredActions: ignoredAccessibilityFocusActions,
                actions: <AndroidSemanticsAction>[],
              ),
              reason: "Alert $item button doesn't have the right semantics",
            );
          }

          await tester.tap(find.byKey(const ValueKey<String>('$alertKeyValue.OK')));
          await tester.pumpAndSettle();

          // Pop up the alert again, to verify that TalkBack gets the right answer
          // more than just the first time.
          await tester.tap(alertButton);
          await tester.pumpAndSettle();

          expect(
            await getSemantics(find.byKey(const ValueKey<String>('$alertKeyValue.OK')), tester),
            hasAndroidSemantics(
              className: AndroidClassName.button,
              isChecked: false,
              isCheckable: false,
              isEnabled: true,
              isFocusable: true,
              ignoredActions: ignoredAccessibilityFocusActions,
              actions: <AndroidSemanticsAction>[
                AndroidSemanticsAction.click,
              ],
            ),
            reason: "Alert OK button doesn't have the right semantics",
          );

          for (final String item in <String>['Title', 'Body1', 'Body2']) {
            expect(
              await getSemantics(find.byKey(ValueKey<String>('$alertKeyValue.$item')), tester),
              hasAndroidSemantics(
                className: AndroidClassName.view,
                isChecked: false,
                isCheckable: false,
                isEnabled: true,
                isFocusable: true,
                ignoredActions: ignoredAccessibilityFocusActions,
                actions: <AndroidSemanticsAction>[],
              ),
              reason: "Alert $item button doesn't have the right semantics",
            );
          }
        } finally {
          await tester.tap(find.byKey(const ValueKey<String>('$alertKeyValue.OK')));
        }
      }, timeout: Timeout.none);
    });

    group('Headings', () {
      Future<void> prepareHeading(WidgetTester tester) async {
        app.main();
        await tester.pumpAndSettle();
        await tester.tap(find.text(headingsRoute));
        await tester.pumpAndSettle();
      }

      testWidgets('AppBar title has correct Android heading semantics', (WidgetTester tester) async {
        await prepareHeading(tester);
        expect(
          await getSemantics(find.byKey(const ValueKey<String>(appBarTitleKeyValue)), tester),
          hasAndroidSemantics(isHeading: true),
        );
      }, timeout: Timeout.none);

      testWidgets('body text does not have Android heading semantics', (WidgetTester tester) async {
        await prepareHeading(tester);
        expect(
          await getSemantics(find.byKey(const ValueKey<String>(bodyTextKeyValue)), tester),
          hasAndroidSemantics(isHeading: false),
        );
      }, timeout: Timeout.none);
    });
  });
}