Flutter: Debugging an integration test

Question

I'm learning Flutter and using Android Studio as my IDE and i've hit some pain points around Integration Testing.

As part of the learning process i have written a basic Integration Test.

The intention with this integration test is to examine an Image widget (created via Image.Asset) to see if the image source, which is dynamically generated, is the expected value, or that an image is being displayed.

I run the integration test using the Terminal tab in the IDE, e.g: flutter drive --target=my_app/test_driver/user_list_scrolling.dart

I want to add a breakpoint to my Integration Test method and step through it from within Android Studio to help aid my learning of the testing functions.

My questions are:

How can i debug an integration test from within Android Studio? - As I'm learning i would love to put a breakpoint in my integration test and play around with the Finders in the immediate window. However, when i start my integration test from the terminal my Breakpoints seem to be ignored, i also tried adding the Debugger(); command. Execution paused, but i was unable to step through my code in Android Studio. I've also tried using the 'Attach to process' option in the IDE but the 'Choose process' list is empty.

Can i execute an integration test from within Android Studio without having to manually enter a command into a terminal? - i would rather click a button than memorise a command. Right-clicking my integration test file and selecting run does not appear to work.

How can i effectively test an Image widget from within an Integration Test? - The image source is set by calling Image.Asset() with a calculated value as the first argument, so i want to confirm that an image is displayed / the argument is the expected value. I'm guessing i need to use find.byType("Image") and somehow examine the result for the source value?

Spencer Connaughton · Accepted Answer · 2021-12-09 17:36:10Z

8

For some reason in Android Studio the icon to run in debug mode doesn't work with configurations scoped to entire directories. Create a configuration targeting one file, or simply click the "Run Test" icon in the gutter next to your main() function and select the "Debug" option.

answered Dec 9, 2021 at 17:36

Spencer Connaughton

1,09211 silver badges25 bronze badges

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

Comments

mmccabe · Accepted Answer · 2018-12-11 18:43:59Z

6

The following are the steps I took to set-up for integration test development using Flutter tooling, including debugging:

Configure the app to listen on a shared port (in this case 8888) Add ‘— observatory-port 8888’ to ‘Additional Arguments’
Configure integration test to connect on the same shared port Add ‘VM_SERVICE_URL=http://127.0.0.1:8888/’ to ‘Environment Variables’
Start the app in run or debug-mode (only required once, with hot-reload when needed):
Start the integration test in run or debug mode (as many times as you want):

You can now add breakpoints to the app and/or test and view source code and variables in debugger.

The following describes how to setup Android Studio to develop integration tests in more detail.

A how-to for fast integration test development with existing tooling

answered Dec 11, 2018 at 18:43

mmccabe

2,3291 gold badge24 silver badges27 bronze badges

2 Comments

Vitaliy Vostrikov Over a year ago

And maybe in "Additional arguments" need '--disable-service-auth-codes': --observatory-port 8888 --disable-service-auth-codes

gdbj Over a year ago

Does this work with the integration_test upgrade from driver? I cannot seem to get it working.

danronmoon · Accepted Answer · 2023-10-29 15:33:49Z

2

With the new integration_test package you can just run flutter run integration_test/app_test.dart to debug your tests.

My launch.json (I'm using VS Code):

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Integration Test",
      "request": "launch",
      "type": "dart",
      "program": "example/integration_test/app_test.dart",
    },
  ]
}

edited Oct 29, 2023 at 15:33

danronmoon

3,8735 gold badges36 silver badges58 bronze badges

answered Apr 8, 2022 at 18:14

Nils Reichardt

3,7752 gold badges23 silver badges34 bronze badges

2 Comments

Emile Haas Over a year ago

Thanks for the tip! Could you explain why the flutter docs tell you to use chromedriver? Running with flutter run path/to/test is indeed much faster, and allows for reloading without closing test window which is a HUGE time gain.

Nils Reichardt Over a year ago

chromedriver is only needed for Flutter Web tests

Asaf Pinhassi · Accepted Answer · 2022-12-08 06:54:58Z

1

You can run then the integration test from the AndroidStudio as you would run any other Flutter app (right-click on the file, run -> debug).

Sometimes the AndroidStudio identifies the file as Dart and not Flutter, so you have to create a new Run/Debug configuration for Flutter instead. At "Dart entrypoint", select the integration file with the "main" func.

answered Dec 8, 2022 at 6:54

Asaf Pinhassi

15.6k12 gold badges112 silver badges135 bronze badges

Comments

thanhbinh84 · Accepted Answer · 2023-12-20 05:08:21Z

0

From menu: Run / Edit Configurations / Add New Configuration / Flutter Test

Test file: choose your debug file.

Then, from toolbar, you can debug app like as with the main app.

answered Dec 20, 2023 at 5:08

thanhbinh84

18.6k7 gold badges67 silver badges76 bronze badges

Collectives™ on Stack Overflow

Flutter: Debugging an integration test

5 Answers 5

Comments

2 Comments

2 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

Comments

2 Comments

2 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related