[package_info] Support the v2 Android embedder (with e2e tests) (flut…

…ter#2160) * Migrate the package_info plugin to use the new embedder. * Upgraded to AndroidX. * Added a unit test. * Added Firebase Test Lab compatible e2e testing (including changes to Dockerfile and .cirrus.yml)
sungmin-park · Dec 17, 2019 · 8b1342f · 8b1342f
1 parent f3e29b1
commit 8b1342f
Show file tree

Hide file tree

Showing 20 changed files with 271 additions and 63 deletions.
diff --git a/.ci/Dockerfile b/.ci/Dockerfile
@@ -1,5 +1,20 @@
 FROM cirrusci/flutter:stable
 
+RUN sudo apt-get update -y
+
+RUN sudo apt-get install -y --no-install-recommends gnupg
+
+# Add repo for gcloud sdk and install it
+RUN echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | \
+    sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list 
+
+RUN curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | \
+    sudo apt-key --keyring /usr/share/keyrings/cloud.google.gpg add -
+
+RUN sudo apt-get update && sudo apt-get install -y google-cloud-sdk && \
+    gcloud config set core/disable_usage_reporting true && \
+    gcloud config set component_manager/disable_update_check true
+
 RUN yes | sdkmanager \
     "platforms;android-27" \
     "build-tools;27.0.3" \

diff --git a/.cirrus.yml b/.cirrus.yml
@@ -24,12 +24,13 @@ task:
       script: ./script/incremental_build.sh analyze
     - name: build_all_plugins_apk
       script: ./script/build_all_plugins_app.sh apk
-    - name: build-apks+java-test+drive-examples
+    - name: build-apks+java-test+firebase-test-lab
       env:
         matrix:
           PLUGIN_SHARDING: "--shardIndex 0 --shardCount 2"
           PLUGIN_SHARDING: "--shardIndex 1 --shardCount 2"
         MAPS_API_KEY: ENCRYPTED[596a9f6bca436694625ac50851dc5da6b4d34cba8025f7db5bc9465142e8cd44e15f69e3507787753accebfc4910d550]
+        GCLOUD_FIREBASE_TESTLAB_KEY: ENCRYPTED[07586610af1fdfc894e5969f70ef2458341b9b7e9c3b7c4225a663b4a48732b7208a4d91c3b7d45305a6b55fa2a37fc4]
       script:
         # Unsetting CIRRUS_CHANGE_MESSAGE and CIRRUS_COMMIT_MESSAGE as they
         # might include non-ASCII characters which makes Gradle crash.
@@ -43,6 +44,12 @@ task:
         - export CIRRUS_COMMIT_MESSAGE=""
         - ./script/incremental_build.sh build-examples --apk
         - ./script/incremental_build.sh java-test  # must come after apk build
+        - if [[ $GCLOUD_FIREBASE_TESTLAB_KEY == ENCRYPTED* ]]; then
+        -   echo "This user does not have permission to run Firebase Test Lab tests."
+        - else
+        -   echo $GCLOUD_FIREBASE_TESTLAB_KEY > ${HOME}/gcloud-service-key.json
+        -   ./script/incremental_build.sh firebase-test-lab
+        - fi
         - export CIRRUS_CHANGE_MESSAGE=`cat /tmp/cirrus_change_message.txt`
         - export CIRRUS_COMMIT_MESSAGE=`cat /tmp/cirrus_commit_message.txt`
 

diff --git a/packages/package_info/CHANGELOG.md b/packages/package_info/CHANGELOG.md
@@ -1,3 +1,10 @@
+## 0.4.0+8
+
+* Support the v2 Android embedder.
+* Update to AndroidX.
+* Add a unit test.
+* Migrate to using the new e2e test binding.
+
 ## 0.4.0+7
 
 * Update and migrate iOS example project.

diff --git a/packages/package_info/android/build.gradle b/packages/package_info/android/build.gradle
@@ -45,3 +45,28 @@ android {
         disable 'InvalidPackage'
     }
 }
