Add proper tests for new functionality.

Author: tim-schilling

blog/models.py

@@ -31,8 +31,10 @@ def _md_slugify(value, separator):
 
 
 class EntryQuerySet(models.QuerySet):
-    def published(self):
-        return self.active().filter(pub_date__lte=timezone.now())
+    def published(self, pub_date=None):
+        if pub_date is None:
+            pub_date = timezone.now()
+        return self.active().filter(pub_date__lte=pub_date)
 
     def active(self):
         return self.filter(is_active=True)

blog/tests.py

@@ -64,6 +64,11 @@ def test_manager_published(self):
             ["past active"],
             transform=lambda entry: entry.headline,
         )
+        self.assertQuerySetEqual(
+            Entry.objects.published(self.tomorrow),
+            ["future active", "past active"],
+            transform=lambda entry: entry.headline,
+        )
 
     def test_manager_searchable(self):
         """

docs/models.py

@@ -271,6 +271,7 @@ def _sync_views_to_db(self):
                 path = reverse_path(url_name, kwargs=kwargs)
                 request = RequestFactory().get(path, HTTP_HOST=www_host)
                 body = resolve(path).func(request).render().text
+                # Need to parse the body element.
                 Document.objects.create(
                     release=self,
                     path=absolute_url,
@@ -302,7 +303,9 @@ def _clean_document_path(path):
 
 
 def document_url(doc):
-    if doc.path:
+    if doc.metadata["parents"] == "weblog":
+        return doc.path
+    elif doc.path:
         kwargs = {
             "lang": doc.release.lang,
             "version": doc.release.version,
@@ -460,16 +463,3 @@ def body(self):
         with open(str(self.full_path)) as fp:
             doc = json.load(fp)
         return doc["body"]
-
-    def document_url(self):
-        if self.metadata["parents"] == "weblog":
-            return self.path
-        return reverse(
-            "document-detail",
-            kwargs={
-                "lang": self.release.lang,
-                "version": self.release.version,
-                "url": self.path,
-            },
-            host="docs",
-        )

docs/templates/docs/search_results.html

@@ -43,11 +43,11 @@ <h2>{% translate "No search query given" %}</h2>
         {% for result in page.object_list %}
           <dt>
             <h2 class="result-title">
-              <a href="{{ result.document_url }}{% if not start_sel in result.headline %}{{ result.highlight|fragment }}{% endif %}">{{ result.headline|safe }}</a>
+              <a href="{{ result.get_absolute_url }}{% if not start_sel in result.headline %}{{ result.highlight|fragment }}{% endif %}">{{ result.headline|safe }}</a>
             </h2>
             <span class="meta breadcrumbs">
               {% for breadcrumb in result.breadcrumbs %}
-                <a href="{{ result.document_url }}">{{ breadcrumb.title }}</a>{% if not forloop.last %} <span class="arrow">»</span>{% endif %}
+                <a href="{{ result.get_absolute_url }}">{{ breadcrumb.title }}</a>{% if not forloop.last %} <span class="arrow">»</span>{% endif %}
               {% endfor %}
             </span>
           </dt>
@@ -60,7 +60,7 @@ <h2 class="result-title">
               <ul class="code-links">
                 {% for name, value in result_code_links.items %}
                   <li>
-                    <a href="{{ result.document_url }}#{{ value.full_path }}">
+                    <a href="{{ result.get_absolute_url }}#{{ value.full_path }}">
                       <div>
                         <code>{{ name }}</code>
                         {% if value.module_path %}<div class="meta">{{ value.module_path }}</div>{% endif %}

docs/tests/test_models.py

@@ -4,7 +4,10 @@
 from django.conf import settings
 from django.db import connection
 from django.test import TestCase
+from django.utils import timezone
+from django_hosts import reverse
 
+from blog.models import Entry
 from releases.models import Release
 
 from ..models import DOCUMENT_SEARCH_VECTOR, Document, DocumentRelease
@@ -465,7 +468,19 @@ def test_search_title(self):
 class UpdateDocTests(TestCase):
     @classmethod
     def setUpTestData(cls):
-        cls.release = DocumentRelease.objects.create()
+        now = timezone.now()
+        cls.release = DocumentRelease.objects.create(
+            support_end=now + datetime.timedelta(days=1)
+        )
+        cls.entry = Entry.objects.create(
+            pub_date=now,
+            is_active=True,
+            is_searchable=True,
+            headline="Searchable post",
+            slug="a",
+            body_html="<h1>Searchable Blog Post</h1>",
+        )
+        cls.docs_documents = cls.release.documents.exclude(metadata__parents="weblog")
 
     def test_sync_to_db(self):
         self.release.sync_to_db(
@@ -477,8 +492,43 @@ def test_sync_to_db(self):
                 }
             ]
         )
-        document = self.release.documents.get()
-        self.assertEqual(document.path, "foo/bar")
+        document_paths = set(self.release.documents.values_list("path", flat=True))
+        self.assertEqual(
+            document_paths,
+            {
+                "foo/bar",
+                reverse("community-ecosystem", host="www"),
+                self.entry.get_absolute_url(),
+            },
+        )
+
+    def test_blog_to_db_skip_non_english(self):
+        """
+        Releases must be English to include the blog and website results in search.
+        """
+        non_english = DocumentRelease.objects.create(
+            lang="es",
+            release=Release.objects.create(version="88.0"),
+            support_end=self.release.support_end,
+        )
+        non_english.sync_to_db([])
+        self.assertFalse(non_english.documents.exists())
+
+    def test_blog_to_db_skip_no_end_support(self):
+        """
+        Releases must have an end support to include the blog.
+        """
+        no_end_support = DocumentRelease.objects.create(
+            lang="en",
+            release=Release.objects.create(version="99.0"),
+        )
+        no_end_support.sync_to_db([])
+        self.assertEqual(
+            set(no_end_support.documents.values_list("path", flat=True)),
+            {
+                reverse("community-ecosystem", host="www"),
+            },
+        )
 
     def test_clean_path(self):
         self.release.sync_to_db(
@@ -490,7 +540,7 @@ def test_clean_path(self):
                 }
             ]
         )
-        document = self.release.documents.get()
+        document = self.docs_documents.get()
         self.assertEqual(document.path, "foo/bar")
 
     def test_title_strip_tags(self):
@@ -504,7 +554,7 @@ def test_title_strip_tags(self):
             ]
         )
         self.assertQuerySetEqual(
-            self.release.documents.all(),
+            self.docs_documents.all(),
             ["This is the title"],
             transform=attrgetter("title"),
         )
@@ -520,7 +570,7 @@ def test_title_entities(self):
             ]
         )
         self.assertQuerySetEqual(
-            self.release.documents.all(),
+            self.docs_documents,
             ["Title & title"],
             transform=attrgetter("title"),
         )
@@ -533,7 +583,7 @@ def test_empty_documents(self):
                 {"current_page_name": "foo/3"},
             ]
         )
-        self.assertQuerySetEqual(self.release.documents.all(), [])
+        self.assertQuerySetEqual(self.docs_documents, [])
 
     def test_excluded_documents(self):
         """
