- I tried to build it on ios. On emulators it worked ( i tested it on all avaible version of iphone and ipad), but when i tried do the same with real device (iphone 6) all i got was. Flutter run No devices connected Flutter doctor said only. Connected Device! No devices connected Which is strange, because my mac see this device and xcode see it too.
- Tools: Flutter depends on these command-line tools being available in your environment. With Xcode, you'll be able to run Flutter apps on an iOS device or on the simulator. Deploy to iOS devices. To deploy your Flutter app to a physical iOS device, you'll need some additional tools and an Apple account.
Map Launcher is a flutter plugin to find available maps installed on a device and launch them with a marker or show directions.
Flutter is an UI Framework based on Dart, made by Google. While the primary focus of Flutter is mobile platforms like iOS and Android with a growing support for the Web, Flutter is also heading towards Linux and Windows. Flutter is also used at Google to provide the HMI for some of Google's own devices and will become even more important once Fuchsia will be succeeding Android.
Marker | Navigation |
---|
Currently supported maps:
Google Maps
Apple Maps (iOS only)
Google Maps GO (Android only)
Baidu Maps
Amap (Gaode Maps)
Waze
Yandex Maps
Yandex Navigator
Citymapper
Maps.me
OsmAnd
2GIS
Tencent (QQ Maps)
Migrating to v1 #
Breaking change: map_launcher does not depend on flutter_svg anymore which means you will have to add flutter_svg in your project if you want to use images.
This should allow you to use any version of flutter_svg and it also fixes bunch of issues related to that like #45, #40, etc
The icon
property from AvailableMap
now returns String
instead of ImageProvider
so to get it working all you have to do is to go from
to
Get started #
Add dependency #
For iOS add url schemes in Info.plist file #
Usage #
Get list of installed maps and launch first #
Check if map is installed and launch it #
API #
Show Marker #
option | type | required | default |
---|---|---|---|
mapType | MapType | yes | - |
coords | Coords(lat, long) | yes | - |
title | String | no | ' |
description | String | no | ' |
zoom | Int | no | 16 |
extraParams | Map | no | {} |
mapType | coords | title | description | zoom | extraParams |
---|---|---|---|---|---|
.google | ✓ | iOS only see Known Issues section below | ✗ | ✓ | ✓ |
.apple | ✓ | ✓ | ✗ | ✗ | ✓ |
.googleGo | ✓ | ✗ | ✗ | ✓ | ✓ |
.amap | ✓ | ✓ | ✓ | Android only | ✓ |
.baidu | ✓ | ✓ | ✓ | ✓ | ✓ |
.waze | ✓ | ✗ | ✗ | ✓ | ✓ |
.yandexMaps | ✓ | ✗ | ✗ | ✓ | ✓ |
.yandexNavi | ✓ | ✓ | ✗ | ✓ | ✓ |
.citymapper | ✓ does not support marker shows directions instead | ✓ | ✗ | ✗ | ✓ |
.mapswithme | ✓ | ✓ | ✗ | ✗ | ✓ |
.osmand | ✓ | iOS only | ✗ | Android only | ✓ |
.doubleGis | ✓ android does not support marker shows directions instead | ✗ | ✗ | ✗ | ✓ |
.tencent | ✓ | ✓ | ✗ | ✗ | ✓ |
Show Directions #
option | type | required | default |
---|---|---|---|
mapType | MapType | yes | - |
destination | Coords(lat, long) | yes | - |
destinationTitle | String | no | 'Destination' |
origin | Coords(lat, long) | no | Current Location |
originTitle | String | no | 'Origin' |
directionsMode | DirectionsMode | no | .driving |
waypoints | List | no | null |
extraParams | Map | no | {} |
mapType | destination | destinationTitle | origin | originTitle | directionsMode | waypoints | extraParams |
---|---|---|---|---|---|---|---|
.google | ✓ | ✗ | ✓ | ✗ | ✓ | ✓ (up to 8 on iOS and unlimited? on android) | ✓ |
.apple | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ | ✓ |
.googleGo | ✓ | ✗ | ✓ | ✗ | ✓ | ✓ | ✓ |
.amap | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ | ✓ |
.baidu | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ | ✓ |
.waze | ✓ | ✗ | always uses current location | ✗ | ✗ | ✗ | ✓ |
.yandexMaps | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ | ✓ |
.yandexNavi | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ | ✓ |
.citymapper | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ | ✓ |
.mapswithme | ✓ | ✓ | only shows marker | ✗ | ✗ | ✗ | ✓ |
.osmand | ✓ | iOS only | always uses current location | ✗ | ✗ | ✗ | ✓ |
.doubleGis | ✓ | ✗ | ✓ | ✗ | ✗ | ✗ | ✓ |
.tencent | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ | ✓ |
Extra Params #
It's possible to pass some map specific query params like api keys etc using extraParams
option
Here are known params for some maps:
mapType | extraParams |
---|---|
.tencent | { 'referer': ' } |
.yandexNavi | { 'client': ', 'signature': ' } |
Example #
Using with bottom sheet #
Known issues #
Google Maps for Android have a bug that setting label for a marker doesn't work. See more on Google Issue Tracker
On iOS it's possible to 'delete' Apple Maps which actually just removes it from homescreen and does not actually delete it. Because of that Apple Maps will always show up as available on iOS. You can read more about it here
Contributing #
Pull requests are welcome.
A fully featured Gherkin parser and test runner. Works with Flutter and Dart 2.
This implementation of the Gherkin tries to follow as closely as possible other implementations of Gherkin and specifically Cucumber in it's various forms.
Available as a Dart package https://pub.dartlang.org/packages/flutter_gherkin
Table of Contents #
- Getting Started
- Configuration
- Flutter specific configuration options
- Features Files
- Steps Definitions
- Attachments
- Flutter
- Restarting the app before each test
- Pre-defined Steps
- Debugging
Getting Started #
See https://docs.cucumber.io/gherkin/ for information on the Gherkin syntax and Behaviour Driven Development (BDD).
See example readme for a quick start guide to running the example features and app.
The first step is to create a version of your app that has flutter driver enabled so that it can be automated. A good guide how to do this is show here. However in short, create a folder called test_driver
and within that create a file called app.dart
and paste in the below code.
All this code does is enable the Flutter driver extension which is required to be able to automate the app and then runs your application.
To get started with BDD in Flutter the first step is to write a feature file and a test scenario within that.
First create a folder called test_driver
(this is inline with the current integration test as we will need to use the Flutter driver to automate the app). Within the folder create a folder called features
, then create a file called counter.feature
.
Now we have created a scenario we need to implement the steps within. Steps are just classes that extends from the base step definition class or any of its variations Given
, Then
, When
, And
, But
.
Granted the example is a little contrived but is serves to illustrate the process.
This library has a couple of built in step definitions for convenience. The first step uses the built in step, however the second step When I tap the 'increment' button 10 times
is a custom step and has to be implemented. To implement a step we have to create a simple step definition class.
As you can see the when2
method is invoked specifying two input parameters. The third type FlutterWorld
is a special world context object that allow access from the context object to the Flutter driver that allows you to interact with your app. If you did not need a custom world object or strongly typed parameters you can omit the type arguments completely.
The input parameters are retrieved via the pattern regex from well know parameter types {string}
and {int}
explained below. They are just special syntax to indicate you are expecting a string and an integer at those points in the step text. Therefore, when the step to execute is When I tap the 'increment' button 10 times
the parameters 'increment' and 10 will be passed into the step as the correct types. Note that in the pattern you can use any regex capture group to indicate any input parameter. For example the regex RegExp(r'When I tap the {string} (button|icon) {int} times')
indicates 3 parameters and would match to either of the below step text.
It is worth noting that this library does not rely on mirrors (reflection) for many reasons but most prominently for ease of maintenance and to fall inline with the principles of Flutter not allowing reflection. All in all this make for a much easier to understand and maintain code base as well as much easier debugging for the user. The downside is that we have to be slightly more explicit by providing instances of custom code such as step definition, hook, reporters and custom parameters.
Now that we have a testable app, a feature file and a custom step definition we need to create a class that will call this library and actually run the tests. Create a file called app_test.dart
and put the below code in.
This code simple creates a configuration object and calls this library which will then promptly parse your feature files and run the tests. The configuration file is important and explained in further detail below. However, all that is happening is a Glob
is provide which specifies the path to one or more feature files, it sets the reporters to the ProgressReporter
report which prints the result of scenarios and steps to the standard output (console). The TestRunSummaryReporter
prints a summary of the run once all tests have been executed. Finally it specifies the path to the testable app created above test_driver/app.dart
. This is important as it instructions the library which app to run the tests against.
Finally to actually run the tests run the below on the command line:
To debug tests see Debugging.
Note: You might need to ensure dart is accessible by adding it to your path variable.
Configuration #
The configuration is an important piece of the puzzle in this library as it specifies not only what to run but classes to run against in the form of steps, hooks and reporters. Unlike other implementation this library does not rely on reflection so need to be explicitly told classes to use.
The parameters below can be specified in your configuration file:
features
Required
An iterable of Glob
patterns that specify the location(s) of *.feature
files to run. See https://pub.dartlang.org/packages/glob
tagExpression
Defaults to null
.
An infix boolean expression which defines the features and scenarios to run based of their tags. See Tags.
order
Defaults to ExecutionOrder.random
The order by which scenarios will be run. Running an a random order may highlight any inter-test dependencies that should be fixed.
stepDefinitions
Defaults to Iterable
Place instances of any custom step definition classes Given
, Then
, When
, And
, But
that match to any custom steps defined in your feature files.
defaultLanguage
Defaults to en
This specifies the default language the feature files are written in. See https://cucumber.io/docs/gherkin/reference/#overview for supported languages.
Note that this can be overridden in the feature itself by the use of a language block.
customStepParameterDefinitions
Defaults to CustomParameter
.
Place instances of any custom step parameters that you have defined. These will be matched up to steps when scenarios are run and their result passed to the executable step. See Custom Parameters.
hooks
Hooks are custom bits of code that can be run at certain points with the test run such as before or after a scenario. Place instances of any custom Hook
class instance in this collection. They will then be run at the defined points with the test run. https://kpyrx.over-blog.com/2021/01/adobe-acrobat-pro-cd.html.
attachments
Attachment are pieces of data you can attach to a running scenario. Siegecraft commander 1 2. This could be simple bits of textual data or even image like a screenshot. These attachments can then be used by reporters to provide more contextual information. For example when a step fails some contextual information could be attached to the scenario which is then used by a reporter to display why the step failed.
Attachments would typically be attached via a Hook
for example onAfterStep
.
To take a screenshot on a step failing you can used the pre-defined hook AttachScreenshotOnFailedStepHook
and include it in the hook configuration of the tests config. This hook will take a screenshot and add it as an attachment to the scenario. If the JsonReporter
is being used the screenshot will be embedded in the report which can be used to generate a HTML report which will ultimately display the screenshot under the failed step.
reporters
Reporters are classes that are able to report on the status of the test run. This could be a simple as merely logging scenario result to the console. There are a number of built-in reporter:
StdoutReporter
: Logs all messages from the test run to the standard output (console).ProgressReporter
: Logs the progress of the test run marking each step with a scenario as either passed, skipped or failed.JsonReporter
- creates a JSON file with the results of the test run which can then be used by 'https://www.npmjs.com/package/cucumber-html-reporter.' to create a HTML report. You can pass in the file path of the json file to be created.
You should provide at least one reporter in the configuration otherwise it'll be hard to know what is going on.
Note: Feel free to PR new reporters!
createWorld
Defaults to null
.
While it is not recommended so share state between steps within the same scenario we all in fact live in the real world and thus at time may need to share certain information such as login credentials etc for future steps to use. The world context object is created once per scenario and then destroyed at the end of each scenario. This configuration property allows you to specify a custom World
class to create which can then be accessed in your step classes.
logFlutterProcessOutput
Defaults to false
If true
the output from the flutter process is logged to the stdout / stderr streams. Useful when debugging app build or start failures
flutterBuildTimeout
Defaults to 90 seconds
Specifies the period of time to wait for the Flutter build to complete and the app to be installed and in a state to be tested. Slower machines may need longer than the default 90 seconds to complete this process.
onBeforeFlutterDriverConnect
An async method that is called before an attempt by Flutter driver to connect to the app under test
onAfterFlutterDriverConnect
An async method that is called after a successful attempt by Flutter driver to connect to the app under test
flutterDriverMaxConnectionAttempts
Defaults to 3
Specifies the number of Flutter driver connection attempts to a running app before the test is aborted
flutterDriverReconnectionDelay
Defaults to 2 seconds
Specifies the amount of time to wait after a failed Flutter driver connection attempt to the running app
exitAfterTestRun
Facebook desktop application. Defaults to true
True to exit the program after all tests have run. You may want to set this to false during debugging.
Flutter specific configuration options #
The FlutterTestConfiguration
will automatically create some default Flutter options such as well know step definitions, the Flutter world context object which provides access to a Flutter driver instance as well as the ability to restart you application under test between scenarios. Most of the time you should use this configuration object if you are testing Flutter applications.
restartAppBetweenScenarios
Defaults to true
.
To avoid tests starting on an app changed by a previous test it is suggested that the Flutter application under test be restarted between each scenario. While this will increase the execution time slightly it will limit tests failing because they run against an app changed by a previous test. Note in more complex application it may also be necessary to use the AfterScenario
hook to reset the application to a base state a test can run on. Logging out for example if restarting an application will present a lock screen etc. This now performs a hot reload of the application which resets the state and drastically reduces the time to run the tests.
targetAppPath
Defaults to lib/test_driver/app.dart
This should point to the testable application that enables the Flutter driver extensions and thus is able to be automated. This application wil be started when the test run is started and restarted if the restartAppBetweenScenarios
configuration property is set to true.
build
Defaults to true
This optional argument lets you specify if the target application should be built prior to running the first test. This defaults to true
keepAppRunningAfterTests
Defaults to false
This optional argument will keep the Flutter application running when done testing. This defaults to false
buildFlavor
Defaults to empty string
This optional argument lets you specify which flutter flavor you want to test against. Flutter's flavor has similar concept with Android Build Variants
or iOS Scheme Configuration
. This flavoring flutter documentation has complete guide on both flutter and android/ios side. Photoimpact x3 activation code keygen.
buildMode
Defaults to BuildMode.Debug
This optional argument lets you specify which build mode you prefer while compiling your app. Flutter Gherkin supports --debug
and --profile
modes. Check Flutter's build modes documentation for more details.
targetDeviceId
Defaults to empty string
This optional argument lets you specify device target id as flutter run --device-id
command. To show list of connected devices, run flutter devices
. If you only have one device connected, no need to provide this argument.
runningAppProtocolEndpointUri
An observatory url that the test runner can connect to instead of creating a new running instance of the target applicationThe url takes the form of http://127.0.0.1:51540/EM72VtRsUV0=/
and usually printed to stdout in the form Connecting to service protocol: http://127.0.0.1:51540/EM72VtRsUV0=/
You will have to add the --verbose
flag to the command to start your flutter app to see this output and ensure enableFlutterDriverExtension()
is called by the running app
Features Files #
Steps Definitions #
Step definitions are the coded representation of a textual step in a feature file. Each step starts with either Given
, Then
, When
, And
or But
. It is worth noting that all steps are actually the same but semantically different. The keyword is not taken into account when matching a step. Therefore the two below steps are actually treated the same and will result in the same step definition being invoked.
Note: Step definitions (in this implementation) are allowed up to 5 input parameters. Isonics 1 8 1 download free. If you find yourself needing more than this you might want to consider making your step more isolated or using a Table
parameter.
However, the domain language you choose will influence what keyword works best in each context. For more information https://docs.cucumber.io/gherkin/reference/#steps.
Given
Given
steps are used to describe the initial state of a system. The execution of a Given
step will usually put the system into well defined state.
To implement a Given
step you can inherit from the Given
class.
Would be implemented like so:
If you need to have more than one Given in a block it is often best to use the additional keywords And
or But
.
Then
Then
steps are used to describe an expected outcome, or result. They would typically have an assertion in which can pass or fail.
Would be implemented like so:
Expects Assertions
Caveat: The expect
library currently only works within the library's own test
function blocks; so using it with a Then
step will cause an error. Therefore, the expectMatch
or expectA
or this.expect
or context.expect
methods have been added which mimic the underlying functionality of except
in that they assert that the give is true. The Matcher
within Dart's test library still work and can be used as expected.
Step Timeout
By default a step will timeout if it exceed the defaultTimeout
parameter in the configuration file. In some cases you want have a step that is longer or shorter running and in the case you can optionally proved a custom timeout to that step. To do this pass in a Duration
object in the step's call to super
.
For example, the below sets the step's timeout to 10 seconds.
Multiline Strings
Multiline strings can follow a step and will be give to the step it proceeds as the final argument. To denote a multiline string the pre and postfix can either be third double or single quotes '' . ''
or '' . ''
.
For example:
The matching step definition would then be:
Data tables
Well known step parameters
In addition to being able to define a step's own parameters (by using regex capturing groups) there are some well known parameter types you can include that will automatically match and convert the parameter into the correct type before passing it to you step definition. (see https://docs.cucumber.io/cucumber/cucumber-expressions/#parameter-types).
In most scenarios theses parameters will be enough for you to write quite advanced step definitions.
Parameter Name | Description | Aliases | Type | Example |
---|---|---|---|---|
{word} | Matches a single word surrounded by a quotes | {word}, {Word} | String | Given I eat a {word} would match Given I eat a 'worm' |
{string} | Matches one more words surrounded by a quotes | {string}, {String} | String | Given I eat a {string} would match Given I eat a 'can of worms' |
{int} | Matches an integer | {int}, {Int} | int | Given I see {int} worm(s) would match Given I see 6 worms |
{num} | Matches an number | {num}, {Num}, {float}, {Float} | num | Given I see {num} worm(s) would match Given I see 0.75 worms |
Note that you can combine there well known parameters in any step. For example Given I {word} {int} worm(s)
would match Given I 'see' 6 worms
and also match Given I 'eat' 1 worm
Pluralization
As the aim of a feature is to convey human readable tests it is often desirable to optionally have some word pluralized so you can use the special pluralization syntax to do simple pluralization of some words in your step definition. For example:
The step string Given I see {int} worm(s)
has the pluralization syntax on the word 'worm' and thus would be matched to both Given I see 1 worm
and Given I see 4 worms
.
Custom Parameters
While the well know step parameter will be sufficient in most cases there are time when you would want to defined a custom parameter that might be used across more than or step definition or convert into a custom type.
The below custom parameter defines a regex that matches the words 'red', 'green' or 'blue'. The matches word is passed into the function which is then able to convert the string into a Color object. The name of the custom parameter is used to identity the parameter within the step text. In the below example the word 'colour' is used. This is combined with the pre / post prefixes (which default to '{' and '}') to match to the custom parameter.
The step definition would then use this custom parameter like so:
This customer parameter would be used like this: Given I pick the colour red
. When the step is invoked the word 'red' would matched and passed to the custom parameter to convert it into a Colour
enum which is then finally passed to the step definition code as a Colour
object.
World Context (per test scenario shared state)
Assertions
Tags #
Tags are a great way of organizing your features and marking them with filterable information. Tags can be uses to filter the scenarios that are run. For instance you might have a set of smoke tests to run on every check-in as the full test suite is only ran once a day. You could also use an @ignore
or @todo
tag to ignore certain scenarios that might not be ready to run yet.
You can filter the scenarios by providing a tag expression to your configuration file. Tag expression are simple infix expressions such as:
@smoke
@smoke and @perf
@billing or @onboarding
@smoke and not @ignore
You can even us brackets to ensure the order of precedence
@smoke and not (@ignore or @todo)
You can use the usual boolean statement 'and', 'or', 'not'
Also see https://docs.cucumber.io/cucumber/api/#tags
Languages #
In order to allow features to be written in a number of languages, you can now write the keywords in languages other than English. To improve readability and flow, some languages may have more than one translation for any given keyword. See https://cucumber.io/docs/gherkin/reference/#overview for a list of supported languages.
You can set the default language of feature files in your project via the configuration setting see defaultLanguage
For example these two features are the same the keywords are just written in different languages. Note the # language: de
on the second feature. English is the default language.
Please note the language data is take and attributed to the cucumber project https://github.com/cucumber/cucumber/blob/master/gherkin/gherkin-languages.json
Hooks #
A hook is a point in the execution that custom code can be run. Hooks can be run at the below points in the test run.
- Before any tests run
- After all the tests have run
- Before each scenario
- After each scenario
To create a hook is easy. Just inherit from Hook
and override the method(s) that signifies the point in the process you want to run code at. Note that not all methods need to be override, just the points at which you want to run custom code.
Finally ensure the hook is added to the hook collection in your configuration file.
Reporting #
A reporter is a class that is able to report on the progress of the test run. In it simplest form it could just print messages to the console or be used to tell a build server such as TeamCity of the progress of the test run. The library has a number of built in reporters.
StdoutReporter
- prints all messages from the test run to the console.ProgressReporter
- prints the result of each scenario and step to the console - colours the output.TestRunSummaryReporter
- prints the results and duration of the test run once the run has completed - colours the output.JsonReporter
- creates a JSON file with the results of the test run which can then be used by 'https://www.npmjs.com/package/cucumber-html-reporter.' to create a HTML report. You can pass in the file path of the json file to be created.FlutterDriverReporter
- prints the output from Flutter Driver. Flutter driver logs all messages to the stderr stream by default so most CI servers would mark the process as failed if anything is logged to the stderr stream (even if the Flutter driver logs are only info messages). This reporter ensures the log messages are output to the most appropriate stream depending on their log level.
You can create your own custom reporter by inheriting from the base Reporter
class and overriding the one or many of the methods to direct the output message. The Reporter
defines the following methods that can be overridden. All methods must return a Future
and can be async.
onTestRunStarted
onTestRunFinished
onFeatureStarted
onFeatureFinished
onScenarioStarted
onScenarioFinished
onStepStarted
onStepFinished
onException
message
dispose
Once you have created your custom reporter don't forget to add it to thereporters
configuration file property.
Note: PR's of new reporters are always welcome.
Flutter #
Restarting the app before each test #
By default to ensure your app is in a consistent state at the start of each test the app is shut-down and restarted. This behaviour can be turned off by setting the restartAppBetweenScenarios
flag in your configuration object. Although in more complex scenarios you might want to handle the app reset behaviour yourself; possibly via hooks.
You might additionally want to do some clean-up of your app after each test by implementing an onAfterScenario
hook.
Flutter World
Pre-defined Steps #
Flutter Ios Build
For convenience the library defines a number of pre-defined steps so you can get going much quicker without having to implement lots of step classes. The pre-defined steps are:
Flutter No Devices Available Ios 12.4
Step Text | Description | Examples |
---|---|---|
I tap the {string} [button|element|label|icon|field|text|widget] | Taps the element with the provided key ( given by the first input parameter) | When I tap the 'login' button , Then I tap the 'save' icon |
I fill the {string} field with {string} | Fills the element with the provided key with the given value (given by the second input parameter) | When I fill the 'email' field with 'someone@gmail.com' |
I expect the {string} to be {string} | Asserts that the element with the given key has the given string value | Then I expect the 'cost' to be '£10.95' |
I (open|close) the drawer | Opens or closes the application default drawer | When I open the drawer , And I close the drawer |
I expect the [button|element|label|icon|field|text|widget] {string} to be present within {int} second(s) | Expects a widget with the given key to be present within n seconds | Then I expect the widget 'notification' to be present within 10 seconds , Then I expect the icon 'notification' to be present within 1 second |
I pause for {int} seconds | Pauses the test execution for the given seconds. Only use in debug scenarios or to inspect the state of the app | Then I pause for 20 seconds |
I restart the app | Restarts the app under test | Then I restart the app |
I tap the back button | Taps the page default back button widget | Then I tap the back button |
I expect a {string} that contains the text {string} to also contain the text {string} | Discovers a sibling based on its parent widget type and asserts that the both text string exist within the parent. | Then I expect a 'Row' that contains the text 'X' to also contain the text 'Y' |
I swipe [down|left|right|up] by {int} pixels on the {string} | Swipes in a cardinal direction on a widget discovered by its key. | Then I swipe up by 800 pixels on the 'login_screen' , Then I swipe left by 200 pixels on the 'dismissible_list_item' |
I swipe [down|left|right|up] by {int} pixels on the on the [button|element|label|field|text|widget|dialog|popup] that contains the text {string} | Swipes in a cardinal direction on a widget discovered by its test. | Then I swipe left by 400 pixels on the widget that contains the text 'Dismiss Me' |
I tap the [button|element|label|field|text|widget] that contains the text {string} within the {string} | Taps a widget that contains the text within another widget. If the text is not visible, the ancestor will be scrolled. | Then I tap the label that contains the text 'Logout' within the 'user_settings_list' |
I tap the [button|element|label|icon|field|text|widget] of type {string} | Taps a widget of type. | Then I tap the element of type 'MaterialButton' , Then I tap the label of type 'ListTile' , Then I tap the field of type 'TextField' |
I tap the [button|element|label|icon|field|text|widget] of type {string} within the {string} | Taps a widget of type within another widget. | Then I tap the element of type 'MaterialButton' within the 'user_settings_list' |
I tap the [button|element|label|icon|field|text|widget] that contains the text {string} | Taps a widget that contains text. | Then I tap the label that contains the text 'Logout' , Then I tap the button that contains the text 'Sign up' , Then I tap the widget that contains the text 'My User Profile' |
I expect the text {string} to be [present|absent] | Asserts the existence of text on the screen. | Then I expect the text 'Logout' to be present , But I expect the text 'Signup' to be absent |
I expect the text {string} to be [present|absent] within the {string} | Asserts the existence of text within a parent widget. | Then I expect the text 'Logout' to be present within the 'user_settings_list' , But I expect the text 'Signup' to be absent within the 'login_screen' |
I wait until the {string} is [presentabsent] | Delays until a widget is present or absent. | Then I wait until the 'login_loading_indicator' is absent , And I wait until the 'login_screen' is present |
I wait until the [button|element|label|icon|field|text|widget] of type {string} is [presentabsent] | Waits until a widget type is present or absent. | Then I wait until the element of type 'ProgressIndicator' is absent , And I wait until the button of type 'MaterialButton' is present |
I long press the {string} [button|element|label|icon|field|text|widget] | Scrolls into view and long presses the widget for 500 milliseconds. | When I long press 'controlKey' button |
I long press the {string} [button|element|label|icon|field|text|widget] without scrolling it into view | Long presses the widget for 500 milliseconds. | When I long press 'controlKey' button without scrolling it into view |
I long press the {string} [button|element|label|icon|field|text|widget] for {int} milliseconds | Scrolls into view and long presses the widget for the give number of milliseconds. | When I long press 'controlKey' button without scrolling it into view for 1500 milliseconds |
Flutter Driver Utilities
For convenience the library provides a static FlutterDriverUtils
class that abstracts away some common Flutter driver functionality like tapping a button, getting and entering text, checking if an element is present or absent, waiting for a condition to become true. See lib/src/flutter/utils/driver_utils.dart.
Debugging #
In VSCode simply add add this block to your launch.json file (if you testable app is called app_test.dart
and within the test_driver
folder, if not replace that with the correct file path). Don't forget to put a break point somewhere!
After which the file will most likely look like this
Debugging the app under test
Setting the configuration property runningAppProtocolEndpointUri
to the service protocol endpoint (found in stdout when an app has --verbose
logging turned on) will ensure that the existing app is connected to rather than starting a new instance of the app.
NOTE: ensure the app you are trying to connect to calls enableFlutterDriverExtension()
when it starts up otherwise the Flutter Driver will not be able to connect to it.
Flutter No Devices Available Ios 13.3
Also ensure that the --verbose
flag is set when starting the app to test, this will then log the service protocol endpoint out to the console which is the uri you will need to set this property to. It usually takes the form of Connecting to service protocol: http://127.0.0.1:51540/EM72VtRsUV0=/
so set the runningAppProtocolEndpointUri
to http://127.0.0.1:51540/EM72VtRsUV0=/
and then start the tests.