SaFi Bank Space : Integration Testing

Overview

Flutter integration test is UI test flow of the app from the user perspective. We use integration_test package that enables self-driving testing of Flutter code on devices and emulators. It adapts flutter_test results into a format that is compatible with flutter drive and native Android instrumentation testing. We are going to execute them locally and also in a more production-grade setup with Firebase Test Lab and Google Cloud.

Setting up the project

To start, add the bdd_widget_test , integration_test , build_runner , and flutter_test package to your pubspec.yaml file :

dependencies:
  bdd_widget_test: ^1.2.1
  integration_test:
    sdk: flutter
  
dev_dependencies:
  build_runner: ^2.1.7
  flutter_test:
    sdk: flutter

Create a build.yaml file in your project :

targets:
  $default:
    sources:
      - integration_test/**
      - lib/**
      - $package$
    builders:
      bdd_widget_test|featureBuilder:
        generate_for:
          - integration_test/**/*.feature
        options:
          stepFolderName: ../step

Driver Entrypoint

Create a folder called integration_test at the root of the Flutter project and inside it a file called driver.dart. This will run the integrationDriver.

import 'package:integration_test/integration_test_driver.dart';

Future<void> main() => integrationDriver();

Then, create a folder named feature and step in integration_test folder, and inside the step folder create a file named the_app_is_running.dart . For example :

Writing integration tests

Start create a feature file in the feature folder. For example :

After that run this command to generate the test file in your terminal :

flutter pub run build_runner build --delete-conflicting-outputs --build-filter integration_test/**/*_test.dart

It will automate created the test file going to be called <name>_test.dart . For example :

Using Flutter Driver to Run Tests

Just start up an emulator/simulator or even connect a real device through a USB and then run the following command :

flutter drive --driver=integration_test/<name_file_test_driver>.dart --target=integration_test/feature/<name_file_test.dart

For example :

flutter drive --driver=integration_test/common/driver.dart --target=integration_test/feature/demo_page/subcription_demo_page_test.dart

After running this command, you should see something similar on your emulator and also an output saying "All tests passed!" in the terminal.

Testing Android On Firebase Test Lab

Android Setup

Create an instrumentation test file in android/app/src/androidTest/java/com/example/myapp/ directory(replacing com, example, and myapp from app’s package name). You can get app’s package name from file MainActivity.kt

So, you have to make test file in android/app/src/androidTest/java/com/vl/safi/flutter_safi directory. You can name this test file MainActivityTest.java

// package com.example.myapp;
package com.vl.safi.flutter_safi;

import androidx.test.rule.ActivityTestRule;
import dev.flutter.plugins.integration_test.FlutterTestRunner;
import org.junit.Rule;
import org.junit.runner.RunWith;

@RunWith(FlutterTestRunner.class)
public class MainActivityTest {
  @Rule
  public ActivityTestRule<MainActivity> rule = new ActivityTestRule<>(MainActivity.class, true, false);
}

Update your application's myapp/android/app/build.gradle

{
  "consumer": {
    "name": "SafiMobile-Consumer"
  },
  "interactions": [
    {
      "description": "",
      "providerStates": [
        {
          "name": "Get All Card By CustomerId"
        }
      ],
      "request": {
        "method": "GET",
        "path": "/cards/8f7f8a2c-14a3-422d-b1dd-6abc6325597d"
      },
      "response": {
        "body": [
          {
            "accountNo": "0190239038",
            "accountType": "MAIN_ACCOUNT",
            "cardId": "7ea584a2-08b7-44ec-b152-d56a75d96386",
            "cardType": "DP1",
            "customerId": "8f7f8a2c-14a3-422d-b1dd-6abc6325597d",
            "embossName": "Maria Santos Dela Crup",
            "orderingNumber": 1
          }
        ],
        "headers": {
          "Content-Type": "application/json"
        },
        "matchingRules": {
          "body": {
            "$": {
              "combine": "AND",
              "matchers": [
                {
                  "match": "type",
                  "min": 1
                }
              ]
            },
            "$[*].accountNo": {
              "combine": "AND",
              "matchers": [
                {
                  "match": "type"
                }
              ]
            },
            "$[*].accountType": {
              "combine": "AND",
              "matchers": [
                {
                  "match": "type"
                }
              ]
            },
            "$[*].cardId": {
              "combine": "AND",
              "matchers": [
                {
                  "match": "regex",
                  "regex": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$"
                }
              ]
            },
            "$[*].cardType": {
              "combine": "AND",
              "matchers": [
                {
                  "match": "type"
                }
              ]
            },
            "$[*].customerId": {
              "combine": "AND",
              "matchers": [
                {
                  "match": "type"
                }
              ]
            },
            "$[*].embossName": {
              "combine": "AND",
              "matchers": [
                {
                  "match": "regex",
                  "regex": "^[a-zA-Z ]*$"
                }
              ]
            },
            "$[*].expiration": {
              "combine": "AND",
              "matchers": [
                {
                  "match": "type"
                }
              ]
            },
            "$[*].internationalBlockingFlag": {
              "combine": "AND",
              "matchers": [
                {
                  "match": "type"
                }
              ]
            },
            "$[*].maskingCardNo": {
              "combine": "AND",
              "matchers": [
                {
                  "match": "type"
                }
              ]
            },
            "$[*].namePrinted": {
              "combine": "AND",
              "matchers": [
                {
                  "match": "type"
                }
              ]
            },
            "$[*].orderingNumber": {
              "combine": "AND",
              "matchers": [
                {
                  "match": "integer"
                }
              ]
            },
            "$[*].updatedAt": {
              "combine": "AND",
              "matchers": [
                {
                  "match": "type"
                }
              ]
            }
          }
        },
        "status": 200
      }
    }
  ],
  "metadata": {
    "pactRust": {
      "version": "0.1.2"
    },
    "pactSpecification": {
      "version": "3.0.0"
    }
  },
  "provider": {
    "name": "CardManager-Provider"
  }
}

Firebase Test Lab

To using Firebase Test Lab, we can upload Android APK by manual upload or using command line. In this project we will use command line to upload Android APK for testing by Firebase Test Lab.

Create file android_integration.sh to build an instrumentation test for Android use gradle commands

pushd android
# flutter build generates files in android/ for building the app
flutter build apk
./gradlew app:assembleAndroidTest
./gradlew app:assembleDebug -Ptarget=integration_test/feature/safi_demo_test.dart
popd

Google Cloud Setup

To send this apk to firebase automatically, we have to install Google Cloud SDK. Use this guide to install https://cloud.google.com/sdk/docs/install
Go to your Google Cloud console using google account used to access the Firebase Test Lab
Select your project and open Service Account from IAM & Admin menu
Find firebase-adminsdk from the list
In Action, go to manage key and generate the key in json format
Save the file in the roof of the application
Ensure the key is not publish
Go to IAM menu, and find firebase-adminsdk
If you don’t have editor role, you can edit and add role
Go to library from APIs & Services menu
Find Cloud Tool Results API and ensure the API is enable

Finally, update the android_integration.sh

...

gcloud auth activate-service-account --key-file=simple-integration-d61f59baaea2.json

gcloud --quiet config set project simple-integration

gcloud firebase test android run --type instrumentation \
    --app build/app/outputs/apk/debug/app-debug.apk \
    --test build/app/outputs/apk/androidTest/debug/app-debug-androidTest.apk \

To authenticate the google cloud with service account we create, use key in –key-file=<KEY_FILE>
Set the project to firebase project ID. You can get Project ID in Project settings
Set firebase test with gcloud from common line for instrumentation test
Run ./android_integration.sh
You can see the result from firebase test lab