@@ -562,3 +612,47 @@ def test_excluded_documents(self):
         )
         document = release.documents.get()
         self.assertEqual(document.path, "nonexcluded/bar")
+
+
+class DocumentUrlTests(TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        cls.release = DocumentRelease.objects.create(
+            release=Release.objects.create(version="1.2.3"),
+        )
+        documents = [
+            {
+                "metadata": {"parents": "topics http"},
+                "path": "topics/http/generic-views",
+                "release": cls.release,
+                "title": "Generic views",
+            },
+            # I'm not sure if this is valid or not.
+            {
+                "metadata": {"parents": "topics"},
+                "path": "",
+                "release": cls.release,
+                "title": "Index",
+            },
+        ]
+        # Include the static views in the document search
+        cls.release._sync_views_to_db()
+        Document.objects.bulk_create(Document(**doc) for doc in documents)
+        cls.document_index, cls.document_view, cls.document_detail = (
+            cls.release.documents.order_by("path")
+        )
+
+    def test_document_url(self):
+        self.assertEqual(
+            self.document_index.get_absolute_url(),
+            "http://docs.djangoproject.localhost:8000/en/1.2.3/",
+        )
+        self.assertEqual(
+            self.document_view.get_absolute_url(),
+            "http://www.djangoproject.localhost:8000/community/ecosystem/",
+        )
+        self.assertEqual(
+            self.document_detail.get_absolute_url(),
+            "http://docs.djangoproject.localhost:8000"
+            "/en/1.2.3/topics/http/generic-views/",
+        )