+
+// TODO(amirh): Remove this hack once androidx.lifecycle is included on stable. https://github.com/flutter/flutter/issues/42348
+afterEvaluate {
+    def containsEmbeddingDependencies = false
+    for (def configuration : configurations.all) {
+        for (def dependency : configuration.dependencies) {
+            if (dependency.group == 'io.flutter' &&
+                    dependency.name.startsWith('flutter_embedding') &&
+                    dependency.isTransitive())
+            {
+                containsEmbeddingDependencies = true
+                break
+            }
+        }
+    }
+    if (!containsEmbeddingDependencies) {
+        android {
+            dependencies {
+                def lifecycle_version = "2.1.0"
+                api "androidx.lifecycle:lifecycle-common-java8:$lifecycle_version"
+                api "androidx.lifecycle:lifecycle-runtime:$lifecycle_version"
+            }
+        }
+    }
+}
diff --git a/packages/package_info/android/gradle.properties b/packages/package_info/android/gradle.properties
@@ -1 +1,2 @@
 org.gradle.jvmargs=-Xmx1536M
+android.enableJetifier=true
diff --git a/.../package_info/android/src/main/java/io/flutter/plugins/packageinfo/PackageInfoPlugin.java b/.../package_info/android/src/main/java/io/flutter/plugins/packageinfo/PackageInfoPlugin.java
@@ -8,6 +8,8 @@
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager;
 import android.os.Build;
+import io.flutter.embedding.engine.plugins.FlutterPlugin;
+import io.flutter.plugin.common.BinaryMessenger;
 import io.flutter.plugin.common.MethodCall;
 import io.flutter.plugin.common.MethodChannel;
 import io.flutter.plugin.common.MethodChannel.MethodCallHandler;
@@ -17,31 +19,45 @@
 import java.util.Map;
 
 /** PackageInfoPlugin */
