Files
linkding/bookmarks/tests_e2e/e2e_test_new_bookmark_form.py
2025-03-22 12:16:48 +01:00

314 lines
13 KiB
Python

from unittest.mock import patch
from urllib.parse import quote
from django.urls import reverse
from playwright.sync_api import sync_playwright, expect
from bookmarks.tests_e2e.helpers import LinkdingE2ETestCase
from bookmarks.services import website_loader
mock_website_metadata = website_loader.WebsiteMetadata(
url="https://example.com",
title="Example Domain",
description="This domain is for use in illustrative examples in documents. You may use this domain in literature without prior coordination or asking for permission.",
preview_image=None,
)
class BookmarkFormE2ETestCase(LinkdingE2ETestCase):
def setUp(self) -> None:
super().setUp()
self.website_loader_patch = patch.object(
website_loader, "load_website_metadata", return_value=mock_website_metadata
)
self.website_loader_mock = self.website_loader_patch.start()
def tearDown(self) -> None:
super().tearDown()
self.website_loader_patch.stop()
def test_enter_url_prefills_title_and_description(self):
with sync_playwright() as p:
page = self.open(reverse("linkding:bookmarks.new"), p)
url = page.get_by_label("URL")
title = page.get_by_label("Title")
description = page.get_by_label("Description")
url.fill("https://example.com")
expect(title).to_have_value("Example Domain")
expect(description).to_have_value(
"This domain is for use in illustrative examples in documents. You may use this domain in literature without prior coordination or asking for permission."
)
def test_enter_url_does_not_overwrite_modified_title_and_description(self):
with sync_playwright() as p:
page = self.open(reverse("linkding:bookmarks.new"), p)
url = page.get_by_label("URL")
title = page.get_by_label("Title")
description = page.get_by_label("Description")
title.fill("Modified title")
description.fill("Modified description")
url.fill("https://example.com")
page.wait_for_timeout(timeout=1000)
expect(title).to_have_value("Modified title")
expect(description).to_have_value("Modified description")
def test_with_initial_url_prefills_title_and_description(self):
with sync_playwright() as p:
page_url = (
reverse("linkding:bookmarks.new")
+ f"?url={quote('https://example.com')}"
)
page = self.open(page_url, p)
url = page.get_by_label("URL")
title = page.get_by_label("Title")
description = page.get_by_label("Description")
page.wait_for_timeout(timeout=1000)
expect(url).to_have_value("https://example.com")
expect(title).to_have_value("Example Domain")
expect(description).to_have_value(
"This domain is for use in illustrative examples in documents. You may use this domain in literature without prior coordination or asking for permission."
)
def test_with_initial_url_title_description_does_not_overwrite_title_and_description(
self,
):
with sync_playwright() as p:
page_url = (
reverse("linkding:bookmarks.new")
+ f"?url={quote('https://example.com')}&title=Initial+title&description=Initial+description"
)
page = self.open(page_url, p)
url = page.get_by_label("URL")
title = page.get_by_label("Title")
description = page.get_by_label("Description")
page.wait_for_timeout(timeout=1000)
expect(url).to_have_value("https://example.com")
expect(title).to_have_value("Initial title")
expect(description).to_have_value("Initial description")
def test_create_should_check_for_existing_bookmark(self):
existing_bookmark = self.setup_bookmark(
title="Existing title",
description="Existing description",
notes="Existing notes",
tags=[self.setup_tag(name="tag1"), self.setup_tag(name="tag2")],
unread=True,
)
tag_names = " ".join(existing_bookmark.tag_names)
with sync_playwright() as p:
page = self.open(reverse("linkding:bookmarks.new"), p)
# Enter bookmarked URL
page.get_by_label("URL").fill(existing_bookmark.url)
# Already bookmarked hint should be visible
page.get_by_text("This URL is already bookmarked.").wait_for(timeout=2000)
# Form should be pre-filled with data from existing bookmark
self.assertEqual(
existing_bookmark.title, page.get_by_label("Title").input_value()
)
self.assertEqual(
existing_bookmark.description,
page.get_by_label("Description").input_value(),
)
self.assertEqual(
existing_bookmark.notes, page.get_by_label("Notes").input_value()
)
self.assertEqual(tag_names, page.get_by_label("Tags").input_value())
self.assertTrue(tag_names, page.get_by_label("Mark as unread").is_checked())
# Enter non-bookmarked URL
page.get_by_label("URL").fill("https://example.com/unknown")
# Already bookmarked hint should be hidden
page.get_by_text("This URL is already bookmarked.").wait_for(
state="hidden", timeout=2000
)
def test_enter_url_of_existing_bookmark_should_show_notes(self):
bookmark = self.setup_bookmark(
notes="Existing notes", description="Existing description"
)
with sync_playwright() as p:
page = self.open(reverse("linkding:bookmarks.new"), p)
details = page.locator("details.notes")
expect(details).not_to_have_attribute("open", value="")
page.get_by_label("URL").fill(bookmark.url)
expect(details).to_have_attribute("open", value="")
def test_create_should_preview_auto_tags(self):
profile = self.get_or_create_test_user().profile
profile.auto_tagging_rules = "github.com dev github"
profile.save()
with sync_playwright() as p:
# Open page with URL that should have auto tags
url = (
reverse("linkding:bookmarks.new")
+ "?url=https%3A%2F%2Fgithub.com%2Fsissbruecker%2Flinkding"
)
page = self.open(url, p)
auto_tags_hint = page.locator(".form-input-hint.auto-tags")
expect(auto_tags_hint).to_be_visible()
expect(auto_tags_hint).to_have_text("Auto tags: dev github")
# Change to URL without auto tags
page.get_by_label("URL").fill("https://example.com")
expect(auto_tags_hint).to_be_hidden()
def test_clear_buttons_only_shown_when_fields_have_content(self):
with sync_playwright() as p:
page = self.open(reverse("linkding:bookmarks.new"), p)
title_field = page.get_by_label("Title")
title_clear_button = page.locator("[ld-clear-button][data-for='id_title']")
description_field = page.get_by_label("Description")
description_clear_button = page.locator(
"[ld-clear-button][data-for='id_description']"
)
# Initially, clear buttons should be hidden because fields are empty
expect(title_clear_button).to_be_hidden()
expect(description_clear_button).to_be_hidden()
# Add content to title field, its clear button should become visible
title_field.fill("Test title")
expect(title_clear_button).to_be_visible()
# Add content to description field, its clear button should become visible
description_field.fill("Test description")
expect(description_clear_button).to_be_visible()
# Clear title field, its clear button should be hidden again
title_field.fill("")
expect(title_clear_button).to_be_hidden()
# Clear description field, its clear button should be hidden again
description_field.fill("")
expect(description_clear_button).to_be_hidden()
def test_refresh_button_only_shown_for_existing_bookmarks(self):
existing_bookmark = self.setup_bookmark(
title="Existing title", description="Existing description"
)
with sync_playwright() as p:
page = self.open(reverse("linkding:bookmarks.new"), p)
refresh_button = page.locator("#refresh-button")
# Initially, refresh button should be hidden
expect(refresh_button).to_be_hidden()
# Enter a URL that is not bookmarked yet
page.get_by_label("URL").fill("https://example.com/not-bookmarked")
page.wait_for_timeout(timeout=1000)
expect(refresh_button).to_be_hidden()
# Enter a URL that is already bookmarked
page.get_by_label("URL").fill(existing_bookmark.url)
expect(refresh_button).to_be_visible()
# Change back to non-bookmarked URL
page.get_by_label("URL").fill("https://example.com/another-not-bookmarked")
expect(refresh_button).to_be_hidden()
def test_refresh_from_website_button_updates_title_and_description(self):
existing_bookmark = self.setup_bookmark(
title="Existing title", description="Existing description"
)
with sync_playwright() as p:
page = self.open(reverse("linkding:bookmarks.new"), p)
url_field = page.get_by_label("URL")
title_field = page.get_by_label("Title")
description_field = page.get_by_label("Description")
refresh_button = page.locator("#refresh-button")
# Enter the URL of the existing bookmark to make refresh button visible
url_field.fill(existing_bookmark.url)
# Wait for metadata to be loaded and for refresh button to be visible
expect(refresh_button).to_be_visible()
expect(title_field).to_have_value("Existing title")
expect(description_field).to_have_value("Existing description")
# Update the mock to return different metadata when refresh is requested
self.website_loader_mock.reset_mock()
self.website_loader_mock.return_value = website_loader.WebsiteMetadata(
url="https://example.com",
title="Updated Example Domain",
description="This is a refreshed description for the example domain.",
preview_image=None,
)
# Click the refresh button
refresh_button.click()
# Verify that title and description have been updated with new values
expect(title_field).to_have_value("Updated Example Domain")
expect(description_field).to_have_value(
"This is a refreshed description for the example domain."
)
# Verify that the fields are visually marked as modified
expect(title_field).to_have_class("form-input modified")
expect(description_field).to_have_class("form-input modified")
def test_refresh_from_website_button_does_not_modify_fields_if_metadata_is_same(
self,
):
existing_bookmark = self.setup_bookmark(
title="Existing title", description="Existing description"
)
with sync_playwright() as p:
page = self.open(reverse("linkding:bookmarks.new"), p)
url_field = page.get_by_label("URL")
title_field = page.get_by_label("Title")
description_field = page.get_by_label("Description")
refresh_button = page.locator("#refresh-button")
# Enter the URL of the existing bookmark to make refresh button visible
url_field.fill(existing_bookmark.url)
# Wait for metadata to be loaded and for refresh button to be visible
expect(refresh_button).to_be_visible()
expect(title_field).to_have_value("Existing title")
expect(description_field).to_have_value("Existing description")
# Update the mock to return same metadata when refresh is requested
self.website_loader_mock.reset_mock()
self.website_loader_mock.return_value = website_loader.WebsiteMetadata(
url="https://example.com",
title="Existing title",
description="Existing description",
preview_image=None,
)
# Click the refresh button
refresh_button.click()
page.wait_for_timeout(timeout=1000)
# Verify that title and description values are still the same
expect(title_field).to_have_value("Existing title")
expect(description_field).to_have_value("Existing description")
# Verify that the fields are NOT visually marked as modified
expect(title_field).to_have_class("form-input")
expect(description_field).to_have_class("form-input")