Add hourly period job to fetch battery usage data in Settings.

Bug: 253395332
Test: make RunSettingsRoboTests + manually
Change-Id: I342066a30fed202e5013b8c2554f36d991975c3e

tests/robotests/src/com/android/settings/fuelgauge/batteryusage/BatteryUsageContentProviderTest.java

@@ -20,9 +20,11 @@ import static com.google.common.truth.Truth.assertThat;
 
 import static org.junit.Assert.assertThrows;
 
+import android.app.Application;
 import android.content.ContentResolver;
 import android.content.ContentValues;
 import android.content.Context;
+import android.content.Intent;
 import android.database.Cursor;
 import android.net.Uri;
 
@@ -37,9 +39,11 @@ import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.robolectric.RobolectricTestRunner;
+import org.robolectric.Shadows;
 
 import java.time.Duration;
 import java.util.List;
+import java.util.concurrent.TimeUnit;
 
 /** Tests for {@link BatteryUsageContentProvider}. */
 @RunWith(RobolectricTestRunner.class)
@@ -301,6 +305,11 @@ public final class BatteryUsageContentProviderTest {
         final String actualPackageName3 = cursor.getString(packageNameIndex);
         assertThat(actualPackageName3).isEqualTo(packageName3);
         cursor.close();
-        // TODO: add verification for recheck broadcast.
+        // Verifies the broadcast intent.
+        TimeUnit.SECONDS.sleep(1);
+        final List<Intent> intents = Shadows.shadowOf((Application) mContext).getBroadcastIntents();
+        assertThat(intents).hasSize(1);
+        assertThat(intents.get(0).getAction()).isEqualTo(
+                BootBroadcastReceiver.ACTION_PERIODIC_JOB_RECHECK);
     }
 }

tests/robotests/src/com/android/settings/fuelgauge/batteryusage/BootBroadcastReceiverTest.java

