Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run integration tests against Android emulator #31

Merged
merged 22 commits into from
Oct 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 62 additions & 37 deletions .github/workflows/pipeline.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,26 @@
on:
push:

env:
SCRIPT: ./example/integration_test/execute.sh

jobs:
android:
name: Android APKs
name: Android integration tests
strategy:
fail-fast: false
matrix:
flutter-version:
- 3.x
- 3.0.0
runs-on: ubuntu-latest
include:
- avd-api-level: 21
avd-target: google_apis
flutter-version: 3.0.0
macos-version: macos-11
- avd-api-level: 34
avd-target: google_apis
flutter-version: any
macos-version: macos-latest
runs-on: ${{ matrix.macos-version }}

steps:
- uses: actions/checkout@v3

Expand All @@ -22,47 +33,64 @@ jobs:
uses: actions/cache@v3
with:
path: ${{ env.PUB_CACHE }}
key: pub-cache-ubuntu-latest-${{ steps.flutter-action.outputs.VERSION }}-${{ hashFiles('example/pubspec.lock') }}
key: pub-cache-${{ steps.flutter-action.outputs.VERSION }}-${{ hashFiles('example/pubspec.lock') }}

- name: Setup Java 11
uses: actions/setup-java@v3
with:
cache: gradle
distribution: temurin
java-version: "11"
# pre-build the app to (hopefully) speed up the test execution time,
# avoiding the `Test timed out after 12 minutes.` error.
# Apparently the timeout could not be configured, see https://github.com/flutter/flutter/issues/105913
- name: Run flutter build apk
run: |
set -e
- run: flutter build apk --split-per-abi
# use pre-installed Java 11
export JAVA_HOME=$JAVA_HOME_11_X64
echo "JAVA_HOME=$JAVA_HOME" >> $GITHUB_ENV
flutter build apk --debug --target=integration_test/app_test.dart
working-directory: example

