src/catalogue/tests/test_tags.py

   1 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
   2 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
   3 #
   4 from unittest import skip
   5
   6 from django.core.files.base import ContentFile
   7 from django.test import Client
   8 from catalogue import models
   9 from catalogue.test_utils import *
  10
  11
  12 class BooksByTagTests(WLTestCase):
  13     """ tests the /katalog/category/tag page for found books """
  14
  15     def setUp(self):
  16         WLTestCase.setUp(self)
  17         author = PersonStub(("Common",), "Man")
  18
  19         # grandchild
  20         self.gchild_info = BookInfoStub(genre='Genre', epoch='Epoch', kind='Kind', author=author,
  21                                         **info_args("GChild"))
  22         # child
  23         self.child_info = BookInfoStub(genre='Genre', epoch='Epoch', kind='Other Kind', author=author,
  24                                        parts=[self.gchild_info.url],
  25                                        **info_args("Child"))
  26         # parent
  27         self.parent_info = BookInfoStub(genre='Genre', epoch='Epoch', kind='Kind', author=author,
  28                                         parts=[self.child_info.url],
  29                                         **info_args("Parent"))
  30
  31         self.book_file = ContentFile(b'<utwor />')
  32
  33     def test_nonexistent_tag(self):
  34         """ Looking for a non-existent tag should yield 404 """
  35         self.assertEqual(404, self.client.get('/katalog/autor/czeslaw-milosz/').status_code)
  36
  37     def test_book_tag(self):
  38         """ Looking for a book tag isn't permitted """
  39         models.Book.from_text_and_meta(self.book_file, self.gchild_info)
  40         self.assertEqual(404, self.client.get('/katalog/gchild/').status_code)
  41
  42     def test_tag_empty(self):
  43         """ Tag with no books should return no books """
  44         models.Book.from_text_and_meta(self.book_file, self.gchild_info)
  45         models.Tag.objects.create(name='Empty tag', slug='empty', category='author')
  46
  47         context = self.client.get('/katalog/autor/empty/').context
  48         self.assertEqual(0, len(context['object_list']))
  49
  50     def test_tag_eliminate(self):
  51         """ Filtering by tag should only yield top-level qualifying books. """
  52         for info in self.gchild_info, self.child_info, self.parent_info:
  53             models.Book.from_text_and_meta(self.book_file, info)
  54
  55         # all three qualify
  56         context = self.client.get('/katalog/gatunek/genre/').context
  57         self.assertEqual([book.title for book in context['object_list']],
  58                          ['Parent'])
  59
  60         # parent and gchild qualify, child doesn't
  61         context = self.client.get('/katalog/rodzaj/kind/').context
  62         self.assertEqual([book.title for book in context['object_list']],
  63                          ['Parent'])
  64
  65         # Filtering by child's tag should yield the child
  66         context = self.client.get('/katalog/rodzaj/other-kind/').context
  67         self.assertEqual([book.title for book in context['object_list']],
  68                          ['Child'])
  69
  70
  71 class TagRelatedTagsTests(WLTestCase):
  72     """ tests the /katalog/category/tag/ page for related tags """
  73
  74     def setUp(self):
  75         WLTestCase.setUp(self)
  76         self.client = Client()
  77         author = PersonStub(("Common",), "Man")
  78
  79         gchild_info = BookInfoStub(author=author, genre="GchildGenre", epoch='Epoch', kind="Kind",
  80                                    **info_args("GChild"))
  81         child1_info = BookInfoStub(author=author, genre="ChildGenre", epoch='Epoch', kind="ChildKind",
  82                                    parts=[gchild_info.url],
  83                                    **info_args("Child1"))
  84         child2_info = BookInfoStub(author=author, genre="ChildGenre", epoch='Epoch', kind="ChildKind",
  85                                    **info_args("Child2"))
  86         parent_info = BookInfoStub(author=author, genre="Genre", epoch='Epoch', kind="Kind",
  87                                    parts=[child1_info.url, child2_info.url],
  88                                    **info_args("Parent"))
  89
  90         for info in gchild_info, child1_info, child2_info, parent_info:
  91             book_text = """<utwor><opowiadanie><akap>
  92                 <begin id="m01" />
  93                     <motyw id="m01">Theme, %sTheme</motyw>
  94                     Ala ma kota
  95                 <end id="m01" />
  96                 </akap></opowiadanie></utwor>
  97                 """ % info.title
  98             book = models.Book.from_text_and_meta(
  99                 ContentFile(book_text.encode('utf-8')),
 100                 info
 101             )
 102             book.save()
 103
 104         tag_empty = models.Tag(name='Empty tag', slug='empty', category='author')
 105         tag_empty.save()
 106
 107     def test_empty(self):
 108         """ empty tag should have no related tags """
 109
 110         cats = self.client.get('/katalog/autor/empty/').context['categories']
 111         self.assertEqual({k: v for (k, v) in cats.items() if v}, {}, 'tags related to empty tag')
 112
 113     def test_has_related(self):
 114         """ related own and descendants' tags should be generated """
 115
 116         cats = self.client.get('/katalog/rodzaj/kind/').context['categories']
 117         self.assertTrue('Common Man' in [tag.name for tag in cats['author']],
 118                         'missing `author` related tag')
 119         self.assertTrue('Epoch' in [tag.name for tag in cats['epoch']],
 120                         'missing `epoch` related tag')
 121         self.assertFalse(cats.get("kind", False),
 122                          "There should be no child-only related `kind` tags")
 123         self.assertTrue("Genre" in [tag.name for tag in cats['genre']],
 124                         'missing `genre` related tag')
 125         self.assertFalse("ChildGenre" in [tag.name for tag in cats['genre']],
 126                          "There should be no child-only related `genre` tags")
 127         self.assertTrue("GchildGenre" in [tag.name for tag in cats['genre']],
 128                         "missing grandchild's related tag")
 129         self.assertTrue('Theme' in [tag.name for tag in cats['theme']],
 130                         "missing related theme")
 131         self.assertFalse('Child1Theme' in [tag.name for tag in cats['theme']],
 132                          "There should be no child-only related `theme` tags")
 133         self.assertTrue('GChildTheme' in [tag.name for tag in cats['theme']],
 134                         "missing grandchild's related theme")
 135
 136     def test_related_differ(self):
 137         """ related tags shouldn't include filtering tags """
 138
 139         response = self.client.get('/katalog/rodzaj/kind/')
 140         cats = response.context['categories']
 141         self.assertFalse(cats.get('kind', False),
 142                          'filtering tag wrongly included in related')
 143         cats = self.client.get('/katalog/motyw/theme/').context['categories']
 144         self.assertFalse('Theme' in [tag.name for tag in cats['theme']],
 145                          'filtering theme wrongly included in related')
 146
 147     def test_parent_tag_once(self):
 148         """ if parent and descendants have a common tag, count it only once """
 149
 150         cats = self.client.get('/katalog/rodzaj/kind/').context['categories']
 151         self.assertEqual([(tag.name, tag.count) for tag in cats['epoch']],
 152                          [('Epoch', 1)],
 153                          'wrong related tag epoch tag on tag page')
 154
 155     def test_siblings_tags_count(self):
 156         """ if children have tags and parent hasn't, count the children """
 157
 158         cats = self.client.get('/katalog/epoka/epoch/').context['categories']
 159         self.assertTrue(
 160             ('ChildKind', 2) in [(tag.name, tag.count) for tag in cats['kind']],
 161             'wrong related kind tags on tag page, got: ' +
 162             str([(tag.name, tag.count) for tag in cats['kind']]))
 163
 164         # all occurencies of theme should be counted
 165         self.assertTrue(('Theme', 4) in [(tag.name, tag.count) for tag in cats['theme']],
 166                         'wrong related theme count')
 167
 168     def test_query_child_tag(self):
 169         """
 170         If child and parent have a common tag, but parent isn't included
 171         in the result, child should still count.
 172         """
 173         cats = self.client.get('/katalog/gatunek/childgenre/').context['categories']
 174         self.assertTrue(('Epoch', 2) in [(tag.name, tag.count) for tag in cats['epoch']],
 175                         'wrong related kind tags on tag page, got: ' +
 176                         str([(tag.name, tag.count) for tag in cats['epoch']]))
 177
 178
 179 class CleanTagRelationTests(WLTestCase):
 180     """ tests for tag relations cleaning after deleting things """
 181
 182     def setUp(self):
 183         WLTestCase.setUp(self)
 184         author = PersonStub(("Common",), "Man")
 185
 186         book_info = BookInfoStub(author=author, genre="G", epoch='E', kind="K", **info_args("Book"))
 187         book_text = """<utwor><opowiadanie><akap>
 188             <begin id="m01" /><motyw id="m01">Theme</motyw>Ala ma kota
 189             <end id="m01" />
 190             </akap></opowiadanie></utwor>
 191             """
 192         self.book = models.Book.from_text_and_meta(
 193                 ContentFile(book_text.encode('utf-8')),
 194                 book_info)
 195
 196     @skip('Not implemented and not priority')
 197     def test_delete_objects(self):
 198         """ there should be no related tags left after deleting some objects """
 199
 200         models.Book.objects.all().delete()
 201         cats = self.client.get('/katalog/rodzaj/k/').context['categories']
 202         self.assertEqual({k: v for (k, v) in cats.items() if v}, {})
 203         self.assertEqual(models.Fragment.objects.all().count(), 0,
 204                          "orphaned fragments left")
 205         self.assertEqual(models.Tag.intermediary_table_model.objects.all().count(), 0,
 206                          "orphaned TagRelation objects left")
 207
 208     def test_deleted_tag(self):
 209         """ there should be no tag relations left after deleting tags """
 210
 211         models.Tag.objects.all().delete()
 212         self.assertEqual(len(self.book.related_themes()), 0)
 213         self.assertEqual(models.Tag.intermediary_table_model.objects.all().count(), 0,
 214                          "orphaned TagRelation objects left")
 215
 216
 217 class TestIdenticalTag(WLTestCase):
 218
 219     def setUp(self):
 220         WLTestCase.setUp(self)
 221         author = PersonStub((), "Tag")
 222
 223         self.book_info = BookInfoStub(author=author, genre="tag", epoch='tag', kind="tag", **info_args("tag"))
 224         self.book_text = """<utwor>
 225             <opowiadanie>
 226             <akap>
 227                 <begin id="m01" /><motyw id="m01">tag</motyw>Ala ma kota<end id="m01" />
 228             </akap>
 229             </opowiadanie>
 230             </utwor>
 231         """
 232
 233     def test_book_tags(self):
 234         """ there should be all related tags in relevant categories """
 235         book = models.Book.from_text_and_meta(
 236                 ContentFile(self.book_text.encode('utf-8')),
 237                 self.book_info)
 238
 239         related_themes = book.related_themes()
 240         for category in 'author', 'kind', 'genre', 'epoch':
 241             self.assertTrue('tag' in book.tags.filter(category=category).values_list('slug', flat=True),
 242                             'missing related tag for %s' % category)
 243         self.assertTrue('tag' in [tag.slug for tag in related_themes])
 244
 245     def test_qualified_url(self):
 246         models.Book.from_text_and_meta(
 247                 ContentFile(self.book_text.encode('utf-8')),
 248                 self.book_info)
 249         categories = {'author': 'autor', 'theme': 'motyw', 'epoch': 'epoka', 'kind': 'rodzaj', 'genre': 'gatunek'}
 250         for cat, localcat in categories.items():
 251             context = self.client.get('/katalog/%s/tag/' % localcat).context
 252             self.assertEqual(1, len(context['object_list']))
 253             self.assertNotEqual({}, context['categories'])
 254             self.assertFalse(context['categories'].get(cat, False))
 255
 256
 257 class BookTagsTests(WLTestCase):
 258     """ tests the /katalog/lektura/book/ page for related tags """
 259
 260     def setUp(self):
 261         WLTestCase.setUp(self)
 262         author1 = PersonStub(("Common",), "Man")
 263         author2 = PersonStub(("Jim",), "Lazy")
 264
 265         child_info = BookInfoStub(authors=(author1, author2), genre="ChildGenre", epoch='Epoch', kind="ChildKind",
 266                                   **info_args("Child"))
 267         parent_info = BookInfoStub(author=author1, genre="Genre", epoch='Epoch', kind="Kind",
 268                                    parts=[child_info.url],
 269                                    **info_args("Parent"))
 270
 271         for info in child_info, parent_info:
 272             book_text = """<utwor><opowiadanie><akap>
 273                 <begin id="m01" />
 274                     <motyw id="m01">Theme, %sTheme</motyw>
 275                     Ala ma kota
 276                 <end id="m01" />
 277                 </akap></opowiadanie></utwor>
 278                 """ % info.title
 279             models.Book.from_text_and_meta(
 280                     ContentFile(book_text.encode('utf-8')),
 281                     info)
 282
 283     def test_book_tags(self):
 284         """ book should have own tags and whole tree's themes """
 285
 286         book = models.Book.objects.get(slug='parent')
 287         related_themes = book.related_themes()
 288
 289         self.assertEqual([t.slug for t in book.authors()],
 290                          ['common-man'])
 291         self.assertEqual([t.slug for t in book.tags.filter(category='kind')],
 292                          ['kind'])
 293         self.assertEqual([(tag.name, tag.count) for tag in related_themes],
 294                          [('Theme', 2), ('ChildTheme', 1), ('ParentTheme', 1)])