reonokiy/swh-lister
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

lister: Allow lister to build url out of the instance parameter

Browse source 
This pushes the rather elementary logic within the lister's scope. This will simplify
and unify cli call between lister and scheduler clis. This will also allow to reduce
erroneous operations which can happen for example in the add-forge-now.

With the following, we will only have to provide the type and the instance, then
everything will be scheduled properly.

Refs. swh/devel/swh-lister#4693
This commit is contained in:
Antoine R. Dumont (@ardumont) 2023-05-19 11:04:26 +02:00
parent 596e8c6c40
commit 19bdeefb14
No known key found for this signature in database
GPG key ID: 52E2E9840D10C3B8
7 changed files with 100 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

9
swh/lister/gogs/lister.py
View file

@ -1,4 +1,4 @@
# Copyright (C) 2022 The Software Heritage developers
# Copyright (C) 2023 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information
@ -70,7 +70,7 @@ class GogsLister(Lister[GogsListerState, GogsListerPage]):
def __init__(
self,
scheduler: SchedulerInterface,
url: str,
url: Optional[str] = None,
instance: Optional[str] = None,
api_token: Optional[str] = None,
page_size: int = 50,
@ -111,6 +111,11 @@ class GogsLister(Lister[GogsListerState, GogsListerPage]):
"No authentication token set in configuration, using anonymous mode"
)
def build_url(self, instance: str) -> str:
"Build gogs url out of the instance."
prefix_url = super().build_url(instance)
return f"{prefix_url}/api/v1/"
def state_from_dict(self, d: Dict[str, Any]) -> GogsListerState:
return GogsListerState(**d)

18
swh/lister/gogs/tests/test_lister.py
View file

@ -1,4 +1,4 @@
# Copyright (C) 2022 The Software Heritage developers
# Copyright (C) 2022-2023 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information
@ -99,13 +99,23 @@ def check_listed_origins(lister_urls: List[str], scheduler_origins: List[ListedO
assert set(lister_urls) == {origin.url for origin in scheduler_origins}
def test_lister_gogs_fail_to_instantiate(swh_scheduler):
"""Build a lister without its url nor its instance should raise"""
# while instantiating a gogs lister is fine with the url or the instance...
assert GogsLister(swh_scheduler, url="https://try.gogs.io/api/v1") is not None
assert GogsLister(swh_scheduler, instance="try.gogs.io") is not None
# ... It will raise without any of those
with pytest.raises(ValueError, match="'url' or 'instance'"):
GogsLister(swh_scheduler)
def test_gogs_full_listing(
swh_scheduler, requests_mock, mocker, trygogs_p1, trygogs_p2, trygogs_p3_last
):
kwargs = dict(
url=TRY_GOGS_URL, instance="try_gogs", page_size=3, api_token="secret"
)
kwargs = dict(instance="try.gogs.io", page_size=3, api_token="secret")
lister = GogsLister(scheduler=swh_scheduler, **kwargs)
assert lister.url == TRY_GOGS_URL
lister.get_origins_from_page: Mock = mocker.spy(lister, "get_origins_from_page")