have a general populate() to fill some data in

Especially with all the "list" commands, we now see that we always have
to put some data into the instance. This is cumbersome, especially as we
get to the track commands. Therefore, I added a method to put some data
into the instance -- that also helps to ensure that we properly cascade
things if we delete a user, for example.

Currently, this method only adds two users and two tracks, but I plan to
also add comments and friendship associations.

Further, we can think about re-writing the playwright tests to use this
population as well, instead of the playwright_helper one.

1 files changed, 126 insertions, 0 deletions

diff --git a/tests/testutils.py b/tests/testutils.py
index 810bdf7..9db3673 100644
--- a/tests/testutils.py
+++ b/tests/testutils.py
@@ -1,8 +1,34 @@
 """Various utility functions for testing."""
+import datetime
 import gzip
+import io
 from pathlib import Path
+from typing import NamedTuple
 
 from playwright.sync_api import Page
+from sqlalchemy import Engine
+from sqlalchemy.orm import Session
+
+from fietsboek import convert, models, util
+from fietsboek.data import DataManager
+
+
+class PopulationIds(NamedTuple):
+    """Collection of database IDs that :func:`populate` returns."""
+    jon: int
+    davos: int
+
+
+def load_test_asset(filename: str) -> bytes:
+    """Load a test asset.
+
+    Unlike :func:`load_gpx_asset`, this function does not do gzip decompression.
+
+    :param filkename: Name of the asset to load.
+    :return: The content of the file as bytes.
+    """
+    asset_dir = Path(__file__).parent / "assets"
+    return (asset_dir / filename).read_bytes()
 
 
 def load_gpx_asset(filename: str) -> bytes:
@@ -36,3 +62,103 @@ def extract_and_upload(page: Page, filename: str, tmp_path: Path):
     page.get_by_label("GPX file").set_input_files(gpx_path)
 
     page.locator(".bi-upload").click()
+
+
+def populate(dbengine: Engine, data_manager: DataManager) -> PopulationIds:
+    """Populates the database and data directory with some test data."""
+    user_ids = []
+    with Session(dbengine) as session:
+        user = models.User(name="Jon", email="jon.snow@nw.org", is_verified=True, is_admin=True)
+        user.set_password("ygritte")
+        user.roll_session_secret()
+        session.add(user)
+        session.flush()
+        user_ids.append(user.id)
+
+        user = models.User(name="Davos", email="davos@seaworth.com", is_verified=True)
+        user.set_password("123456")
+        user.roll_session_secret()
+        session.add(user)
+        session.flush()
+        user_ids.append(user.id)
+
+        session.commit()
+
+    for user_id in user_ids:
+        data_manager.initialize_user(user_id)
+
+    # First track for Jon:
+
+    gpx_data = load_gpx_asset("Teasi_1.gpx.gz")
+    track = convert.smart_convert(gpx_data)
+    path = track.path()
+    track.points = []
+    track.owner_id = user_ids[0]
+    track.title = "Trip around Winterfell"
+    track.visibility = models.track.Visibility.PUBLIC
+    track.type = models.track.TrackType.ORGANIC
+    track.description = "I took my sister for a quick trip around Winterfell"
+    track.badges = []
+    track.link_secret = util.random_link_secret()
+    track.tagged_people = []
+    track.date = datetime.datetime(1984, 1, 2, 10, 11, tzinfo=datetime.UTC)
+    track.transformers = []
+    track.sync_tags({"westeros"})
+
+    with Session(dbengine) as session:
+        session.add(track)
+        session.flush()
+
+        assert track.id is not None
+        manager = data_manager.initialize(track.id)
+        manager.compress_backup(gpx_data)
+
+        track.fast_set_path(path)
+        track.ensure_cache(path)
+        session.add(track.cache)
+
+        image_name = manager.add_image(io.BytesIO(load_test_asset("picture01.jpg")), "PIC001.jpg")
+        image_meta = models.ImageMetadata(track=track, image_name=image_name)
+        image_meta.description = "Beautiful sight out of the Hunter's Gate"
+        session.add(image_meta)
+
+        image_name = manager.add_image(io.BytesIO(load_test_asset("picture02.jpg")), "PIC002.jpg")
+        image_meta = models.ImageMetadata(track=track, image_name=image_name)
+        image_meta.description = "Our steel wire horses ready to gallop"
+        session.add(image_meta)
+
+        session.commit()
+
+    # Second track for Jon:
+
+    gpx_data = load_gpx_asset("MyTourbook_1.gpx.gz")
+    track = convert.smart_convert(gpx_data)
+    path = track.path()
+    track.points = []
+    track.owner_id = user_ids[0]
+    track.title = "Road to Riverrun"
+    track.visibility = models.track.Visibility.PUBLIC
+    track.type = models.track.TrackType.ORGANIC
+    track.description = "Got a wedding to attend!"
+    track.badges = []
+    track.link_secret = util.random_link_secret()
+    track.tagged_people = []
+    track.date = datetime.datetime(1985, 8, 5, 16, 41, tzinfo=datetime.UTC)
+    track.transformers = []
+    track.sync_tags({"westeros"})
+
+    with Session(dbengine) as session:
+        session.add(track)
+        session.flush()
+
+        assert track.id is not None
+        manager = data_manager.initialize(track.id)
+        manager.compress_backup(gpx_data)
+
+        track.fast_set_path(path)
+        track.ensure_cache(path)
+        session.add(track.cache)
+
+        session.commit()
+
+    return PopulationIds(jon=user_ids[0], davos=user_ids[1])