When upgrading from non one grid to one grid, we should do the row shift migration type, here we are logging data to make sure that is what happens on upgrade Flag: EXEMPT logging Test: n/a Bug: 393175684 Change-Id: Id09257094bc9bc44da757c73a4f63bf15987772c
275 lines
10 KiB
Kotlin
275 lines
10 KiB
Kotlin
/*
|
|
* Copyright (C) 2023 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.launcher3.model.gridmigration
|
|
|
|
import android.content.Context
|
|
import android.database.sqlite.SQLiteDatabase
|
|
import android.graphics.Point
|
|
import android.os.Process
|
|
import android.platform.test.annotations.DisableFlags
|
|
import android.platform.test.annotations.EnableFlags
|
|
import android.util.Log
|
|
import androidx.test.ext.junit.runners.AndroidJUnit4
|
|
import androidx.test.filters.SmallTest
|
|
import androidx.test.platform.app.InstrumentationRegistry
|
|
import com.android.launcher3.Flags
|
|
import com.android.launcher3.GridType.Companion.GRID_TYPE_ANY
|
|
import com.android.launcher3.InvariantDeviceProfile
|
|
import com.android.launcher3.LauncherSettings.Favorites
|
|
import com.android.launcher3.celllayout.testgenerator.ValidGridMigrationTestCaseGenerator
|
|
import com.android.launcher3.celllayout.testgenerator.generateItemsForTest
|
|
import com.android.launcher3.model.DatabaseHelper
|
|
import com.android.launcher3.model.DeviceGridState
|
|
import com.android.launcher3.model.GridSizeMigrationDBController
|
|
import com.android.launcher3.model.GridSizeMigrationLogic
|
|
import com.android.launcher3.pm.UserCache
|
|
import com.android.launcher3.provider.LauncherDbUtils
|
|
import com.android.launcher3.util.rule.TestStabilityRule
|
|
import com.android.launcher3.util.rule.TestStabilityRule.Stability
|
|
import java.util.Random
|
|
import org.junit.Before
|
|
import org.junit.Test
|
|
import org.junit.runner.RunWith
|
|
|
|
private data class Grid(val tableName: String, val size: Point, val items: List<WorkspaceItem>) {
|
|
fun toGridState(): DeviceGridState =
|
|
DeviceGridState(
|
|
size.x,
|
|
size.y,
|
|
size.x,
|
|
InvariantDeviceProfile.TYPE_PHONE,
|
|
tableName,
|
|
GRID_TYPE_ANY,
|
|
)
|
|
}
|
|
|
|
@SmallTest
|
|
@RunWith(AndroidJUnit4::class)
|
|
class ValidGridMigrationUnitTest {
|
|
|
|
companion object {
|
|
const val SEED = 1044542
|
|
val REPEAT_AFTER = Point(0, 10)
|
|
val REPEAT_AFTER_DST = Point(6, 15)
|
|
const val TAG = "ValidGridMigrationUnitTest"
|
|
const val SMALL_TEST_SIZE = 60
|
|
const val LARGE_TEST_SIZE = 1000
|
|
}
|
|
|
|
private lateinit var context: Context
|
|
|
|
@Before
|
|
fun setUp() {
|
|
context = InstrumentationRegistry.getInstrumentation().targetContext
|
|
}
|
|
|
|
private fun validate(srcGrid: Grid, dstGrid: Grid, resultItems: List<WorkspaceItem>) {
|
|
// This returns a map with the number of repeated elements
|
|
// ex { calculatorIcon : 6, weatherWidget : 2 }
|
|
val itemsToMap = { it: List<WorkspaceItem> ->
|
|
it.filter { it.container != Favorites.CONTAINER_HOTSEAT }
|
|
.groupingBy {
|
|
when (it.type) {
|
|
Favorites.ITEM_TYPE_FOLDER,
|
|
Favorites.ITEM_TYPE_APP_PAIR -> throw Exception("Not implemented")
|
|
Favorites.ITEM_TYPE_APPWIDGET -> it.appWidgetProvider
|
|
Favorites.ITEM_TYPE_APPLICATION -> it.intent
|
|
else -> it.title
|
|
}
|
|
}
|
|
.eachCount()
|
|
}
|
|
resultItems.forEach {
|
|
assert((it.x in 0..dstGrid.size.x) && (it.y in 0..dstGrid.size.y)) {
|
|
"Item outside of the board size. Size = ${dstGrid.size} Item = $it"
|
|
}
|
|
assert(
|
|
(it.x + it.spanX in 0..dstGrid.size.x) && (it.y + it.spanY in 0..dstGrid.size.y)
|
|
) {
|
|
"Item doesn't fit in the grid. Size = ${dstGrid.size} Item = $it"
|
|
}
|
|
}
|
|
|
|
val srcCountMap = itemsToMap(srcGrid.items)
|
|
val resultCountMap = itemsToMap(resultItems)
|
|
val diff = resultCountMap.toMutableMap()
|
|
for ((srcKey, srcValue) in srcCountMap) {
|
|
val destValue = diff[srcKey]
|
|
if (destValue != null) {
|
|
diff[srcKey] = destValue - srcValue
|
|
}
|
|
}
|
|
|
|
diff.forEach { (k, count) ->
|
|
assert(count >= 0) { "Source item $k not present on the result" }
|
|
}
|
|
}
|
|
|
|
private fun addItemsToDb(db: SQLiteDatabase, grid: Grid) {
|
|
LauncherDbUtils.SQLiteTransaction(db).use { transaction ->
|
|
grid.items.forEach { insertIntoDb(grid.tableName, it, transaction.db) }
|
|
transaction.commit()
|
|
}
|
|
}
|
|
|
|
private fun migrate(srcGrid: Grid, dstGrid: Grid): List<WorkspaceItem> {
|
|
val userSerial = UserCache.INSTANCE[context].getSerialNumberForUser(Process.myUserHandle())
|
|
val dbHelper =
|
|
DatabaseHelper(
|
|
context,
|
|
null,
|
|
{ UserCache.INSTANCE.get(context).getSerialNumberForUser(it) },
|
|
{},
|
|
)
|
|
|
|
Favorites.addTableToDb(dbHelper.writableDatabase, userSerial, false, srcGrid.tableName)
|
|
|
|
addItemsToDb(dbHelper.writableDatabase, srcGrid)
|
|
addItemsToDb(dbHelper.writableDatabase, dstGrid)
|
|
|
|
LauncherDbUtils.SQLiteTransaction(dbHelper.writableDatabase).use {
|
|
if (Flags.gridMigrationRefactor()) {
|
|
val gridSizeMigrationLogic = GridSizeMigrationLogic()
|
|
val idsInUse = mutableListOf<Int>()
|
|
gridSizeMigrationLogic.migrateHotseat(
|
|
srcGrid.size.x,
|
|
dstGrid.size.x,
|
|
GridSizeMigrationDBController.DbReader(it.db, srcGrid.tableName, context),
|
|
GridSizeMigrationDBController.DbReader(it.db, dstGrid.tableName, context),
|
|
dbHelper,
|
|
idsInUse,
|
|
)
|
|
gridSizeMigrationLogic.migrateWorkspace(
|
|
GridSizeMigrationDBController.DbReader(it.db, srcGrid.tableName, context),
|
|
GridSizeMigrationDBController.DbReader(it.db, dstGrid.tableName, context),
|
|
dbHelper,
|
|
dstGrid.size,
|
|
idsInUse,
|
|
)
|
|
} else {
|
|
GridSizeMigrationDBController.migrate(
|
|
dbHelper,
|
|
GridSizeMigrationDBController.DbReader(it.db, srcGrid.tableName, context),
|
|
GridSizeMigrationDBController.DbReader(it.db, dstGrid.tableName, context),
|
|
srcGrid.size.x,
|
|
dstGrid.size.x,
|
|
dstGrid.size,
|
|
srcGrid.toGridState(),
|
|
dstGrid.toGridState(),
|
|
)
|
|
}
|
|
it.commit()
|
|
}
|
|
return readDb(dstGrid.tableName, dbHelper.readableDatabase)
|
|
}
|
|
|
|
@Test
|
|
@EnableFlags(Flags.FLAG_GRID_MIGRATION_REFACTOR)
|
|
fun runTestCaseRefactorFlagEnabled() {
|
|
runTestCase()
|
|
}
|
|
|
|
@Test
|
|
@DisableFlags(Flags.FLAG_GRID_MIGRATION_REFACTOR)
|
|
fun runTestCaseRefactorFlagDisabled() {
|
|
runTestCase()
|
|
}
|
|
|
|
private fun runTestCase() {
|
|
val caseGenerator = ValidGridMigrationTestCaseGenerator(Random(SEED.toLong()))
|
|
for (i in 0..SMALL_TEST_SIZE) {
|
|
val testCase = caseGenerator.generateTestCase(isDestEmpty = true)
|
|
Log.d(TAG, "Test case = $testCase")
|
|
val srcGrid =
|
|
Grid(
|
|
tableName = Favorites.TMP_TABLE,
|
|
size = testCase.srcSize,
|
|
items = generateItemsForTest(testCase.boards, REPEAT_AFTER),
|
|
)
|
|
val dstGrid =
|
|
Grid(tableName = Favorites.TABLE_NAME, size = testCase.targetSize, items = listOf())
|
|
validate(srcGrid, dstGrid, migrate(srcGrid, dstGrid))
|
|
}
|
|
}
|
|
|
|
@Test
|
|
@EnableFlags(Flags.FLAG_GRID_MIGRATION_REFACTOR)
|
|
fun mergeBoardsRefactorFlagEnabled() {
|
|
mergeBoards()
|
|
}
|
|
|
|
@Test
|
|
@DisableFlags(Flags.FLAG_GRID_MIGRATION_REFACTOR)
|
|
fun mergeBoardsRefactorFlagDisabled() {
|
|
mergeBoards()
|
|
}
|
|
|
|
private fun mergeBoards() {
|
|
val caseGenerator = ValidGridMigrationTestCaseGenerator(Random(SEED.toLong()))
|
|
for (i in 0..SMALL_TEST_SIZE) {
|
|
val testCase = caseGenerator.generateTestCase(isDestEmpty = false)
|
|
Log.d(TAG, "Test case = $testCase")
|
|
val srcGrid =
|
|
Grid(
|
|
tableName = Favorites.TMP_TABLE,
|
|
size = testCase.srcSize,
|
|
items = generateItemsForTest(testCase.boards, REPEAT_AFTER),
|
|
)
|
|
val dstGrid =
|
|
Grid(
|
|
tableName = Favorites.TABLE_NAME,
|
|
size = testCase.targetSize,
|
|
items = generateItemsForTest(testCase.destBoards, REPEAT_AFTER_DST),
|
|
)
|
|
validate(srcGrid, dstGrid, migrate(srcGrid, dstGrid))
|
|
}
|
|
}
|
|
|
|
// This test takes about 4 minutes, there is no need to run it in presubmit.
|
|
@Stability(flavors = TestStabilityRule.LOCAL or TestStabilityRule.PLATFORM_POSTSUBMIT)
|
|
@Test
|
|
@EnableFlags(Flags.FLAG_GRID_MIGRATION_REFACTOR)
|
|
fun runExtensiveTestCasesRefactorFlagEnabled() {
|
|
runExtensiveTestCases()
|
|
}
|
|
|
|
// This test takes about 4 minutes, there is no need to run it in presubmit.
|
|
@Stability(flavors = TestStabilityRule.LOCAL or TestStabilityRule.PLATFORM_POSTSUBMIT)
|
|
@Test
|
|
@DisableFlags(Flags.FLAG_GRID_MIGRATION_REFACTOR)
|
|
fun runExtensiveTestCasesRefactorFlagDisabled() {
|
|
runExtensiveTestCases()
|
|
}
|
|
|
|
private fun runExtensiveTestCases() {
|
|
val caseGenerator = ValidGridMigrationTestCaseGenerator(Random(SEED.toLong()))
|
|
for (i in 0..LARGE_TEST_SIZE) {
|
|
val testCase = caseGenerator.generateTestCase(isDestEmpty = true)
|
|
Log.d(TAG, "Test case = $testCase")
|
|
val srcGrid =
|
|
Grid(
|
|
tableName = Favorites.TMP_TABLE,
|
|
size = testCase.srcSize,
|
|
items = generateItemsForTest(testCase.boards, REPEAT_AFTER),
|
|
)
|
|
val dstGrid =
|
|
Grid(tableName = Favorites.TABLE_NAME, size = testCase.targetSize, items = listOf())
|
|
validate(srcGrid, dstGrid, migrate(srcGrid, dstGrid))
|
|
}
|
|
}
|
|
}
|