Skip to content

Commit

Permalink
Make BackgroundMode public. (flutter#45747) (flutter#14673)
Browse files Browse the repository at this point in the history
  • Loading branch information
matthew-carroll authored and NoamDev committed Feb 27, 2020
1 parent cef181f commit a57823c
Show file tree
Hide file tree
Showing 6 changed files with 96 additions and 12 deletions.
2 changes: 2 additions & 0 deletions shell/platform/android/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,7 @@ action("robolectric_tests") {
"test/io/flutter/embedding/android/FlutterAndroidComponentTest.java",
"test/io/flutter/embedding/android/FlutterFragmentTest.java",
"test/io/flutter/embedding/android/FlutterViewTest.java",
"test/io/flutter/embedding/android/RobolectricFlutterActivity.java",
"test/io/flutter/embedding/engine/FlutterEngineCacheTest.java",
"test/io/flutter/embedding/engine/FlutterEngineTest.java",
"test/io/flutter/embedding/engine/FlutterJNITest.java",
Expand All @@ -429,6 +430,7 @@ action("robolectric_tests") {
"test/io/flutter/embedding/engine/plugins/shim/ShimPluginRegistryTest.java",
"test/io/flutter/embedding/engine/renderer/FlutterRendererTest.java",
"test/io/flutter/embedding/engine/systemchannels/PlatformChannelTest.java",
"test/io/flutter/external/FlutterLaunchTests.java",
"test/io/flutter/plugin/common/StandardMessageCodecTest.java",
"test/io/flutter/plugin/editing/TextInputPluginTest.java",
"test/io/flutter/plugin/platform/SingleViewPresentationTest.java",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,29 @@

package io.flutter.embedding.android;

class FlutterActivityLaunchConfigs {
/**
* Collection of Flutter launch configuration options.
*/
// This class is public so that Flutter app developers can reference
// BackgroundMode
@SuppressWarnings("WeakerAccess")
public class FlutterActivityLaunchConfigs {
// Meta-data arguments, processed from manifest XML.
static final String DART_ENTRYPOINT_META_DATA_KEY = "io.flutter.Entrypoint";
static final String INITIAL_ROUTE_META_DATA_KEY = "io.flutter.InitialRoute";
static final String SPLASH_SCREEN_META_DATA_KEY = "io.flutter.embedding.android.SplashScreenDrawable";
static final String NORMAL_THEME_META_DATA_KEY = "io.flutter.embedding.android.NormalTheme";
/* package */ static final String DART_ENTRYPOINT_META_DATA_KEY = "io.flutter.Entrypoint";
/* package */ static final String INITIAL_ROUTE_META_DATA_KEY = "io.flutter.InitialRoute";
/* package */ static final String SPLASH_SCREEN_META_DATA_KEY = "io.flutter.embedding.android.SplashScreenDrawable";
/* package */ static final String NORMAL_THEME_META_DATA_KEY = "io.flutter.embedding.android.NormalTheme";

// Intent extra arguments.
static final String EXTRA_INITIAL_ROUTE = "initial_route";
static final String EXTRA_BACKGROUND_MODE = "background_mode";
static final String EXTRA_CACHED_ENGINE_ID = "cached_engine_id";
static final String EXTRA_DESTROY_ENGINE_WITH_ACTIVITY = "destroy_engine_with_activity";
/* package */ static final String EXTRA_INITIAL_ROUTE = "initial_route";
/* package */ static final String EXTRA_BACKGROUND_MODE = "background_mode";
/* package */ static final String EXTRA_CACHED_ENGINE_ID = "cached_engine_id";
/* package */ static final String EXTRA_DESTROY_ENGINE_WITH_ACTIVITY = "destroy_engine_with_activity";

// Default configuration.
static final String DEFAULT_DART_ENTRYPOINT = "main";
static final String DEFAULT_INITIAL_ROUTE = "/";
static final String DEFAULT_BACKGROUND_MODE = BackgroundMode.opaque.name();
/* package */ static final String DEFAULT_DART_ENTRYPOINT = "main";
/* package */ static final String DEFAULT_INITIAL_ROUTE = "/";
/* package */ static final String DEFAULT_BACKGROUND_MODE = BackgroundMode.opaque.name();

/**
* The mode of the background of a Flutter {@code Activity}, either opaque or transparent.
Expand Down
2 changes: 2 additions & 0 deletions shell/platform/android/test/io/flutter/FlutterTestSuite.java
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import io.flutter.embedding.engine.plugins.shim.ShimPluginRegistryTest;
import io.flutter.embedding.engine.renderer.FlutterRendererTest;
import io.flutter.embedding.engine.systemchannels.PlatformChannelTest;
import io.flutter.external.FlutterLaunchTests;
import io.flutter.plugin.common.StandardMessageCodecTest;
import io.flutter.plugin.editing.TextInputPluginTest;
import io.flutter.plugin.platform.SingleViewPresentationTest;
Expand All @@ -37,6 +38,7 @@
FlutterEngineTest.class,
FlutterFragmentTest.class,
FlutterJNITest.class,
FlutterLaunchTests.class,
FlutterShellArgsTest.class,
FlutterRendererTest.class,
FlutterViewTest.class,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package io.flutter.embedding.android;

import android.content.Intent;

import org.robolectric.Robolectric;
import org.robolectric.android.controller.ActivityController;

/**
* Creates a {@code FlutterActivity} for use by test code that do not sit
* within the {@code io.flutter.embedding.android} package, and offers public
* access to some package private properties of {@code FlutterActivity} for
* testing purposes.
*/
public class RobolectricFlutterActivity {
/**
* Creates a {@code FlutterActivity} that is controlled by Robolectric, which
* otherwise can not be done in a test outside of the io.flutter.embedding.android
* package.
*/
public static FlutterActivity createFlutterActivity(Intent intent) {
ActivityController<FlutterActivity> activityController = Robolectric.buildActivity(FlutterActivity.class, intent);
FlutterActivity flutterActivity = activityController.get();
flutterActivity.setDelegate(new FlutterActivityAndFragmentDelegate(flutterActivity));
return flutterActivity;
}

/**
* Returns a given {@code FlutterActivity}'s {@code BackgroundMode} for use by
* tests that do not sit in the {@code io.flutter.embedding.android} package.
*/
public static FlutterActivityLaunchConfigs.BackgroundMode getBackgroundMode(FlutterActivity activity) {
return activity.getBackgroundMode();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
package io.flutter.external;

import android.content.Intent;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.RuntimeEnvironment;
import org.robolectric.annotation.Config;

import io.flutter.embedding.android.FlutterActivity;
import io.flutter.embedding.android.FlutterActivityLaunchConfigs.BackgroundMode;
import io.flutter.embedding.android.FlutterView;
import io.flutter.embedding.android.RobolectricFlutterActivity;

import static org.junit.Assert.assertArrayEquals;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;

@Config(manifest=Config.NONE)
@RunWith(RobolectricTestRunner.class)
public class FlutterLaunchTests {
@Test
public void launchFlutterActivity_with_defaultIntent_expect_defaultConfiguration() {
Intent intent = FlutterActivity.createDefaultIntent(RuntimeEnvironment.application);
FlutterActivity flutterActivity = RobolectricFlutterActivity.createFlutterActivity(intent);

assertEquals("main", flutterActivity.getDartEntrypointFunctionName());
assertEquals("/", flutterActivity.getInitialRoute());
assertArrayEquals(new String[]{}, flutterActivity.getFlutterShellArgs().toArray());
assertTrue(flutterActivity.shouldAttachEngineToActivity());
assertNull(flutterActivity.getCachedEngineId());
assertTrue(flutterActivity.shouldDestroyEngineWithHost());
assertEquals(BackgroundMode.opaque, RobolectricFlutterActivity.getBackgroundMode(flutterActivity));
assertEquals(FlutterView.RenderMode.surface, flutterActivity.getRenderMode());
assertEquals(FlutterView.TransparencyMode.opaque, flutterActivity.getTransparencyMode());
}
}
1 change: 1 addition & 0 deletions shell/platform/android/test/io/flutter/external/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This `external` package exists to run tests in a package other than where the code under test is defined. This is offered for tests that need to verify that app devs, with their own packages, can reference and execute APIs that Flutter intends to be public.

0 comments on commit a57823c

Please sign in to comment.