Add query tests

bookmarks/tests/helpers.py

@@ -1,3 +1,5 @@
+import random
+
 from django.contrib.auth.models import User
 from django.utils import timezone
 from django.utils.crypto import get_random_string
@@ -20,17 +22,25 @@ class BookmarkFactoryMixin:
                        is_archived: bool = False,
                        tags=None,
                        user: User = None,
+                       url: str = '',
                        title: str = '',
-                       description: str = ''):
+                       description: str = '',
+                       website_title: str = '',
+                       website_description: str = '',
+                       ):
         if tags is None:
             tags = []
         if user is None:
             user = self.get_or_create_test_user()
-        unique_id = get_random_string(length=32)
+        if not url:
+            unique_id = get_random_string(length=32)
+            url = 'https://example.com/' + unique_id
         bookmark = Bookmark(
-            url='https://example.com/' + unique_id,
+            url=url,
             title=title,
             description=description,
+            website_title=website_title,
+            website_description=website_description,
             date_added=timezone.now(),
             date_modified=timezone.now(),
             owner=user,
@@ -42,10 +52,11 @@ class BookmarkFactoryMixin:
         bookmark.save()
         return bookmark
 
-    def setup_tag(self, user: User = None):
+    def setup_tag(self, user: User = None, name: str = ''):
         if user is None:
             user = self.get_or_create_test_user()
-        name = get_random_string(length=32)
+        if not name:
+            name = get_random_string(length=32)
         tag = Tag(name=name, date_added=timezone.now(), owner=user)
         tag.save()
         return tag
@@ -71,3 +82,38 @@ class LinkdingApiTestCase(APITestCase):
         response = self.client.delete(url)
         self.assertEqual(response.status_code, expected_status_code)
         return response
+
+
+_words = [
+    'quasi',
+    'consequatur',
+    'necessitatibus',
+    'debitis',
+    'quod',
+    'vero',
+    'qui',
+    'commodi',
+    'quod',
+    'odio',
+    'aliquam',
+    'veniam',
+    'architecto',
+    'consequatur',
+    'autem',
+    'qui',
+    'iste',
+    'asperiores',
+    'soluta',
+    'et',
+]
+
+
+def random_sentence(num_words: int = None, including_word: str = ''):
+    if num_words is None:
+        num_words = random.randint(5, 10)
+    selected_words = random.choices(_words, k=num_words)
+    if including_word:
+        selected_words.append(including_word)
+    random.shuffle(selected_words)
+
+    return ' '.join(selected_words)

bookmarks/tests/test_queries.py

@@ -1,14 +1,209 @@
+import operator
+
 from django.contrib.auth import get_user_model
+from django.db.models import QuerySet
 from django.test import TestCase
 
 from bookmarks import queries
-from bookmarks.tests.helpers import BookmarkFactoryMixin
+from bookmarks.models import Bookmark
+from bookmarks.tests.helpers import BookmarkFactoryMixin, random_sentence
+from bookmarks.utils import unique
 
 User = get_user_model()
 
 
 class QueriesTestCase(TestCase, BookmarkFactoryMixin):
 
+    def setup_bookmark_search_data(self) -> None:
+        tag1 = self.setup_tag(name='tag1')
+        tag2 = self.setup_tag(name='tag2')
+
+        self.other_bookmarks = [
+            self.setup_bookmark(),
+            self.setup_bookmark(),
+            self.setup_bookmark(),
+        ]
+        self.term1_bookmarks = [
+            self.setup_bookmark(url='http://example.com/term1'),
+            self.setup_bookmark(title=random_sentence(including_word='term1')),
+            self.setup_bookmark(description=random_sentence(including_word='term1')),
+            self.setup_bookmark(website_title=random_sentence(including_word='term1')),
+            self.setup_bookmark(website_description=random_sentence(including_word='term1')),
+        ]
+        self.term1_term2_bookmarks = [
+            self.setup_bookmark(url='http://example.com/term1/term2'),
+            self.setup_bookmark(title=random_sentence(including_word='term1'),
+                                description=random_sentence(including_word='term2')),
+            self.setup_bookmark(description=random_sentence(including_word='term1'),
+                                title=random_sentence(including_word='term2')),
+            self.setup_bookmark(website_title=random_sentence(including_word='term1'),
+                                title=random_sentence(including_word='term2')),
+            self.setup_bookmark(website_description=random_sentence(including_word='term1'),
+                                title=random_sentence(including_word='term2')),
+        ]
+        self.tag1_bookmarks = [
+            self.setup_bookmark(tags=[tag1]),
+            self.setup_bookmark(title=random_sentence(), tags=[tag1]),
+            self.setup_bookmark(description=random_sentence(), tags=[tag1]),
+            self.setup_bookmark(website_title=random_sentence(), tags=[tag1]),
+            self.setup_bookmark(website_description=random_sentence(), tags=[tag1]),
+        ]
+        self.term1_tag1_bookmarks = [
+            self.setup_bookmark(url='http://example.com/term1', tags=[tag1]),
+            self.setup_bookmark(title=random_sentence(including_word='term1'), tags=[tag1]),
+            self.setup_bookmark(description=random_sentence(including_word='term1'), tags=[tag1]),
+            self.setup_bookmark(website_title=random_sentence(including_word='term1'), tags=[tag1]),
+            self.setup_bookmark(website_description=random_sentence(including_word='term1'), tags=[tag1]),
+        ]
+        self.tag2_bookmarks = [
+            self.setup_bookmark(tags=[tag2]),
+        ]
+        self.tag1_tag2_bookmarks = [
+            self.setup_bookmark(tags=[tag1, tag2]),
+        ]
+
+    def setup_tag_search_data(self):
+        tag1 = self.setup_tag(name='tag1')
+        tag2 = self.setup_tag(name='tag2')
+
+        self.other_bookmarks = [
+            self.setup_bookmark(tags=[self.setup_tag()]),
+            self.setup_bookmark(tags=[self.setup_tag()]),
+            self.setup_bookmark(tags=[self.setup_tag()]),
+        ]
+        self.term1_bookmarks = [
+            self.setup_bookmark(url='http://example.com/term1', tags=[self.setup_tag()]),
+            self.setup_bookmark(title=random_sentence(including_word='term1'), tags=[self.setup_tag()]),
+            self.setup_bookmark(description=random_sentence(including_word='term1'), tags=[self.setup_tag()]),
+            self.setup_bookmark(website_title=random_sentence(including_word='term1'), tags=[self.setup_tag()]),
+            self.setup_bookmark(website_description=random_sentence(including_word='term1'), tags=[self.setup_tag()]),
+        ]
+        self.term1_term2_bookmarks = [
+            self.setup_bookmark(url='http://example.com/term1/term2', tags=[self.setup_tag()]),
+            self.setup_bookmark(title=random_sentence(including_word='term1'),
+                                description=random_sentence(including_word='term2'),
+                                tags=[self.setup_tag()]),
+            self.setup_bookmark(description=random_sentence(including_word='term1'),
+                                title=random_sentence(including_word='term2'),
+                                tags=[self.setup_tag()]),
+            self.setup_bookmark(website_title=random_sentence(including_word='term1'),
+                                title=random_sentence(including_word='term2'),
+                                tags=[self.setup_tag()]),
+            self.setup_bookmark(website_description=random_sentence(including_word='term1'),
+                                title=random_sentence(including_word='term2'),
+                                tags=[self.setup_tag()]),
+        ]
+        self.tag1_bookmarks = [
+            self.setup_bookmark(tags=[tag1, self.setup_tag()]),
+            self.setup_bookmark(title=random_sentence(), tags=[tag1, self.setup_tag()]),
+            self.setup_bookmark(description=random_sentence(), tags=[tag1, self.setup_tag()]),
+            self.setup_bookmark(website_title=random_sentence(), tags=[tag1, self.setup_tag()]),
+            self.setup_bookmark(website_description=random_sentence(), tags=[tag1, self.setup_tag()]),
+        ]
+        self.term1_tag1_bookmarks = [
+            self.setup_bookmark(url='http://example.com/term1', tags=[tag1, self.setup_tag()]),
+            self.setup_bookmark(title=random_sentence(including_word='term1'), tags=[tag1, self.setup_tag()]),
+            self.setup_bookmark(description=random_sentence(including_word='term1'), tags=[tag1, self.setup_tag()]),
+            self.setup_bookmark(website_title=random_sentence(including_word='term1'), tags=[tag1, self.setup_tag()]),
+            self.setup_bookmark(website_description=random_sentence(including_word='term1'),
+                                tags=[tag1, self.setup_tag()]),
+        ]
+        self.tag2_bookmarks = [
+            self.setup_bookmark(tags=[tag2, self.setup_tag()]),
+        ]
+        self.tag1_tag2_bookmarks = [
+            self.setup_bookmark(tags=[tag1, tag2, self.setup_tag()]),
+        ]
+
+    def get_tags_from_bookmarks(self, bookmarks: [Bookmark]):
+        all_tags = []
+        for bookmark in bookmarks:
+            all_tags = all_tags + list(bookmark.tags.all())
+        return all_tags
+
+    def assertQueryResult(self, query: QuerySet, item_lists: [[any]]):
+        expected_items = []
+        for item_list in item_lists:
+            expected_items = expected_items + item_list
+
+        expected_items = unique(expected_items, operator.attrgetter('id'))
+
+        self.assertCountEqual(list(query), expected_items)
+
+    def test_query_bookmarks_should_return_all_for_empty_query(self):
+        self.setup_bookmark_search_data()
+
+        query = queries.query_bookmarks(self.get_or_create_test_user(), '')
+        self.assertQueryResult(query, [
+            self.other_bookmarks,
+            self.term1_bookmarks,
+            self.term1_term2_bookmarks,
+            self.tag1_bookmarks,
+            self.term1_tag1_bookmarks,
+            self.tag2_bookmarks,
+            self.tag1_tag2_bookmarks
+        ])
+
+    def test_query_bookmarks_should_search_single_term(self):
+        self.setup_bookmark_search_data()
+
+        query = queries.query_bookmarks(self.get_or_create_test_user(), 'term1')
+        self.assertQueryResult(query, [
+            self.term1_bookmarks,
+            self.term1_term2_bookmarks,
+            self.term1_tag1_bookmarks
+        ])
+
+    def test_query_bookmarks_should_search_multiple_terms(self):
+        self.setup_bookmark_search_data()
+
+        query = queries.query_bookmarks(self.get_or_create_test_user(), 'term2 term1')
+
+        self.assertQueryResult(query, [self.term1_term2_bookmarks])
+
+    def test_query_bookmarks_should_search_single_tag(self):
+        self.setup_bookmark_search_data()
+
+        query = queries.query_bookmarks(self.get_or_create_test_user(), '#tag1')
+
+        self.assertQueryResult(query, [self.tag1_bookmarks, self.tag1_tag2_bookmarks, self.term1_tag1_bookmarks])
+
+    def test_query_bookmarks_should_search_multiple_tags(self):
+        self.setup_bookmark_search_data()
+
+        query = queries.query_bookmarks(self.get_or_create_test_user(), '#tag1 #tag2')
+
+        self.assertQueryResult(query, [self.tag1_tag2_bookmarks])
+
+    def test_query_bookmarks_should_search_multiple_tags_ignoring_casing(self):
+        self.setup_bookmark_search_data()
+
+        query = queries.query_bookmarks(self.get_or_create_test_user(), '#Tag1 #TAG2')
+
+        self.assertQueryResult(query, [self.tag1_tag2_bookmarks])
+
+    def test_query_bookmarks_should_search_terms_and_tags_combined(self):
+        self.setup_bookmark_search_data()
+
+        query = queries.query_bookmarks(self.get_or_create_test_user(), 'term1 #tag1')
+
+        self.assertQueryResult(query, [self.term1_tag1_bookmarks])
+
+    def test_query_bookmarks_should_return_no_matches(self):
+        self.setup_bookmark_search_data()
+
+        query = queries.query_bookmarks(self.get_or_create_test_user(), 'term3')
+        self.assertQueryResult(query, [])
+
+        query = queries.query_bookmarks(self.get_or_create_test_user(), 'term1 term3')
+        self.assertQueryResult(query, [])
+
+        query = queries.query_bookmarks(self.get_or_create_test_user(), 'term1 #tag2')
+        self.assertQueryResult(query, [])
+
+        query = queries.query_bookmarks(self.get_or_create_test_user(), '#tag3')
+        self.assertQueryResult(query, [])
+
     def test_query_bookmarks_should_not_return_archived_bookmarks(self):
         bookmark1 = self.setup_bookmark()
         bookmark2 = self.setup_bookmark()
@@ -18,7 +213,7 @@ class QueriesTestCase(TestCase, BookmarkFactoryMixin):
 
         query = queries.query_bookmarks(self.get_or_create_test_user(), '')
 
-        self.assertCountEqual([bookmark1, bookmark2], list(query))
+        self.assertQueryResult(query, [[bookmark1, bookmark2]])
 
     def test_query_archived_bookmarks_should_not_return_unarchived_bookmarks(self):
         bookmark1 = self.setup_bookmark(is_archived=True)
@@ -29,7 +224,144 @@ class QueriesTestCase(TestCase, BookmarkFactoryMixin):
 
         query = queries.query_archived_bookmarks(self.get_or_create_test_user(), '')
 
-        self.assertCountEqual([bookmark1, bookmark2], list(query))
+        self.assertQueryResult(query, [[bookmark1, bookmark2]])
+
+    def test_query_bookmarks_should_only_return_user_owned_bookmarks(self):
+        other_user = User.objects.create_user('otheruser', 'otheruser@example.com', 'password123')
+        owned_bookmarks = [
+            self.setup_bookmark(),
+            self.setup_bookmark(),
+            self.setup_bookmark(),
+        ]
+        self.setup_bookmark(user=other_user)
+        self.setup_bookmark(user=other_user)
+        self.setup_bookmark(user=other_user)
+
+        query = queries.query_bookmarks(self.user, '')
+
+        self.assertQueryResult(query, [owned_bookmarks])
+
+    def test_query_archived_bookmarks_should_only_return_user_owned_bookmarks(self):
+        other_user = User.objects.create_user('otheruser', 'otheruser@example.com', 'password123')
+        owned_bookmarks = [
+            self.setup_bookmark(is_archived=True),
+            self.setup_bookmark(is_archived=True),
+            self.setup_bookmark(is_archived=True),
+        ]
+        self.setup_bookmark(is_archived=True, user=other_user)
+        self.setup_bookmark(is_archived=True, user=other_user)
+        self.setup_bookmark(is_archived=True, user=other_user)
+
+        query = queries.query_archived_bookmarks(self.user, '')
+
+        self.assertQueryResult(query, [owned_bookmarks])
+
+    def test_query_bookmarks_should_use_tag_projection(self):
+        self.setup_bookmark_search_data()
+
+        # Test projection on bookmarks with tags
+        query = queries.query_bookmarks(self.user, '#tag1 #tag2')
+
+        for bookmark in query:
+            self.assertEqual(bookmark.tag_count, 2)
+            self.assertEqual(bookmark.tag_string, 'tag1,tag2')
+            self.assertTrue(bookmark.tag_projection)
+
+        # Test projection on bookmarks without tags
+        query = queries.query_bookmarks(self.user, 'term2')
+
+        for bookmark in query:
+            self.assertEqual(bookmark.tag_count, 0)
+            self.assertEqual(bookmark.tag_string, None)
+            self.assertTrue(bookmark.tag_projection)
+
+    def test_query_bookmark_tags_should_return_all_tags_for_empty_query(self):
+        self.setup_tag_search_data()
+
+        query = queries.query_bookmark_tags(self.user, '')
+
+        self.assertQueryResult(query, [
+            self.get_tags_from_bookmarks(self.other_bookmarks),
+            self.get_tags_from_bookmarks(self.term1_bookmarks),
+            self.get_tags_from_bookmarks(self.term1_term2_bookmarks),
+            self.get_tags_from_bookmarks(self.tag1_bookmarks),
+            self.get_tags_from_bookmarks(self.term1_tag1_bookmarks),
+            self.get_tags_from_bookmarks(self.tag2_bookmarks),
+            self.get_tags_from_bookmarks(self.tag1_tag2_bookmarks),
+        ])
+
+    def test_query_bookmark_tags_should_search_single_term(self):
+        self.setup_tag_search_data()
+
+        query = queries.query_bookmark_tags(self.user, 'term1')
+
+        self.assertQueryResult(query, [
+            self.get_tags_from_bookmarks(self.term1_bookmarks),
+            self.get_tags_from_bookmarks(self.term1_term2_bookmarks),
+            self.get_tags_from_bookmarks(self.term1_tag1_bookmarks),
+        ])
+
+    def test_query_bookmark_tags_should_search_multiple_terms(self):
+        self.setup_tag_search_data()
+
+        query = queries.query_bookmark_tags(self.user, 'term2 term1')
+
+        self.assertQueryResult(query, [
+            self.get_tags_from_bookmarks(self.term1_term2_bookmarks),
+        ])
+
+    def test_query_bookmark_tags_should_search_single_tag(self):
+        self.setup_tag_search_data()
+
+        query = queries.query_bookmark_tags(self.user, '#tag1')
+
+        self.assertQueryResult(query, [
+            self.get_tags_from_bookmarks(self.tag1_bookmarks),
+            self.get_tags_from_bookmarks(self.term1_tag1_bookmarks),
+            self.get_tags_from_bookmarks(self.tag1_tag2_bookmarks),
+        ])
+
+    def test_query_bookmark_tags_should_search_multiple_tags(self):
+        self.setup_tag_search_data()
+
+        query = queries.query_bookmark_tags(self.user, '#tag1 #tag2')
+
+        self.assertQueryResult(query, [
+            self.get_tags_from_bookmarks(self.tag1_tag2_bookmarks),
+        ])
+
+    def test_query_bookmark_tags_should_search_multiple_tags_ignoring_casing(self):
+        self.setup_tag_search_data()
+
+        query = queries.query_bookmark_tags(self.user, '#Tag1 #TAG2')
+
+        self.assertQueryResult(query, [
+            self.get_tags_from_bookmarks(self.tag1_tag2_bookmarks),
+        ])
+
+    def test_query_bookmark_tags_should_search_term_and_tag_combined(self):
+        self.setup_tag_search_data()
+
+        query = queries.query_bookmark_tags(self.user, 'term1 #tag1')
+
+        self.assertQueryResult(query, [
+            self.get_tags_from_bookmarks(self.term1_tag1_bookmarks),
+        ])
+
+    def test_query_bookmark_tags_should_return_no_matches(self):
+        self.setup_tag_search_data()
+
+        query = queries.query_bookmarks(self.get_or_create_test_user(), 'term3')
+        self.assertQueryResult(query, [])
+
+        query = queries.query_bookmarks(self.get_or_create_test_user(), 'term1 term3')
+        self.assertQueryResult(query, [])
+
+        query = queries.query_bookmarks(self.get_or_create_test_user(), 'term1 #tag2')
+        self.assertQueryResult(query, [])
+
+        query = queries.query_bookmarks(self.get_or_create_test_user(), '#tag3')
+        self.assertQueryResult(query, [])
 
     def test_query_bookmark_tags_should_return_tags_for_unarchived_bookmarks_only(self):
         tag1 = self.setup_tag()
@@ -40,7 +372,7 @@ class QueriesTestCase(TestCase, BookmarkFactoryMixin):
 
         query = queries.query_bookmark_tags(self.get_or_create_test_user(), '')
 
-        self.assertCountEqual([tag1], list(query))
+        self.assertQueryResult(query, [[tag1]])
 
     def test_query_bookmark_tags_should_return_distinct_tags(self):
         tag = self.setup_tag()
@@ -50,7 +382,7 @@ class QueriesTestCase(TestCase, BookmarkFactoryMixin):
 
         query = queries.query_bookmark_tags(self.get_or_create_test_user(), '')
 
-        self.assertCountEqual([tag], list(query))
+        self.assertQueryResult(query, [[tag]])
 
     def test_query_archived_bookmark_tags_should_return_tags_for_archived_bookmarks_only(self):
         tag1 = self.setup_tag()
@@ -61,7 +393,7 @@ class QueriesTestCase(TestCase, BookmarkFactoryMixin):
 
         query = queries.query_archived_bookmark_tags(self.get_or_create_test_user(), '')
 
-        self.assertCountEqual([tag2], list(query))
+        self.assertQueryResult(query, [[tag2]])
 
     def test_query_archived_bookmark_tags_should_return_distinct_tags(self):
         tag = self.setup_tag()
@@ -71,4 +403,34 @@ class QueriesTestCase(TestCase, BookmarkFactoryMixin):
 
         query = queries.query_archived_bookmark_tags(self.get_or_create_test_user(), '')
 
-        self.assertCountEqual([tag], list(query))
+        self.assertQueryResult(query, [[tag]])
+
+    def test_query_bookmark_tags_should_only_return_user_owned_tags(self):
+        other_user = User.objects.create_user('otheruser', 'otheruser@example.com', 'password123')
+        owned_bookmarks = [
+            self.setup_bookmark(tags=[self.setup_tag()]),
+            self.setup_bookmark(tags=[self.setup_tag()]),
+            self.setup_bookmark(tags=[self.setup_tag()]),
+        ]
+        self.setup_bookmark(user=other_user, tags=[self.setup_tag(user=other_user)])
+        self.setup_bookmark(user=other_user, tags=[self.setup_tag(user=other_user)])
+        self.setup_bookmark(user=other_user, tags=[self.setup_tag(user=other_user)])
+
+        query = queries.query_bookmark_tags(self.user, '')
+
+        self.assertQueryResult(query, [self.get_tags_from_bookmarks(owned_bookmarks)])
+
+    def test_query_archived_bookmark_tags_should_only_return_user_owned_tags(self):
+        other_user = User.objects.create_user('otheruser', 'otheruser@example.com', 'password123')
+        owned_bookmarks = [
+            self.setup_bookmark(is_archived=True, tags=[self.setup_tag()]),
+            self.setup_bookmark(is_archived=True, tags=[self.setup_tag()]),
+            self.setup_bookmark(is_archived=True, tags=[self.setup_tag()]),
+        ]
+        self.setup_bookmark(is_archived=True, user=other_user, tags=[self.setup_tag(user=other_user)])
+        self.setup_bookmark(is_archived=True, user=other_user, tags=[self.setup_tag(user=other_user)])
+        self.setup_bookmark(is_archived=True, user=other_user, tags=[self.setup_tag(user=other_user)])
+
+        query = queries.query_archived_bookmark_tags(self.user, '')
+
+        self.assertQueryResult(query, [self.get_tags_from_bookmarks(owned_bookmarks)])