-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Expand file tree
/
Copy pathtest_chromium.py
More file actions
2198 lines (1691 loc) · 74.9 KB
/
test_chromium.py
File metadata and controls
2198 lines (1691 loc) · 74.9 KB
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
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import asyncio
import sys
import time
from unittest.mock import ANY, AsyncMock, patch
import aiohttp
import pytest
class MockPlaywright:
def __init__(self):
self.chromium = AsyncMock()
self.firefox = AsyncMock()
class MockBrowser:
def __init__(self):
self.new_context = AsyncMock()
class MockContext:
def __init__(self):
self.new_page = AsyncMock()
class MockPage:
def __init__(self):
self.goto = AsyncMock()
self.wait_for_load_state = AsyncMock()
self.content = AsyncMock()
self.evaluate = AsyncMock()
self.mouse = AsyncMock()
self.mouse.wheel = AsyncMock()
@pytest.fixture
def mock_playwright():
with patch("playwright.async_api.async_playwright") as mock:
mock_pw = MockPlaywright()
mock_browser = MockBrowser()
mock_context = MockContext()
mock_page = MockPage()
mock_pw.chromium.launch.return_value = mock_browser
mock_pw.firefox.launch.return_value = mock_browser
mock_browser.new_context.return_value = mock_context
mock_context.new_page.return_value = mock_page
mock.return_value.__aenter__.return_value = mock_pw
yield mock_pw, mock_browser, mock_context, mock_page
import pytest
from langchain_core.documents import Document
from scrapegraphai.docloaders.chromium import ChromiumLoader
async def dummy_scraper(url):
"""A dummy scraping function that returns dummy HTML content for the URL."""
return f"<html>dummy content for {url}</html>"
@pytest.fixture
def loader_with_dummy(monkeypatch):
"""Fixture returning a ChromiumLoader instance with dummy scraping methods patched."""
urls = ["http://example.com", "http://test.com"]
loader = ChromiumLoader(urls, backend="playwright", requires_js_support=False)
monkeypatch.setattr(loader, "ascrape_playwright", dummy_scraper)
monkeypatch.setattr(loader, "ascrape_with_js_support", dummy_scraper)
monkeypatch.setattr(loader, "ascrape_undetected_chromedriver", dummy_scraper)
return loader
def test_lazy_load(loader_with_dummy):
"""Test that lazy_load yields Document objects with the correct dummy content and metadata."""
docs = list(loader_with_dummy.lazy_load())
assert len(docs) == 2
for doc, url in zip(docs, loader_with_dummy.urls):
assert isinstance(doc, Document)
assert f"dummy content for {url}" in doc.page_content
assert doc.metadata["source"] == url
@pytest.mark.asyncio
async def test_alazy_load(loader_with_dummy):
"""Test that alazy_load asynchronously yields Document objects with dummy content and proper metadata."""
docs = [doc async for doc in loader_with_dummy.alazy_load()]
assert len(docs) == 2
for doc, url in zip(docs, loader_with_dummy.urls):
assert isinstance(doc, Document)
assert f"dummy content for {url}" in doc.page_content
assert doc.metadata["source"] == url
@pytest.mark.asyncio
async def test_scrape_method_unsupported_backend():
"""Test that the scrape method raises a ValueError when an unsupported backend is provided."""
loader = ChromiumLoader(["http://example.com"], backend="unsupported")
with pytest.raises(ValueError):
await loader.scrape("http://example.com")
@pytest.mark.asyncio
async def test_scrape_method_selenium(monkeypatch):
"""Test that the scrape method works correctly for selenium by returning the dummy selenium content."""
async def dummy_selenium(url):
return f"<html>dummy selenium content for {url}</html>"
urls = ["http://example.com"]
loader = ChromiumLoader(urls, backend="selenium")
loader.browser_name = "chromium"
monkeypatch.setattr(loader, "ascrape_undetected_chromedriver", dummy_selenium)
result = await loader.scrape("http://example.com")
assert "dummy selenium content" in result
@pytest.mark.asyncio
async def test_ascrape_playwright_scroll(mock_playwright):
"""Test the ascrape_playwright_scroll method with various configurations."""
mock_pw, mock_browser, mock_context, mock_page = mock_playwright
url = "http://example.com"
loader = ChromiumLoader([url], backend="playwright")
# Test with default parameters
mock_page.evaluate.side_effect = [1000, 2000, 2000] # Simulate scrolling
result = await loader.ascrape_playwright_scroll(url)
assert mock_page.goto.call_count == 1
assert mock_page.wait_for_load_state.call_count == 1
assert mock_page.mouse.wheel.call_count > 0
assert mock_page.content.call_count == 1
# Test with custom parameters
mock_page.evaluate.side_effect = [1000, 2000, 3000, 4000, 4000]
result = await loader.ascrape_playwright_scroll(
url, timeout=10, scroll=10000, sleep=1, scroll_to_bottom=True
)
assert mock_page.goto.call_count == 2
assert mock_page.wait_for_load_state.call_count == 2
assert mock_page.mouse.wheel.call_count > 0
assert mock_page.content.call_count == 2
@pytest.mark.asyncio
async def test_ascrape_with_js_support(mock_playwright):
"""Test the ascrape_with_js_support method with different browser configurations."""
mock_pw, mock_browser, mock_context, mock_page = mock_playwright
url = "http://example.com"
loader = ChromiumLoader([url], backend="playwright", requires_js_support=True)
# Test with Chromium
result = await loader.ascrape_with_js_support(url, browser_name="chromium")
assert mock_pw.chromium.launch.call_count == 1
assert mock_page.goto.call_count == 1
assert mock_page.content.call_count == 1
# Test with Firefox
result = await loader.ascrape_with_js_support(url, browser_name="firefox")
assert mock_pw.firefox.launch.call_count == 1
assert mock_page.goto.call_count == 2
assert mock_page.content.call_count == 2
# Test with invalid browser name
with pytest.raises(ValueError):
await loader.ascrape_with_js_support(url, browser_name="invalid")
@pytest.mark.asyncio
async def test_scrape_method_playwright(mock_playwright):
"""Test the scrape method with playwright backend."""
mock_pw, mock_browser, mock_context, mock_page = mock_playwright
url = "http://example.com"
loader = ChromiumLoader([url], backend="playwright")
mock_page.content.return_value = "<html>Playwright content</html>"
result = await loader.scrape(url)
assert "Playwright content" in result
assert mock_pw.chromium.launch.call_count == 1
assert mock_page.goto.call_count == 1
assert mock_page.wait_for_load_state.call_count == 1
assert mock_page.content.call_count == 1
@pytest.mark.asyncio
async def test_scrape_method_retry_logic(mock_playwright):
"""Test the retry logic in the scrape method."""
mock_pw, mock_browser, mock_context, mock_page = mock_playwright
url = "http://example.com"
loader = ChromiumLoader([url], backend="playwright", retry_limit=3)
# Simulate two failures and then a success
mock_page.goto.side_effect = [asyncio.TimeoutError(), aiohttp.ClientError(), None]
mock_page.content.return_value = "<html>Success after retries</html>"
result = await loader.scrape(url)
assert "Success after retries" in result
assert mock_page.goto.call_count == 3
assert mock_page.content.call_count == 1
# Test failure after all retries
mock_page.goto.side_effect = asyncio.TimeoutError()
with pytest.raises(RuntimeError):
await loader.scrape(url)
assert mock_page.goto.call_count == 6 # 3 more attempts
@pytest.mark.asyncio
async def test_ascrape_playwright_scroll_invalid_params():
"""Test that ascrape_playwright_scroll raises ValueError for invalid scroll parameters."""
loader = ChromiumLoader(["http://example.com"], backend="playwright")
with pytest.raises(
ValueError,
match="If set, timeout value for scrolling scraper must be greater than 0.",
):
await loader.ascrape_playwright_scroll("http://example.com", timeout=0)
with pytest.raises(
ValueError, match="Sleep for scrolling scraper value must be greater than 0."
):
await loader.ascrape_playwright_scroll("http://example.com", sleep=0)
with pytest.raises(
ValueError,
match="Scroll value for scrolling scraper must be greater than or equal to 5000.",
):
await loader.ascrape_playwright_scroll("http://example.com", scroll=4000)
@pytest.mark.asyncio
async def test_ascrape_with_js_support_retry_failure(monkeypatch):
"""Test that ascrape_with_js_support retries and ultimately fails when page.goto always times out."""
loader = ChromiumLoader(
["http://example.com"],
backend="playwright",
requires_js_support=True,
retry_limit=2,
timeout=1,
)
# Create dummy classes to simulate failure in page.goto
class DummyPage:
async def goto(self, url, wait_until):
raise asyncio.TimeoutError("Forced timeout")
async def wait_for_load_state(self, state):
return
async def content(self):
return "<html>Dummy</html>"
class DummyContext:
async def new_page(self):
return DummyPage()
class DummyBrowser:
async def new_context(self, **kwargs):
return DummyContext()
async def close(self):
return
class DummyPW:
async def __aenter__(self):
return self
async def __aexit__(self, exc_type, exc, tb):
return
class chromium:
@staticmethod
async def launch(headless, proxy, **kwargs):
return DummyBrowser()
class firefox:
@staticmethod
async def launch(headless, proxy, **kwargs):
return DummyBrowser()
# Patch the async_playwright to return our dummy
monkeypatch.setattr("playwright.async_api.async_playwright", lambda: DummyPW())
with pytest.raises(RuntimeError, match="Failed to scrape after"):
await loader.ascrape_with_js_support("http://example.com")
@pytest.mark.asyncio
async def test_ascrape_undetected_chromedriver_success(monkeypatch):
"""Test that ascrape_undetected_chromedriver successfully returns content using the selenium backend."""
# Create a dummy undetected_chromedriver module with a dummy Chrome driver.
import types
dummy_module = types.ModuleType("undetected_chromedriver")
class DummyDriver:
def __init__(self, options):
self.options = options
self.page_source = "<html>selenium content</html>"
def quit(self):
pass
dummy_module.Chrome = lambda options: DummyDriver(options)
monkeypatch.setitem(sys.modules, "undetected_chromedriver", dummy_module)
urls = ["http://example.com"]
loader = ChromiumLoader(urls, backend="selenium", retry_limit=1, timeout=5)
loader.browser_name = "chromium"
result = await loader.ascrape_undetected_chromedriver("http://example.com")
assert "selenium content" in result
@pytest.mark.asyncio
async def test_lazy_load_exception(loader_with_dummy, monkeypatch):
"""Test that lazy_load propagates exception if the scraping function fails."""
async def dummy_failure(url):
raise Exception("Dummy scraping error")
# Patch the scraping method to always raise an exception
loader_with_dummy.backend = "playwright"
monkeypatch.setattr(loader_with_dummy, "ascrape_playwright", dummy_failure)
with pytest.raises(Exception, match="Dummy scraping error"):
list(loader_with_dummy.lazy_load())
@pytest.mark.asyncio
async def test_ascrape_undetected_chromedriver_unsupported_browser(monkeypatch):
"""Test ascrape_undetected_chromedriver raises an error when an unsupported browser is provided."""
import types
dummy_module = types.ModuleType("undetected_chromedriver")
# Provide a dummy Chrome; this will not be used for an unsupported browser.
dummy_module.Chrome = lambda options: None
monkeypatch.setitem(sys.modules, "undetected_chromedriver", dummy_module)
loader = ChromiumLoader(
["http://example.com"], backend="selenium", retry_limit=1, timeout=1
)
loader.browser_name = "opera" # Unsupported browser.
with pytest.raises(UnboundLocalError):
await loader.ascrape_undetected_chromedriver("http://example.com")
@pytest.mark.asyncio
async def test_alazy_load_partial_failure(monkeypatch):
"""Test that alazy_load propagates an exception if one of the scraping tasks fails."""
urls = ["http://example.com", "http://fail.com"]
loader = ChromiumLoader(urls, backend="playwright")
async def partial_scraper(url):
if "fail" in url:
raise Exception("Scraping failed for " + url)
return f"<html>Content for {url}</html>"
monkeypatch.setattr(loader, "ascrape_playwright", partial_scraper)
with pytest.raises(Exception, match="Scraping failed for http://fail.com"):
[doc async for doc in loader.alazy_load()]
@pytest.mark.asyncio
async def test_ascrape_playwright_retry_failure(monkeypatch):
"""Test that ascrape_playwright retries scraping and raises RuntimeError after all attempts fail."""
# Dummy classes to simulate persistent failure in page.goto for ascrape_playwright
class DummyPage:
async def goto(self, url, wait_until):
raise asyncio.TimeoutError("Forced timeout in goto")
async def wait_for_load_state(self, state):
return
async def content(self):
return "<html>This should not be returned</html>"
class DummyContext:
async def new_page(self):
return DummyPage()
class DummyBrowser:
async def new_context(self, **kwargs):
return DummyContext()
async def close(self):
return
class DummyPW:
async def __aenter__(self):
return self
async def __aexit__(self, exc_type, exc, tb):
return
class chromium:
@staticmethod
async def launch(headless, proxy, **kwargs):
return DummyBrowser()
class firefox:
@staticmethod
async def launch(headless, proxy, **kwargs):
return DummyBrowser()
monkeypatch.setattr("playwright.async_api.async_playwright", lambda: DummyPW())
loader = ChromiumLoader(
["http://example.com"], backend="playwright", retry_limit=2, timeout=1
)
with pytest.raises(RuntimeError, match="Failed to scrape after 2 attempts"):
await loader.ascrape_playwright("http://example.com")
@pytest.mark.asyncio
async def test_init_overrides():
"""Test that ChromiumLoader picks up and overrides attributes using kwargs."""
urls = ["http://example.com"]
loader = ChromiumLoader(
urls,
backend="playwright",
headless=False,
proxy={"http": "http://proxy"},
load_state="load",
requires_js_support=True,
storage_state="state",
browser_name="firefox",
retry_limit=5,
timeout=120,
extra="value",
)
# Check that attributes are correctly set
assert loader.headless is False
assert loader.proxy == {"http": "http://proxy"}
assert loader.load_state == "load"
assert loader.requires_js_support is True
assert loader.storage_state == "state"
assert loader.browser_name == "firefox"
assert loader.retry_limit == 5
assert loader.timeout == 120
# Check that extra kwargs go into browser_config
assert loader.browser_config.get("extra") == "value"
# Check that the backend remains as provided
assert loader.backend == "playwright"
@pytest.mark.asyncio
async def test_lazy_load_with_js_support(monkeypatch):
"""Test that lazy_load uses ascrape_with_js_support when requires_js_support is True."""
urls = ["http://example.com", "http://test.com"]
loader = ChromiumLoader(urls, backend="playwright", requires_js_support=True)
async def dummy_js(url):
return f"<html>JS content for {url}</html>"
monkeypatch.setattr(loader, "ascrape_with_js_support", dummy_js)
docs = list(loader.lazy_load())
assert len(docs) == 2
for doc, url in zip(docs, urls):
assert isinstance(doc, Document)
assert f"JS content for {url}" in doc.page_content
assert doc.metadata["source"] == url
@pytest.mark.asyncio
async def test_no_retry_returns_none(monkeypatch):
"""Test that ascrape_playwright returns None if retry_limit is set to 0."""
urls = ["http://example.com"]
loader = ChromiumLoader(urls, backend="playwright", retry_limit=0)
# Even if we patch ascrape_playwright, the while loop won't run since retry_limit is 0, so it should return None.
async def dummy(url, browser_name="chromium"):
return f"<html>Content for {url}</html>"
monkeypatch.setattr(loader, "ascrape_playwright", dummy)
result = await loader.ascrape_playwright("http://example.com")
# With retry_limit=0, the loop never runs and the function returns None.
assert result is None
@pytest.mark.asyncio
async def test_alazy_load_empty_urls():
"""Test that alazy_load yields no documents when the urls list is empty."""
loader = ChromiumLoader([], backend="playwright")
docs = [doc async for doc in loader.alazy_load()]
assert docs == []
def test_lazy_load_empty_urls():
"""Test that lazy_load yields no documents when the urls list is empty."""
loader = ChromiumLoader([], backend="playwright")
docs = list(loader.lazy_load())
assert docs == []
@pytest.mark.asyncio
async def test_ascrape_undetected_chromedriver_missing_import(monkeypatch):
"""Test that ascrape_undetected_chromedriver raises ImportError when undetected_chromedriver is not installed."""
# Remove undetected_chromedriver from sys.modules if it exists
if "undetected_chromedriver" in sys.modules:
monkeyatch_key = "undetected_chromedriver"
monkeypatch.delenitem(sys.modules, monkeyatch_key)
loader = ChromiumLoader(
["http://example.com"], backend="selenium", retry_limit=1, timeout=5
)
loader.browser_name = "chromium"
with pytest.raises(
ImportError, match="undetected_chromedriver is required for ChromiumLoader"
):
await loader.ascrape_undetected_chromedriver("http://example.com")
@pytest.mark.asyncio
async def test_ascrape_undetected_chromedriver_quit_called(monkeypatch):
"""Test that ascrape_undetected_chromedriver calls driver.quit() on every attempt even when get() fails."""
# List to collect each DummyDriver instance for later inspection.
driver_instances = []
attempt_counter = [0]
class DummyDriver:
def __init__(self, options):
self.options = options
self.quit_called = False
driver_instances.append(self)
def get(self, url):
# Force a failure on the first attempt then succeed on subsequent attempts.
if attempt_counter[0] < 1:
attempt_counter[0] += 1
raise aiohttp.ClientError("Forced failure")
# If no failure, simply pass.
@property
def page_source(self):
return "<html>driver content</html>"
def quit(self):
self.quit_called = True
import types
dummy_module = types.ModuleType("undetected_chromedriver")
dummy_module.Chrome = lambda options: DummyDriver(options)
monkeypatch.setitem(sys.modules, "undetected_chromedriver", dummy_module)
urls = ["http://example.com"]
loader = ChromiumLoader(urls, backend="selenium", retry_limit=2, timeout=5)
loader.browser_name = "chromium"
result = await loader.ascrape_undetected_chromedriver("http://example.com")
assert "driver content" in result
# Verify that two driver instances were used and that each had its quit() method called.
assert len(driver_instances) == 2
for driver in driver_instances:
assert driver.quit_called is True
@pytest.mark.parametrize("backend", ["playwright", "selenium"])
def test_dynamic_import_failure(monkeypatch, backend):
"""Test that ChromiumLoader raises ImportError when dynamic_import fails."""
def fake_dynamic_import(backend, message):
raise ImportError("Test dynamic import error")
monkeypatch.setattr(
"scrapegraphai.docloaders.chromium.dynamic_import", fake_dynamic_import
)
with pytest.raises(ImportError, match="Test dynamic import error"):
ChromiumLoader(["http://example.com"], backend=backend)
@pytest.mark.asyncio
async def test_ascrape_with_js_support_retry_success(monkeypatch):
"""Test that ascrape_with_js_support retries on failure and returns content on a subsequent successful attempt."""
attempt_count = {"count": 0}
class DummyPage:
async def goto(self, url, wait_until):
if attempt_count["count"] < 1:
attempt_count["count"] += 1
raise asyncio.TimeoutError("Forced timeout")
# On second attempt, do nothing (simulate successful navigation)
async def wait_for_load_state(self, state):
return
async def content(self):
return "<html>Success on retry</html>"
class DummyContext:
async def new_page(self):
return DummyPage()
class DummyBrowser:
async def new_context(self, **kwargs):
return DummyContext()
async def close(self):
return
class DummyPW:
async def __aenter__(self):
return self
async def __aexit__(self, exc_type, exc, tb):
return
class chromium:
@staticmethod
async def launch(headless, proxy, **kwargs):
return DummyBrowser()
class firefox:
@staticmethod
async def launch(headless, proxy, **kwargs):
return DummyBrowser()
monkeypatch.setattr("playwright.async_api.async_playwright", lambda: DummyPW())
# Create a loader with JS support and a retry_limit of 2 (so one failure is allowed)
loader = ChromiumLoader(
["http://example.com"],
backend="playwright",
requires_js_support=True,
retry_limit=2,
timeout=1,
)
result = await loader.ascrape_with_js_support("http://example.com")
assert result == "<html>Success on retry</html>"
@pytest.mark.asyncio
async def test_proxy_parsing_in_init(monkeypatch):
"""Test that providing a proxy triggers the use of parse_or_search_proxy and sets loader.proxy correctly."""
dummy_proxy_value = {"dummy": True}
monkeypatch.setattr(
"scrapegraphai.docloaders.chromium.parse_or_search_proxy",
lambda proxy: dummy_proxy_value,
)
loader = ChromiumLoader(
["http://example.com"], backend="playwright", proxy="some_proxy_value"
)
assert loader.proxy == dummy_proxy_value
@pytest.mark.asyncio
async def test_scrape_method_selenium_firefox(monkeypatch):
"""Test that the scrape method works correctly for selenium with firefox backend."""
async def dummy_selenium(url):
return f"<html>dummy selenium firefox content for {url}</html>"
urls = ["http://example.com"]
loader = ChromiumLoader(urls, backend="selenium")
loader.browser_name = "firefox"
monkeypatch.setattr(loader, "ascrape_undetected_chromedriver", dummy_selenium)
result = await loader.scrape("http://example.com")
assert "dummy selenium firefox content" in result
def test_init_with_no_proxy():
"""Test that initializing ChromiumLoader with proxy=None results in loader.proxy being None."""
urls = ["http://example.com"]
loader = ChromiumLoader(urls, backend="playwright", proxy=None)
assert loader.proxy is None
@pytest.mark.asyncio
async def test_ascrape_playwright_negative_retry(monkeypatch):
"""Test that ascrape_playwright returns None when retry_limit is negative (loop not executed)."""
# Set-up a dummy playwright context which should never be used because retry_limit is negative.
class DummyPW:
async def __aenter__(self):
return self
async def __aexit__(self, exc_type, exc, tb):
return
class chromium:
@staticmethod
async def launch(headless, proxy, **kwargs):
# Should not be called as retry_limit is negative.
raise Exception("Should not launch browser")
monkeypatch.setattr("playwright.async_api.async_playwright", lambda: DummyPW())
urls = ["http://example.com"]
loader = ChromiumLoader(urls, backend="playwright", retry_limit=-1)
result = await loader.ascrape_playwright("http://example.com")
assert result is None
@pytest.mark.asyncio
async def test_ascrape_with_js_support_negative_retry(monkeypatch):
"""Test that ascrape_with_js_support returns None when retry_limit is negative (loop not executed)."""
class DummyPW:
async def __aenter__(self):
return self
async def __aexit__(self, exc_type, exc, tb):
return
class chromium:
@staticmethod
async def launch(headless, proxy, **kwargs):
# Should not be called because retry_limit is negative.
raise Exception("Should not launch browser")
monkeypatch.setattr("playwright.async_api.async_playwright", lambda: DummyPW())
urls = ["http://example.com"]
loader = ChromiumLoader(
urls, backend="playwright", requires_js_support=True, retry_limit=-1
)
try:
result = await loader.ascrape_with_js_support("http://example.com")
except RuntimeError:
result = None
assert result is None
@pytest.mark.asyncio
async def test_ascrape_with_js_support_storage_state(monkeypatch):
"""Test that ascrape_with_js_support passes the storage_state to the new_context call."""
class DummyPage:
async def goto(self, url, wait_until):
return
async def wait_for_load_state(self, state):
return
async def content(self):
return "<html>Storage State Tested</html>"
class DummyContext:
async def new_page(self):
return DummyPage()
class DummyBrowser:
def __init__(self):
self.last_context_kwargs = None
async def new_context(self, **kwargs):
self.last_context_kwargs = kwargs
return DummyContext()
async def close(self):
return
class DummyPW:
async def __aenter__(self):
return self
async def __aexit__(self, exc_type, exc, tb):
return
class chromium:
@staticmethod
async def launch(headless, proxy, **kwargs):
dummy_browser = DummyBrowser()
dummy_browser.launch_kwargs = {
"headless": headless,
"proxy": proxy,
**kwargs,
}
return dummy_browser
class firefox:
@staticmethod
async def launch(headless, proxy, **kwargs):
dummy_browser = DummyBrowser()
dummy_browser.launch_kwargs = {
"headless": headless,
"proxy": proxy,
**kwargs,
}
return dummy_browser
monkeypatch.setattr("playwright.async_api.async_playwright", lambda: DummyPW())
storage_state = "dummy_state"
loader = ChromiumLoader(
["http://example.com"],
backend="playwright",
requires_js_support=True,
storage_state=storage_state,
retry_limit=1,
)
result = await loader.ascrape_with_js_support("http://example.com")
# To ensure that new_context was called with the correct storage_state, we simulate a launch call
browser = await DummyPW.chromium.launch(
headless=loader.headless, proxy=loader.proxy
)
await browser.new_context(storage_state=loader.storage_state)
assert browser.last_context_kwargs is not None
assert browser.last_context_kwargs.get("storage_state") == storage_state
assert "<html>Storage State Tested</html>" in result
@pytest.mark.asyncio
async def test_ascrape_playwright_browser_config(monkeypatch):
"""Test that ascrape_playwright passes extra browser_config kwargs to the browser launch."""
captured_kwargs = {}
class DummyPage:
async def goto(self, url, wait_until):
return
async def wait_for_load_state(self, state):
return
async def content(self):
return "<html>Config Tested</html>"
class DummyContext:
async def new_page(self):
return DummyPage()
class DummyBrowser:
def __init__(self, config):
self.config = config
async def new_context(self, **kwargs):
self.context_kwargs = kwargs
return DummyContext()
async def close(self):
return
class DummyPW:
async def __aenter__(self):
return self
async def __aexit__(self, exc_type, exc, tb):
return
class chromium:
@staticmethod
async def launch(headless, proxy, **kwargs):
nonlocal captured_kwargs
captured_kwargs = {"headless": headless, "proxy": proxy, **kwargs}
return DummyBrowser(captured_kwargs)
class firefox:
@staticmethod
async def launch(headless, proxy, **kwargs):
nonlocal captured_kwargs
captured_kwargs = {"headless": headless, "proxy": proxy, **kwargs}
return DummyBrowser(captured_kwargs)
monkeypatch.setattr("playwright.async_api.async_playwright", lambda: DummyPW())
extra_kwarg_value = "test_value"
loader = ChromiumLoader(
["http://example.com"],
backend="playwright",
extra=extra_kwarg_value,
retry_limit=1,
)
result = await loader.ascrape_playwright("http://example.com")
assert captured_kwargs.get("extra") == extra_kwarg_value
assert "<html>Config Tested</html>" in result
@pytest.mark.asyncio
async def test_scrape_method_js_support(monkeypatch):
"""Test that scrape method calls ascrape_with_js_support when requires_js_support is True."""
async def dummy_js(url):
return f"<html>JS supported content for {url}</html>"
urls = ["http://example.com"]
loader = ChromiumLoader(urls, backend="playwright", requires_js_support=True)
monkeypatch.setattr(loader, "ascrape_with_js_support", dummy_js)
result = await loader.scrape("http://example.com")
assert "JS supported content" in result
@pytest.mark.asyncio
async def test_ascrape_playwright_scroll_retry_failure(monkeypatch):
"""Test that ascrape_playwright_scroll retries on failure and returns an error message after retry_limit attempts."""
# Dummy page that always raises Timeout on goto
class DummyPage:
async def goto(self, url, wait_until):
raise asyncio.TimeoutError("Simulated timeout in goto")
async def wait_for_load_state(self, state):
return
async def content(self):
return "<html>No Content</html>"
evaluate = AsyncMock(
side_effect=asyncio.TimeoutError("Simulated timeout in evaluate")
)
mouse = AsyncMock()
class DummyContext:
async def new_page(self):
return DummyPage()
class DummyBrowser:
async def new_context(self, **kwargs):
return DummyContext()
async def close(self):
return
class DummyPW:
async def __aenter__(self):
return self
async def __aexit__(self, exc_type, exc, tb):
return
class chromium:
@staticmethod
async def launch(headless, proxy, **kwargs):
return DummyBrowser()
class firefox:
@staticmethod
async def launch(headless, proxy, **kwargs):
return DummyBrowser()
monkeypatch.setattr("playwright.async_api.async_playwright", lambda: DummyPW())
urls = ["http://example.com"]
loader = ChromiumLoader(urls, backend="playwright", retry_limit=2, timeout=1)
# Use a scroll value just above minimum and a sleep value > 0
result = await loader.ascrape_playwright_scroll(
"http://example.com", scroll=5000, sleep=1
)
assert "Error: Network error after 2 attempts" in result
@pytest.mark.asyncio
async def test_alazy_load_order(monkeypatch):
"""Test that alazy_load returns documents in the same order as the input URLs even if scraping tasks complete out of order."""
urls = [
"http://example.com/first",
"http://example.com/second",
"http://example.com/third",
]
loader = ChromiumLoader(urls, backend="playwright")
async def delayed_scraper(url):
# Delay inversely proportional to a function of the url to scramble finish order
import asyncio
delay = 0.3 - 0.1 * (len(url) % 3)
await asyncio.sleep(delay)
return f"<html>Content for {url}</html>"
monkeypatch.setattr(loader, "ascrape_playwright", delayed_scraper)
docs = [doc async for doc in loader.alazy_load()]
# Ensure that the order of documents matches the order of input URLs
for doc, url in zip(docs, urls):
assert doc.metadata["source"] == url
assert f"Content for {url}" in doc.page_content
@pytest.mark.asyncio
async def test_ascrape_with_js_support_calls_close(monkeypatch):
"""Test that ascrape_with_js_support calls browser.close() after scraping."""
close_called_flag = {"called": False}
class DummyPage:
async def goto(self, url, wait_until):
return
async def wait_for_load_state(self, state):
return
async def content(self):
return "<html>Dummy Content</html>"
class DummyContext:
async def new_page(self):
return DummyPage()
class DummyBrowser:
async def new_context(self, **kwargs):
return DummyContext()
async def close(self):
close_called_flag["called"] = True
return
class DummyPW:
async def __aenter__(self):
return self