Merge "Test multi-threaded behavior of coroutine tracing" into main (8a3a12c7) · Commits · e / os / android_frameworks_libs_systemui

tracinglib/src/fakeTest/kotlin/com/android/app/tracing/coroutines/CoroutineTracingTest.kt

+164 −7

Original line number	Diff line number	Diff line
		@@ -17,7 +17,11 @@
		package com.android.app.tracing.coroutines

		import com.android.app.tracing.TraceState.openSectionsOnCurrentThread
		import kotlin.coroutines.CoroutineContext
		import kotlin.coroutines.EmptyCoroutineContext
		import kotlinx.coroutines.delay
		import kotlinx.coroutines.launch
		import kotlinx.coroutines.newSingleThreadContext
		import kotlinx.coroutines.test.runTest
		import org.junit.Assert.assertArrayEquals
		import org.junit.Assert.assertEquals
		@@ -25,27 +29,180 @@ import org.junit.Test
		import org.junit.runner.RunWith
		import org.junit.runners.BlockJUnit4ClassRunner

		/**
		* Helper util for asserting that the open trace sections on the current thread equal the passed
		* list of strings.
		*/
		private fun assertTraceEquals(vararg openTraceSections: String) {
		assertArrayEquals(openTraceSections, openSectionsOnCurrentThread())
		}

		/** Helper util for asserting that there are no open trace sections on the current thread. */
		private fun assertTraceIsEmpty() = assertEquals(0, openSectionsOnCurrentThread().size)

		@RunWith(BlockJUnit4ClassRunner::class)
		class CoroutineTracingTest {

		@Test
		fun nestedTraceSectionsOnSingleThread() {
		runTest(TraceContextElement()) {
		val fetchData: suspend () -> String = {
		delay(1L)
		traceCoroutine("span-for-fetchData") {
		assertArrayEquals(
		arrayOf("span-for-launch", "span-for-fetchData"),
		openSectionsOnCurrentThread()
		)
		assertTraceEquals("span-for-launch", "span-for-fetchData")
		}
		"stuff"
		}
		launch("span-for-launch") {
		assertEquals("stuff", fetchData())
		assertArrayEquals(arrayOf("span-for-launch"), openSectionsOnCurrentThread())
		assertTraceEquals("span-for-launch")
		}
		assertTraceIsEmpty()
		}
		}
		assertEquals(0, openSectionsOnCurrentThread().size)

		private fun testTraceSectionsMultiThreaded(
		testContext: CoroutineContext,
		thread1Context: CoroutineContext,
		thread2Context: CoroutineContext
		) {
		runTest(testContext) {
		val fetchData1: suspend () -> String = {
		assertTraceEquals("span-for-launch-1")
		delay(1L)
		traceCoroutine("span-for-fetchData-1") {
		assertTraceEquals("span-for-launch-1", "span-for-fetchData-1")
		}
		assertTraceEquals("span-for-launch-1")
		"stuff-1"
		}

		val fetchData2: suspend () -> String = {
		assertTraceEquals(
		"span-for-launch-1",
		"span-for-launch-2",
		)
		delay(1L)
		traceCoroutine("span-for-fetchData-2") {
		assertTraceEquals(
		"span-for-launch-1",
		"span-for-launch-2",
		"span-for-fetchData-2"
		)
		}
		assertTraceEquals(
		"span-for-launch-1",
		"span-for-launch-2",
		)
		"stuff-2"
		}

		val thread1 = newSingleThreadContext("thread-#1") + thread1Context
		val thread2 = newSingleThreadContext("thread-#2") + thread2Context

		launch("span-for-launch-1", thread1) {
		assertEquals("stuff-1", fetchData1())
		assertTraceEquals("span-for-launch-1")
		launch("span-for-launch-2", thread2) {
		assertEquals("stuff-2", fetchData2())
		assertTraceEquals("span-for-launch-1", "span-for-launch-2")
		}
		assertTraceEquals("span-for-launch-1")
		}
		assertTraceIsEmpty()

		// Launching without the trace extension won't result in traces
		launch(thread1) { assertTraceIsEmpty() }
		launch(thread2) { assertTraceIsEmpty() }
		}
		}

		@Test
		fun nestedTraceSectionsMultiThreaded1() {
		// Thread-#1 and Thread-#2 inherit TraceContextElement from the test context:
		testTraceSectionsMultiThreaded(
		testContext = TraceContextElement(),
		thread1Context = EmptyCoroutineContext,
		thread2Context = EmptyCoroutineContext
		)
		}

		@Test
		fun nestedTraceSectionsMultiThreaded2() {
		// Thread-#2 inherits the TraceContextElement from Thread-#1. The test context does not need
		// the trace context
		testTraceSectionsMultiThreaded(
		testContext = EmptyCoroutineContext,
		thread1Context = TraceContextElement(),
		thread2Context = EmptyCoroutineContext
		)
		}

		@Test
		fun nestedTraceSectionsMultiThreaded3() {
		// Thread-#2 overrides the TraceContextElement from Thread-#1 - but the merging context
		// should be a no-op. The test context does not need the trace context.
		testTraceSectionsMultiThreaded(
		testContext = EmptyCoroutineContext,
		thread1Context = TraceContextElement(),
		thread2Context = TraceContextElement()
		)
		}

		@Test
		fun nestedTraceSectionsMultiThreaded4() {
		// TraceContextElement is merged on each context switch, which should have no effect on the
		// trace results.
		testTraceSectionsMultiThreaded(
		testContext = TraceContextElement(),
		thread1Context = TraceContextElement(),
		thread2Context = TraceContextElement()
		)
		}

		@Test
		fun missingTraceContextObjects() {
		// Thread-#1 is missing a TraceContextElement, so some of the trace sections get dropped.
		// The resulting trace sections will be different than the 4 tests above.
		runTest {
		val fetchData1: suspend () -> String = {
		assertTraceIsEmpty()
		delay(1L)
		traceCoroutine("span-for-fetchData-1") { assertTraceIsEmpty() }
		assertTraceIsEmpty()
		"stuff-1"
		}

		val fetchData2: suspend () -> String = {
		assertTraceEquals(
		"span-for-launch-2",
		)
		delay(1L)
		traceCoroutine("span-for-fetchData-2") {
		assertTraceEquals("span-for-launch-2", "span-for-fetchData-2")
		}
		assertTraceEquals(
		"span-for-launch-2",
		)
		"stuff-2"
		}

		val thread1 = newSingleThreadContext("thread-#1")
		val thread2 = newSingleThreadContext("thread-#2") + TraceContextElement()

		launch("span-for-launch-1", thread1) {
		assertEquals("stuff-1", fetchData1())
		assertTraceIsEmpty()
		launch("span-for-launch-2", thread2) {
		assertEquals("stuff-2", fetchData2())
		assertTraceEquals("span-for-launch-2")
		}
		assertTraceIsEmpty()
		}
		assertTraceIsEmpty()

		// Launching without the trace extension won't result in traces
		launch(thread1) { assertTraceIsEmpty() }
		launch(thread2) { assertTraceIsEmpty() }
		}
		}
		}