|
| 1 | +"""Unit tests for the write verification of store_entity(). |
| 2 | +
|
| 3 | +Regression guard for #175: store_entity() returned normally and listed a page in |
| 4 | +created_pages when that page did not exist on the wiki afterwards. An edit that |
| 5 | +raises nothing is not proof that the page was created, and page.changed is True |
| 6 | +in the failing case as well. store_entity() must now query the edited pages and |
| 7 | +report an absent one in result.failed. |
| 8 | +
|
| 9 | +These run fully offline: WtPage.init, the overwrite policy and the existence |
| 10 | +query are stubbed, so no network is required. |
| 11 | +""" |
| 12 | + |
| 13 | +import pytest |
| 14 | + |
| 15 | +import osw.model.entity as model |
| 16 | +from osw.core import OSW |
| 17 | +from osw.utils.wiki import get_namespace, get_title |
| 18 | +from osw.wtsite import WtPage |
| 19 | + |
| 20 | + |
| 21 | +def _title(entity): |
| 22 | + return f"{get_namespace(entity)}:{get_title(entity)}" |
| 23 | + |
| 24 | + |
| 25 | +class _FakeMwSite: |
| 26 | + """Records the API queries and answers them from a set of missing titles.""" |
| 27 | + |
| 28 | + def __init__(self, missing_titles=(), normalized=None): |
| 29 | + self.missing_titles = set(missing_titles) |
| 30 | + self.normalized = normalized or {} |
| 31 | + self.queries = [] |
| 32 | + |
| 33 | + def api(self, action, **kwargs): |
| 34 | + assert action == "query" |
| 35 | + titles = kwargs["titles"].split("|") |
| 36 | + self.queries.append(titles) |
| 37 | + pages = {} |
| 38 | + for i, title in enumerate(titles): |
| 39 | + reported = self.normalized.get(title, title) |
| 40 | + if title in self.missing_titles: |
| 41 | + pages[str(-(i + 1))] = {"title": reported, "missing": ""} |
| 42 | + else: |
| 43 | + pages[str(i + 1)] = {"title": reported, "pageid": i + 1} |
| 44 | + query = {"pages": pages} |
| 45 | + if self.normalized: |
| 46 | + query["normalized"] = [ |
| 47 | + {"from": k, "to": v} for k, v in self.normalized.items() |
| 48 | + ] |
| 49 | + return {"query": query} |
| 50 | + |
| 51 | + |
| 52 | +class _FakeSite: |
| 53 | + def __init__(self, mw_site): |
| 54 | + self.mw_site = mw_site |
| 55 | + |
| 56 | + |
| 57 | +@pytest.fixture |
| 58 | +def offline_osw(monkeypatch): |
| 59 | + """An OSW that never touches the network, with a controllable existence query.""" |
| 60 | + monkeypatch.setattr(WtPage, "init", lambda self: setattr(self, "exists", False)) |
| 61 | + monkeypatch.setattr( |
| 62 | + OSW, "_apply_overwrite_policy", staticmethod(lambda param: param.page) |
| 63 | + ) |
| 64 | + monkeypatch.setattr(WtPage, "edit", lambda self, *a, **kw: None) |
| 65 | + |
| 66 | + def _make(missing_titles=(), normalized=None): |
| 67 | + mw_site = _FakeMwSite(missing_titles, normalized) |
| 68 | + return OSW.construct(site=_FakeSite(mw_site)), mw_site |
| 69 | + |
| 70 | + return _make |
| 71 | + |
| 72 | + |
| 73 | +def test_absent_page_is_reported_as_failed(offline_osw): |
| 74 | + item = model.Item(label=[model.Label(text="Ghost")]) |
| 75 | + title = _title(item) |
| 76 | + osw_obj, _mw_site = offline_osw(missing_titles=[title]) |
| 77 | + |
| 78 | + with pytest.raises(OSW.StoreEntityPartialError) as exc_info: |
| 79 | + osw_obj.store_entity(OSW.StoreEntityParam(entities=[item], parallel=False)) |
| 80 | + |
| 81 | + err = exc_info.value |
| 82 | + assert title in err.failed |
| 83 | + assert isinstance(err.failed[title], OSW.PageNotCreatedError) |
| 84 | + assert err.failed[title].title == title |
| 85 | + assert title not in err.result.pages |
| 86 | + assert err.stored == [] |
| 87 | + |
| 88 | + |
| 89 | +def test_present_page_is_reported_as_stored(offline_osw): |
| 90 | + item = model.Item(label=[model.Label(text="Real")]) |
| 91 | + title = _title(item) |
| 92 | + osw_obj, mw_site = offline_osw() |
| 93 | + |
| 94 | + result = osw_obj.store_entity(OSW.StoreEntityParam(entities=[item], parallel=False)) |
| 95 | + |
| 96 | + assert set(result.pages.keys()) == {title} |
| 97 | + assert result.failed == {} |
| 98 | + assert mw_site.queries == [[title]] |
| 99 | + |
| 100 | + |
| 101 | +def test_only_the_absent_page_of_a_batch_is_reported(offline_osw): |
| 102 | + items = [model.Item(label=[model.Label(text=f"Batch{i}")]) for i in range(3)] |
| 103 | + titles = [_title(it) for it in items] |
| 104 | + osw_obj, _mw_site = offline_osw(missing_titles=[titles[1]]) |
| 105 | + |
| 106 | + with pytest.raises(OSW.StoreEntityPartialError) as exc_info: |
| 107 | + osw_obj.store_entity(OSW.StoreEntityParam(entities=items, parallel=True)) |
| 108 | + |
| 109 | + err = exc_info.value |
| 110 | + assert set(err.result.pages.keys()) == {titles[0], titles[2]} |
| 111 | + assert set(err.failed.keys()) == {titles[1]} |
| 112 | + |
| 113 | + |
| 114 | +def test_verification_is_skipped_when_disabled(offline_osw): |
| 115 | + item = model.Item(label=[model.Label(text="Unchecked")]) |
| 116 | + title = _title(item) |
| 117 | + osw_obj, mw_site = offline_osw(missing_titles=[title]) |
| 118 | + |
| 119 | + result = osw_obj.store_entity( |
| 120 | + OSW.StoreEntityParam(entities=[item], parallel=False, verify_write=False) |
| 121 | + ) |
| 122 | + |
| 123 | + assert mw_site.queries == [] |
| 124 | + assert set(result.pages.keys()) == {title} |
| 125 | + |
| 126 | + |
| 127 | +def test_verification_is_skipped_offline(offline_osw): |
| 128 | + item = model.Item(label=[model.Label(text="Offline")]) |
| 129 | + title = _title(item) |
| 130 | + osw_obj, mw_site = offline_osw(missing_titles=[title]) |
| 131 | + |
| 132 | + result = osw_obj.store_entity( |
| 133 | + OSW.StoreEntityParam(entities=[item], parallel=False, offline=True) |
| 134 | + ) |
| 135 | + |
| 136 | + assert mw_site.queries == [] |
| 137 | + assert set(result.pages.keys()) == {title} |
| 138 | + |
| 139 | + |
| 140 | +def test_titles_are_queried_in_batches_of_fifty(offline_osw): |
| 141 | + osw_obj, mw_site = offline_osw() |
| 142 | + titles = [f"Item:OSW{i:04d}" for i in range(120)] |
| 143 | + |
| 144 | + missing = osw_obj._get_missing_page_titles(titles) |
| 145 | + |
| 146 | + assert missing == [] |
| 147 | + assert [len(batch) for batch in mw_site.queries] == [50, 50, 20] |
| 148 | + |
| 149 | + |
| 150 | +def test_missing_titles_are_mapped_back_to_the_requested_form(offline_osw): |
| 151 | + requested = "Item:OSW_with_underscores" |
| 152 | + osw_obj, _mw_site = offline_osw( |
| 153 | + missing_titles=[requested], |
| 154 | + normalized={requested: "Item:OSW with underscores"}, |
| 155 | + ) |
| 156 | + |
| 157 | + assert osw_obj._get_missing_page_titles([requested]) == [requested] |
0 commit comments