• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2025 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.systemui.compose
18 
19 import androidx.compose.runtime.snapshots.Snapshot
20 import kotlinx.coroutines.test.TestScope
21 import kotlinx.coroutines.test.runTest
22 
23 /**
24  * Runs the given test [block] in a [TestScope] that's set up such that the Compose snapshot state
25  * writes are properly applied to the global snapshot. This is for instance necessary if your test
26  * is using `snapshotFlow {}` or any other mechanism that is observing the global snapshot.
27  *
28  * Note that this isn't needed in a Compose test environment, e.g. if you use the
29  * `Compose(Content)TestRule`.
30  */
TestScopenull31 fun TestScope.runTestWithSnapshots(block: suspend TestScope.() -> Unit) {
32     val handle = Snapshot.registerGlobalWriteObserver { Snapshot.sendApplyNotifications() }
33 
34     try {
35         runTest { block() }
36     } finally {
37         handle.dispose()
38     }
39 }
40