@@ -0,0 +1,182 @@
+/*
+ * Copyright (C) 2022 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.settings.fuelgauge.batteryusage;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import static org.robolectric.Shadows.shadowOf;
+
+import android.app.AlarmManager;
+import android.app.Application;
+import android.content.Context;
+import android.content.Intent;
+
+import androidx.test.core.app.ApplicationProvider;
+
+import com.android.settings.fuelgauge.batteryusage.db.BatteryStateDao;
+import com.android.settings.fuelgauge.batteryusage.db.BatteryStateDatabase;
+import com.android.settings.testutils.BatteryTestUtils;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.robolectric.RobolectricTestRunner;
+import org.robolectric.Shadows;
+import org.robolectric.shadows.ShadowAlarmManager;
+
+import java.time.Clock;
+import java.time.Duration;
+import java.util.List;
+import java.util.concurrent.TimeUnit;
+
+/** Tests of {@link BootBroadcastReceiver}. */
+@RunWith(RobolectricTestRunner.class)
+public final class BootBroadcastReceiverTest {
+    private Context mContext;
+    private BatteryStateDao mDao;
+    private BootBroadcastReceiver mReceiver;
+    private ShadowAlarmManager mShadowAlarmManager;
+    private PeriodicJobManager mPeriodicJobManager;
+
+    @Before
+    public void setUp() {
+        mContext = ApplicationProvider.getApplicationContext();
+        mPeriodicJobManager = PeriodicJobManager.getInstance(mContext);
+        mShadowAlarmManager = shadowOf(mContext.getSystemService(AlarmManager.class));
+        ShadowAlarmManager.setCanScheduleExactAlarms(true);
+        mReceiver = new BootBroadcastReceiver();
+
+        // Inserts fake data into database for testing.
+        final BatteryStateDatabase database = BatteryTestUtils.setUpBatteryStateDatabase(mContext);
+        BatteryTestUtils.insertDataToBatteryStateDatabase(
+                mContext, Clock.systemUTC().millis(), "com.android.systemui");
+        mDao = database.batteryStateDao();
+    }
+
+    @After
+    public void tearDown() {
+        mPeriodicJobManager.reset();
+    }
+
+    @Test
+    public void onReceive_withWorkProfile_notRefreshesJob() {
+        BatteryTestUtils.setWorkProfile(mContext);
+        mReceiver.onReceive(mContext, new Intent(Intent.ACTION_BOOT_COMPLETED));
+
+        assertThat(mShadowAlarmManager.peekNextScheduledAlarm()).isNull();
+    }
+
+    @Test
+    public void onReceive_withMyPackageReplacedIntent_refreshesJob() {
+        mReceiver.onReceive(mContext, new Intent(Intent.ACTION_MY_PACKAGE_REPLACED));
+        assertThat(mShadowAlarmManager.peekNextScheduledAlarm()).isNotNull();
+    }
+
+    @Test
+    public void onReceive_withMyPackageUnsuspendIntent_refreshesJob() {
+        mReceiver.onReceive(mContext, new Intent(Intent.ACTION_MY_PACKAGE_UNSUSPENDED));
+        assertThat(mShadowAlarmManager.peekNextScheduledAlarm()).isNotNull();
+    }
+
+    @Test
+    public void onReceive_withBootCompletedIntent_refreshesJob() {
+        mReceiver.onReceive(mContext, new Intent(Intent.ACTION_BOOT_COMPLETED));
+        assertThat(mShadowAlarmManager.peekNextScheduledAlarm()).isNotNull();
+    }
+
+    @Test
+    public void onReceive_withSetupWizardIntent_refreshesJob() {
+        mReceiver.onReceive(
+                mContext, new Intent(BootBroadcastReceiver.ACTION_SETUP_WIZARD_FINISHED));
+        assertThat(mShadowAlarmManager.peekNextScheduledAlarm()).isNotNull();
+    }
+
+    @Test
+    public void onReceive_withRecheckIntent_refreshesJob() {
+        mReceiver.onReceive(
+                mContext, new Intent(BootBroadcastReceiver.ACTION_PERIODIC_JOB_RECHECK));
+        assertThat(mShadowAlarmManager.peekNextScheduledAlarm()).isNotNull();
+    }
+
+    @Test
+    public void onReceive_unexpectedIntent_notRefreshesJob() {
+        mReceiver.onReceive(mContext, new Intent("invalid intent action"));
+        assertThat(mShadowAlarmManager.peekNextScheduledAlarm()).isNull();
+    }
+
+    @Test
+    public void onReceive_nullIntent_notRefreshesJob() {
+        mReceiver.onReceive(mContext, /*intent=*/ null);
+        assertThat(mShadowAlarmManager.peekNextScheduledAlarm()).isNull();
+    }
+
+    @Test
+    public void onReceive_containsExpiredData_clearsExpiredDataFromDatabase()
+            throws InterruptedException {
+        insertExpiredData(/*shiftDay=*/ DatabaseUtils.DATA_RETENTION_INTERVAL_DAY);
+
+        mReceiver.onReceive(mContext, new Intent(Intent.ACTION_BOOT_COMPLETED));
+
+        TimeUnit.MILLISECONDS.sleep(100);
+        assertThat(mDao.getAllAfter(0)).hasSize(1);
+    }
+
+    @Test
+    public void onReceive_withoutExpiredData_notClearsExpiredDataFromDatabase()
+            throws InterruptedException {
+        insertExpiredData(/*shiftDay=*/ DatabaseUtils.DATA_RETENTION_INTERVAL_DAY - 1);
+
+        mReceiver.onReceive(mContext, new Intent(Intent.ACTION_BOOT_COMPLETED));
+
+        TimeUnit.MILLISECONDS.sleep(100);
+        assertThat(mDao.getAllAfter(0)).hasSize(3);
+    }
+
+    @Test
+    public void onReceive_withTimeChangedIntent_clearsAllDataAndRefreshesJob()
+            throws InterruptedException {
+        mReceiver.onReceive(mContext, new Intent(Intent.ACTION_TIME_CHANGED));
+
+        TimeUnit.MILLISECONDS.sleep(100);
+        assertThat(mDao.getAllAfter(0)).isEmpty();
+        assertThat(mShadowAlarmManager.peekNextScheduledAlarm()).isNotNull();
+    }
+
+    @Test
+    public void invokeJobRecheck_broadcastsIntent() {
+        BootBroadcastReceiver.invokeJobRecheck(mContext);
+
+        final List<Intent> intents =
+                Shadows.shadowOf((Application) mContext).getBroadcastIntents();
+        assertThat(intents).hasSize(1);
+        assertThat(intents.get(0).getAction()).isEqualTo(
+                BootBroadcastReceiver.ACTION_PERIODIC_JOB_RECHECK);
+    }
+
+    private void insertExpiredData(int shiftDay) {
+        final long expiredTimeInMs =
+                Clock.systemUTC().millis() - Duration.ofDays(shiftDay).toMillis();
+        BatteryTestUtils.insertDataToBatteryStateDatabase(
+                mContext, expiredTimeInMs - 1, "com.android.systemui");
+        BatteryTestUtils.insertDataToBatteryStateDatabase(
+                mContext, expiredTimeInMs, "com.android.systemui");
+        // Ensures the testing environment is correct.
+        assertThat(mDao.getAllAfter(0)).hasSize(3);
+    }
+
+}

