Switch to integration tests (#1461)

* Allow tests to be run as integration tests * Adapt flutter driver tests to new structure * Drop flavor_helpers.dart Use copyFile function variable instead, and override runtime in driver tests * Drop lib symlinks in tests Use package imports over ../lib relative imports * Use a group per test file * Remove test symlink as well * Check both dart defined and shell defined env .. to support both flutter drive and dart test * Fix CI * Simplify dartdoc_options.yaml a bit * Switch to integration_test * bump compileSdkVersion to 33 for android integration tests * Disable realm_map_test on Android integration tests (TEST) * Run android flutter tests on ubuntu-latest - faster, cheaper, and more runners * Enable gradle caching * Only drop Decimal128 tests on Android (TEMPORARY) * Re-create platforms * Allow network again for macos * Publish Test Report from flutter integration test * Remember to set org to io.realm when creating platforms projects * Move copyFile * Fix line-length in app_test.dart * default differentiator to 'local' * Add full directories as assets
realm · Jan 26, 2024 · 517ace7 · 517ace7
1 parent 9ab76b9
commit 517ace7
Show file tree

Hide file tree

Showing 110 changed files with 936 additions and 629 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -321,9 +321,23 @@ jobs:
 
       - name: Run tests on iOS Simulator
         run: |
-          flutter drive --target=test_driver/app.dart --dart-define=testName="" --suppress-analytics --debug
+          flutter test integration_test/all_tests.dart \
+            --dart-define=BAAS_BAASAAS_API_KEY=$BAAS_BAASAAS_API_KEY \
+            --dart-define=BAAS_DIFFERENTIATOR=$BAAS_DIFFERENTIATOR \
+            --file-reporter=json:test-results.json \
+            --suppress-analytics
         working-directory: ./flutter/realm_flutter/tests
 
+      - name: Publish Test Report
+        uses: dorny/[email protected]
+        if: success() || failure()
+        with:
+          name: Test Results Flutter iOS
+          path: test-results.json
+          reporter: dart-json
+          only-summary: true
+          working-directory: ./flutter/realm_flutter/tests
+
   cleanup-cluster-flutter-ios:
     name: Cleanup Cluster for Flutter iOS
     uses: ./.github/workflows/terminate-baas.yml
@@ -342,7 +356,7 @@ jobs:
       differentiator: fa${{ github.run_id }}${{ github.run_attempt }}
 
   flutter-tests-android:
-    runs-on: macos-latest
+    runs-on: ubuntu-latest
     name: Flutter Tests Android
     timeout-minutes: 45
     needs:
@@ -358,6 +372,15 @@ jobs:
         with:
           submodules: 'recursive'
 
+      - name: Enable KVM
+        run: |
+          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+          sudo udevadm control --reload-rules
+          sudo udevadm trigger --name-match=kvm
+
+      - name: Gradle cache
+        uses: gradle/gradle-build-action@v2
+
       - name: Set up Java
         uses: actions/setup-java@v3
         with:
@@ -411,7 +434,17 @@ jobs:
           ndk: 21.0.6113669
           arch: x86
           cmake: 3.10.2.4988404
-          script: flutter build apk --debug --target=test_driver/app.dart && flutter install --debug && flutter drive --target=test_driver/app.dart --dart-define=testName="" --suppress-analytics --debug
+          script: flutter test integration_test/all_tests.dart --dart-define=BAAS_BAASAAS_API_KEY=$BAAS_BAASAAS_API_KEY --dart-define=BAAS_DIFFERENTIATOR=$BAAS_DIFFERENTIATOR --file-reporter=json:test-results.json --suppress-analytics
+          working-directory: ./flutter/realm_flutter/tests
+
+      - name: Publish Test Report
+        uses: dorny/[email protected]
+        if: success() || failure()
+        with:
+          name: Test Results Flutter Android
+          path: test-results.json
+          reporter: dart-json
+          only-summary: true
           working-directory: ./flutter/realm_flutter/tests
 
   cleanup-cluster-flutter-android:

diff --git a/.github/workflows/flutter-desktop-tests.yml b/.github/workflows/flutter-desktop-tests.yml
@@ -72,5 +72,23 @@ jobs:
         if: ${{ contains(inputs.os, 'macos') }}
 
       - name: Run tests
-        run: ${{ inputs.os == 'linux' && 'xvfb-run' || '' }} flutter drive -d ${{ inputs.os }} --target=test_driver/app.dart --suppress-analytics --dart-entrypoint-args="" --debug # -a="Some test name"
+        run: |
+          ${{ inputs.os == 'linux' && 'xvfb-run' || '' }} \
+          flutter test integration_test/all_tests.dart \
+            --dart-define=BAAS_BAASAAS_API_KEY=$BAAS_BAASAAS_API_KEY \
+            --dart-define=BAAS_DIFFERENTIATOR=$BAAS_DIFFERENTIATOR \
+            --device-id=${{ inputs.os }} \
+            --file-reporter=json:test-results.json \
+            --suppress-analytics
+        shell: bash
         working-directory: ./flutter/realm_flutter/tests
+
+      - name: Publish Test Report
+        uses: dorny/[email protected]
+        if: success() || failure()
+        with:
+          name: Test Results Flutter ${{ inputs.os }} ${{ inputs.architecture }}
+          path: test-results.json
+          reporter: dart-json
+          only-summary: true
+          working-directory: ./flutter/realm_flutter/tests
diff --git a/common/topic.md b/common/topic.md
diff --git a/dartdoc_options.yaml b/dartdoc_options.yaml
@@ -1,20 +1,10 @@
 dartdoc:
   categories:
     "Configuration":
-      markdown: topic.md
-      name: Configuration
     "Annotations":
-      markdown: topic.md
-      name: Annotations
     "Realm":
-      markdown: topic.md
-      name: Realm
     "Application":
-      markdown: topic.md
-      name: Application
     "Sync":
-      markdown: topic.md
-      name: Sync
   categoryOrder: ["Realm", "Configuration", "Annotations", "Application", "Sync"]
   examplePathPrefix: 'example'
   # nodoc: ['generator/flutter/ffigen/scripts/src/test/*.g.dart']

diff --git a/flavor_helpers.dart b/flavor_helpers.dart
diff --git a/flutter/realm_flutter/data b/flutter/realm_flutter/data
diff --git a/flutter/realm_flutter/realm_flutter.iml b/flutter/realm_flutter/realm_flutter.iml
diff --git a/flutter/realm_flutter/tests/.metadata b/flutter/realm_flutter/tests/.metadata
@@ -4,7 +4,39 @@
 # This file should be version controlled and should not be manually edited.
 
 version:
-  revision: f18b9281c2280c2646aa3d4348715ed5bb9446c8
-  channel: beta
+  revision: "67457e669f79e9f8d13d7a68fe09775fefbb79f4"
+  channel: "stable"
 
 project_type: app
+
+# Tracks metadata for the flutter migrate command
+migration:
+  platforms:
+    - platform: root
+      create_revision: 67457e669f79e9f8d13d7a68fe09775fefbb79f4
+      base_revision: 67457e669f79e9f8d13d7a68fe09775fefbb79f4
+    - platform: android
+      create_revision: 67457e669f79e9f8d13d7a68fe09775fefbb79f4
+      base_revision: 67457e669f79e9f8d13d7a68fe09775fefbb79f4
+    - platform: ios
+      create_revision: 67457e669f79e9f8d13d7a68fe09775fefbb79f4
+      base_revision: 67457e669f79e9f8d13d7a68fe09775fefbb79f4
+    - platform: linux
+      create_revision: 67457e669f79e9f8d13d7a68fe09775fefbb79f4
+      base_revision: 67457e669f79e9f8d13d7a68fe09775fefbb79f4
+    - platform: macos
+      create_revision: 67457e669f79e9f8d13d7a68fe09775fefbb79f4
+      base_revision: 67457e669f79e9f8d13d7a68fe09775fefbb79f4
+    - platform: windows
+      create_revision: 67457e669f79e9f8d13d7a68fe09775fefbb79f4
+      base_revision: 67457e669f79e9f8d13d7a68fe09775fefbb79f4
+
+  # User provided section
+
+  # List of Local paths (relative to this file) that should be
+  # ignored by the migrate tool.
+  #
+  # Files that are not part of the templates will be ignored by default.
+  unmanaged_files:
+    - 'lib/main.dart'
+    - 'ios/Runner.xcodeproj/project.pbxproj'
diff --git a/flutter/realm_flutter/tests/android/app/build.gradle b/flutter/realm_flutter/tests/android/app/build.gradle
@@ -1,3 +1,9 @@
+plugins {
+    id "com.android.application"
+    id "kotlin-android"
+    id "dev.flutter.flutter-gradle-plugin"
+}
+
 def localProperties = new Properties()
 def localPropertiesFile = rootProject.file('local.properties')
 if (localPropertiesFile.exists()) {
@@ -6,11 +12,6 @@ if (localPropertiesFile.exists()) {
     }
 }
 
-def flutterRoot = localProperties.getProperty('flutter.sdk')
-if (flutterRoot == null) {
-    throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.")
-}
-
 def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
 if (flutterVersionCode == null) {
     flutterVersionCode = '1'
@@ -21,21 +22,31 @@ if (flutterVersionName == null) {
     flutterVersionName = '1.0'
 }
 
-apply plugin: 'com.android.application'
-apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
-
 android {
-    compileSdkVersion 31
+    namespace "io.realm.tests"
+    compileSdkVersion flutter.compileSdkVersion
+    ndkVersion flutter.ndkVersion
 
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_1_8
         targetCompatibility JavaVersion.VERSION_1_8
     }
 
+    kotlinOptions {
+        jvmTarget = '1.8'
+    }
+
+    sourceSets {
+        main.java.srcDirs += 'src/main/kotlin'
+    }
+
     defaultConfig {
+        // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
         applicationId "io.realm.tests"
-        minSdkVersion 16
-        targetSdkVersion 30
+        // You can update the following values to match your application needs.
+        // For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-gradle-build-configuration.
+        minSdkVersion flutter.minSdkVersion
+        targetSdkVersion flutter.targetSdkVersion
         versionCode flutterVersionCode.toInteger()
         versionName flutterVersionName
     }
@@ -52,3 +63,5 @@ android {
 flutter {
     source '../..'
 }
+
+dependencies {}
diff --git a/flutter/realm_flutter/tests/android/app/src/debug/AndroidManifest.xml b/flutter/realm_flutter/tests/android/app/src/debug/AndroidManifest.xml
@@ -1,6 +1,6 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="io.realm.tests">
-    <!-- Flutter needs it to communicate with the running application
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <!-- The INTERNET permission is required for development. Specifically,
+         the Flutter tool needs it to communicate with the running application
          to allow setting breakpoints, to provide hot reload, etc.
     -->
     <uses-permission android:name="android.permission.INTERNET"/>

diff --git a/flutter/realm_flutter/tests/android/app/src/main/AndroidManifest.xml b/flutter/realm_flutter/tests/android/app/src/main/AndroidManifest.xml
@@ -1,10 +1,11 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="io.realm.tests">
-   <application
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <application
         android:label="tests"
+        android:name="${applicationName}"
         android:icon="@mipmap/ic_launcher">
         <activity
             android:name=".MainActivity"
+            android:exported="true"
             android:launchMode="singleTop"
             android:theme="@style/LaunchTheme"
             android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
@@ -18,15 +19,6 @@
               android:name="io.flutter.embedding.android.NormalTheme"
               android:resource="@style/NormalTheme"
               />
-            <!-- Displays an Android View that continues showing the launch screen
-                 Drawable until Flutter paints its first frame, then this splash
-                 screen fades out. A splash screen is useful to avoid any visual
-                 gap between the end of Android's launch screen and the painting of
-                 Flutter's first frame. -->
-            <meta-data
-              android:name="io.flutter.embedding.android.SplashScreenDrawable"
-              android:resource="@drawable/launch_background"
-              />
             <intent-filter>
                 <action android:name="android.intent.action.MAIN"/>
                 <category android:name="android.intent.category.LAUNCHER"/>

diff --git a/flutter/realm_flutter/tests/android/app/src/main/java/io/tests/MainActivity.java b/flutter/realm_flutter/tests/android/app/src/main/java/io/tests/MainActivity.java
diff --git a/flutter/realm_flutter/tests/android/app/src/main/kotlin/io/realm/tests/MainActivity.kt b/flutter/realm_flutter/tests/android/app/src/main/kotlin/io/realm/tests/MainActivity.kt
@@ -0,0 +1,6 @@
+package io.realm.tests
+
+import io.flutter.embedding.android.FlutterActivity
+
+class MainActivity: FlutterActivity() {
+}
diff --git a/flutter/realm_flutter/tests/android/app/src/main/res/values-night/styles.xml b/flutter/realm_flutter/tests/android/app/src/main/res/values-night/styles.xml
@@ -3,14 +3,14 @@
     <!-- Theme applied to the Android Window while the process is starting when the OS's Dark Mode setting is on -->
     <style name="LaunchTheme" parent="@android:style/Theme.Black.NoTitleBar">
         <!-- Show a splash screen on the activity. Automatically removed when
-             Flutter draws its first frame -->
+             the Flutter engine draws its first frame -->
         <item name="android:windowBackground">@drawable/launch_background</item>
     </style>
     <!-- Theme applied to the Android Window as soon as the process has started.
          This theme determines the color of the Android Window while your
          Flutter UI initializes, as well as behind your Flutter UI while its
          running.
-         
+
          This Theme is only used starting with V2 of Flutter's Android embedding. -->
     <style name="NormalTheme" parent="@android:style/Theme.Black.NoTitleBar">
         <item name="android:windowBackground">?android:colorBackground</item>

diff --git a/flutter/realm_flutter/tests/android/app/src/main/res/values/styles.xml b/flutter/realm_flutter/tests/android/app/src/main/res/values/styles.xml
@@ -3,14 +3,14 @@
     <!-- Theme applied to the Android Window while the process is starting when the OS's Dark Mode setting is off -->
     <style name="LaunchTheme" parent="@android:style/Theme.Light.NoTitleBar">
         <!-- Show a splash screen on the activity. Automatically removed when
-             Flutter draws its first frame -->
+             the Flutter engine draws its first frame -->
         <item name="android:windowBackground">@drawable/launch_background</item>
     </style>
     <!-- Theme applied to the Android Window as soon as the process has started.
          This theme determines the color of the Android Window while your
          Flutter UI initializes, as well as behind your Flutter UI while its
          running.
-         
+
          This Theme is only used starting with V2 of Flutter's Android embedding. -->
     <style name="NormalTheme" parent="@android:style/Theme.Light.NoTitleBar">
         <item name="android:windowBackground">?android:colorBackground</item>

diff --git a/flutter/realm_flutter/tests/android/app/src/profile/AndroidManifest.xml b/flutter/realm_flutter/tests/android/app/src/profile/AndroidManifest.xml
@@ -1,6 +1,6 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="io.realm.tests">
-    <!-- Flutter needs it to communicate with the running application
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <!-- The INTERNET permission is required for development. Specifically,
+         the Flutter tool needs it to communicate with the running application
          to allow setting breakpoints, to provide hot reload, etc.
     -->
     <uses-permission android:name="android.permission.INTERNET"/>

diff --git a/flutter/realm_flutter/tests/android/build.gradle b/flutter/realm_flutter/tests/android/build.gradle
@@ -1,11 +1,12 @@
 buildscript {
+    ext.kotlin_version = '1.7.10'
     repositories {
         google()
         mavenCentral()
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:7.3.0'
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
 }
 
@@ -14,17 +15,13 @@ allprojects {
         google()
         mavenCentral()
     }
-
-     gradle.projectsEvaluated {
-        tasks.withType(JavaCompile) {
-            options.compilerArgs << "-Xlint:deprecation"
-        }
-    }   
 }
 
 rootProject.buildDir = '../build'
 subprojects {
     project.buildDir = "${rootProject.buildDir}/${project.name}"
+}
+subprojects {
     project.evaluationDependsOn(':app')
 }
 

diff --git a/flutter/realm_flutter/tests/android/gradle.properties b/flutter/realm_flutter/tests/android/gradle.properties
@@ -1,4 +1,3 @@
-org.gradle.jvmargs=-Xmx1536M
+org.gradle.jvmargs=-Xmx4G
 android.useAndroidX=true
 android.enableJetifier=true
-android.native.buildOutput=verbose