From 734901747b95537d7537ca1533f1b06e8d29e8d0 Mon Sep 17 00:00:00 2001
From: Nicolas Dandrimont <nicolas@dandrimont.eu>
Date: Mon, 7 Dec 2020 18:12:15 +0100
Subject: [PATCH] Implement a base pattern for listers with no state storage

---
 swh/lister/pattern.py            | 10 +++++++
 swh/lister/tests/test_pattern.py | 50 ++++++++++++++++++++++++++++++++
 2 files changed, 60 insertions(+)

diff --git a/swh/lister/pattern.py b/swh/lister/pattern.py
index e8f359d..3eaa498 100644
--- a/swh/lister/pattern.py
+++ b/swh/lister/pattern.py
@@ -258,3 +258,13 @@ class Lister(Generic[StateType, PageType]):
         """
         config = load_from_envvar()
         return cls.from_config(**config, **kwargs)
+
+
+class StatelessLister(Lister[None, PageType], Generic[PageType]):
+    def state_from_dict(self, d: BackendStateType) -> None:
+        """Always return empty state"""
+        return None
+
+    def state_to_dict(self, state: None) -> BackendStateType:
+        """Always set empty state"""
+        return {}
diff --git a/swh/lister/tests/test_pattern.py b/swh/lister/tests/test_pattern.py
index ae82257..9eacfc9 100644
--- a/swh/lister/tests/test_pattern.py
+++ b/swh/lister/tests/test_pattern.py
@@ -111,3 +111,53 @@ def test_run(swh_scheduler):
     assert stored_lister.current_state["updated"] == "yes"
 
     check_listed_origins(swh_scheduler, lister, stored_lister)
+
+
+class InstantiableStatelessLister(pattern.StatelessLister[PageType]):
+    LISTER_NAME = "test-stateless-lister"
+
+
+def test_stateless_instantiation(swh_scheduler):
+    lister = InstantiableStatelessLister(
+        scheduler=swh_scheduler, url="https://example.com", instance="example.com",
+    )
+
+    # check the lister was registered in the scheduler backend
+    stored_lister = swh_scheduler.get_or_create_lister(
+        name="test-stateless-lister", instance_name="example.com"
+    )
+    assert stored_lister == lister.lister_obj
+    assert stored_lister.current_state == {}
+    assert lister.state is None
+
+    with pytest.raises(NotImplementedError):
+        lister.run()
+
+
+class RunnableStatelessLister(ListerMixin, InstantiableStatelessLister):
+    def finalize(self):
+        self.updated = True
+
+
+def test_stateless_run(swh_scheduler):
+    lister = RunnableStatelessLister(
+        scheduler=swh_scheduler, url="https://example.com", instance="example.com"
+    )
+
+    update_date = lister.lister_obj.updated
+
+    run_result = lister.run()
+
+    assert run_result.pages == 2
+    assert run_result.origins == 20
+
+    stored_lister = swh_scheduler.get_or_create_lister(
+        name="test-stateless-lister", instance_name="example.com"
+    )
+
+    # Check that the finalize operation happened
+    assert stored_lister.updated > update_date
+    assert stored_lister.current_state == {}
+
+    # And that all origins are stored
+    check_listed_origins(swh_scheduler, lister, stored_lister)