-
Notifications
You must be signed in to change notification settings - Fork 586
/
WebTest.kt
768 lines (629 loc) · 23.7 KB
/
WebTest.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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
/*
* Copyright 2021 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
*
* https://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.google.accompanist.web
import android.content.Context
import android.graphics.Bitmap
import android.webkit.WebView
import androidx.compose.foundation.background
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.wrapContentHeight
import androidx.compose.material.MaterialTheme
import androidx.compose.runtime.Composable
import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.MutableState
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.snapshotFlow
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.platform.testTag
import androidx.compose.ui.test.IdlingResource
import androidx.compose.ui.test.SemanticsNodeInteraction
import androidx.compose.ui.test.assertHeightIsAtLeast
import androidx.compose.ui.test.junit4.createComposeRule
import androidx.compose.ui.test.onNodeWithTag
import androidx.compose.ui.unit.dp
import androidx.test.espresso.web.assertion.WebViewAssertions.webMatches
import androidx.test.espresso.web.model.Atoms.getCurrentUrl
import androidx.test.espresso.web.model.Atoms.getTitle
import androidx.test.espresso.web.sugar.Web.onWebView
import androidx.test.espresso.web.webdriver.DriverAtoms.findElement
import androidx.test.espresso.web.webdriver.DriverAtoms.getText
import androidx.test.espresso.web.webdriver.DriverAtoms.webClick
import androidx.test.espresso.web.webdriver.Locator
import androidx.test.ext.junit.runners.AndroidJUnit4
import androidx.test.filters.FlakyTest
import androidx.test.filters.SdkSuppress
import com.google.common.truth.Truth.assertThat
import junit.framework.TestCase.assertEquals
import kotlinx.coroutines.flow.toCollection
import okhttp3.mockwebserver.MockResponse
import okhttp3.mockwebserver.MockWebServer
import org.hamcrest.CoreMatchers.containsString
import org.hamcrest.CoreMatchers.equalTo
import org.junit.After
import org.junit.Before
import org.junit.Ignore
import org.junit.Rule
import org.junit.Test
import org.junit.runner.RunWith
import java.util.concurrent.TimeUnit
@RunWith(AndroidJUnit4::class)
// Emulator image doesn't have a WebView until API 26
// Google API emulator image seems to be really flaky before 28 so currently we will set these tests
// to min 29 and max 30. 31/32 image is also really flaky
@SdkSuppress(minSdkVersion = 28, maxSdkVersion = 30)
class WebTest {
@get:Rule
val rule = createComposeRule()
private lateinit var idleResource: WebViewIdlingResource
@Before
fun setup() {
idleResource = WebViewIdlingResource()
rule.registerIdlingResource(idleResource)
}
@After
fun tearDown() {
rule.unregisterIdlingResource(idleResource)
}
@Test
fun testDataLoaded() {
lateinit var state: WebViewState
rule.setContent {
state = rememberWebViewStateWithHTMLData(data = TEST_DATA)
WebTestContent(
state,
idleResource
)
}
onWebView()
.withElement(findElement(Locator.TAG_NAME, "a"))
.check(webMatches(getText(), containsString(LINK_TEXT)))
}
@Test
fun testDataLoadedWithBaseUrl() {
lateinit var state: WebViewState
rule.setContent {
state = rememberWebViewStateWithHTMLData(
data = TEST_DATA,
baseUrl = "file:///android_asset/"
)
WebTestContent(
state,
idleResource
)
}
onWebView()
.withElement(findElement(Locator.TAG_NAME, "a"))
.check(webMatches(getText(), containsString(LINK_TEXT)))
}
@Test
fun testCanNavigateFromDataToUrl() {
lateinit var state: WebViewState
rule.setContent {
state = rememberWebViewStateWithHTMLData(
data = TEST_DATA,
baseUrl = "file:///android_asset/"
)
WebTestContent(
state,
idleResource
)
}
onWebView()
.withElement(findElement(Locator.ID, "link"))
.perform(webClick())
// Wait for the webview to load and then perform the check
rule.waitForIdle()
onWebView().check(webMatches(getCurrentUrl(), containsString(LINK_URL)))
assertThat(state.content.getCurrentUrl())
.isEqualTo(LINK_URL)
}
@Test
fun testUrlLoaded() {
lateinit var state: WebViewState
rule.setContent {
state = rememberWebViewState(url = LINK_URL)
WebTestContent(
state,
idleResource
)
}
onWebView()
.withElement(findElement(Locator.ID, "content"))
.check(webMatches(getText(), containsString("Test content")))
}
@Test
fun testStateUpdated() {
lateinit var state: WebViewState
rule.setContent {
state = rememberWebViewStateWithHTMLData(data = TEST_DATA)
WebTestContent(
state,
idleResource
)
}
// Ensure the data is loaded first
onWebView()
.check(webMatches(getCurrentUrl(), containsString("about:blank")))
// Update the state, the webview should change url
state.content = WebContent.Url(LINK_URL)
onWebView()
.check(webMatches(getCurrentUrl(), containsString(LINK_URL)))
}
@Test
fun testUrlUpdatedWithRemember() {
val url = mutableStateOf("about:blank")
rule.setContent {
@Composable
fun MyWebView(url: String) {
val webViewState = rememberWebViewState(url = url)
WebTestContent(webViewState = webViewState, idlingResource = idleResource)
}
MyWebView(url = url.value)
}
// Ensure the data is loaded first
onWebView()
.check(webMatches(getCurrentUrl(), containsString("about:blank")))
url.value = LINK_URL
rule.waitForIdle()
onWebView()
.check(webMatches(getCurrentUrl(), containsString(LINK_URL)))
}
@Test
fun testDataUpdatedWithRemember() {
val data = mutableStateOf(TEST_DATA)
rule.setContent {
@Composable
fun MyWebView(data: String) {
val webViewState = rememberWebViewStateWithHTMLData(data = data)
WebTestContent(webViewState = webViewState, idlingResource = idleResource)
}
MyWebView(data = data.value)
}
// Ensure the data is loaded first
onWebView()
.withElement(findElement(Locator.TAG_NAME, "a"))
.check(webMatches(getText(), containsString(LINK_TEXT)))
data.value = TEST_TITLE_DATA
onWebView()
.check(webMatches(getTitle(), containsString(TITLE_TEXT)))
}
@Test
fun testCustomClientIsAssigned() {
lateinit var state: WebViewState
var pageStartCalled = false
rule.setContent {
state = rememberWebViewStateWithHTMLData(data = TEST_DATA)
WebTestContent(
state,
idleResource,
client = object : AccompanistWebViewClient() {
override fun onPageStarted(view: WebView?, url: String?, favicon: Bitmap?) {
super.onPageStarted(view, url, favicon)
pageStartCalled = true
}
}
)
}
// Ensure the data is loaded first
onWebView()
.check(webMatches(getCurrentUrl(), containsString("about:blank")))
// Wait for the webview to load and then perform the check
rule.waitForIdle()
assertThat(pageStartCalled).isTrue()
}
@Test
fun testChromeClientIsAssigned() {
lateinit var state: WebViewState
var titleReceived: String? = null
rule.setContent {
state = rememberWebViewStateWithHTMLData(data = TEST_TITLE_DATA)
WebTestContent(
state,
idleResource,
chromeClient = object : AccompanistWebChromeClient() {
override fun onReceivedTitle(view: WebView?, title: String?) {
super.onReceivedTitle(view, title)
titleReceived = title
}
}
)
}
// Wait for new title
onWebView()
.check(webMatches(getTitle(), equalTo(TITLE_TEXT)))
// Wait for the webview to load and then perform the check
rule.waitForIdle()
assertThat(titleReceived).isEqualTo(TITLE_TEXT)
}
// SDKs less than 29 do not call onPageStarted when loading about:blank.
// This breaks the idling resource counter.
// This test was testing an edge case that no longer exists and could potentially
// just be removed.
@SdkSuppress(minSdkVersion = 29)
@Test
fun testCanNavigateToBlank() {
lateinit var state: WebViewState
rule.setContent {
state = rememberWebViewState(url = LINK_URL)
WebTestContent(
state,
idleResource
)
}
onWebView()
.withElement(findElement(Locator.ID, "blankurl"))
.perform(webClick())
// Wait for the webview to load and then perform the check
rule.waitForIdle()
onWebView().check(webMatches(getCurrentUrl(), containsString("about:blank")))
assertThat(state.content.getCurrentUrl())
.isEqualTo("about:blank")
}
@Test
fun testLinksCaptured() {
lateinit var state: WebViewState
rule.setContent {
state = rememberWebViewStateWithHTMLData(data = TEST_DATA)
WebTestContent(
state,
idleResource
)
}
onWebView()
.withElement(findElement(Locator.ID, "link"))
.perform(webClick())
// Wait for the webview to load and then perform the check
rule.waitForIdle()
onWebView().check(webMatches(getCurrentUrl(), containsString(LINK_URL)))
assertThat(state.content.getCurrentUrl())
.isEqualTo(LINK_URL)
}
@Test
fun testImageResourceLoadError() {
lateinit var state: WebViewState
rule.setContent {
state = rememberWebViewStateWithHTMLData(data = TEST_BAD_DATA)
WebTestContent(
state,
idleResource
)
}
// Wait for content to be loaded
onWebView()
.withElement(findElement(Locator.TAG_NAME, "p"))
.check(webMatches(getText(), containsString(LINK_TEXT)))
// Check an error was captured
assertThat(state.errorsForCurrentRequest)
.isNotEmpty()
state.content = WebContent.Data(TEST_DATA)
// Check the webview can recover from an error and successfully load another request
onWebView()
.check(webMatches(getCurrentUrl(), containsString("about:blank")))
// Check that the error is cleared on a new request
assertThat(state.errorsForCurrentRequest)
.isEmpty()
}
@Test
fun testPageTitle() {
lateinit var state: WebViewState
rule.setContent {
state = rememberWebViewStateWithHTMLData(data = TEST_TITLE_DATA)
WebTestContent(webViewState = state, idlingResource = idleResource)
}
// Wait for new title
onWebView()
.check(webMatches(getTitle(), equalTo(TITLE_TEXT)))
// Check that the web view state has been updated with the HTML title
assertThat(state.pageTitle)
.isEqualTo(TITLE_TEXT)
// Check that state is reset on the loading of a new page (without a title or favicon set)
state.content = WebContent.Data(TEST_DATA)
// Wait for new title
onWebView()
.check(webMatches(getTitle(), equalTo("")))
assertThat(state.pageTitle)
.isEqualTo("about:blank") // No title results in about:blank being received
}
@FlakyTest(detail = "https://github.com/google/accompanist/issues/1085")
@Test
fun testLoadingState() {
lateinit var state: WebViewState
val mockServer = MockWebServer()
// Simulate time spent loading
mockServer.enqueue(MockResponse().setBody("Test").setBodyDelay(1, TimeUnit.SECONDS))
mockServer.start()
val baseUrl = mockServer.url("/")
val collectedLoadingStates = mutableListOf<LoadingState>()
rule.setContent {
state = rememberWebViewState(url = baseUrl.toString())
LaunchedEffect(state) {
snapshotFlow { state.loadingState }
.toCollection(collectedLoadingStates)
}
WebTestContent(webViewState = state, idlingResource = idleResource)
}
rule.waitUntil(3_000) { collectedLoadingStates.any { it is LoadingState.Loading } }
rule.waitForIdle()
assertThat(collectedLoadingStates.first()).isInstanceOf(LoadingState.Initializing::class.java)
assertThat(collectedLoadingStates.last()).isInstanceOf(LoadingState.Finished::class.java)
assertThat(collectedLoadingStates.filterIsInstance<LoadingState.Loading>()).isNotEmpty()
mockServer.shutdown()
}
@Test
fun testNavigatorBack() {
lateinit var state: WebViewState
lateinit var navigator: WebViewNavigator
rule.setContent {
state = rememberWebViewStateWithHTMLData(data = TEST_DATA)
navigator = rememberWebViewNavigator()
WebTestContent(
webViewState = state,
idlingResource = idleResource,
navigator = navigator
)
}
rule.waitForIdle()
onWebView()
.withElement(findElement(Locator.ID, "link"))
.perform(webClick())
rule.waitUntil { navigator.canGoBack }
assertThat(state.content.getCurrentUrl()).isEqualTo(LINK_URL)
navigator.navigateBack()
// Check that we're back on the original page with the link
onWebView()
.withElement(findElement(Locator.ID, "link"))
.check(webMatches(getText(), equalTo(LINK_TEXT)))
}
@FlakyTest
@Test
fun testNavigatorForward() {
lateinit var state: WebViewState
lateinit var navigator: WebViewNavigator
rule.setContent {
state = rememberWebViewStateWithHTMLData(data = TEST_DATA)
navigator = rememberWebViewNavigator()
WebTestContent(
webViewState = state,
idlingResource = idleResource,
navigator = navigator
)
}
rule.waitForIdle()
onWebView()
.withElement(findElement(Locator.ID, "link"))
.perform(webClick())
rule.waitUntil { navigator.canGoBack }
navigator.navigateBack()
// Check that we're back on the original page with the link
onWebView()
.withElement(findElement(Locator.ID, "link"))
.check(webMatches(getText(), equalTo(LINK_TEXT)))
navigator.navigateForward()
rule.waitUntil { navigator.canGoBack }
rule.waitForIdle()
assertThat(state.content.getCurrentUrl()).isEqualTo(LINK_URL)
}
@Test
fun testNavigatorCanGoBack() {
lateinit var state: WebViewState
lateinit var navigator: WebViewNavigator
rule.setContent {
state = rememberWebViewStateWithHTMLData(data = TEST_DATA)
navigator = rememberWebViewNavigator()
WebTestContent(
webViewState = state,
idlingResource = idleResource,
navigator = navigator
)
}
rule.waitForIdle()
assertThat(navigator.canGoBack).isFalse()
onWebView()
.withElement(findElement(Locator.ID, "link"))
.perform(webClick())
rule.waitUntil { navigator.canGoBack }
assertThat(navigator.canGoBack).isTrue()
}
@Test
fun testNavigatorCanGoForward() {
lateinit var state: WebViewState
lateinit var navigator: WebViewNavigator
rule.setContent {
state = rememberWebViewStateWithHTMLData(data = TEST_DATA)
navigator = rememberWebViewNavigator()
WebTestContent(
webViewState = state,
idlingResource = idleResource,
navigator = navigator
)
}
rule.waitForIdle()
onWebView()
.withElement(findElement(Locator.ID, "link"))
.perform(webClick())
rule.waitUntil { navigator.canGoBack }
navigator.navigateBack()
rule.waitUntil { navigator.canGoForward }
assertThat(navigator.canGoForward).isTrue()
}
@FlakyTest
@Ignore("Slow and flaky: https://github.com/google/accompanist/issues/1085")
@Test
fun testAdditionalHttpHeaders() {
val mockServer = MockWebServer()
mockServer.start()
val baseUrl = mockServer.url("/")
rule.setContent {
val state = rememberWebViewState(
url = baseUrl.toString(),
additionalHttpHeaders = mapOf(
"first-additional-header" to "first",
"second-additional-header" to "second",
)
)
WebTestContent(
webViewState = state,
idlingResource = idleResource,
)
}
rule.waitForIdle()
val request = mockServer.takeRequest()
assertThat(request.getHeader("first-additional-header")).isEqualTo("first")
assertThat(request.getHeader("second-additional-header")).isEqualTo("second")
mockServer.shutdown()
}
@Test
fun testOnDisposeCalled() {
lateinit var state: WebViewState
lateinit var toggle: MutableState<Boolean>
var isOnDisposeCalled = false
rule.setContent {
toggle = remember { mutableStateOf(true) }
if (toggle.value) {
state = rememberWebViewStateWithHTMLData(data = TEST_DATA)
WebTestContent(
state,
idleResource,
onDispose = { isOnDisposeCalled = true },
)
}
}
toggle.value = false
webNode.assertDoesNotExist()
assertThat(isOnDisposeCalled).isTrue()
}
@Test
fun testJSReloadTriggersRefresh() {
lateinit var state: WebViewState
var pageStartedCalled = 0
val client = object : AccompanistWebViewClient() {
override fun onPageStarted(view: WebView?, url: String?, favicon: Bitmap?) {
super.onPageStarted(view, url, favicon)
pageStartedCalled++
}
}
rule.setContent {
state = rememberWebViewStateWithHTMLData(
data =
"""
<html><body>
<input id="button" type="button" value="Reload"
onclick="window.location.reload()" />
</body></html>
""".trimIndent()
)
WebTestContent(
webViewState = state,
idlingResource = idleResource,
client = client
)
}
rule.waitForIdle()
onWebView()
.withElement(findElement(Locator.ID, "button"))
.perform(webClick())
// Check the url remained about:blank
onWebView()
.check(webMatches(getCurrentUrl(), equalTo("about:blank")))
assertEquals("Page should be loaded twice", 2, pageStartedCalled)
}
private val webNode: SemanticsNodeInteraction
get() = rule.onNodeWithTag(WebViewTag)
@Test
fun testWebViewFactoryUsedIfSupplied() {
lateinit var constructedWebView: WebView
rule.setContent {
WebTestContent(
rememberWebViewState(url = LINK_URL),
idleResource,
onCreated = { constructedWebView = it },
factory = { context -> CustomWebView(context) }
)
}
assertThat(constructedWebView).isInstanceOf(CustomWebView::class.java)
}
@Test
fun testWebViewCanWrapHeight() {
rule.setContent {
Column(Modifier.fillMaxSize()) {
val webViewState = rememberWebViewStateWithHTMLData(data = TEST_DATA)
WebTestContent(
webViewState = webViewState,
idlingResource = idleResource,
modifier = Modifier.wrapContentHeight()
)
Box(
Modifier
.weight(1f)
.fillMaxWidth()
.background(Color.Red)
.testTag("box")
)
}
}
rule.waitForIdle()
// If the WebView is wrapping it's content successfully, the box will have some height.
rule.onNodeWithTag("box").assertHeightIsAtLeast(1.dp)
}
}
private const val LINK_ID = "link"
private const val LINK_TEXT = "Click me"
private const val LINK_URL = "file:///android_asset/test.html"
private const val TITLE_TEXT = "A Test Title"
private const val TEST_DATA =
"<html><body><a id=$LINK_ID href=\"$LINK_URL\">$LINK_TEXT</a></body></html>"
private const val TEST_BAD_DATA =
"<html><body><img src=\"https://alwaysfail.zxyz.zxyz\" /><p>$LINK_TEXT</p></body></html>"
private const val TEST_TITLE_DATA =
"<html><head><title>$TITLE_TEXT</title></head><body></body></html>"
private const val WebViewTag = "webview_tag"
@Composable
private fun WebTestContent(
webViewState: WebViewState,
idlingResource: WebViewIdlingResource,
modifier: Modifier = Modifier,
navigator: WebViewNavigator = rememberWebViewNavigator(),
onCreated: (WebView) -> Unit = { it.settings.javaScriptEnabled = true },
onDispose: (WebView) -> Unit = {},
client: AccompanistWebViewClient = remember { AccompanistWebViewClient() },
chromeClient: AccompanistWebChromeClient = remember { AccompanistWebChromeClient() },
factory: ((Context) -> WebView)? = null
) {
idlingResource.webviewLoading = webViewState.loadingState !is LoadingState.Finished
MaterialTheme {
WebView(
state = webViewState,
modifier = modifier.testTag(WebViewTag),
navigator = navigator,
onCreated = onCreated,
onDispose = onDispose,
client = client,
chromeClient = chromeClient,
factory = factory
)
}
}
private class WebViewIdlingResource : IdlingResource {
var webviewLoading: Boolean = false
override val isIdleNow: Boolean
get() = !webviewLoading
}
private class CustomWebView(context: Context) : WebView(context)