Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d655e5b5 authored by Peter Kalauskas's avatar Peter Kalauskas Committed by Android Build Cherrypicker Worker
Browse files

Extract common test functionality to new class 

Flag: TEST_ONLY
Test: atest tracinglib-host-test
Bug: 350931144
(cherry picked from https://googleplex-android-review.googlesource.com/q/commit:f81d74393700cd339854494daec1d1c2b6f02232)
Merged-In: Idffddb499880fd4071db9499fafb87d3e116c701
Change-Id: Idffddb499880fd4071db9499fafb87d3e116c701
parent 4f57fc60

tracinglib/core/host/test/CoroutineTracingTest.kt

+2 −79
Original line number Diff line number Diff line
@@ -16,14 +16,12 @@ 


package com.android.app.tracing.coroutines



import com.android.app.tracing.FakeTraceState.getOpenTraceSectionsOnCurrentThread

import com.android.app.tracing.setAndroidSystemTracingEnabled

import com.android.systemui.Flags

import com.android.systemui.util.Compile

import java.util.concurrent.CyclicBarrier

import java.util.concurrent.Executors

import java.util.concurrent.TimeUnit

import java.util.concurrent.atomic.AtomicInteger

import kotlin.coroutines.CoroutineContext

import kotlin.coroutines.EmptyCoroutineContext

import kotlinx.coroutines.CoroutineScope
@@ -36,7 +34,6 @@ import kotlinx.coroutines.test.TestScope 
import kotlinx.coroutines.test.UnconfinedTestDispatcher

import kotlinx.coroutines.test.runTest

import kotlinx.coroutines.withContext

import org.junit.After

import org.junit.Assert.assertArrayEquals

import org.junit.Assert.assertEquals

import org.junit.Assert.assertNotNull
@@ -45,29 +42,12 @@ import org.junit.Assert.assertNull 
import org.junit.Assert.assertSame

import org.junit.Assert.assertTrue

import org.junit.Assert.fail

import org.junit.Before

import org.junit.Test

import org.junit.runner.RunWith

import org.junit.runners.BlockJUnit4ClassRunner



@RunWith(BlockJUnit4ClassRunner::class)

class CoroutineTracingTest {

    @Before

    fun setup() {

        TraceData.strictModeForTesting = true

        Compile.setIsDebug(true)

        Flags.setCoroutineTracingEnabled(true)

        setAndroidSystemTracingEnabled(true)

    }



    @After

    fun checkFinished() {

        val lastEvent = eventCounter.get()

        assertTrue(

            "Expected `finish(${lastEvent + 1})` to be called, but the test finished",

            lastEvent == FINAL_EVENT || lastEvent == 0,

        )

    }

class CoroutineTracingTest : TestBase() {



    @Test

    fun simpleTraceSection() = runTestWithTraceContext {
@@ -605,61 +585,4 @@ class CoroutineTracingTest { 
            }

        }

    }



    private fun expect(vararg expectedOpenTraceSections: String) {

        expect(null, *expectedOpenTraceSections)

    }



    /**

     * Checks the currently active trace sections on the current thread, and optionally checks the

     * order of operations if [expectedEvent] is not null.

     */

    private fun expect(expectedEvent: Int? = null, vararg expectedOpenTraceSections: String) {

        if (expectedEvent != null) {

            val previousEvent = eventCounter.getAndAdd(1)

            val currentEvent = previousEvent + 1

            check(expectedEvent == currentEvent) {

                if (previousEvent == FINAL_EVENT) {

                    "Expected event=$expectedEvent, but finish() was already called"

                } else {

                    "Expected event=$expectedEvent," +

                        " but the event counter is currently at $currentEvent"

                }

            }

        }



        // Inspect trace output to the fake used for recording android.os.Trace API calls:

        assertArrayEquals(expectedOpenTraceSections, getOpenTraceSectionsOnCurrentThread())

    }



    /** Same as [expect], except that no more [expect] statements can be called after it. */

    private fun finish(expectedEvent: Int, vararg expectedOpenTraceSections: String) {

        val previousEvent = eventCounter.getAndSet(FINAL_EVENT)

        val currentEvent = previousEvent + 1

        check(expectedEvent == currentEvent) {

            if (previousEvent == FINAL_EVENT) {

                "finish() was called more than once"

            } else {

                "Finished with event=$expectedEvent," +

                    " but the event counter is currently $currentEvent"

            }

        }



        // Inspect trace output to the fake used for recording android.os.Trace API calls:

        assertArrayEquals(expectedOpenTraceSections, getOpenTraceSectionsOnCurrentThread())

    }



    private val eventCounter = AtomicInteger(0)



    companion object {

        const val FINAL_EVENT = Int.MIN_VALUE

    }

}
 
 No newline at end of file
 


/**

 * Helper util for calling [runTest] with a [TraceContextElement]. This is useful for formatting

 * purposes. Passing an arg to `runTest {}` directly, as in `fun testStuff() =

 * runTestWithTraceContext {}` would require more indentations according to our style guide.

 */

private fun runTestWithTraceContext(testBody: suspend TestScope.() -> Unit) =

    runTest(context = TraceContextElement(), testBody = testBody)

tracinglib/core/host/test/TestBase.kt

0 → 100644
+108 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2024 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.app.tracing.coroutines



import com.android.app.tracing.FakeTraceState.getOpenTraceSectionsOnCurrentThread

import com.android.app.tracing.setAndroidSystemTracingEnabled

import com.android.systemui.Flags

import com.android.systemui.util.Compile

import java.util.concurrent.atomic.AtomicInteger

import kotlinx.coroutines.test.TestScope

import kotlinx.coroutines.test.runTest

import org.junit.After

import org.junit.Assert.assertArrayEquals

import org.junit.Assert.assertTrue

import org.junit.Before

import org.junit.runner.RunWith

import org.junit.runners.BlockJUnit4ClassRunner



@RunWith(BlockJUnit4ClassRunner::class)

open class TestBase {

    @Before

    fun setup() {

        TraceData.strictModeForTesting = true

        Compile.setIsDebug(true)

        Flags.setCoroutineTracingEnabled(true)

        setAndroidSystemTracingEnabled(true)

    }



    @After

    fun checkFinished() {

        val lastEvent = eventCounter.get()

        assertTrue(

            "Expected `finish(${lastEvent + 1})` to be called, but the test finished",

            lastEvent == FINAL_EVENT || lastEvent == 0,

        )

    }



    protected fun expect(vararg expectedOpenTraceSections: String) {

        expect(null, *expectedOpenTraceSections)

    }



    /**

     * Checks the currently active trace sections on the current thread, and optionally checks the

     * order of operations if [expectedEvent] is not null.

     */

    protected fun expect(expectedEvent: Int? = null, vararg expectedOpenTraceSections: String) {

        if (expectedEvent != null) {

            val previousEvent = eventCounter.getAndAdd(1)

            val currentEvent = previousEvent + 1

            check(expectedEvent == currentEvent) {

                if (previousEvent == FINAL_EVENT) {

                    "Expected event=$expectedEvent, but finish() was already called"

                } else {

                    "Expected event=$expectedEvent," +

                        " but the event counter is currently at $currentEvent"

                }

            }

        }



        // Inspect trace output to the fake used for recording android.os.Trace API calls:

        assertArrayEquals(expectedOpenTraceSections, getOpenTraceSectionsOnCurrentThread())

    }



    /** Same as [expect], except that no more [expect] statements can be called after it. */

    protected fun finish(expectedEvent: Int, vararg expectedOpenTraceSections: String) {

        val previousEvent = eventCounter.getAndSet(FINAL_EVENT)

        val currentEvent = previousEvent + 1

        check(expectedEvent == currentEvent) {

            if (previousEvent == FINAL_EVENT) {

                "finish() was called more than once"

            } else {

                "Finished with event=$expectedEvent," +

                    " but the event counter is currently $currentEvent"

            }

        }



        // Inspect trace output to the fake used for recording android.os.Trace API calls:

        assertArrayEquals(expectedOpenTraceSections, getOpenTraceSectionsOnCurrentThread())

    }



    private val eventCounter = AtomicInteger(0)



    companion object {

        const val FINAL_EVENT = Int.MIN_VALUE

    }

}



/**

 * Helper util for calling [runTest] with a [TraceContextElement]. This is useful for formatting

 * purposes. Passing an arg to `runTest {}` directly, as in `fun testStuff() =

 * runTestWithTraceContext {}` would require more indentations according to our style guide.

 */

fun runTestWithTraceContext(testBody: suspend TestScope.() -> Unit) =

    runTest(context = TraceContextElement(), testBody = testBody)