-public class PackageInfoPlugin implements MethodCallHandler {
-  private final Registrar mRegistrar;
+public class PackageInfoPlugin implements MethodCallHandler, FlutterPlugin {
+  private Context applicationContext;
+  private MethodChannel methodChannel;
 
   /** Plugin registration. */
   public static void registerWith(Registrar registrar) {
-    final MethodChannel channel =
-        new MethodChannel(registrar.messenger(), "plugins.flutter.io/package_info");
-    channel.setMethodCallHandler(new PackageInfoPlugin(registrar));
+    final PackageInfoPlugin instance = new PackageInfoPlugin();
+    instance.onAttachedToEngine(registrar.context(), registrar.messenger());
   }
 
-  private PackageInfoPlugin(Registrar registrar) {
-    this.mRegistrar = registrar;
+  @Override
+  public void onAttachedToEngine(FlutterPluginBinding binding) {
+    onAttachedToEngine(
+        binding.getApplicationContext(), binding.getFlutterEngine().getDartExecutor());
+  }
+
+  private void onAttachedToEngine(Context applicationContext, BinaryMessenger messenger) {
+    this.applicationContext = applicationContext;
+    methodChannel = new MethodChannel(messenger, "plugins.flutter.io/package_info");
+    methodChannel.setMethodCallHandler(this);
+  }
+
+  @Override
+  public void onDetachedFromEngine(FlutterPluginBinding binding) {
+    applicationContext = null;
+    methodChannel.setMethodCallHandler(null);
+    methodChannel = null;
   }
 
   @Override
   public void onMethodCall(MethodCall call, Result result) {
     try {
-      Context context = mRegistrar.context();
       if (call.method.equals("getAll")) {
-        PackageManager pm = context.getPackageManager();
-        PackageInfo info = pm.getPackageInfo(context.getPackageName(), 0);
+        PackageManager pm = applicationContext.getPackageManager();
+        PackageInfo info = pm.getPackageInfo(applicationContext.getPackageName(), 0);
 
         Map<String, String> map = new HashMap<>();
         map.put("appName", info.applicationInfo.loadLabel(pm).toString());
-        map.put("packageName", context.getPackageName());
+        map.put("packageName", applicationContext.getPackageName());
         map.put("version", info.versionName);
         map.put("buildNumber", String.valueOf(getLongVersionCode(info)));
 

diff --git a/packages/package_info/example/android/app/gradle.properties b/packages/package_info/example/android/app/gradle.properties
@@ -1,2 +1,3 @@
 android.enableJetifier=true
-android.useAndroidX=true
+android.useAndroidX=true
+android.enableR8=true
diff --git a/...pp/src/androidTest/java/io/flutter/plugins/packageinfoexample/EmbedderV1ActivityTest.java b/...pp/src/androidTest/java/io/flutter/plugins/packageinfoexample/EmbedderV1ActivityTest.java
@@ -0,0 +1,17 @@
+// Copyright 2019 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package io.flutter.plugins.packageinfoexample;
+
+import androidx.test.rule.ActivityTestRule;
+import dev.flutter.plugins.e2e.FlutterRunner;
+import org.junit.Rule;
+import org.junit.runner.RunWith;
+
+@RunWith(FlutterRunner.class)
+public class EmbedderV1ActivityTest {
+  @Rule
+  public ActivityTestRule<EmbedderV1Activity> rule =
+      new ActivityTestRule<>(EmbedderV1Activity.class);
+}
diff --git a/...roid/app/src/androidTest/java/io/flutter/plugins/packageinfoexample/MainActivityTest.java b/...roid/app/src/androidTest/java/io/flutter/plugins/packageinfoexample/MainActivityTest.java
@@ -0,0 +1,15 @@
+// Copyright 2019 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package io.flutter.plugins.packageinfoexample;
+
+import androidx.test.rule.ActivityTestRule;
+import dev.flutter.plugins.e2e.FlutterRunner;
+import org.junit.Rule;
+import org.junit.runner.RunWith;
+
+@RunWith(FlutterRunner.class)
+public class MainActivityTest {
+  @Rule public ActivityTestRule<MainActivity> rule = new ActivityTestRule<>(MainActivity.class);
+}
diff --git a/packages/package_info/example/android/app/src/main/AndroidManifest.xml b/packages/package_info/example/android/app/src/main/AndroidManifest.xml
@@ -5,7 +5,6 @@
 
     <application android:name="io.flutter.app.FlutterApplication" android:label="package_info_example" android:icon="@mipmap/ic_launcher">
         <activity android:name=".MainActivity"
-                  android:launchMode="singleTop"
                   android:theme="@android:style/Theme.Black.NoTitleBar"
                   android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|layoutDirection"
                   android:hardwareAccelerated="true"
@@ -15,5 +14,11 @@
                 <category android:name="android.intent.category.LAUNCHER"/>
             </intent-filter>
         </activity>
+        <activity android:name=".EmbedderV1Activity"
+                  android:theme="@android:style/Theme.Black.NoTitleBar"
+                  android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|layoutDirection"
+                  android:hardwareAccelerated="true"
+                  android:windowSoftInputMode="adjustResize">
+        </activity>
     </application>
 </manifest>
diff --git a/...e/android/app/src/main/java/io/flutter/plugins/packageinfoexample/EmbedderV1Activity.java b/...e/android/app/src/main/java/io/flutter/plugins/packageinfoexample/EmbedderV1Activity.java
@@ -0,0 +1,17 @@
+// Copyright 2017 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package io.flutter.plugins.packageinfoexample;
+
+import android.os.Bundle;
+import io.flutter.app.FlutterActivity;
+import io.flutter.plugins.GeneratedPluginRegistrant;
+
+public class EmbedderV1Activity extends FlutterActivity {
+  @Override
+  protected void onCreate(Bundle savedInstanceState) {
+    super.onCreate(savedInstanceState);
+    GeneratedPluginRegistrant.registerWith(this);
+  }
+}
diff --git a/...example/android/app/src/main/java/io/flutter/plugins/packageinfoexample/MainActivity.java b/...example/android/app/src/main/java/io/flutter/plugins/packageinfoexample/MainActivity.java
@@ -4,14 +4,17 @@
 
 package io.flutter.plugins.packageinfoexample;
 
-import android.os.Bundle;
-import io.flutter.app.FlutterActivity;
-import io.flutter.plugins.GeneratedPluginRegistrant;
+import dev.flutter.plugins.e2e.E2EPlugin;
+import io.flutter.embedding.android.FlutterActivity;
+import io.flutter.embedding.engine.FlutterEngine;
+import io.flutter.plugins.packageinfo.PackageInfoPlugin;
 
 public class MainActivity extends FlutterActivity {
+  // TODO(jackson): Remove this once v2 of GeneratedPluginRegistrant rolls to stable.
+  // https://github.com/flutter/flutter/issues/42694
   @Override
-  protected void onCreate(Bundle savedInstanceState) {
-    super.onCreate(savedInstanceState);
-    GeneratedPluginRegistrant.registerWith(this);
+  public void configureFlutterEngine(FlutterEngine flutterEngine) {
+    flutterEngine.getPlugins().add(new PackageInfoPlugin());
+    flutterEngine.getPlugins().add(new E2EPlugin());
   }
 }
diff --git a/packages/package_info/example/android/gradle.properties b/packages/package_info/example/android/gradle.properties
@@ -1 +1,4 @@
 org.gradle.jvmargs=-Xmx1536M
+android.enableJetifier=true
+android.enableR8=true
+android.useAndroidX=true
diff --git a/packages/package_info/example/pubspec.yaml b/packages/package_info/example/pubspec.yaml
@@ -6,6 +6,7 @@ dependencies:
     sdk: flutter
   package_info:
     path: ../
+  e2e: "^0.2.1"
 
 dev_dependencies:
   flutter_driver:

diff --git a/packages/package_info/example/test_driver/package_info.dart b/packages/package_info/example/test_driver/package_info.dart
diff --git a/packages/package_info/example/test_driver/package_info_e2e.dart b/packages/package_info/example/test_driver/package_info_e2e.dart
@@ -0,0 +1,51 @@
+// Copyright 2019, the Chromium project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'dart:io';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:e2e/e2e.dart';
+import 'package:package_info/package_info.dart';
+import 'package:package_info_example/main.dart';
+
+void main() {
+  E2EWidgetsFlutterBinding.ensureInitialized();
+
+  testWidgets('fromPlatform', (WidgetTester tester) async {
+    final PackageInfo info = await PackageInfo.fromPlatform();
+    // These tests are based on the example app. The tests should be updated if any related info changes.
+    if (Platform.isAndroid) {
+      expect(info.appName, 'package_info_example');
+      expect(info.buildNumber, '1');
+      expect(info.packageName, 'io.flutter.plugins.packageinfoexample');
+      expect(info.version, '1.0');
+    } else if (Platform.isIOS) {
+      expect(info.appName, 'Package Info Example');
+      expect(info.buildNumber, '1');
+      expect(info.packageName, 'io.flutter.plugins.packageInfoExample');
+      expect(info.version, '1.0');
+    } else {
+      throw (UnsupportedError('platform not supported'));
+    }
+  });
+
+  testWidgets('example', (WidgetTester tester) async {
+    await tester.pumpWidget(MyApp());
+    await tester.pumpAndSettle();
+    if (Platform.isAndroid) {
+      expect(find.text('package_info_example'), findsOneWidget);
+      expect(find.text('1'), findsOneWidget);
+      expect(
+          find.text('io.flutter.plugins.packageinfoexample'), findsOneWidget);
+      expect(find.text('1.0'), findsOneWidget);
+    } else if (Platform.isIOS) {
+      expect(find.text('Package Info Example'), findsOneWidget);
+      expect(find.text('1'), findsOneWidget);
+      expect(
+          find.text('io.flutter.plugins.packageInfoExample'), findsOneWidget);
+      expect(find.text('1.0'), findsOneWidget);
+    } else {
+      throw (UnsupportedError('platform not supported'));
+    }
+  });
+}
diff --git a/packages/package_info/example/test_driver/package_info_e2e_test.dart b/packages/package_info/example/test_driver/package_info_e2e_test.dart
@@ -0,0 +1,15 @@
+// Copyright 2019, the Chromium project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'dart:io';
+
+import 'package:flutter_driver/flutter_driver.dart';
+
+Future<void> main() async {
+  final FlutterDriver driver = await FlutterDriver.connect();
+  final String result =
+      await driver.requestData(null, timeout: const Duration(minutes: 1));
+  driver.close();
+  exit(result == 'pass' ? 0 : 1);
+}
diff --git a/packages/package_info/example/test_driver/package_info_test.dart b/packages/package_info/example/test_driver/package_info_test.dart