-
Notifications
You must be signed in to change notification settings - Fork 53
Expand file tree
/
Copy pathtest_bootstrapper_iterative.py
More file actions
2675 lines (2283 loc) · 98.3 KB
/
Copy pathtest_bootstrapper_iterative.py
File metadata and controls
2675 lines (2283 loc) · 98.3 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
"""Tests for the iterative bootstrap implementation.
Tests cover:
- Phase class hierarchy: class variables and base class behavior
- WorkItem dataclass defaults and state accumulation
- _track_why context manager behavior
- create_unresolved_work_items helper
- Resolve.run() version expansion
- Start.run() graph addition and seen-check
- PrepareSource.run() all branches (prebuilt, source, cached, bad path)
- PrepareBuild.run() dep installation and extraction
- Build.run() conditional install and result construction
- ProcessInstallDeps.run() hooks, dep extraction, error modes
- Complete.run() cleanup
- _handle_phase_error for all three error modes
- End-to-end iterative loop with LIFO ordering
"""
from __future__ import annotations
import concurrent.futures
import logging
import pathlib
import typing
from unittest.mock import Mock, call, patch
import pytest
from packaging.requirements import Requirement
from packaging.utils import canonicalize_name
from packaging.version import Version
from resolvelib.resolvers import ResolverException
from fromager import bootstrapper, build_environment
from fromager.bootstrapper._build import Build
from fromager.bootstrapper._complete import Complete
from fromager.bootstrapper._phase import Phase
from fromager.bootstrapper._prepare_build import PrepareBuild
from fromager.bootstrapper._prepare_source import PrepareSource
from fromager.bootstrapper._process_install_deps import ProcessInstallDeps
from fromager.bootstrapper._resolve import Resolve
from fromager.bootstrapper._start import Start
from fromager.bootstrapper._types import (
BootstrapPhase,
PreparedSourceData,
SourceBuildResult,
)
from fromager.bootstrapper._work_item import WorkItem
from fromager.context import WorkContext
from fromager.requirements_file import RequirementType, SourceType
def _make_resolved_future(
result: typing.Any,
) -> concurrent.futures.Future[typing.Any]:
"""Return an already-completed Future carrying *result*."""
future: concurrent.futures.Future[typing.Any] = concurrent.futures.Future()
future.set_result(result)
return future
def _make_work_item(
req: str = "testpkg",
req_type: RequirementType = RequirementType.INSTALL,
why_snapshot: list | None = None,
parent: tuple | None = None,
source_url: str | None = None,
version: str | None = None,
build_env: build_environment.BuildEnvironment | None = None,
sdist_root_dir: pathlib.Path | None = None,
unpack_dir: pathlib.Path | None = None,
build_result: SourceBuildResult | None = None,
build_system_deps: set[Requirement] | None = None,
build_backend_deps: set[Requirement] | None = None,
build_sdist_deps: set[Requirement] | None = None,
pbi_pre_built: bool = False,
cached_wheel_filename: pathlib.Path | None = None,
build_sdist_only: bool = False,
) -> WorkItem:
return WorkItem(
req=Requirement(req),
req_type=req_type,
why_snapshot=why_snapshot or [],
parent=parent,
source_url=source_url,
resolved_version=Version(version) if version else None,
build_env=build_env,
sdist_root_dir=sdist_root_dir,
unpack_dir=unpack_dir,
build_result=build_result,
build_system_deps=build_system_deps if build_system_deps is not None else set(),
build_backend_deps=build_backend_deps
if build_backend_deps is not None
else set(),
build_sdist_deps=build_sdist_deps if build_sdist_deps is not None else set(),
pbi_pre_built=pbi_pre_built,
cached_wheel_filename=cached_wheel_filename,
build_sdist_only=build_sdist_only,
)
def _make_resolve_item(
req: str = "testpkg",
req_type: RequirementType = RequirementType.INSTALL,
why_snapshot: list | None = None,
parent: tuple | None = None,
) -> Resolve:
return Resolve(
WorkItem(
req=Requirement(req),
req_type=req_type,
why_snapshot=why_snapshot or [],
parent=parent,
)
)
def _make_start_item(
req: str = "testpkg",
req_type: RequirementType = RequirementType.INSTALL,
source_url: str = "https://pypi.org/testpkg-1.0.tar.gz",
version: str = "1.0",
why_snapshot: list | None = None,
parent: tuple | None = None,
) -> Start:
return Start(
WorkItem(
req=Requirement(req),
req_type=req_type,
why_snapshot=why_snapshot or [],
parent=parent,
source_url=source_url,
resolved_version=Version(version),
)
)
_PHASE_TO_CLASS: dict[BootstrapPhase, type[Phase]] = {
BootstrapPhase.RESOLVE: Resolve,
BootstrapPhase.START: Start,
BootstrapPhase.PREPARE_SOURCE: PrepareSource,
BootstrapPhase.PREPARE_BUILD: PrepareBuild,
BootstrapPhase.BUILD: Build,
BootstrapPhase.PROCESS_INSTALL_DEPS: ProcessInstallDeps,
BootstrapPhase.COMPLETE: Complete,
}
def _make_build_item(
req: str = "testpkg",
version: str = "1.0",
phase: BootstrapPhase = BootstrapPhase.PREPARE_SOURCE,
source_url: str = "https://pypi.org/testpkg-1.0.tar.gz",
build_env: build_environment.BuildEnvironment | None = None,
sdist_root_dir: pathlib.Path | None = None,
unpack_dir: pathlib.Path | None = None,
build_result: SourceBuildResult | None = None,
build_system_deps: set[Requirement] | None = None,
build_backend_deps: set[Requirement] | None = None,
build_sdist_deps: set[Requirement] | None = None,
pbi_pre_built: bool = False,
cached_wheel_filename: pathlib.Path | None = None,
build_sdist_only: bool = False,
) -> Phase:
wi = WorkItem(
req=Requirement(req),
req_type=RequirementType.INSTALL,
why_snapshot=[],
source_url=source_url,
resolved_version=Version(version),
build_env=build_env,
sdist_root_dir=sdist_root_dir,
unpack_dir=unpack_dir,
build_result=build_result,
build_system_deps=build_system_deps if build_system_deps is not None else set(),
build_backend_deps=build_backend_deps
if build_backend_deps is not None
else set(),
build_sdist_deps=build_sdist_deps if build_sdist_deps is not None else set(),
pbi_pre_built=pbi_pre_built,
cached_wheel_filename=cached_wheel_filename,
build_sdist_only=build_sdist_only,
)
return _PHASE_TO_CLASS[phase](wi)
class TestPhaseClassVariables:
"""Verify class-variable declarations on each Phase subclass."""
@pytest.mark.parametrize(
"cls, expected_phase, expected_tracks_why",
[
(Resolve, BootstrapPhase.RESOLVE, False),
(Start, BootstrapPhase.START, False),
(PrepareSource, BootstrapPhase.PREPARE_SOURCE, True),
(PrepareBuild, BootstrapPhase.PREPARE_BUILD, True),
(Build, BootstrapPhase.BUILD, True),
(ProcessInstallDeps, BootstrapPhase.PROCESS_INSTALL_DEPS, True),
(Complete, BootstrapPhase.COMPLETE, True),
],
)
def test_class_variables(
self,
tmp_context: WorkContext,
cls: type[Phase],
expected_phase: BootstrapPhase,
expected_tracks_why: bool,
) -> None:
assert cls.phase == expected_phase
assert cls.tracks_why == expected_tracks_why
def test_str_default(self) -> None:
wi = _make_work_item(req="mypkg")
item = Build(wi)
assert str(item) == "Build(mypkg)"
def test_background_work_returns_none_by_default(
self, tmp_context: WorkContext
) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
for cls in (PrepareBuild, Build, ProcessInstallDeps, Complete):
wi = _make_work_item(req="testpkg", version="1.0")
item = cls(wi)
assert item.background_work(bt) is None, (
f"{cls.__name__}.background_work() should return None"
)
class TestWorkItem:
def test_defaults_for_resolve_item(self) -> None:
item = _make_resolve_item()
wi = item.work_item
assert wi.source_url is None
assert wi.resolved_version is None
assert wi.build_sdist_only is False
assert wi.build_env is None
assert wi.build_result is None
assert wi.pbi_pre_built is False
assert wi.build_system_deps == set()
assert wi.build_backend_deps == set()
assert wi.build_sdist_deps == set()
def test_state_accumulation(self) -> None:
item = _make_start_item()
wi = item.work_item
wi.pbi_pre_built = True
wi.build_sdist_only = True
mock_env = Mock()
wi.build_env = mock_env
assert wi.pbi_pre_built is True
assert wi.build_sdist_only is True
assert wi.build_env is mock_env
class TestTrackWhy:
def test_noop_for_resolve_phase(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
bt.why = [(RequirementType.TOP_LEVEL, Requirement("parent"), Version("1.0"))]
item = _make_resolve_item()
with bt._track_why(item):
assert len(bt.why) == 1
assert len(bt.why) == 1
def test_noop_for_start_phase(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
bt.why = []
item = _make_start_item()
with bt._track_why(item):
assert len(bt.why) == 0
assert len(bt.why) == 0
def test_pushes_and_pops_for_build_phase(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
bt.why = []
item = _make_build_item(phase=BootstrapPhase.PREPARE_SOURCE)
wi = item.work_item
with bt._track_why(item):
assert len(bt.why) == 1
assert bt.why[0][1] == wi.req
assert bt.why[0][2] == wi.resolved_version
assert len(bt.why) == 0
def test_pops_on_exception(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
bt.why = []
item = _make_build_item(phase=BootstrapPhase.BUILD)
with pytest.raises(ValueError, match="boom"):
with bt._track_why(item):
assert len(bt.why) == 1
raise ValueError("boom")
assert len(bt.why) == 0
class TestCreateUnresolvedWorkItems:
def test_creates_resolve_phase_items(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
deps = [Requirement("dep-a"), Requirement("dep-b")]
items = bt.create_unresolved_work_items(
deps, RequirementType.BUILD_SYSTEM, Requirement("parent"), Version("1.0")
)
assert len(items) == 2
for item in items:
assert isinstance(item, Resolve)
assert item.phase == BootstrapPhase.RESOLVE
assert item.work_item.req_type == RequirementType.BUILD_SYSTEM
assert item.work_item.parent == (Requirement("parent"), Version("1.0"))
assert item.work_item.source_url is None
assert item.work_item.resolved_version is None
def test_captures_why_snapshot(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
bt.why = [(RequirementType.TOP_LEVEL, Requirement("root"), Version("2.0"))]
items = bt.create_unresolved_work_items(
[Requirement("dep")],
RequirementType.INSTALL,
Requirement("parent"),
Version("1.0"),
)
assert len(items) == 1
assert items[0].work_item.why_snapshot == bt.why
# Verify it's a copy, not a reference
bt.why.append((RequirementType.INSTALL, Requirement("other"), Version("3.0")))
assert len(items[0].work_item.why_snapshot) == 1
def test_sorts_by_name(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
deps = [Requirement("zebra"), Requirement("alpha"), Requirement("middle")]
items = bt.create_unresolved_work_items(
deps, RequirementType.INSTALL, Requirement("p"), Version("1.0")
)
names = [str(item.work_item.req.name) for item in items]
assert names == ["alpha", "middle", "zebra"]
def test_empty_deps(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
items = bt.create_unresolved_work_items(
[], RequirementType.INSTALL, Requirement("p"), Version("1.0")
)
assert items == []
class TestPhaseResolve:
def test_single_version(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
item = _make_resolve_item()
wi = item.work_item
wi.parent = (Requirement("parent"), Version("2.0"))
item.bg_future = _make_resolved_future(
[("https://pypi.org/testpkg-1.0.tar.gz", Version("1.0"))]
)
result = item.run(bt)
assert len(result) == 1
assert isinstance(result[0], Start)
assert result[0].work_item.source_url == "https://pypi.org/testpkg-1.0.tar.gz"
assert result[0].work_item.resolved_version == Version("1.0")
assert result[0].work_item.parent == wi.parent
def test_multiple_versions(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context, multiple_versions=True)
item = _make_resolve_item()
item.bg_future = _make_resolved_future(
[
("https://pypi.org/testpkg-2.0.tar.gz", Version("2.0")),
("https://pypi.org/testpkg-1.0.tar.gz", Version("1.0")),
]
)
result = item.run(bt)
assert len(result) == 2
# Reversed so highest version ends up on top of stack (last element)
assert result[0].work_item.resolved_version == Version("1.0")
assert result[1].work_item.resolved_version == Version("2.0")
def test_empty_resolution_raises(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
item = _make_resolve_item()
item.bg_future = _make_resolved_future([])
with pytest.raises(RuntimeError, match="Could not resolve"):
item.run(bt)
def test_preserves_why_snapshot(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
snapshot = [(RequirementType.TOP_LEVEL, Requirement("root"), Version("1.0"))]
item = _make_resolve_item(why_snapshot=list(snapshot))
item.bg_future = _make_resolved_future([("url", Version("1.0"))])
result = item.run(bt)
assert result[0].work_item.why_snapshot == snapshot
def test_filters_cached_versions_in_multiple_versions_mode(
self, tmp_context: WorkContext
) -> None:
"""Cached versions are filtered out before creating Starts."""
bt = bootstrapper.Bootstrapper(tmp_context, multiple_versions=True)
item = _make_resolve_item()
item.bg_future = _make_resolved_future(
[
("url-3.0", Version("3.0")),
("url-2.0", Version("2.0")),
("url-1.0", Version("1.0")),
]
)
def mock_cache(
ctx: object, cache_url: object, req: Requirement, version: Version
) -> tuple:
if str(version) == "2.0":
return (tmp_context.work_dir / "pkg-2.0-py3-none-any.whl", None)
return (None, None)
with patch(
"fromager.bootstrapper._cache.find_cached_wheel", side_effect=mock_cache
):
result = item.run(bt)
assert len(result) == 2
versions = {str(it.work_item.resolved_version) for it in result}
assert versions == {"1.0", "3.0"}
def test_all_cached_keeps_highest_version(self, tmp_context: WorkContext) -> None:
"""If all versions are cached, keeps the highest for dependency discovery."""
bt = bootstrapper.Bootstrapper(tmp_context, multiple_versions=True)
item = _make_resolve_item()
item.bg_future = _make_resolved_future(
[
("url-3.0", Version("3.0")),
("url-2.0", Version("2.0")),
("url-1.0", Version("1.0")),
]
)
with patch(
"fromager.bootstrapper._cache.find_cached_wheel",
return_value=(tmp_context.work_dir / "cached.whl", None),
):
result = item.run(bt)
assert len(result) == 1
assert result[0].work_item.resolved_version == Version("3.0")
def test_no_filtering_in_single_version_mode(
self, tmp_context: WorkContext
) -> None:
"""Cache filtering does not apply in single version mode."""
bt = bootstrapper.Bootstrapper(tmp_context, multiple_versions=False)
item = _make_resolve_item()
item.bg_future = _make_resolved_future([("url-1.0", Version("1.0"))])
with patch("fromager.bootstrapper._cache.find_cached_wheel") as mock_cache:
result = item.run(bt)
assert len(result) == 1
mock_cache.assert_not_called()
def test_empty_resolution_raises_runtime_error(
self, tmp_context: WorkContext
) -> None:
"""Empty resolution raises RuntimeError regardless of mode."""
for multi in (False, True):
bt = bootstrapper.Bootstrapper(tmp_context, multiple_versions=multi)
item = _make_resolve_item()
item.bg_future = _make_resolved_future([])
with pytest.raises(RuntimeError, match="Could not resolve"):
item.run(bt)
def test_filters_failed_versions_in_multiple_versions_mode(
self, tmp_context: WorkContext
) -> None:
"""Previously failed versions are excluded before creating Starts."""
bt = bootstrapper.Bootstrapper(tmp_context, multiple_versions=True)
item = _make_resolve_item()
bt._failed_versions[(canonicalize_name("testpkg"), "2.0")] = RuntimeError(
"boom"
)
item.bg_future = _make_resolved_future(
[
("url-3.0", Version("3.0")),
("url-2.0", Version("2.0")),
("url-1.0", Version("1.0")),
]
)
with patch(
"fromager.bootstrapper._cache.find_cached_wheel", return_value=(None, None)
):
result = item.run(bt)
versions = {str(it.work_item.resolved_version) for it in result}
assert versions == {"1.0", "3.0"}
def test_failed_version_filter_does_not_apply_in_single_version_mode(
self, tmp_context: WorkContext
) -> None:
"""Failed-version filtering only applies in multiple_versions mode."""
bt = bootstrapper.Bootstrapper(tmp_context, multiple_versions=False)
item = _make_resolve_item()
bt._failed_versions[(canonicalize_name("testpkg"), "1.0")] = RuntimeError(
"boom"
)
item.bg_future = _make_resolved_future([("url-1.0", Version("1.0"))])
result = item.run(bt)
assert len(result) == 1
assert result[0].work_item.resolved_version == Version("1.0")
def test_all_versions_failed_raises_runtime_error(
self, tmp_context: WorkContext
) -> None:
"""Raises RuntimeError when all resolved versions already failed."""
bt = bootstrapper.Bootstrapper(tmp_context, multiple_versions=True)
item = _make_resolve_item()
bt._failed_versions[(canonicalize_name("testpkg"), "1.0")] = RuntimeError(
"boom"
)
item.bg_future = _make_resolved_future([("url-1.0", Version("1.0"))])
with pytest.raises(RuntimeError, match="failed previously"):
item.run(bt)
def test_bg_future_exception_propagates(self, tmp_context: WorkContext) -> None:
"""Exceptions from the background resolver thread are surfaced by run()."""
bt = bootstrapper.Bootstrapper(tmp_context)
item = _make_resolve_item()
future: concurrent.futures.Future[list[tuple[str, Version]]] = (
concurrent.futures.Future()
)
future.set_exception(ValueError("resolver exploded"))
item.bg_future = future
with pytest.raises(ValueError, match="resolver exploded"):
item.run(bt)
class TestPhaseStart:
def test_new_item_advances_to_prepare_source(
self, tmp_context: WorkContext
) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
bt.why = []
item = _make_start_item()
result = item.run(bt)
assert len(result) == 1
assert isinstance(result[0], PrepareSource)
assert result[0].work_item is item.work_item
def test_already_seen_returns_empty(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
bt.why = []
item = _make_start_item()
wi = item.work_item
# Mark as seen first
assert wi.resolved_version is not None
bt.mark_as_seen(wi.req, wi.resolved_version)
result = item.run(bt)
assert result == []
def test_adds_to_graph_for_non_toplevel(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
bt.why = []
item = _make_start_item(req_type=RequirementType.INSTALL)
item.run(bt)
key = f"{canonicalize_name('testpkg')}==1.0"
assert key in tmp_context.dependency_graph.nodes
def test_skips_graph_for_toplevel(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
bt.why = []
item = _make_start_item(req_type=RequirementType.TOP_LEVEL)
item.run(bt)
key = f"{canonicalize_name('testpkg')}==1.0"
assert key not in tmp_context.dependency_graph.nodes
def test_sdist_only_set_for_non_build_requirement(
self, tmp_context: WorkContext
) -> None:
bt = bootstrapper.Bootstrapper(tmp_context, sdist_only=True)
bt.why = []
item = _make_start_item(req_type=RequirementType.INSTALL)
item.run(bt)
assert item.work_item.build_sdist_only is True
def test_sdist_only_not_set_for_build_requirement(
self, tmp_context: WorkContext
) -> None:
bt = bootstrapper.Bootstrapper(tmp_context, sdist_only=True)
bt.why = []
item = _make_start_item(req_type=RequirementType.BUILD_SYSTEM)
item.run(bt)
assert item.work_item.build_sdist_only is False
def test_marks_as_seen(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
bt.why = []
item = _make_start_item()
wi = item.work_item
assert wi.resolved_version is not None
assert not bt.has_been_seen(wi.req, wi.resolved_version)
item.run(bt)
assert bt.has_been_seen(wi.req, wi.resolved_version)
def test_sets_pbi_pre_built_before_prepare_source(
self, tmp_context: WorkContext
) -> None:
"""pbi_pre_built is set on work_item before PrepareSource is constructed."""
bt = bootstrapper.Bootstrapper(tmp_context)
bt.why = []
item = _make_start_item()
with patch.object(
tmp_context,
"package_build_info",
return_value=Mock(pre_built=True),
):
result = item.run(bt)
assert len(result) == 1
assert isinstance(result[0], PrepareSource)
assert result[0].work_item.pbi_pre_built is True
class TestComplete:
def test_calls_clean_build_dirs(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
mock_sdist_root = tmp_context.work_dir / "pkg-1.0" / "pkg-1.0"
mock_env = Mock()
build_result = SourceBuildResult(
wheel_filename=None,
sdist_filename=None,
unpack_dir=tmp_context.work_dir,
sdist_root_dir=mock_sdist_root,
build_env=mock_env,
source_type=SourceType.SDIST,
)
item = _make_build_item(phase=BootstrapPhase.COMPLETE)
item.work_item.build_result = build_result
with patch.object(tmp_context, "clean_build_dirs") as mock_clean:
result = item.run(bt)
assert result == []
mock_clean.assert_called_once_with(mock_sdist_root, mock_env)
def test_no_build_result_skips_cleanup(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
item = _make_build_item(phase=BootstrapPhase.COMPLETE)
item.work_item.build_result = None
with patch.object(tmp_context, "clean_build_dirs") as mock_clean:
result = item.run(bt)
assert result == []
mock_clean.assert_not_called()
def test_returns_empty_list(self, tmp_context: WorkContext) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
item = _make_build_item(phase=BootstrapPhase.COMPLETE)
assert item.run(bt) == []
class TestEnrichResolutionError:
"""Tests for _enrich_resolution_error, used by _handle_phase_error."""
def _why_snapshot(self) -> list[tuple[RequirementType, Requirement, Version]]:
return [
(RequirementType.TOP_LEVEL, Requirement("its-hub"), Version("1.0")),
(RequirementType.INSTALL, Requirement("reward-hub"), Version("2.0")),
(RequirementType.INSTALL, Requirement("vllm"), Version("3.0")),
]
def test_resolver_exception_gets_dependency_chain(
self, tmp_context: WorkContext
) -> None:
"""Regression test for #1214: name the whole chain, not just the
top-level package.
"""
bt = bootstrapper.Bootstrapper(tmp_context)
item = _make_resolve_item(
req="flashinfer-python==0.6.8.post1", why_snapshot=self._why_snapshot()
)
err = ResolverException("found no match")
enriched = bt._enrich_resolution_error(item, err)
assert isinstance(enriched, ResolverException)
assert str(enriched) == (
"found no match (dependency chain: its-hub==1.0 -> "
"reward-hub==2.0 -> vllm==3.0 -> flashinfer-python==0.6.8.post1)"
)
def test_runtime_error_gets_dependency_chain(
self, tmp_context: WorkContext
) -> None:
"""Regression test for a gap in the earlier fix: a plain RuntimeError
(e.g. "Could not resolve any versions for ...") also gets the chain,
not just ResolverException.
"""
bt = bootstrapper.Bootstrapper(tmp_context)
item = _make_resolve_item(
req="flashinfer-python==0.6.8.post1", why_snapshot=self._why_snapshot()
)
err = RuntimeError("Could not resolve any versions for flashinfer-python")
enriched = bt._enrich_resolution_error(item, err)
assert isinstance(enriched, RuntimeError)
assert str(enriched) == (
"Could not resolve any versions for flashinfer-python "
"(dependency chain: its-hub==1.0 -> reward-hub==2.0 -> "
"vllm==3.0 -> flashinfer-python==0.6.8.post1)"
)
def test_unknown_exception_type_falls_back_to_runtime_error(
self, tmp_context: WorkContext
) -> None:
"""`type(err)(msg)` isn't safe for arbitrary exception classes, so an
unrecognized type is wrapped in a RuntimeError that keeps the
original type name visible, instead of risking a TypeError trying
to reconstruct it.
"""
bt = bootstrapper.Bootstrapper(tmp_context)
item = _make_resolve_item(
req="flashinfer-python==0.6.8.post1", why_snapshot=self._why_snapshot()
)
err = ValueError("some unexpected failure")
enriched = bt._enrich_resolution_error(item, err)
assert isinstance(enriched, RuntimeError)
assert "ValueError: some unexpected failure" in str(enriched)
assert "dependency chain: its-hub==1.0" in str(enriched)
def test_no_chain_returns_original_object_unchanged(
self, tmp_context: WorkContext
) -> None:
"""Top-level requirements have no chain, so the original exception
object is returned as-is (identity preserved, nothing reconstructed).
"""
bt = bootstrapper.Bootstrapper(tmp_context)
item = _make_resolve_item() # default why_snapshot=[]
err = ResolverException("found no match")
enriched = bt._enrich_resolution_error(item, err)
assert enriched is err
def test_non_resolve_phase_returns_original_object_unchanged(
self, tmp_context: WorkContext
) -> None:
"""Only RESOLVE-phase failures get a chain suffix."""
bt = bootstrapper.Bootstrapper(tmp_context)
item = _make_build_item(phase=BootstrapPhase.BUILD)
item.work_item.why_snapshot = self._why_snapshot()
err = RuntimeError("build failed")
enriched = bt._enrich_resolution_error(item, err)
assert enriched is err
def test_enriched_exception_chains_via_context_not_cause(
self, tmp_context: WorkContext
) -> None:
"""When actually raised (not just constructed), the enriched
exception must carry the original as `__context__` (implicit
chaining, preserves the real traceback for `exc_info=True`
logging) while leaving `__cause__` unset, so
`__main__._format_exception()` - which only follows `__cause__` -
doesn't print the original message a second time via
"... because ...". See #1243 for that formatter's own,
independent duplication bug.
"""
from fromager import __main__
bt = bootstrapper.Bootstrapper(tmp_context)
item = _make_resolve_item(
req="flashinfer-python==0.6.8.post1", why_snapshot=self._why_snapshot()
)
original = ResolverException("found no match")
try:
raise original
except ResolverException as caught:
enriched = bt._enrich_resolution_error(item, caught)
try:
raise enriched
except ResolverException as raised:
final = raised
assert final.__cause__ is None
assert final.__context__ is original
formatted = __main__._format_exception(final)
assert formatted.count("found no match") == 1
class TestHandlePhaseError:
# -- RESOLVE phase errors --
def test_resolve_error_in_test_mode_records_failure(
self, tmp_context: WorkContext
) -> None:
bt = bootstrapper.Bootstrapper(tmp_context, test_mode=True)
item = _make_resolve_item()
err = RuntimeError("resolution failed")
result = bt._handle_phase_error(item, err)
assert result == []
assert len(bt.failed_packages) == 1
assert bt.failed_packages[0]["failure_type"] == "resolution"
assert bt.failed_packages[0]["version"] is None
def test_resolve_error_in_normal_mode_raises(
self, tmp_context: WorkContext
) -> None:
bt = bootstrapper.Bootstrapper(tmp_context)
item = _make_resolve_item()
err = RuntimeError("resolution failed")
with pytest.raises(RuntimeError, match="resolution failed"):
try:
raise err
except RuntimeError:
bt._handle_phase_error(item, err)
def test_resolve_error_in_multiple_versions_mode_continues(
self, tmp_context: WorkContext
) -> None:
"""RESOLVE failures in multiple versions mode are recorded, not raised."""
bt = bootstrapper.Bootstrapper(tmp_context, multiple_versions=True)
item = _make_resolve_item()
err = RuntimeError("resolution failed")
try:
raise err
except RuntimeError:
result = bt._handle_phase_error(item, err)
assert result == []
assert len(bt._failed_versions) == 1
key = (canonicalize_name("testpkg"), "unresolved")
assert key in bt._failed_versions
assert bt._failed_versions[key] is err
def test_resolve_error_enriched_before_test_mode_record(
self, tmp_context: WorkContext
) -> None:
"""Gap identified in review: test mode must record the enriched
message, not the raw one, so `failed_packages[].exception_message`
shows the real dependency chain.
"""
bt = bootstrapper.Bootstrapper(tmp_context, test_mode=True)
why_snapshot = [
(RequirementType.TOP_LEVEL, Requirement("its-hub"), Version("1.0")),
]
item = _make_resolve_item(
req="flashinfer-python==0.6.8.post1", why_snapshot=why_snapshot
)
err = ResolverException("found no match")
bt._handle_phase_error(item, err)
assert len(bt.failed_packages) == 1
assert (
"dependency chain: its-hub==1.0"
in (bt.failed_packages[0]["exception_message"])
)
def test_resolve_error_enriched_before_multiple_versions_record(
self, tmp_context: WorkContext
) -> None:
"""Gap identified in review: multiple-versions mode must record the
enriched message too.
"""
bt = bootstrapper.Bootstrapper(tmp_context, multiple_versions=True)
why_snapshot = [
(RequirementType.TOP_LEVEL, Requirement("its-hub"), Version("1.0")),
]
item = _make_resolve_item(
req="flashinfer-python==0.6.8.post1", why_snapshot=why_snapshot
)
err = ResolverException("found no match")
bt._handle_phase_error(item, err)
key = (canonicalize_name("flashinfer-python"), "unresolved")
assert "dependency chain: its-hub==1.0" in str(bt._failed_versions[key])
def test_resolve_error_enriched_before_normal_mode_raise(
self, tmp_context: WorkContext
) -> None:
"""Gap this feature originally targeted: a plain RuntimeError
("Could not resolve any versions...") also gets the chain in
normal (fail-fast) mode, not just ResolverException.
"""
bt = bootstrapper.Bootstrapper(tmp_context)
why_snapshot = [
(RequirementType.TOP_LEVEL, Requirement("its-hub"), Version("1.0")),
]
item = _make_resolve_item(
req="flashinfer-python==0.6.8.post1", why_snapshot=why_snapshot
)
err = RuntimeError("Could not resolve any versions for flashinfer-python")
with pytest.raises(RuntimeError, match=r"dependency chain: its-hub==1\.0"):
try:
raise err
except RuntimeError:
bt._handle_phase_error(item, err)
# -- Build phase errors in test mode --
def test_build_phase_test_mode_fallback_success(
self, tmp_context: WorkContext
) -> None:
bt = bootstrapper.Bootstrapper(tmp_context, test_mode=True)
item = _make_build_item(phase=BootstrapPhase.PREPARE_SOURCE)
item.work_item.pbi_pre_built = False
err = RuntimeError("build failed")
mock_fallback = Mock(spec=SourceBuildResult)
with patch.object(bt, "_handle_test_mode_failure", return_value=mock_fallback):
result = bt._handle_phase_error(item, err)
assert len(result) == 1
assert isinstance(result[0], ProcessInstallDeps)
assert result[0].work_item is item.work_item
assert result[0].work_item.build_result is mock_fallback
assert len(bt.failed_packages) == 0
def test_build_phase_test_mode_fallback_failure(
self, tmp_context: WorkContext
) -> None:
bt = bootstrapper.Bootstrapper(tmp_context, test_mode=True)
item = _make_build_item(phase=BootstrapPhase.BUILD)
item.work_item.pbi_pre_built = False
err = RuntimeError("build failed")
with patch.object(bt, "_handle_test_mode_failure", return_value=None):
result = bt._handle_phase_error(item, err)
assert result == []
assert len(bt.failed_packages) == 1
assert bt.failed_packages[0]["failure_type"] == "bootstrap"
def test_build_phase_test_mode_prebuilt_skips_fallback(
self, tmp_context: WorkContext
) -> None:
bt = bootstrapper.Bootstrapper(tmp_context, test_mode=True)
item = _make_build_item(phase=BootstrapPhase.PREPARE_SOURCE)
item.work_item.pbi_pre_built = True
err = RuntimeError("download failed")
result = bt._handle_phase_error(item, err)
assert result == []
assert len(bt.failed_packages) == 1