-
-
Notifications
You must be signed in to change notification settings - Fork 432
/
AndroidOptionsInitializerTest.kt
367 lines (302 loc) · 12.2 KB
/
AndroidOptionsInitializerTest.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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
package io.sentry.android.core
import android.content.Context
import android.os.Bundle
import androidx.test.core.app.ApplicationProvider
import androidx.test.ext.junit.runners.AndroidJUnit4
import com.nhaarman.mockitokotlin2.any
import com.nhaarman.mockitokotlin2.mock
import com.nhaarman.mockitokotlin2.whenever
import io.sentry.ILogger
import io.sentry.MainEventProcessor
import io.sentry.SendCachedEnvelopeFireAndForgetIntegration
import io.sentry.SentryOptions
import io.sentry.android.fragment.FragmentLifecycleIntegration
import io.sentry.android.timber.SentryTimberIntegration
import org.junit.runner.RunWith
import java.io.File
import kotlin.test.BeforeTest
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertFalse
import kotlin.test.assertNotNull
import kotlin.test.assertNull
import kotlin.test.assertTrue
@RunWith(AndroidJUnit4::class)
class AndroidOptionsInitializerTest {
class Fixture(val context: Context, private val file: File) {
val sentryOptions = SentryAndroidOptions()
lateinit var mockContext: Context
val logger = mock<ILogger>()
fun initSut(
metadata: Bundle? = null,
hasAppContext: Boolean = true,
useRealContext: Boolean = false,
configureOptions: SentryAndroidOptions.() -> Unit = {},
configureContext: Context.() -> Unit = {}
) {
mockContext = if (metadata != null) {
ContextUtilsTest.mockMetaData(
mockContext = ContextUtilsTest.createMockContext(hasAppContext),
metaData = metadata
)
} else {
ContextUtilsTest.createMockContext(hasAppContext)
}
whenever(mockContext.cacheDir).thenReturn(file)
if (mockContext.applicationContext != null) {
whenever(mockContext.applicationContext.cacheDir).thenReturn(file)
}
mockContext.configureContext()
sentryOptions.configureOptions()
AndroidOptionsInitializer.init(
sentryOptions, if (useRealContext) context else mockContext
)
}
fun initSutWithClassLoader(
minApi: Int = 16,
classToLoad: Class<*>? = null,
isFragmentAvailable: Boolean = false,
isTimberAvailable: Boolean = false
) {
mockContext = ContextUtilsTest.mockMetaData(
mockContext = ContextUtilsTest.createMockContext(hasAppContext = true),
metaData = Bundle().apply {
putString(ManifestMetadataReader.DSN, "https://key@sentry.io/123")
}
)
sentryOptions.setDebug(true)
AndroidOptionsInitializer.init(
sentryOptions, mockContext, logger, createBuildInfo(minApi),
createClassMock(classToLoad), isFragmentAvailable, isTimberAvailable
)
}
private fun createBuildInfo(minApi: Int = 16): BuildInfoProvider {
val buildInfo = mock<BuildInfoProvider>()
whenever(buildInfo.sdkInfoVersion).thenReturn(minApi)
return buildInfo
}
private fun createClassMock(clazz: Class<*>?): LoadClass {
val loadClassMock = mock<LoadClass>()
whenever(loadClassMock.loadClass(any(), any())).thenReturn(clazz)
whenever(loadClassMock.isClassAvailable(any(), any<ILogger>())).thenReturn(clazz != null)
return loadClassMock
}
}
private lateinit var fixture: Fixture
@BeforeTest
fun `set up`() {
val appContext = ApplicationProvider.getApplicationContext<Context>()
fixture = Fixture(appContext, appContext.cacheDir)
}
@Test
fun `logger set to AndroidLogger`() {
fixture.initSut()
val logger = SentryOptions::class.java.declaredFields.first { it.name == "logger" }
logger.isAccessible = true
val loggerField = logger.get(fixture.sentryOptions)
val innerLogger = loggerField.javaClass.declaredFields.first { it.name == "logger" }
innerLogger.isAccessible = true
assertTrue(innerLogger.get(loggerField) is AndroidLogger)
}
@Test
fun `AndroidEventProcessor added to processors list`() {
fixture.initSut()
val actual =
fixture.sentryOptions.eventProcessors.any { it is DefaultAndroidEventProcessor }
assertNotNull(actual)
}
@Test
fun `PerformanceAndroidEventProcessor added to processors list`() {
fixture.initSut()
val actual =
fixture.sentryOptions.eventProcessors.any { it is PerformanceAndroidEventProcessor }
assertNotNull(actual)
}
@Test
fun `MainEventProcessor added to processors list and its the 1st`() {
fixture.initSut()
val actual = fixture.sentryOptions.eventProcessors.firstOrNull { it is MainEventProcessor }
assertNotNull(actual)
}
@Test
fun `ScreenshotEventProcessor added to processors list`() {
fixture.initSut()
val actual =
fixture.sentryOptions.eventProcessors.any { it is ScreenshotEventProcessor }
assertNotNull(actual)
}
@Test
fun `envelopesDir should be set at initialization`() {
fixture.initSut()
assertTrue(
fixture.sentryOptions.cacheDirPath?.endsWith(
"${File.separator}cache${File.separator}sentry"
)!!
)
}
@Test
fun `profilingTracesDirPath should be set at initialization`() {
fixture.initSut()
assertTrue(
fixture.sentryOptions.profilingTracesDirPath?.endsWith(
"${File.separator}cache${File.separator}sentry${File.separator}profiling_traces"
)!!
)
assertFalse(File(fixture.sentryOptions.profilingTracesDirPath!!).exists())
}
@Test
fun `outboxDir should be set at initialization`() {
fixture.initSut()
assertTrue(
fixture.sentryOptions.outboxPath?.endsWith(
"${File.separator}cache${File.separator}sentry${File.separator}outbox"
)!!
)
}
@Test
fun `init should set context package name as appInclude`() {
fixture.initSut(useRealContext = true)
// cant mock PackageInfo, its buggy
assertTrue(fixture.sentryOptions.inAppIncludes.contains("io.sentry.android.core.test"))
}
@Test
fun `init should set release if empty`() {
fixture.initSut(useRealContext = true)
// cant mock PackageInfo, its buggy
assertTrue(fixture.sentryOptions.release!!.startsWith("io.sentry.android.core.test@"))
}
@Test
fun `init should not replace options if set on manifest`() {
fixture.initSut(configureOptions = { release = "release" })
assertEquals("release", fixture.sentryOptions.release)
}
@Test
fun `init should not set context package name if it starts with android package`() {
fixture.initSut(configureContext = {
whenever(packageName).thenReturn("android.context")
})
assertFalse(fixture.sentryOptions.inAppIncludes.contains("android.context"))
}
@Test
fun `init should set distinct id on start`() {
fixture.initSut()
assertNotNull(fixture.sentryOptions.distinctId) {
assertTrue(it.isNotEmpty())
}
val installation = File(fixture.context.filesDir, Installation.INSTALLATION)
installation.deleteOnExit()
}
@Test
fun `init should set proguard uuid id on start`() {
fixture.initSut(
Bundle().apply {
putString(ManifestMetadataReader.PROGUARD_UUID, "proguard-uuid")
},
hasAppContext = false
)
assertEquals("proguard-uuid", fixture.sentryOptions.proguardUuid)
}
@Test
fun `init should set Android transport gate`() {
fixture.initSut()
assertNotNull(fixture.sentryOptions.transportGate)
assertTrue(fixture.sentryOptions.transportGate is AndroidTransportGate)
}
@Test
fun `init should set Android transaction profiler`() {
fixture.initSut()
assertNotNull(fixture.sentryOptions.transactionProfiler)
assertTrue(fixture.sentryOptions.transactionProfiler is AndroidTransactionProfiler)
}
@Test
fun `NdkIntegration will load SentryNdk class and add to the integration list`() {
fixture.initSutWithClassLoader(classToLoad = SentryNdk::class.java)
val actual = fixture.sentryOptions.integrations.firstOrNull { it is NdkIntegration }
assertNotNull((actual as NdkIntegration).sentryNdkClass)
}
@Test
fun `NdkIntegration won't be enabled because API is lower than 16`() {
fixture.initSutWithClassLoader(minApi = 14, classToLoad = SentryNdk::class.java)
val actual = fixture.sentryOptions.integrations.firstOrNull { it is NdkIntegration }
assertNull((actual as NdkIntegration).sentryNdkClass)
}
@Test
fun `NdkIntegration won't be enabled, if class not found`() {
fixture.initSutWithClassLoader(classToLoad = null)
val actual = fixture.sentryOptions.integrations.firstOrNull { it is NdkIntegration }
assertNull((actual as NdkIntegration).sentryNdkClass)
}
@Test
fun `AnrIntegration added to integration list`() {
fixture.initSut()
val actual = fixture.sentryOptions.integrations.firstOrNull { it is AnrIntegration }
assertNotNull(actual)
}
@Test
fun `EnvelopeFileObserverIntegration added to integration list`() {
fixture.initSut()
val actual =
fixture.sentryOptions.integrations.firstOrNull { it is EnvelopeFileObserverIntegration }
assertNotNull(actual)
}
@Test
fun `SendCachedEnvelopeFireAndForgetIntegration added to integration list`() {
fixture.initSut()
val actual =
fixture.sentryOptions.integrations
.firstOrNull { it is SendCachedEnvelopeFireAndForgetIntegration }
assertNotNull(actual)
}
@Test
fun `When given Context returns a non null ApplicationContext, uses it`() {
fixture.initSut()
assertNotNull(fixture.mockContext)
}
@Test
fun `When given Context returns a null ApplicationContext is null, keep given Context`() {
fixture.initSut(hasAppContext = false)
assertNotNull(fixture.mockContext)
}
@Test
fun `When given Context is not an Application class, do not add ActivityLifecycleIntegration`() {
fixture.initSut(hasAppContext = false)
val actual = fixture.sentryOptions.integrations
.firstOrNull { it is ActivityLifecycleIntegration }
assertNull(actual)
}
@Test
fun `When given Context is not an Application class, do not add UserInteractionIntegration`() {
fixture.initSut(hasAppContext = false)
val actual = fixture.sentryOptions.integrations
.firstOrNull { it is UserInteractionIntegration }
assertNull(actual)
}
@Test
fun `FragmentLifecycleIntegration added to the integration list if available on classpath`() {
fixture.initSutWithClassLoader(isFragmentAvailable = true)
val actual =
fixture.sentryOptions.integrations.firstOrNull { it is FragmentLifecycleIntegration }
assertNotNull(actual)
}
@Test
fun `FragmentLifecycleIntegration won't be enabled, it throws class not found`() {
fixture.initSutWithClassLoader(isFragmentAvailable = false)
val actual =
fixture.sentryOptions.integrations.firstOrNull { it is FragmentLifecycleIntegration }
assertNull(actual)
}
@Test
fun `SentryTimberIntegration added to the integration list if available on classpath`() {
fixture.initSutWithClassLoader(isTimberAvailable = true)
val actual =
fixture.sentryOptions.integrations.firstOrNull { it is SentryTimberIntegration }
assertNotNull(actual)
}
@Test
fun `SentryTimberIntegration won't be enabled, it throws class not found`() {
fixture.initSutWithClassLoader(isTimberAvailable = false)
val actual =
fixture.sentryOptions.integrations.firstOrNull { it is SentryTimberIntegration }
assertNull(actual)
}
}