Add BatteryHistoricalLogUtil class

- Impl optimize mode log mechanism to record optimize setup flow
 - Log optimize action with MANUAL, APPLY, RESET and RESTORE
 - Use proto file to serialize logs
 sample result: https://screenshot.googleplex.com/5KPrHVGb4pMvS7V.png

Bug: 241735485
Test: make SettingsRoboTests
Change-Id: I879663de4cf45d0cfb9cd7eee957eeb65addfbe1

tests/robotests/src/com/android/settings/fuelgauge/AdvancedPowerUsageDetailTest.java

@@ -184,6 +184,7 @@ public class AdvancedPowerUsageDetailTest {
         mFragment.mBatteryUtils = new BatteryUtils(RuntimeEnvironment.application);
         mFragment.mBatteryOptimizeUtils = mBatteryOptimizeUtils;
         mFragment.mBackupManager = mBackupManager;
+        mFragment.mLogStringBuilder = new StringBuilder();
         mAppEntry.info = mock(ApplicationInfo.class);
 
         mTestActivity = spy(new SettingsActivity());

tests/robotests/src/com/android/settings/fuelgauge/BatteryBackupHelperTest.java

@@ -51,6 +51,7 @@ import android.os.UserHandle;
 import android.os.UserManager;
 import android.util.ArraySet;
 
+import com.android.settings.fuelgauge.BatteryOptimizeHistoricalLogEntry.Action;
 import com.android.settingslib.fuelgauge.PowerAllowlistBackend;
 
 import org.junit.After;
@@ -312,8 +313,9 @@ public final class BatteryBackupHelperTest {
         TimeUnit.SECONDS.sleep(1);
 
         final InOrder inOrder = inOrder(mBatteryOptimizeUtils);
-        inOrder.verify(mBatteryOptimizeUtils).setAppUsageState(MODE_RESTRICTED);
-        inOrder.verify(mBatteryOptimizeUtils, never()).setAppUsageState(anyInt());
+        inOrder.verify(mBatteryOptimizeUtils).setAppUsageState(MODE_RESTRICTED, Action.RESTORE);
+        inOrder.verify(mBatteryOptimizeUtils, never())
+                .setAppUsageState(anyInt(), eq(Action.RESTORE));
     }
 
     @Test
@@ -327,9 +329,10 @@ public final class BatteryBackupHelperTest {
         TimeUnit.SECONDS.sleep(1);
 
         final InOrder inOrder = inOrder(mBatteryOptimizeUtils);
-        inOrder.verify(mBatteryOptimizeUtils).setAppUsageState(MODE_RESTRICTED);
-        inOrder.verify(mBatteryOptimizeUtils).setAppUsageState(MODE_UNRESTRICTED);
-        inOrder.verify(mBatteryOptimizeUtils, never()).setAppUsageState(MODE_RESTRICTED);
+        inOrder.verify(mBatteryOptimizeUtils).setAppUsageState(MODE_RESTRICTED, Action.RESTORE);
+        inOrder.verify(mBatteryOptimizeUtils).setAppUsageState(MODE_UNRESTRICTED, Action.RESTORE);
+        inOrder.verify(mBatteryOptimizeUtils, never())
+                .setAppUsageState(MODE_RESTRICTED, Action.RESTORE);
     }
 
     private void mockUid(int uid, String packageName) throws Exception {

tests/robotests/src/com/android/settings/fuelgauge/BatteryHistoricalLogUtilTest.java

@@ -0,0 +1,82 @@
+/*
+ * 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;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import android.content.Context;
+
+import androidx.test.core.app.ApplicationProvider;
+
+import com.android.settings.fuelgauge.BatteryOptimizeHistoricalLogEntry.Action;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.robolectric.RobolectricTestRunner;
+
+import java.io.PrintWriter;
+import java.io.StringWriter;
+
+@RunWith(RobolectricTestRunner.class)
+public final class BatteryHistoricalLogUtilTest {
+
+    private final StringWriter mTestStringWriter = new StringWriter();
+    private final PrintWriter mTestPrintWriter = new PrintWriter(mTestStringWriter);
+
+    private Context mContext;
+
+    @Before
+    public void setUp() {
+        mContext = ApplicationProvider.getApplicationContext();
+        BatteryHistoricalLogUtil.getSharedPreferences(mContext).edit().clear().commit();
+    }
+
+    @Test
+    public void printHistoricalLog_withDefaultLogs() {
+        BatteryHistoricalLogUtil.printBatteryOptimizeHistoricalLog(mContext, mTestPrintWriter);
+        assertThat(mTestStringWriter.toString()).contains("No past logs");
+    }
+
+    @Test
+    public void writeLog_withExpectedLogs() {
+        BatteryHistoricalLogUtil.writeLog(mContext, Action.APPLY, "pkg1", "logs");
+        BatteryHistoricalLogUtil.printBatteryOptimizeHistoricalLog(mContext, mTestPrintWriter);
+
+        assertThat(mTestStringWriter.toString()).contains("pkg1\tAction:APPLY\tEvent:logs");
+    }
+
+    @Test
+    public void writeLog_multipleLogs_withCorrectCounts() {
+        for (int i = 0; i < BatteryHistoricalLogUtil.MAX_ENTRIES; i++) {
+            BatteryHistoricalLogUtil.writeLog(mContext, Action.MANUAL, "pkg" + i, "logs");
+        }
+        BatteryHistoricalLogUtil.printBatteryOptimizeHistoricalLog(mContext, mTestPrintWriter);
+
+        assertThat(mTestStringWriter.toString().split("MANUAL").length).isEqualTo(41);
+    }
+
+    @Test
+    public void writeLog_overMaxEntriesLogs_withCorrectCounts() {
+        for (int i = 0; i < BatteryHistoricalLogUtil.MAX_ENTRIES + 10; i++) {
+            BatteryHistoricalLogUtil.writeLog(mContext, Action.RESET, "pkg" + i, "logs");
+        }
+        BatteryHistoricalLogUtil.printBatteryOptimizeHistoricalLog(mContext, mTestPrintWriter);
+
+        assertThat(mTestStringWriter.toString().split("RESET").length).isEqualTo(41);
+    }
+}

tests/robotests/src/com/android/settings/fuelgauge/BatteryOptimizeUtilsTest.java

@@ -47,6 +47,7 @@ import android.content.pm.UserInfo;
 import android.os.UserManager;
 import android.util.ArraySet;
 
+import com.android.settings.fuelgauge.BatteryOptimizeHistoricalLogEntry.Action;
 import com.android.settingslib.fuelgauge.PowerAllowlistBackend;
 
 import org.junit.Before;
@@ -152,7 +153,7 @@ public class BatteryOptimizeUtilsTest {
         mBatteryOptimizeUtils.mAllowListed = false;
         mBatteryOptimizeUtils.mMode = AppOpsManager.MODE_ALLOWED;
 
-        mBatteryOptimizeUtils.setAppUsageState(MODE_RESTRICTED);
+        mBatteryOptimizeUtils.setAppUsageState(MODE_RESTRICTED, Action.UNKNOWN);
         TimeUnit.SECONDS.sleep(1);
 
         verifySetAppOptimizationMode(AppOpsManager.MODE_IGNORED, /* allowListed */ false);
@@ -160,7 +161,7 @@ public class BatteryOptimizeUtilsTest {
 
     @Test
     public void testSetAppUsageState_Unrestricted_verifyAction() throws Exception {
-        mBatteryOptimizeUtils.setAppUsageState(MODE_UNRESTRICTED);
+        mBatteryOptimizeUtils.setAppUsageState(MODE_UNRESTRICTED, Action.UNKNOWN);
         TimeUnit.SECONDS.sleep(1);
 
         verifySetAppOptimizationMode(AppOpsManager.MODE_ALLOWED, /* allowListed */ true);
@@ -168,7 +169,7 @@ public class BatteryOptimizeUtilsTest {
 
     @Test
     public void testSetAppUsageState_Optimized_verifyAction() throws Exception {
-        mBatteryOptimizeUtils.setAppUsageState(MODE_OPTIMIZED);
+        mBatteryOptimizeUtils.setAppUsageState(MODE_OPTIMIZED, Action.UNKNOWN);
         TimeUnit.SECONDS.sleep(1);
 
         verifySetAppOptimizationMode(AppOpsManager.MODE_ALLOWED, /* allowListed */ false);
@@ -180,7 +181,7 @@ public class BatteryOptimizeUtilsTest {
         mBatteryOptimizeUtils.mAllowListed = true;
         mBatteryOptimizeUtils.mMode = AppOpsManager.MODE_ALLOWED;
 
-        mBatteryOptimizeUtils.setAppUsageState(MODE_UNRESTRICTED);
+        mBatteryOptimizeUtils.setAppUsageState(MODE_UNRESTRICTED, Action.UNKNOWN);
         TimeUnit.SECONDS.sleep(1);
 
         verifyNoInteractions(mMockBackend);