tests/robotests/src/com/android/settings/fuelgauge/batteryusage/PeriodicJobManagerTest.java

@@ -0,0 +1,105 @@
+/*
+ * Copyright (C) 2022 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.settings.fuelgauge.batteryusage;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import static org.robolectric.Shadows.shadowOf;
+
+import android.app.AlarmManager;
+import android.content.Context;
+
+import androidx.test.core.app.ApplicationProvider;
+
+import com.android.settings.testutils.FakeClock;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.robolectric.RobolectricTestRunner;
+import org.robolectric.shadows.ShadowAlarmManager;
+
+import java.time.Duration;
+
+/** Tests of {@link PeriodicJobManager}. */
+@RunWith(RobolectricTestRunner.class)
+public final class PeriodicJobManagerTest {
+    private Context mContext;
+    private ShadowAlarmManager mShadowAlarmManager;
+    private PeriodicJobManager mPeriodicJobManager;
+
+    @Before
+    public void setUp() {
+        mContext = ApplicationProvider.getApplicationContext();
+        mPeriodicJobManager = PeriodicJobManager.getInstance(mContext);
+        mShadowAlarmManager = shadowOf(mContext.getSystemService(AlarmManager.class));
+        ShadowAlarmManager.setCanScheduleExactAlarms(true);
+    }
+
+    @After
+    public void tearDown() {
+        mPeriodicJobManager.reset();
+    }
+
+    @Test
+    public void refreshJob_refreshesAlarmJob() {
+        mPeriodicJobManager.refreshJob();
+
+        final ShadowAlarmManager.ScheduledAlarm alarm =
+                mShadowAlarmManager.peekNextScheduledAlarm();
+        // Verifies the alarm manager type.
+        assertThat(alarm.type).isEqualTo(AlarmManager.RTC_WAKEUP);
+        // Verifies there is pending intent in the alarm.
+        assertThat(alarm.operation).isNotNull();
+    }
+
+    @Test
+    public void refreshJob_withoutPermission_notRefreshesAlarmJob() {
+        ShadowAlarmManager.setCanScheduleExactAlarms(false);
+
+        mPeriodicJobManager.refreshJob();
+
+        assertThat(mShadowAlarmManager.peekNextScheduledAlarm()).isNull();
+    }
+
+    @Test
+    public void getTriggerAtMillis_withoutOffset_returnsExpectedResult() {
+        long timeSlotUnit = PeriodicJobManager.DATA_FETCH_INTERVAL_MINUTE;
+        // Sets the current time.
+        Duration currentTimeDuration =
+                Duration.ofMinutes(timeSlotUnit * 2);
+        FakeClock fakeClock = new FakeClock();
+        fakeClock.setCurrentTime(currentTimeDuration);
+
+        assertThat(PeriodicJobManager.getTriggerAtMillis(fakeClock))
+                .isEqualTo(currentTimeDuration.plusMinutes(timeSlotUnit).toMillis());
+    }
+
+    @Test
+    public void getTriggerAtMillis_withOffset_returnsExpectedResult() {
+        long timeSlotUnit = PeriodicJobManager.DATA_FETCH_INTERVAL_MINUTE;
+        // Sets the current time.
+        Duration currentTimeDuration = Duration.ofMinutes(timeSlotUnit * 2);
+        FakeClock fakeClock = new FakeClock();
+        fakeClock.setCurrentTime(
+                currentTimeDuration.plusMinutes(1L).plusMillis(51L));
+
+        assertThat(PeriodicJobManager.getTriggerAtMillis(fakeClock))
+                .isEqualTo(currentTimeDuration.plusMinutes(timeSlotUnit).toMillis());
+    }
+}

tests/robotests/src/com/android/settings/fuelgauge/batteryusage/PeriodicJobReceiverTest.java

