Suggestions from review

Author: stsewd

readthedocs/search/api.py

@@ -47,7 +47,7 @@ def get_link(self, obj):
         if doctype in {SPHINX_HTMLDIR, MKDOCS}:
             new_path = re.sub('(^|/)index.html$', '/', path)
             # docs_url already ends with /,
-            # make sure to not include it twice.
+            # so path doesn't need to start with /.
             path = new_path.lstrip('/')
 
         return docs_url + path

readthedocs/search/tests/conftest.py

@@ -4,7 +4,7 @@
 
 import pytest
 from django.core.management import call_command
-from django_dynamic_fixture import G
+from django_dynamic_fixture import get
 
 from readthedocs.projects.constants import PUBLIC
 from readthedocs.projects.models import HTMLFile, Project
@@ -28,7 +28,7 @@ def all_projects(es_index, mock_processed_json, db, settings):
     settings.ELASTICSEARCH_DSL_AUTOSYNC = True
     projects_list = []
     for project_slug in ALL_PROJECTS:
-        project = G(
+        project = get(
             Project,
             slug=project_slug,
             name=project_slug,
@@ -41,7 +41,7 @@ def all_projects(es_index, mock_processed_json, db, settings):
             # file_basename in config are without extension so add html extension
             file_name = file_basename + '.html'
             version = project.versions.all()[0]
-            html_file = G(
+            html_file = get(
                 HTMLFile,
                 project=project,
                 version=version,
@@ -60,7 +60,7 @@ def all_projects(es_index, mock_processed_json, db, settings):
                         domain_role_name = domain_data.pop('role_name')
                         domain, type_ = domain_role_name.split(':')
 
-                        G(
+                        get(
                             SphinxDomain,
                             project=project,
                             version=version,

readthedocs/search/tests/test_api.py

@@ -332,12 +332,11 @@ def test_doc_search_hidden_versions(self, api_client, all_projects):
         assert first_result['project'] == subproject.slug
 
     @pytest.mark.parametrize('doctype', [SPHINX, SPHINX_SINGLEHTML, MKDOCS_HTML])
-    def test_search_correct_link_html_projects(self, api_client, doctype):
+    def test_search_correct_link_for_normal_page_html_projects(self, api_client, doctype):
         project = Project.objects.get(slug='docs')
         project.versions.update(documentation_type=doctype)
         version = project.versions.all().first()
 
-        # Check for a normal page.
         search_params = {
             'project': project.slug,
             'version': version.slug,
@@ -347,11 +346,15 @@ def test_search_correct_link_html_projects(self, api_client, doctype):
         assert resp.status_code == 200
 
         result = resp.data['results'][0]
-
         assert result['project'] == project.slug
         assert result['link'].endswith('en/latest/support.html')
 
-        # Check the main index page.
+    @pytest.mark.parametrize('doctype', [SPHINX, SPHINX_SINGLEHTML, MKDOCS_HTML])
+    def test_search_correct_link_for_index_page_html_projects(self, api_client, doctype):
+        project = Project.objects.get(slug='docs')
+        project.versions.update(documentation_type=doctype)
+        version = project.versions.all().first()
+
         search_params = {
             'project': project.slug,
             'version': version.slug,
@@ -361,11 +364,15 @@ def test_search_correct_link_html_projects(self, api_client, doctype):
         assert resp.status_code == 200
 
         result = resp.data['results'][0]
-
         assert result['project'] == project.slug
         assert result['link'].endswith('en/latest/index.html')
 
-        # Check the index page of a subdirectory.
+    @pytest.mark.parametrize('doctype', [SPHINX, SPHINX_SINGLEHTML, MKDOCS_HTML])
+    def test_search_correct_link_for_index_page_subdirectory_html_projects(self, api_client, doctype):
+        project = Project.objects.get(slug='docs')
+        project.versions.update(documentation_type=doctype)
+        version = project.versions.all().first()
+
         search_params = {
             'project': project.slug,
             'version': version.slug,
@@ -375,17 +382,15 @@ def test_search_correct_link_html_projects(self, api_client, doctype):
         assert resp.status_code == 200
 
         result = resp.data['results'][0]
-
         assert result['project'] == project.slug
         assert result['link'].endswith('en/latest/guides/index.html')
 
     @pytest.mark.parametrize('doctype', [SPHINX_HTMLDIR, MKDOCS])
-    def test_search_correct_link_htmldir_projects(self, api_client, doctype):
+    def test_search_correct_link_for_normal_page_htmldir_projects(self, api_client, doctype):
         project = Project.objects.get(slug='docs')
         project.versions.update(documentation_type=doctype)
         version = project.versions.all().first()
 
-        # Check for a normal page.
         search_params = {
             'project': project.slug,
             'version': version.slug,
@@ -395,11 +400,15 @@ def test_search_correct_link_htmldir_projects(self, api_client, doctype):
         assert resp.status_code == 200
 
         result = resp.data['results'][0]
-
         assert result['project'] == project.slug
         assert result['link'].endswith('en/latest/support.html')
 
-        # Check the main index page.
+    @pytest.mark.parametrize('doctype', [SPHINX_HTMLDIR, MKDOCS])
+    def test_search_correct_link_for_index_page_htmldir_projects(self, api_client, doctype):
+        project = Project.objects.get(slug='docs')
+        project.versions.update(documentation_type=doctype)
+        version = project.versions.all().first()
+
         search_params = {
             'project': project.slug,
             'version': version.slug,
@@ -409,11 +418,15 @@ def test_search_correct_link_htmldir_projects(self, api_client, doctype):
         assert resp.status_code == 200
 
         result = resp.data['results'][0]
-
         assert result['project'] == project.slug
         assert result['link'].endswith('en/latest/')
 
-        # Check the index page of a subdirectory.
+    @pytest.mark.parametrize('doctype', [SPHINX_HTMLDIR, MKDOCS])
+    def test_search_correct_link_for_index_page_subdirectory_htmldir_projects(self, api_client, doctype):
+        project = Project.objects.get(slug='docs')
+        project.versions.update(documentation_type=doctype)
+        version = project.versions.all().first()
+
         search_params = {
             'project': project.slug,
             'version': version.slug,
@@ -423,7 +436,6 @@ def test_search_correct_link_htmldir_projects(self, api_client, doctype):
         assert resp.status_code == 200
 
         result = resp.data['results'][0]
-
         assert result['project'] == project.slug
         assert result['link'].endswith('en/latest/guides/')