How to check if widget is visible using FlutterDriver

Question

I am not sure how I would check whether a widget is currently shown or not using FlutterDriver.

Using WidgetTester this is really easy to perform using e.g. findsOneWidget.
However, during integration tests using FlutterDriver, there is no access to a WidgetTester object.

The FlutterDriver.waitFor method does not indicate whether the widget was found in the given duration.

How do I check whether a widget is on screen using FlutterDriver?

What's the use-case? That may not be what you want. Integration tests shouldn't care about how widget-tree looks like. — Rémi Rousselet
– Rémi Rousselet, Commented Jun 20, 2019 at 11:13
But would widget testing be possible? Widget-testing can be used for small integration tests too. — Rémi Rousselet
– Rémi Rousselet, Commented Jun 20, 2019 at 12:09
@RémiRousselet No, it is not. I can currently avoid the problem by taking manual action while the integration test is running because it only happens at some point, however, this is bad for automation as I cannot always ensure that the integration test runs all the way. — creativecreatorormaybenot
– creativecreatorormaybenot, Commented Jun 20, 2019 at 12:12

Nimantha · Accepted Answer · 2021-12-15 07:24:12Z

24

+50

Flutter Driver doesn't have explicit method to check if a widget is present / exists, but we can create a custom method which will serve the purpose using waitFor method. For example, I have a simple text widget on screen and I will write a flutter driver test to check if that widget is present or not using a custom method isPresent.

Main code:

body: Center(
      child:
      Text('This is Test', key: Key('textKey'))

Flutter driver test to check if this widget is present or not is as below:

test('check if text widget is present', () async {
      final isExists = await isPresent(find.byValueKey('textKey'), driver);
      if (isExists) {
        print('widget is present');
      } else {
        print('widget is not present');
      }
    });

isPresent is custom method whose definition is as below:

isPresent(SerializableFinder byValueKey, FlutterDriver driver, {Duration timeout = const Duration(seconds: 1)}) async {
  try {
    await driver.waitFor(byValueKey,timeout: timeout);
    return true;
  } catch(exception) {
    return false;
  }
}

Running the test detects the widget is present:

enter image description here

If I comment out the text widget code and then run the test, it detects that widget is not present:

enter image description here

edited Dec 15, 2021 at 7:24

Nimantha

6,5276 gold badges32 silver badges78 bronze badges

answered Jun 19, 2019 at 4:30

Darshan

11.8k6 gold badges53 silver badges63 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Donki Over a year ago

Can we make the test fail intentionally if the widget is not present?

Luis Fernando Trivelatto Over a year ago

@Donki: just use an expect: expect(await isPresent(find.byValueKey('textKey'), driver), isTrue);

brendan Over a year ago

Hi... I try to use this but i got error like "Unexpected <collected> sentinel."

Collectives™ on Stack Overflow

How to check if widget is visible using FlutterDriver

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related