| /* |
| * 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 android.tools.common.traces.surfaceflinger |
| |
| import android.tools.InitRule |
| import android.tools.TestComponents |
| import android.tools.assertThatErrorContainsDebugInfo |
| import android.tools.assertThrows |
| import android.tools.common.Cache |
| import android.tools.common.CrossPlatform |
| import android.tools.common.datatypes.component.ComponentNameMatcher |
| import android.tools.common.flicker.subject.layers.LayersTraceSubject |
| import android.tools.readLayerTraceFromFile |
| import com.google.common.truth.Truth |
| import org.junit.Before |
| import org.junit.ClassRule |
| import org.junit.FixMethodOrder |
| import org.junit.Test |
| import org.junit.runners.MethodSorters |
| |
| /** Contains [LayerTraceEntry] tests. To run this test: `atest FlickerLibTest:LayersTraceTest` */ |
| @FixMethodOrder(MethodSorters.NAME_ASCENDING) |
| class LayersTraceEntryTest { |
| @Before |
| fun before() { |
| Cache.clear() |
| } |
| |
| @Test |
| fun exceptionContainsDebugInfo() { |
| val layersTraceEntries = |
| readLayerTraceFromFile("layers_trace_emptyregion.pb", legacyTrace = true) |
| val error = |
| assertThrows<AssertionError> { |
| LayersTraceSubject(layersTraceEntries).first().contains(TestComponents.IMAGINARY) |
| } |
| assertThatErrorContainsDebugInfo(error) |
| } |
| |
| @Test |
| fun canParseAllLayers() { |
| val trace = readLayerTraceFromFile("layers_trace_emptyregion.pb", legacyTrace = true) |
| Truth.assertThat(trace.entries).isNotEmpty() |
| Truth.assertThat(trace.entries.first().timestamp.systemUptimeNanos).isEqualTo(922839428857) |
| Truth.assertThat(trace.entries.last().timestamp.systemUptimeNanos).isEqualTo(941432656959) |
| Truth.assertThat(trace.entries.last().flattenedLayers).asList().hasSize(57) |
| } |
| |
| @Test |
| fun canParseVisibleLayersLauncher() { |
| val trace = |
| readLayerTraceFromFile("layers_trace_launch_split_screen.pb", legacyTrace = true) |
| val visibleLayers = |
| trace |
| .getEntryExactlyAt(CrossPlatform.timestamp.from(systemUptimeNanos = 90480846872160)) |
| .visibleLayers |
| val msg = "Visible Layers:\n" + visibleLayers.joinToString("\n") { "\t" + it.name } |
| Truth.assertWithMessage(msg).that(visibleLayers).asList().hasSize(6) |
| Truth.assertThat(msg).contains("ScreenDecorOverlay#0") |
| Truth.assertThat(msg).contains("ScreenDecorOverlayBottom#0") |
| Truth.assertThat(msg).contains("NavigationBar0#0") |
| Truth.assertThat(msg).contains("ImageWallpaper#0") |
| Truth.assertThat(msg).contains("StatusBar#0") |
| Truth.assertThat(msg).contains("NexusLauncherActivity#0") |
| } |
| |
| @Test |
| fun canParseVisibleLayersSplitScreen() { |
| val trace = |
| readLayerTraceFromFile("layers_trace_launch_split_screen.pb", legacyTrace = true) |
| val visibleLayers = |
| trace |
| .getEntryExactlyAt(CrossPlatform.timestamp.from(systemUptimeNanos = 90493757372977)) |
| .visibleLayers |
| val msg = "Visible Layers:\n" + visibleLayers.joinToString("\n") { "\t" + it.name } |
| Truth.assertWithMessage(msg).that(visibleLayers).asList().hasSize(7) |
| Truth.assertThat(msg).contains("ScreenDecorOverlayBottom#0") |
| Truth.assertThat(msg).contains("ScreenDecorOverlay#0") |
| Truth.assertThat(msg).contains("NavigationBar0#0") |
| Truth.assertThat(msg).contains("StatusBar#0") |
| Truth.assertThat(msg).contains("DockedStackDivider#0") |
| Truth.assertThat(msg).contains("ConversationListActivity#0") |
| Truth.assertThat(msg).contains("GoogleDialtactsActivity#0") |
| } |
| |
| @Test |
| fun canParseVisibleLayersInTransition() { |
| val trace = |
| readLayerTraceFromFile("layers_trace_launch_split_screen.pb", legacyTrace = true) |
| val visibleLayers = |
| trace |
| .getEntryExactlyAt(CrossPlatform.timestamp.from(systemUptimeNanos = 90488463619533)) |
| .visibleLayers |
| val msg = "Visible Layers:\n" + visibleLayers.joinToString("\n") { "\t" + it.name } |
| Truth.assertWithMessage(msg).that(visibleLayers).asList().hasSize(10) |
| Truth.assertThat(msg).contains("ScreenDecorOverlayBottom#0") |
| Truth.assertThat(msg).contains("ScreenDecorOverlay#0") |
| Truth.assertThat(msg).contains("NavigationBar0#0") |
| Truth.assertThat(msg).contains("StatusBar#0") |
| Truth.assertThat(msg).contains("DockedStackDivider#0") |
| Truth.assertThat(msg) |
| .contains("SnapshotStartingWindow for taskId=21 - " + "task-snapshot-surface#0") |
| Truth.assertThat(msg).contains("SnapshotStartingWindow for taskId=21") |
| Truth.assertThat(msg).contains("NexusLauncherActivity#0") |
| Truth.assertThat(msg).contains("ImageWallpaper#0") |
| Truth.assertThat(msg).contains("ConversationListActivity#0") |
| } |
| |
| @Test |
| fun canParseLayerHierarchy() { |
| val trace = readLayerTraceFromFile("layers_trace_emptyregion.pb", legacyTrace = true) |
| Truth.assertThat(trace.entries).isNotEmpty() |
| Truth.assertThat(trace.entries.first().timestamp.systemUptimeNanos).isEqualTo(922839428857) |
| Truth.assertThat(trace.entries.last().timestamp.systemUptimeNanos).isEqualTo(941432656959) |
| Truth.assertThat(trace.entries.first().flattenedLayers).asList().hasSize(57) |
| val layers = trace.entries.first().children |
| Truth.assertThat(layers[0].children).asList().hasSize(3) |
| Truth.assertThat(layers[1].children).isEmpty() |
| } |
| |
| // b/76099859 |
| @Test |
| fun canDetectOrphanLayers() { |
| try { |
| readLayerTraceFromFile( |
| "layers_trace_orphanlayers.pb", |
| ignoreOrphanLayers = false, |
| legacyTrace = true |
| ) |
| .entries |
| .first() |
| .flattenedLayers |
| error("Failed to detect orphaned layers.") |
| } catch (exception: RuntimeException) { |
| Truth.assertThat(exception.message) |
| .contains( |
| "Failed to parse layers trace. Found orphan layer with id = 49 with" + |
| " parentId = 1006" |
| ) |
| } |
| } |
| |
| @Test |
| fun testCanParseNonCroppedLayerWithHWC() { |
| val layerName = "BackColorSurface#0" |
| val layersTrace = |
| readLayerTraceFromFile("layers_trace_backcolorsurface.pb", legacyTrace = true) |
| val entry = |
| layersTrace.getEntryExactlyAt( |
| CrossPlatform.timestamp.from(systemUptimeNanos = 131954021476) |
| ) |
| Truth.assertWithMessage("$layerName should not be visible") |
| .that(entry.visibleLayers.map { it.name }) |
| .doesNotContain(layerName) |
| val layer = entry.flattenedLayers.first { it.name == layerName } |
| Truth.assertWithMessage("$layerName should be invisible because of HWC region") |
| .that(layer.visibilityReason) |
| .asList() |
| .contains("Visible region calculated by Composition Engine is empty") |
| } |
| |
| @Test |
| fun canParseTraceEmptyState() { |
| val layersTrace = |
| readLayerTraceFromFile("layers_trace_empty_state.winscope", legacyTrace = true) |
| val emptyStates = layersTrace.entries.filter { it.flattenedLayers.isEmpty() } |
| |
| Truth.assertWithMessage("Some states in the trace should be empty") |
| .that(emptyStates) |
| .isNotEmpty() |
| |
| Truth.assertWithMessage("Expected state 4d4h41m14s193ms to be empty") |
| .that(emptyStates.first().timestamp.systemUptimeNanos) |
| .isEqualTo(362474193519965) |
| } |
| |
| @Test |
| fun canDetectInvisibleLayerOutOfScreen() { |
| val layersTrace = readLayerTraceFromFile("layers_trace_visible_outside_bounds.winscope") |
| val subject = |
| LayersTraceSubject(layersTrace) |
| .getEntryBySystemUpTime(1253267561044, byElapsedTimestamp = true) |
| val region = subject.visibleRegion(ComponentNameMatcher.IME_SNAPSHOT) |
| region.isEmpty() |
| subject.isInvisible(ComponentNameMatcher.IME_SNAPSHOT) |
| } |
| |
| @Test |
| fun canDetectInvisibleLayerOutOfScreen_ConsecutiveLayers() { |
| val layersTrace = readLayerTraceFromFile("layers_trace_visible_outside_bounds.winscope") |
| val subject = LayersTraceSubject(layersTrace) |
| subject.visibleLayersShownMoreThanOneConsecutiveEntry() |
| } |
| |
| @Test |
| fun usesRealTimestampWhenAvailableAndFallsbackOnElapsedTimestamp() { |
| var entry = |
| LayerTraceEntry( |
| elapsedTimestamp = 100, |
| clockTimestamp = 600, |
| hwcBlob = "", |
| where = "", |
| displays = emptyArray(), |
| vSyncId = 123, |
| _rootLayers = emptyArray() |
| ) |
| Truth.assertThat(entry.timestamp.elapsedNanos) |
| .isEqualTo(CrossPlatform.timestamp.empty().elapsedNanos) |
| Truth.assertThat(entry.timestamp.systemUptimeNanos).isEqualTo(100) |
| Truth.assertThat(entry.timestamp.unixNanos).isEqualTo(600) |
| |
| entry = |
| LayerTraceEntry( |
| elapsedTimestamp = 100, |
| clockTimestamp = null, |
| hwcBlob = "", |
| where = "", |
| displays = emptyArray(), |
| vSyncId = 123, |
| _rootLayers = emptyArray() |
| ) |
| Truth.assertThat(entry.timestamp.elapsedNanos) |
| .isEqualTo(CrossPlatform.timestamp.empty().elapsedNanos) |
| Truth.assertThat(entry.timestamp.systemUptimeNanos).isEqualTo(100) |
| Truth.assertThat(entry.timestamp.unixNanos) |
| .isEqualTo(CrossPlatform.timestamp.empty().unixNanos) |
| } |
| |
| companion object { |
| @ClassRule @JvmField val initRule = InitRule() |
| } |
| } |