- uses: actions/upload-artifact@v3
- name: AVD cache
uses: actions/cache@v3
id: avd-cache
with:
name: ${{ steps.flutter-action.outputs.VERSION }}-arm64-v8a
path: example/build/app/outputs/flutter-apk/app-arm64-v8a-release.apk
- uses: actions/upload-artifact@v3
path: |
~/.android/avd/*
~/.android/adb*
key: avd-${{ matrix.avd-api-level }}-${{ matrix.avd-target }}
- name: Create AVD and generate snapshot for caching
if: steps.avd-cache.outputs.cache-hit != 'true'
uses: reactivecircus/android-emulator-runner@v2
with:
name: ${{ steps.flutter-action.outputs.VERSION }}-armeabi-v7a
path: example/build/app/outputs/flutter-apk/app-armeabi-v7a-release.apk
- uses: actions/upload-artifact@v3
api-level: ${{ matrix.avd-api-level }}
arch: x86_64
disk-size: 2G
target: ${{ matrix.avd-target }}
force-avd-creation: false
emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
disable-animations: false
script: echo "Generated AVD snapshot for caching."
- name: RUN ${{ env.SCRIPT }}
uses: reactivecircus/android-emulator-runner@v2
with:
name: ${{ steps.flutter-action.outputs.VERSION }}-x86_64
path: example/build/app/outputs/flutter-apk/app-x86_64-release.apk
api-level: ${{ matrix.avd-api-level }}
arch: x86_64
disk-size: 2G
target: ${{ matrix.avd-target }}
force-avd-creation: false
emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
disable-animations: true
script: ${{ env.SCRIPT }}

ios:
name: iOS integration tests
strategy:
fail-fast: false
matrix:
include:
# oldest available macOS version on GitHub Actions with latest Flutter version
- flutter-version: 3.x
macos-version: macos-11
skip-tests: true # flakiness
# latest available macOS version on GitHub Actions with latest Flutter version
- flutter-version: 3.x
macos-version: macos-12
# oldest supported combination
- flutter-version: 3.0.0
macos-version: macos-11
skip-tests: true # flakiness
- flutter-version: any
macos-version: macos-latest
runs-on: ${{ matrix.macos-version }}

steps:
Expand All @@ -77,7 +105,7 @@ jobs:
uses: actions/cache@v3
with:
path: ${{ env.PUB_CACHE }}
key: pub-cache-${{ matrix.macos-version }}-${{ steps.flutter-action.outputs.VERSION }}-${{ hashFiles('example/pubspec.lock') }}
key: pub-cache-${{ steps.flutter-action.outputs.VERSION }}-${{ hashFiles('example/pubspec.lock') }}
- name: Cache CocoaPods
uses: actions/cache@v3
with:
Expand All @@ -99,11 +127,8 @@ jobs:
xcrun simctl create "$_deviceTypeName" "$_deviceTypeId" "$_runtimeId" | xargs xcrun simctl boot
# pre-build the app to (hopefully) speed up the test execution time,
# avoiding the `Test timed out after 12 minutes.` error.
# Apparently the timeout could not be configured, see https://github.com/flutter/flutter/issues/105913
# https://github.com/flutter/flutter/issues/105913
- run: flutter build ios --simulator --target=integration_test/app_test.dart
working-directory: example

- run: ./example/integration_test/execute.sh
if: ${{ !matrix.skip-tests }}
- run: ${{ env.SCRIPT }}
6 changes: 6 additions & 0 deletions example/lib/main.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
import 'package:flutter/material.dart';
import 'package:logging/logging.dart';
import 'package:stockfish/stockfish.dart';

import 'src/output_widget.dart';

void main() {
Logger.root.level = Level.ALL;
Logger.root.onRecord.listen((record) {
debugPrint('${record.level.name}: ${record.time}: ${record.message}');
});

runApp(const MyApp());
}

Expand Down
96 changes: 40 additions & 56 deletions example/pubspec.lock
Original file line number Diff line number Diff line change
@@ -1,22 +1,14 @@
# Generated by pub
# See https://dart.dev/tools/pub/glossary#lockfile
packages:
archive:
dependency: transitive
description:
name: archive
sha256: "80e5141fafcb3361653ce308776cfd7d45e6e9fbb429e14eec571382c0c5fecb"
url: "https://pub.dev"
source: hosted
version: "3.3.2"
async:
dependency: transitive
description:
name: async
sha256: bfe67ef28df125b7dddcea62755991f807aa39a2492a23e1550161692950bbe0
sha256: "947bfcf187f74dbc5e146c9eb9c0f10c9f8b30743e341481c1e2ed3ecc18c20c"
url: "https://pub.dev"
source: hosted
version: "2.10.0"
version: "2.11.0"
boolean_selector:
dependency: transitive
description:
Expand All @@ -29,10 +21,10 @@ packages:
dependency: transitive
description:
name: characters
sha256: e6a326c8af69605aec75ed6c187d06b349707a27fbff8222ca9cc2cff167975c
sha256: "04a925763edad70e8443c99234dc3328f442e811f1d8fd1a72f1c8ad0f69a605"
url: "https://pub.dev"
source: hosted
version: "1.2.1"
version: "1.3.0"
clock:
dependency: transitive
description:
Expand All @@ -45,18 +37,10 @@ packages:
dependency: transitive
description:
name: collection
sha256: cfc915e6923fe5ce6e153b0723c753045de46de1b4d63771530504004a45fae0
url: "https://pub.dev"
source: hosted
version: "1.17.0"
crypto:
dependency: transitive
description:
name: crypto
sha256: aa274aa7774f8964e4f4f38cc994db7b6158dd36e9187aaceaddc994b35c6c67
sha256: f092b211a4319e98e5ff58223576de6c2803db36221657b46c82574721240687
url: "https://pub.dev"
source: hosted
version: "3.0.2"
version: "1.17.2"
fake_async:
dependency: transitive
description:
Expand Down Expand Up @@ -114,14 +98,6 @@ packages:
description: flutter
source: sdk
version: "0.0.0"
js:
dependency: transitive
description:
name: js
sha256: "5528c2f391ededb7775ec1daa69e65a2d61276f7552de2b5f7b8d34ee9fd4ab7"
url: "https://pub.dev"
source: hosted
version: "0.6.5"
lints:
dependency: transitive
description:
Expand All @@ -130,38 +106,46 @@ packages:
url: "https://pub.dev"
source: hosted
version: "2.0.1"
logging:
dependency: "direct main"
description:
name: logging
sha256: "623a88c9594aa774443aa3eb2d41807a48486b5613e67599fb4c41c0ad47c340"
url: "https://pub.dev"
source: hosted
version: "1.2.0"
matcher:
dependency: transitive
description:
name: matcher
sha256: "16db949ceee371e9b99d22f88fa3a73c4e59fd0afed0bd25fc336eb76c198b72"
sha256: "1803e76e6653768d64ed8ff2e1e67bea3ad4b923eb5c56a295c3e634bad5960e"
url: "https://pub.dev"
source: hosted
version: "0.12.13"
version: "0.12.16"
material_color_utilities:
dependency: transitive
description:
name: material_color_utilities
sha256: d92141dc6fe1dad30722f9aa826c7fbc896d021d792f80678280601aff8cf724
sha256: "9528f2f296073ff54cb9fee677df673ace1218163c3bc7628093e7eed5203d41"
url: "https://pub.dev"
source: hosted
version: "0.2.0"
version: "0.5.0"
meta:
dependency: transitive
description:
name: meta
sha256: "6c268b42ed578a53088d834796959e4a1814b5e9e164f147f580a386e5decf42"
sha256: "3c74dbf8763d36539f114c799d8a2d87343b5067e9d796ca22b5eb8437090ee3"
url: "https://pub.dev"
source: hosted
version: "1.8.0"
version: "1.9.1"
path:
dependency: transitive
description:
name: path
sha256: db9d4f58c908a4ba5953fcee2ae317c94889433e5024c27ce74a37f94267945b
sha256: "8829d8a55c13fc0e37127c29fedf290c102f4e40ae94ada574091fe0ff96c917"
url: "https://pub.dev"
source: hosted
version: "1.8.2"
version: "1.8.3"
platform:
dependency: transitive
description:
Expand All @@ -187,10 +171,10 @@ packages:
dependency: transitive
description:
name: source_span
sha256: dd904f795d4b4f3b870833847c461801f6750a9fa8e61ea5ac53f9422b31f250
sha256: "53e943d4206a5e30df338fd4c6e7a077e02254531b138a15aec3bd143c1a8b3c"
url: "https://pub.dev"
source: hosted
version: "1.9.1"
version: "1.10.0"
stack_trace:
dependency: transitive
description:
Expand All @@ -205,7 +189,7 @@ packages:
path: ".."
relative: true
source: path
version: "1.2.0"
version: "1.3.0"
stream_channel:
dependency: transitive
description:
Expand Down Expand Up @@ -242,18 +226,10 @@ packages:
dependency: transitive
description:
name: test_api
sha256: ad540f65f92caa91bf21dfc8ffb8c589d6e4dc0c2267818b4cc2792857706206
url: "https://pub.dev"
source: hosted
version: "0.4.16"
typed_data:
dependency: transitive
description:
name: typed_data
sha256: "26f87ade979c47a150c9eaab93ccd2bebe70a27dc0b4b29517f2904f04eb11a5"
sha256: "75760ffd7786fffdfb9597c35c5b27eaeec82be8edfb6d71d32651128ed7aab8"
url: "https://pub.dev"
source: hosted
version: "1.3.1"
version: "0.6.0"
vector_math:
dependency: transitive
description:
Expand All @@ -266,18 +242,26 @@ packages:
dependency: transitive
description:
name: vm_service
sha256: e7fb6c2282f7631712b69c19d1bff82f3767eea33a2321c14fa59ad67ea391c7
sha256: c620a6f783fa22436da68e42db7ebbf18b8c44b9a46ab911f666ff09ffd9153f
url: "https://pub.dev"
source: hosted
version: "11.7.1"
web:
dependency: transitive
description:
name: web
sha256: dc8ccd225a2005c1be616fe02951e2e342092edf968cf0844220383757ef8f10
url: "https://pub.dev"
source: hosted
version: "9.4.0"
version: "0.1.4-beta"
webdriver:
dependency: transitive
description:
name: webdriver
sha256: ef67178f0cc7e32c1494645b11639dd1335f1d18814aa8435113a92e9ef9d841
sha256: "3c923e918918feeb90c4c9fdf1fe39220fa4c0e8e2c0fffaded174498ef86c49"
url: "https://pub.dev"
source: hosted
version: "3.0.1"
version: "3.0.2"
sdks:
dart: ">=2.18.0 <3.0.0"
dart: ">=3.1.0-185.0.dev <4.0.0"
flutter: ">=3.0.0"
1 change: 1 addition & 0 deletions example/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ environment:
dependencies:
flutter:
sdk: flutter
logging: ^1.0.0
stockfish:
path: ../

Expand Down
4 changes: 3 additions & 1 deletion lib/src/stockfish.dart
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ class Stockfish {
_mainPort.listen((message) => _cleanUp(message is int ? message : 1));
_stdoutSubscription = _stdoutPort.listen((message) {
if (message is String) {
_logger.finest('The stdout isolate sent $message');
_stdoutController.sink.add(message);
} else {
_logger.fine('The stdout isolate sent $message');
Expand All @@ -35,6 +36,7 @@ class Stockfish {
compute(_spawnIsolates, [_mainPort.sendPort, _stdoutPort.sendPort]).then(
(success) {
final state = success ? StockfishState.ready : StockfishState.error;
_logger.fine('The init isolate reported $state');
_state._setValue(state);
if (state == StockfishState.ready) {
completer?.complete(this);
Expand Down Expand Up @@ -100,7 +102,7 @@ class Stockfish {

/// Creates a C++ engine asynchronously.
///
/// This method is different from the factory method [new Stockfish] that
/// This method is different from the factory method [Stockfish.new] that
/// it will wait for the engine to be ready before returning the instance.
Future<Stockfish> stockfishAsync() {
if (Stockfish._instance != null) {
Expand Down