summaryrefslogtreecommitdiff
path: root/adblib-tools/test/src/com/android/adblib/tools/debugging/utils/ReferenceCountedResourceTest.kt
blob: 12a3a4860b592143569cd74a171d6cefdb2480c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
/*
 * Copyright (C) 2022 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.adblib.tools.debugging.utils

import com.android.adblib.AutoShutdown
import com.android.adblib.testingutils.CoroutineTestUtils.runBlockingWithTimeout
import com.android.adblib.tools.testutils.AdbLibToolsTestBase
import kotlinx.coroutines.Job
import kotlinx.coroutines.delay
import kotlinx.coroutines.joinAll
import kotlinx.coroutines.launch
import org.junit.Assert
import org.junit.Test
import java.util.concurrent.atomic.AtomicBoolean
import java.util.concurrent.atomic.AtomicInteger

class ReferenceCountedResourceTest : AdbLibToolsTestBase() {

    @Test
    fun testUnderlyingResourceIsNotCreatedRightAway() = runBlockingWithTimeout {
        // Prepare
        val res = MyTestResource()
        /*val ref = */ReferenceCountedResource(session) {
            res.creationCount.incrementAndGet()
            res
        }

        // Assert
        Assert.assertEquals(0, res.creationCount.get())
        Assert.assertFalse(res.shutdownCalled.get())
        Assert.assertFalse(res.closeCalled.get())
    }

    @Test
    fun testUnderlyingResourceIsCreatedLazily() = runBlockingWithTimeout {
        // Prepare
        val res = MyTestResource()
        val ref = ReferenceCountedResource(session) {
            res.creationCount.incrementAndGet()
            res
        }

        // Act
        ref.retain()

        // Assert
        Assert.assertEquals(1, res.creationCount.get())
        Assert.assertFalse(res.shutdownCalled.get())
        Assert.assertFalse(res.closeCalled.get())
    }

    @Test
    fun testUnderlyingResourceIsShutDownOnRelease() = runBlockingWithTimeout {
        // Prepare
        val res = MyTestResource()
        val ref = ReferenceCountedResource(session) {
            res.creationCount.incrementAndGet()
            res
        }

        // Act
        ref.retain()
        ref.release()

        // Assert
        Assert.assertEquals(1, res.creationCount.get())
        Assert.assertTrue(res.shutdownCalled.get())
        Assert.assertTrue(res.closeCalled.get())
    }

    @Test
    fun testUnderlyingResourceIsClosedOnClose() = runBlockingWithTimeout {
        // Prepare
        val res = MyTestResource()
        val ref = ReferenceCountedResource(session) {
            res.creationCount.incrementAndGet()
            res
        }

        // Act
        ref.retain()
        ref.close()

        // Assert
        Assert.assertEquals(1, res.creationCount.get())
        Assert.assertFalse(res.shutdownCalled.get())
        Assert.assertTrue(res.closeCalled.get())
    }

    @Test
    fun testUnderlyingResourceIsCreatedOnlyOnce() = runBlockingWithTimeout {
        // Prepare
        val res = MyTestResource()
        val ref = ReferenceCountedResource(session) {
            res.creationCount.incrementAndGet()
            res
        }

        // Act
        ref.retain()
        ref.retain()

        // Assert
        Assert.assertEquals(1, res.creationCount.get())
        Assert.assertFalse(res.shutdownCalled.get())
        Assert.assertFalse(res.closeCalled.get())
    }

    @Test
    fun testUnderlyingResourceIsCreatedOnlyOnceFromConcurrentThreads() = runBlockingWithTimeout {
        // Prepare
        val res = MyTestResource()
        val ref = ReferenceCountedResource(session) {
            res.creationCount.incrementAndGet()
            res
        }

        // Act
        val jobs = mutableListOf<Job>()
        for(i in 1..100) {
            jobs.add(launch {
                for (j in 1..100) {
                    ref.retain()
                    // Release all except first one to ensure resource is not closed
                    if (j >= 2) {
                        ref.release()
                    }
                }
            })
        }
        jobs.joinAll()

        // Assert
        Assert.assertEquals(1, res.creationCount.get())
        Assert.assertFalse(res.shutdownCalled.get())
        Assert.assertFalse(res.closeCalled.get())
    }

    @Test
    fun testUnderlyingResourceIsClosedFromConcurrentThreads() = runBlockingWithTimeout {
        // Prepare
        val res = MyTestResource()
        val ref = ReferenceCountedResource(session) {
            res.creationCount.incrementAndGet()
            res.closeCalled.set(false)
            res
        }

        // Act
        val jobs = mutableListOf<Job>()
        for(i in 1..100) {
            jobs.add(launch {
                for (j in 1..100) {
                    ref.withResource { }
                }
            })
        }
        jobs.joinAll()

        // Assert
        Assert.assertTrue(res.creationCount.get() >= 1)
        Assert.assertTrue(res.shutdownCalled.get())
        Assert.assertTrue(res.closeCalled.get())
    }

    @Test
    fun testUnderlyingResourceIsCreatedOnlyOnceEvenIfDelayed() = runBlockingWithTimeout {
        // Prepare
        val res = MyTestResource()
        val ref = ReferenceCountedResource(session) {
            delay(100)
            res.creationCount.incrementAndGet()
            res
        }

        // Act
        joinAll(launch { ref.retain() }, launch { ref.retain() })

        // Assert
        Assert.assertEquals(1, res.creationCount.get())
        Assert.assertFalse(res.shutdownCalled.get())
        Assert.assertFalse(res.closeCalled.get())
    }

    @Test
    fun testUnderlyingResourceCreationIsCancelledIfRefIsClosedEarly() = runBlockingWithTimeout {
        // Prepare
        val res = MyTestResource()
        val ref = ReferenceCountedResource(session) {
            delay(10_000)
            res.creationCount.incrementAndGet()
            res
        }

        // Act
        val job = launch {
            ref.retain()
        }
        delay(100) // This is much lower than the resource creation delay
        ref.close() // this should cancel the job to create the resource instance
        job.join() // this makes sure cancellation is propagated to the "retain" call

        // Assert
        Assert.assertEquals(0, res.creationCount.get())
        Assert.assertFalse(res.closeCalled.get())
        Assert.assertFalse(res.shutdownCalled.get())
        Assert.assertTrue(job.isCancelled)
    }

    class MyTestResource : AutoShutdown {
        val creationCount = AtomicInteger()
        val closeCalled = AtomicBoolean(false)
        val shutdownCalled = AtomicBoolean(false)

        override suspend fun shutdown() {
            shutdownCalled.set(true)
        }

        override fun close() {
            closeCalled.set(true)
        }
    }
}