-
Notifications
You must be signed in to change notification settings - Fork 7
/
EmbraceSessionPropertiesTest.kt
275 lines (245 loc) · 10.1 KB
/
EmbraceSessionPropertiesTest.kt
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
@file:Suppress("DEPRECATION")
package io.embrace.android.embracesdk
import android.content.Context
import android.preference.PreferenceManager
import androidx.test.core.app.ApplicationProvider
import androidx.test.ext.junit.runners.AndroidJUnit4
import io.embrace.android.embracesdk.config.ConfigService
import io.embrace.android.embracesdk.config.remote.RemoteConfig
import io.embrace.android.embracesdk.fakes.FakeClock
import io.embrace.android.embracesdk.fakes.FakeConfigService
import io.embrace.android.embracesdk.fakes.fakeSessionBehavior
import io.embrace.android.embracesdk.internal.serialization.EmbraceSerializer
import io.embrace.android.embracesdk.logging.InternalEmbraceLogger
import io.embrace.android.embracesdk.prefs.EmbracePreferencesService
import io.embrace.android.embracesdk.prefs.PreferencesService
import io.embrace.android.embracesdk.session.properties.EmbraceSessionProperties
import io.embrace.android.embracesdk.worker.BackgroundWorker
import org.junit.Assert.assertEquals
import org.junit.Assert.assertFalse
import org.junit.Assert.assertTrue
import org.junit.Assert.fail
import org.junit.Before
import org.junit.Test
import org.junit.runner.RunWith
import java.util.concurrent.CountDownLatch
import java.util.concurrent.Executors
@RunWith(AndroidJUnit4::class)
internal class EmbraceSessionPropertiesTest {
companion object {
private val fakeClock = FakeClock()
private const val KEY_VALID = "abc"
private const val VALUE_VALID = "def"
}
private lateinit var preferencesService: PreferencesService
private lateinit var sessionProperties: EmbraceSessionProperties
private lateinit var context: Context
private lateinit var logger: InternalEmbraceLogger
private lateinit var configService: ConfigService
private lateinit var config: RemoteConfig
@Before
fun setUp() {
val worker = BackgroundWorker(Executors.newSingleThreadExecutor())
context = ApplicationProvider.getApplicationContext()
logger = InternalEmbraceLogger()
val prefs = lazy { PreferenceManager.getDefaultSharedPreferences(context) }
preferencesService =
EmbracePreferencesService(worker, prefs, fakeClock, EmbraceSerializer())
config = RemoteConfig()
configService = FakeConfigService(
sessionBehavior = fakeSessionBehavior {
config
}
)
sessionProperties = EmbraceSessionProperties(
preferencesService,
configService,
logger
)
}
@Test
fun `Add session property with no error when maxSessionProperties is absent`() {
assertTrue(sessionProperties.add(KEY_VALID, VALUE_VALID, false))
assertEquals(1, sessionProperties.get().size.toLong())
}
@Test
fun addSessionProperty() {
assertTrue(sessionProperties.add(KEY_VALID, VALUE_VALID, false))
assertEquals(1, sessionProperties.get().size.toLong())
assertEquals(VALUE_VALID, sessionProperties.get()[KEY_VALID])
// temporary property should not have been persisted
val sessionProperties2 = EmbraceSessionProperties(preferencesService, configService, logger)
assertTrue(sessionProperties2.get().isEmpty())
}
@Test
fun addSessionPropertyInvalidKey() {
assertFalse(sessionProperties.add("", VALUE_VALID, false))
assertTrue(sessionProperties.get().isEmpty())
}
@Test
fun addSessionPropertyInvalidValue() {
assertTrue(sessionProperties.get().isEmpty())
}
@Test
fun addSessionPropertyPermanent() {
assertTrue(sessionProperties.add(KEY_VALID, VALUE_VALID, true))
assertEquals(1, sessionProperties.get().size.toLong())
assertEquals(VALUE_VALID, sessionProperties.get()[KEY_VALID])
// permanent property should have been persisted
val sessionProperties2 = EmbraceSessionProperties(preferencesService, configService, logger)
assertEquals(1, sessionProperties2.get().size.toLong())
assertEquals(VALUE_VALID, sessionProperties2.get()[KEY_VALID])
// /change property to be not permanent
assertTrue(sessionProperties.add(KEY_VALID, VALUE_VALID, false))
// permanent property should no longer have been persisted
val sessionProperties3 = EmbraceSessionProperties(preferencesService, configService, logger)
assertTrue(sessionProperties3.get().isEmpty())
}
@Test
fun addSessionPropertyKeyTooLong() {
val longKey = "a".repeat(129)
assertTrue(sessionProperties.add(longKey, VALUE_VALID, false))
assertEquals(1, sessionProperties.get().size.toLong())
val key = "a".repeat(125) + "..."
assertEquals(VALUE_VALID, sessionProperties.get()[key])
}
@Test
fun addSessionPropertyValueTooLong() {
val longValue = "a".repeat(1025)
assertTrue(sessionProperties.add(KEY_VALID, longValue, false))
assertEquals(1, sessionProperties.get().size.toLong())
val value = "a".repeat(1021) + "..."
assertEquals(value, sessionProperties.get()[KEY_VALID])
}
@Test
@Throws(InterruptedException::class)
fun addSessionPropertyFromMultipleThreads() {
val expected: MutableMap<String, String> = HashMap()
val properties = ArrayList<String>()
var key: String
for (i in 0 until MAX_SESSION_PROPERTIES_DEFAULT) {
key = "prop$i"
properties.add(key)
expected[key] = VALUE_VALID
}
val startSignal = CountDownLatch(1)
val doneSignal = CountDownLatch(properties.size)
for (property in properties) {
// start workers that will all add a fragment each
Thread(AddPropertyWorker(startSignal, doneSignal, sessionProperties, property)).start()
}
startSignal.countDown()
// wait for all the workers to finish
doneSignal.await()
assertEquals(properties.size.toLong(), sessionProperties.get().size.toLong())
assertEquals(expected, sessionProperties.get())
}
internal class AddPropertyWorker(
private val startSignal: CountDownLatch,
private val doneSignal: CountDownLatch,
private val properties: EmbraceSessionProperties,
private val property: String
) : Runnable {
override fun run() {
try {
startSignal.await()
assertTrue(properties.add(property, VALUE_VALID, false))
doneSignal.countDown()
} catch (ex: InterruptedException) {
fail("worker thread died")
}
}
}
@Test
fun addPropertyTooManyWithDefaultMax() {
var isPermanent = true
for (i in 0 until MAX_SESSION_PROPERTIES_DEFAULT) {
assertTrue(sessionProperties.add("prop$i", VALUE_VALID, isPermanent))
// flip between permanent and temporary
isPermanent = !isPermanent
}
assertFalse(
"should not be able to add new key when limit is hit",
sessionProperties.add("propNew", VALUE_VALID, true)
)
val otherValue = "other"
assertTrue(
"should be able to update key when properties are full",
sessionProperties.add("prop0", otherValue, true)
)
assertEquals(
"property was updated",
otherValue,
sessionProperties.get()["prop0"]
)
assertTrue(sessionProperties.remove("prop0"))
assertTrue(
"can add key once one was deleted",
sessionProperties.add("prop11", VALUE_VALID, isPermanent)
)
}
@Test
fun addPropertyTooManyWithRemoteConfigMax() {
config = RemoteConfig(maxSessionProperties = MAX_SESSION_PROPERTIES_FROM_CONFIG)
var isPermanent = true
for (i in 0 until MAX_SESSION_PROPERTIES_FROM_CONFIG) {
assertTrue(sessionProperties.add("prop$i", VALUE_VALID, isPermanent))
// flip between permanent and temporary
isPermanent = !isPermanent
}
assertFalse(
"should not be able to add new key when limit is hit",
sessionProperties.add("propNew", VALUE_VALID, true)
)
val otherValue = "other"
assertTrue(
"should be able to update key when properties are full",
sessionProperties.add("prop0", otherValue, true)
)
assertEquals(
"property was updated",
otherValue,
sessionProperties.get()["prop0"]
)
assertTrue(sessionProperties.remove("prop0"))
assertTrue(
"can add key once one was deleted",
sessionProperties.add("prop11", VALUE_VALID, isPermanent)
)
}
@Test
fun removeSessionProperty() {
assertTrue(sessionProperties.add(KEY_VALID, VALUE_VALID, false))
assertTrue(sessionProperties.remove(KEY_VALID))
assertTrue(sessionProperties.get().isEmpty())
}
@Test
fun removeSessionPropertyPermanent() {
assertTrue(sessionProperties.add(KEY_VALID, VALUE_VALID, true))
// permanent property should have been persisted
val sessionProperties2 = EmbraceSessionProperties(preferencesService, configService, logger)
assertEquals(1, sessionProperties2.get().size.toLong())
assertTrue(sessionProperties.remove(KEY_VALID))
assertTrue(sessionProperties.get().isEmpty())
// permanent property should have been removed
val sessionProperties3 = EmbraceSessionProperties(preferencesService, configService, logger)
assertTrue(sessionProperties3.get().isEmpty())
}
@Test
fun removeSessionPropertyInvalidKey() {
assertFalse(sessionProperties.remove(""))
}
@Test
fun removeSessionPropertyDoesNotExist() {
assertFalse(sessionProperties.remove(KEY_VALID))
}
@Test
fun removeSessionPropertyLongKey() {
val longKey = "a".repeat(129)
assertTrue(sessionProperties.add(longKey, VALUE_VALID, false))
assertTrue(sessionProperties.remove(longKey))
assertTrue(sessionProperties.get().isEmpty())
}
}
private const val MAX_SESSION_PROPERTIES_FROM_CONFIG = 5
private const val MAX_SESSION_PROPERTIES_DEFAULT = 10