@@ -0,0 +1,134 @@
+/*
+ * Copyright (C) 2022 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.settings.fuelgauge.batteryusage;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import static org.robolectric.Shadows.shadowOf;
+
+import android.app.AlarmManager;
+import android.content.Context;
+import android.content.Intent;
+
+import androidx.test.core.app.ApplicationProvider;
+
+import com.android.settings.fuelgauge.batteryusage.db.BatteryStateDao;
+import com.android.settings.fuelgauge.batteryusage.db.BatteryStateDatabase;
+import com.android.settings.testutils.BatteryTestUtils;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.robolectric.RobolectricTestRunner;
+import org.robolectric.shadows.ShadowAlarmManager;
+
+import java.time.Clock;
+import java.time.Duration;
+import java.util.concurrent.TimeUnit;
+
+/** Tests of {@link PeriodicJobReceiver}. */
+@RunWith(RobolectricTestRunner.class)
+public final class PeriodicJobReceiverTest {
+    private static final Intent JOB_UPDATE_INTENT =
+            new Intent(PeriodicJobReceiver.ACTION_PERIODIC_JOB_UPDATE);
+
+    private Context mContext;
+    private BatteryStateDao mDao;
+    private PeriodicJobReceiver mReceiver;
+    private PeriodicJobManager mPeriodicJobManager;
+    private ShadowAlarmManager mShadowAlarmManager;
+
+    @Before
+    public void setUp() {
+        mContext = ApplicationProvider.getApplicationContext();
+        mPeriodicJobManager = PeriodicJobManager.getInstance(mContext);
+        mShadowAlarmManager = shadowOf(mContext.getSystemService(AlarmManager.class));
+        ShadowAlarmManager.setCanScheduleExactAlarms(true);
+        mReceiver = new PeriodicJobReceiver();
+
+        // Inserts fake data into database for testing.
+        final BatteryStateDatabase database = BatteryTestUtils.setUpBatteryStateDatabase(mContext);
+        BatteryTestUtils.insertDataToBatteryStateDatabase(
+                mContext, Clock.systemUTC().millis(), "com.android.systemui");
+        mDao = database.batteryStateDao();
+    }
+
+    @After
+    public void tearDown() {
+        mPeriodicJobManager.reset();
+    }
+
+    @Test
+    public void onReceive_validAction_refreshesJob() {
+        mReceiver.onReceive(mContext, JOB_UPDATE_INTENT);
+        assertThat(mShadowAlarmManager.peekNextScheduledAlarm()).isNotNull();
+    }
+
+    @Test
+    public void onReceive_invalidAction_notRefreshesJob() {
+        mReceiver.onReceive(mContext, new Intent("invalid request update intent"));
+        assertThat(mShadowAlarmManager.peekNextScheduledAlarm()).isNull();
+    }
+
+    @Test
+    public void onReceive_nullIntent_notRefreshesJob() {
+        mReceiver.onReceive(mContext, /*intent=*/ null);
+        assertThat(mShadowAlarmManager.peekNextScheduledAlarm()).isNull();
+    }
+
+    @Test
+    public void onReceive_containsExpiredData_clearsExpiredDataFromDatabase()
+            throws InterruptedException {
+        insertExpiredData(/*shiftDay=*/ DatabaseUtils.DATA_RETENTION_INTERVAL_DAY);
+
+        mReceiver.onReceive(mContext, JOB_UPDATE_INTENT);
+
+        TimeUnit.MILLISECONDS.sleep(100);
+        assertThat(mDao.getAllAfter(0)).hasSize(1);
+    }
+
+    @Test
+    public void onReceive_withoutExpiredData_notClearsExpiredDataFromDatabase()
+            throws InterruptedException {
+        insertExpiredData(/*shiftDay=*/ DatabaseUtils.DATA_RETENTION_INTERVAL_DAY - 1);
+
+        mReceiver.onReceive(mContext, JOB_UPDATE_INTENT);
+
+        TimeUnit.MILLISECONDS.sleep(100);
+        assertThat(mDao.getAllAfter(0)).hasSize(3);
+    }
+
+    @Test
+    public void onReceive_inWorkProfileMode_notRefreshesJob() {
+        BatteryTestUtils.setWorkProfile(mContext);
+        mReceiver.onReceive(mContext, JOB_UPDATE_INTENT);
+        assertThat(mShadowAlarmManager.peekNextScheduledAlarm()).isNull();
+    }
+
+    private void insertExpiredData(int shiftDay) {
+        final long expiredTimeInMs =
+                Clock.systemUTC().millis() - Duration.ofDays(shiftDay).toMillis();
+        BatteryTestUtils.insertDataToBatteryStateDatabase(
+                mContext, expiredTimeInMs - 1, "com.android.systemui");
+        BatteryTestUtils.insertDataToBatteryStateDatabase(
+                mContext, expiredTimeInMs, "com.android.systemui");
+        // Ensures the testing environment is correct.
+        assertThat(mDao.getAllAfter(0)).hasSize(3);
+    }
+
+}