[Offline pages] Updates to background scheduling to use BTS

chrome/android/junit/src/org/chromium/chrome/browser/offlinepages/OfflineBackgroundTaskTest.java

+// Copyright 2016 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 org.chromium.chrome.browser.offlinepages;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.any;
+import static org.mockito.Mockito.anyBoolean;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.eq;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+import android.app.Activity;
+import android.content.Context;
+import android.os.Bundle;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.ArgumentCaptor;
+import org.mockito.ArgumentMatchers;
+import org.mockito.Captor;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.robolectric.RuntimeEnvironment;
+import org.robolectric.annotation.Config;
+
+import org.chromium.base.ActivityState;
+import org.chromium.base.ApplicationStatus;
+import org.chromium.base.BaseSwitches;
+import org.chromium.base.Callback;
+import org.chromium.base.CommandLine;
+import org.chromium.base.ContextUtils;
+import org.chromium.base.SysUtils;
+import org.chromium.base.test.util.Feature;
+import org.chromium.chrome.browser.DisableHistogramsRule;
+import org.chromium.chrome.browser.background_task_scheduler.NativeBackgroundTask;
+import org.chromium.components.background_task_scheduler.BackgroundTask;
+import org.chromium.components.background_task_scheduler.BackgroundTaskScheduler;
+import org.chromium.components.background_task_scheduler.BackgroundTaskSchedulerFactory;
+import org.chromium.components.background_task_scheduler.TaskIds;
+import org.chromium.components.background_task_scheduler.TaskInfo;
+import org.chromium.components.background_task_scheduler.TaskParameters;
+import org.chromium.net.ConnectionType;
+import org.chromium.testing.local.LocalRobolectricTestRunner;
+
+/**
+ * Unit tests for OfflineBackgroundTask.
+ */
+@RunWith(LocalRobolectricTestRunner.class)
+@Config(manifest = Config.NONE, shadows = {ShadowDeviceConditions.class})
+public class OfflineBackgroundTaskTest {
+    private static final boolean REQUIRE_POWER = true;
+    private static final boolean REQUIRE_UNMETERED = true;
+    private static final boolean POWER_CONNECTED = true;
+    private static final int MINIMUM_BATTERY_LEVEL = 33;
+    private static final String IS_LOW_END_DEVICE_SWITCH =
+            "--" + BaseSwitches.ENABLE_LOW_END_DEVICE_MODE;
+
+    @Rule
+    public DisableHistogramsRule mDisableHistogramsRule = new DisableHistogramsRule();
+
+    private Bundle mTaskExtras;
+    private long mTestTime;
+    private TriggerConditions mTriggerConditions =
+            new TriggerConditions(!REQUIRE_POWER, MINIMUM_BATTERY_LEVEL, REQUIRE_UNMETERED);
+    private DeviceConditions mDeviceConditions = new DeviceConditions(
+            !POWER_CONNECTED, MINIMUM_BATTERY_LEVEL + 5, ConnectionType.CONNECTION_3G);
+    private Activity mTestActivity;
+
+    @Mock
+    private BackgroundSchedulerProcessor mBackgroundSchedulerProcessor;
+
+    @Mock
+    private BackgroundTaskScheduler mTaskScheduler;
+    @Mock
+    private BackgroundTask.TaskFinishedCallback mTaskFinishedCallback;
+    @Mock
+    private Callback<Boolean> mInternalBooleanCallback;
+    @Captor
+    private ArgumentCaptor<TaskInfo> mTaskInfo;
+
+    @Before
+    public void setUp() throws Exception {
+        MockitoAnnotations.initMocks(this);
+        ContextUtils.initApplicationContextForTests(RuntimeEnvironment.application);
+        BackgroundTaskSchedulerFactory.setSchedulerForTesting(mTaskScheduler);
+        doReturn(true)
+                .when(mTaskScheduler)
+                .schedule(eq(RuntimeEnvironment.application), mTaskInfo.capture());
+
+        ShadowDeviceConditions.setCurrentConditions(mDeviceConditions);
+
+        // Set up background scheduler processor mock.
+        BackgroundSchedulerProcessor.setInstanceForTesting(mBackgroundSchedulerProcessor);
+
+        // Build a bundle with trigger conditions.
+        mTaskExtras = new Bundle();
+        TaskExtrasPacker.packTimeInBundle(mTaskExtras);
+        TaskExtrasPacker.packTriggerConditionsInBundle(mTaskExtras, mTriggerConditions);
+
+        // Run tests as a low-end device.
+        CommandLine.init(new String[] {"testcommand", IS_LOW_END_DEVICE_SWITCH});
+
+        // Set up single, stopped Activity.
+        ApplicationStatus.destroyForJUnitTests();
+        mTestActivity = new Activity();
+        ApplicationStatus.onStateChangeForTesting(mTestActivity, ActivityState.CREATED);
+        ApplicationStatus.onStateChangeForTesting(mTestActivity, ActivityState.STOPPED);
+    }
+
+    @After
+    public void tearDown() throws Exception {
+        // Clean up static state for subsequent Robolectric tests.
+        CommandLine.reset();
+        SysUtils.reset();
+        ApplicationStatus.destroyForJUnitTests();
+    }
+
+    private void setupScheduledProcessingWithResult(boolean result) {
+        doReturn(result)
+                .when(mBackgroundSchedulerProcessor)
+                .startScheduledProcessing(
+                        any(DeviceConditions.class), ArgumentMatchers.<Callback<Boolean>>any());
+    }
+
+    @Test
+    @Feature({"OfflinePages"})
+    public void testCheckConditions_BatteryConditions_LowBattery_NoPower() {
+        // Setup low battery conditions with no power connected.
+        DeviceConditions deviceConditionsLowBattery = new DeviceConditions(
+                !POWER_CONNECTED, MINIMUM_BATTERY_LEVEL - 1, ConnectionType.CONNECTION_WIFI);
+        ShadowDeviceConditions.setCurrentConditions(deviceConditionsLowBattery);
+
+        // Verify that conditions for processing are not met.
+        assertFalse(
+                OfflineBackgroundTask.checkConditions(RuntimeEnvironment.application, mTaskExtras));
+
+        // Check impact on starting before native loaded.
+        TaskParameters params = TaskParameters.create(TaskIds.OFFLINE_PAGES_BACKGROUND_JOB_ID)
+                                        .addExtras(mTaskExtras)
+                                        .build();
+
+        assertEquals(NativeBackgroundTask.RESCHEDULE,
+                new OfflineBackgroundTask().onStartTaskBeforeNativeLoaded(

[Pete Williamson, 2017/05/25 17:30:53]

It feels a bit odd to me to have the function under test called inside the
assert statement, which is supposed to check the output of the statement under
test.  I can understand wanting to save having an extra variable by not having
to store the return value in a variable, but in my opinion, all these tests
would be much easier to read if you structured it like this:

TaskResultStatusEnum result = new
OfflineBackgroundTask().onStartTaskBeforeNativeLoaded(...);
assertEquals(NativeBackgroundTask.RESCHEDULE, result);

[fgorski, 2017/05/25 21:41:50]

I applied that, but only to the calls returning a result other than boolean.

+                        RuntimeEnvironment.application, params, mTaskFinishedCallback));
+        verify(mTaskFinishedCallback, times(0)).taskFinished(anyBoolean());

[Pete Williamson, 2017/05/25 17:30:53]

It seems a bit counter intuitive that you are verifying the callback didn't run.
Maybe add comment:
// If native is not loaded, ensure the task never tried to run.

[fgorski, 2017/05/25 21:41:50]

Done.

+    }
+
+    @Test
+    @Feature({"OfflinePages"})
+    public void testCheckConditions_BatteryConditions_LowBattery_WithPower() {
+        // Set battery percentage below minimum level, but connect power.
+        DeviceConditions deviceConditionsPowerConnected = new DeviceConditions(
+                POWER_CONNECTED, MINIMUM_BATTERY_LEVEL - 1, ConnectionType.CONNECTION_WIFI);
+        ShadowDeviceConditions.setCurrentConditions(deviceConditionsPowerConnected);
+
+        // Now verify that same battery level, with power connected, will pass the conditions.
+        assertTrue(
+                OfflineBackgroundTask.checkConditions(RuntimeEnvironment.application, mTaskExtras));
+
+        // Check impact on starting before native loaded.
+        TaskParameters params = TaskParameters.create(TaskIds.OFFLINE_PAGES_BACKGROUND_JOB_ID)
+                                        .addExtras(mTaskExtras)
+                                        .build();
+
+        assertEquals(NativeBackgroundTask.LOAD_NATIVE,
+                new OfflineBackgroundTask().onStartTaskBeforeNativeLoaded(
+                        RuntimeEnvironment.application, params, mTaskFinishedCallback));
+        verify(mTaskFinishedCallback, times(0)).taskFinished(anyBoolean());
+    }
+
+    @Test
+    @Feature({"OfflinePages"})
+    public void testCheckConditions_OnLowEndDevice_ActivityStarted() {
+        // Transition the test Activity to a running state.
+        ApplicationStatus.onStateChangeForTesting(mTestActivity, ActivityState.STARTED);
+
+        // Verify that conditions for processing are not met.
+        assertFalse(
+                OfflineBackgroundTask.checkConditions(RuntimeEnvironment.application, mTaskExtras));
+
+        // Check impact on starting before native loaded.
+        TaskParameters params = TaskParameters.create(TaskIds.OFFLINE_PAGES_BACKGROUND_JOB_ID)
+                                        .addExtras(mTaskExtras)
+                                        .build();
+
+        assertEquals(NativeBackgroundTask.RESCHEDULE,
+                new OfflineBackgroundTask().onStartTaskBeforeNativeLoaded(
+                        RuntimeEnvironment.application, params, mTaskFinishedCallback));
+        verify(mTaskFinishedCallback, times(0)).taskFinished(anyBoolean());
+    }
+
+    @Test
+    @Feature({"OfflinePages"})
+    public void testCheckConditions_OnLowEndDevice_ActivityStopped() {
+        // Switch activity state to stopped.
+        ApplicationStatus.onStateChangeForTesting(mTestActivity, ActivityState.STOPPED);
+
+        // Now verify that condition check passes when Activity is stopped.
+        assertTrue(
+                OfflineBackgroundTask.checkConditions(RuntimeEnvironment.application, mTaskExtras));
+
+        // Check impact on starting before native loaded.
+        TaskParameters params = TaskParameters.create(TaskIds.OFFLINE_PAGES_BACKGROUND_JOB_ID)
+                                        .addExtras(mTaskExtras)
+                                        .build();
+
+        assertEquals(NativeBackgroundTask.LOAD_NATIVE,
+                new OfflineBackgroundTask().onStartTaskBeforeNativeLoaded(
+                        RuntimeEnvironment.application, params, mTaskFinishedCallback));
+        verify(mTaskFinishedCallback, times(0)).taskFinished(anyBoolean());
+    }
+
+    @Test
+    @Feature({"OfflinePages"})
+    public void testOnStartTaskWithNative_BackupScheduleIfExecutingTask() {
+        setupScheduledProcessingWithResult(true);
+
+        TaskParameters params = TaskParameters.create(TaskIds.OFFLINE_PAGES_BACKGROUND_JOB_ID)
+                                        .addExtras(mTaskExtras)
+                                        .build();
+
+        new OfflineBackgroundTask().onStartTaskWithNative(
+                RuntimeEnvironment.application, params, mTaskFinishedCallback);
+
+        verify(mTaskScheduler, times(1))
+                .schedule(eq(RuntimeEnvironment.application), any(TaskInfo.class));
+        verify(mTaskFinishedCallback, times(0)).taskFinished(anyBoolean());
+    }
+
+    @Test
+    @Feature({"OfflinePages"})
+    public void testOnStartTaskWithNative_RescheduleThroughCallbackWhenRunning() {
+        setupScheduledProcessingWithResult(false);
+
+        TaskParameters params = TaskParameters.create(TaskIds.OFFLINE_PAGES_BACKGROUND_JOB_ID)
+                                        .addExtras(mTaskExtras)
+                                        .build();
+
+        new OfflineBackgroundTask().onStartTaskWithNative(
+                RuntimeEnvironment.application, params, mTaskFinishedCallback);
+
+        verify(mTaskScheduler, times(0)).schedule(any(Context.class), any(TaskInfo.class));
+        verify(mTaskFinishedCallback, times(1)).taskFinished(eq(true));
+    }
+
+    @Test
+    @Feature({"OfflinePages"})
+    public void testStartBackgroundRequests() {
+        setupScheduledProcessingWithResult(true);
+
+        assertTrue(OfflineBackgroundTask.startScheduledProcessing(mBackgroundSchedulerProcessor,
+                RuntimeEnvironment.application, mTaskExtras, mInternalBooleanCallback));
+
+        // Check with BackgroundSchedulerProcessor that processing started.
+        verify(mBackgroundSchedulerProcessor, times(1))
+                .startScheduledProcessing(eq(mDeviceConditions), eq(mInternalBooleanCallback));
+    }
+
+    @Test
+    @Feature({"OfflinePages"})
+    public void testStartBackgroundRequestsNotStarted() {
+        // Processing will not be started here.
+        setupScheduledProcessingWithResult(false);
+
+        assertFalse(OfflineBackgroundTask.startScheduledProcessing(mBackgroundSchedulerProcessor,
+                RuntimeEnvironment.application, mTaskExtras, mInternalBooleanCallback));
+
+        // Check with BackgroundSchedulerProcessor that it did not start.
+        verify(mBackgroundSchedulerProcessor, times(1))
+                .startScheduledProcessing(eq(mDeviceConditions), eq(mInternalBooleanCallback));
+    }
+}