Merge branch 'gsoc-19-pr-builder' into pr-build-tab

Author: saadmk11

docs/conf.py

@@ -54,7 +54,7 @@ def get_version():
 default_role = 'obj'
 intersphinx_mapping = {
     'python': ('https://python.readthedocs.io/en/latest/', None),
-    'django': ('https://django.readthedocs.io/en/1.9.x/', None),
+    'django': ('https://django.readthedocs.io/en/1.11.x/', None),
     'sphinx': ('https://sphinx.readthedocs.io/en/latest/', None),
 }
 htmlhelp_basename = 'ReadTheDocsdoc'

docs/features/sitemaps.rst

@@ -12,7 +12,7 @@ and communicate them additional information about each URL of the project:
 Read the Docs automatically generates a sitemap for each project that hosts
 to improve results when performing a search on these search engines.
 This allow us to prioritize results based on the version number, for example
-to show ``latest`` as the top result followed by ``stable`` and then all the project's
+to show ``stable`` as the top result followed by ``latest`` and then all the project's
 versions sorted following semver_.
 
 .. _semver: https://semver.org/

docs/guides/environment-variables.rst

@@ -17,7 +17,7 @@ To define an environment variable, you need to
 .. note::
 
    Values will never be exposed to users, even to owners of the project.
-   Once you create an environment variable you won't be able to see its value anymore because of security purposes.
+   Once you create an environment variable, you won't be able to see its value anymore for security purposes.
 
 After adding an environment variable from your project's admin, you can access it from your build process using Python,
 for example:

readthedocs/api/v3/mixins.py

@@ -81,17 +81,12 @@ def get_queryset(self):
         4. raise a ``NotFound`` exception otherwise
         """
 
-        # NOTE: ``super().get_queryset`` produces the filter by ``NestedViewSetMixin``
-        # we need to have defined the class attribute as ``queryset = Model.objects.all()``
+        # We need to have defined the class attribute as ``queryset = Model.objects.all()``
         queryset = super().get_queryset()
 
         # Detail requests are public
         if self.detail:
             return self.detail_objects(queryset, self.request.user)
 
         # List view are only allowed if user is owner of parent project
-        listing_objects = self.listing_objects(queryset, self.request.user)
-        if listing_objects:
-            return listing_objects
-
-        raise NotFound
+        return self.listing_objects(queryset, self.request.user)

readthedocs/builds/admin.py

@@ -44,6 +44,7 @@ class BuildAdmin(admin.ModelAdmin):
         'type',
         'state',
         'date',
+        'length'
     )
     list_filter = ('type', 'state', 'success')
     list_select_related = ('project', 'version')

readthedocs/builds/constants.py

@@ -31,6 +31,13 @@
     ('dash', _('Dash')),
 )
 
+# Manager name for Internal Versions or Builds.
+# ie: Versions and Builds Excluding pull request/merge request Versions and Builds.
+INTERNAL = 'internal'
+# Manager name for External Versions or Builds.
+# ie: Only pull request/merge request Versions and Builds.
+EXTERNAL = 'external'
+
 BRANCH = 'branch'
 TAG = 'tag'
 PULL_REQUEST = 'pull_request'
@@ -39,7 +46,7 @@
 VERSION_TYPES = (
     (BRANCH, _('Branch')),
     (TAG, _('Tag')),
-    (PULL_REQUEST, _('Pull Request')),
+    (EXTERNAL, _('External')),
     (UNKNOWN, _('Unknown')),
 )
 

readthedocs/builds/managers.py

@@ -19,7 +19,7 @@
     STABLE,
     STABLE_VERBOSE_NAME,
     TAG,
-    PULL_REQUEST,
+    EXTERNAL,
 )
 from .querysets import VersionQuerySet, BuildQuerySet
 
@@ -91,24 +91,24 @@ class InternalVersionManagerBase(VersionManagerBase):
     """
     Version manager that only includes internal version.
 
-    It will exclude PULL_REQUEST type from the queries
+    It will exclude pull request/merge request versions from the queries
     and only include BRANCH, TAG, UNKONWN type Versions.
     """
 
     def get_queryset(self):
-        return super().get_queryset().exclude(type=PULL_REQUEST)
+        return super().get_queryset().exclude(type=EXTERNAL)
 
 
 class ExternalVersionManagerBase(VersionManagerBase):
 
     """
     Version manager that only includes external version.
 
-    It will only include PULL_REQUEST type Versions in the queries.
+    It will only include pull request/merge request Versions in the queries.
     """
 
     def get_queryset(self):
-        return super().get_queryset().filter(type=PULL_REQUEST)
+        return super().get_queryset().filter(type=EXTERNAL)
 
 
 class VersionManager(SettingsOverrideObject):

readthedocs/builds/migrations/0008_added_external_version_type.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.21 on 2019-06-17 19:43
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('builds', '0007_add-automation-rules'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='version',
+            name='type',
+            field=models.CharField(choices=[('branch', 'Branch'), ('tag', 'Tag'), ('external', 'External'), ('unknown', 'Unknown')], default='unknown', max_length=20, verbose_name='Type'),
+        ),
+        migrations.AlterField(
+            model_name='versionautomationrule',
+            name='version_type',
+            field=models.CharField(choices=[('branch', 'Branch'), ('tag', 'Tag'), ('external', 'External'), ('unknown', 'Unknown')], max_length=32, verbose_name='Version type'),
+        ),
+    ]

readthedocs/builds/models.py

@@ -41,7 +41,7 @@
     INTERNAL,
     LATEST,
     NON_REPOSITORY_VERSIONS,
-    PULL_REQUEST,
+    EXTERNAL,
     STABLE,
     TAG,
     VERSION_TYPES,
@@ -126,7 +126,7 @@ class Version(models.Model):
     objects = VersionManager.from_queryset(VersionQuerySet)()
     # Only include BRANCH, TAG, UNKONWN type Versions.
     internal = InternalVersionManager.from_queryset(VersionQuerySet)()
-    # Only include PULL_REQUEST type Versions.
+    # Only include EXTERNAL type Versions.
     external = ExternalVersionManager.from_queryset(VersionQuerySet)()
 
     class Meta:
@@ -162,7 +162,7 @@ def vcs_url(self):
         Generate VCS (github, gitlab, bitbucket) URL for this version.
 
         Branch/Tag Example: https://github.com/rtfd/readthedocs.org/tree/3.4.2/.
-        Pull Request Example: https://github.com/rtfd/readthedocs.org/pull/9999/.
+        Pull/merge Request Example: https://github.com/rtfd/readthedocs.org/pull/9999/.
         """
         url = ''
         if self.slug == STABLE:
@@ -172,7 +172,7 @@ def vcs_url(self):
         else:
             slug_url = self.slug
 
-        if self.type == PULL_REQUEST:
+        if self.type == EXTERNAL:
             if 'github' in self.project.repo:
                 url = f'/pull/{slug_url}/'
 
@@ -252,14 +252,14 @@ def commit_name(self):
             # the actual tag name.
             return self.verbose_name
 
-        if self.type == PULL_REQUEST:
-            # If this version is a Pull Request, the identifier will
+        if self.type == EXTERNAL:
+            # If this version is a EXTERNAL version, the identifier will
             # contain the actual commit hash. which we can use to
             # generate url for a given file name
             return self.identifier
 
         # If we came that far it's not a special version
-        # nor a branch, tag or Pull Request.
+        # nor a branch, tag or EXTERNAL version.
         # Therefore just return the identifier to make a safe guess.
         log.debug(
             'TODO: Raise an exception here. Testing what cases it happens',

readthedocs/core/urls/subdomain.py

@@ -46,6 +46,7 @@
         serve_docs,
         name='docs_detail',
     ),
+
 ]
 
 groups = [subdomain_urls]

readthedocs/core/views/serve.py

@@ -111,11 +111,27 @@ def inner_view(  # noqa
 def redirect_project_slug(request, project, subproject):  # pylint: disable=unused-argument
     """Handle / -> /en/latest/ directs on subdomains."""
     urlparse_result = urlparse(request.get_full_path())
+
+    # When accessing docs.customdomain.org/projects/subproject/ and the
+    # ``subproject`` is a single-version, we don't have to redirect but to serve
+    # the index file instead.
+    if subproject and subproject.single_version:
+        try:
+            # HACK: this only affects corporate site and won't be hit on the
+            # community. This can be removed once the middleware incorporates
+            # more data or redirects happen outside this application
+            # See: https://github.com/rtfd/readthedocs.org/pull/5690
+            log.warning('Serving docs for a single-version subproject instead redirecting')
+            from readthedocsinc.core.views import serve_docs as corporate_serve_docs  # noqa
+            return corporate_serve_docs(request, project, project.slug, subproject, subproject.slug)
+        except Exception:
+            log.exception('Error trying to redirect a single-version subproject')
+
     return HttpResponseRedirect(
         resolve(
             subproject or project,
             query_params=urlparse_result.query,
-        )
+        ),
     )
 
 

readthedocs/projects/admin.py

@@ -312,8 +312,8 @@ class ImportedFileAdmin(admin.ModelAdmin):
     """Admin view for :py:class:`ImportedFile`."""
 
     raw_id_fields = ('project', 'version')
-    list_display = ('path', 'name', 'version')
-    search_fields = ('project', 'path')
+    list_display = ('path', 'version', 'build')
+    search_fields = ('project__slug', 'version__slug', 'path', 'build')
 
 
 class DomainAdmin(admin.ModelAdmin):

readthedocs/rtd_tests/tests/test_doc_serving.py

@@ -10,7 +10,7 @@
 from django.urls import reverse
 from mock import mock_open, patch
 
-from readthedocs.builds.constants import LATEST, PULL_REQUEST, INTERNAL
+from readthedocs.builds.constants import LATEST, EXTERNAL, INTERNAL
 from readthedocs.builds.models import Version
 from readthedocs.core.middleware import SubdomainMiddleware
 from readthedocs.core.views import server_error_404_subdomain
@@ -259,6 +259,16 @@ def test_sitemap_xml(self):
             project=self.public,
             active=True
         )
+        # This is a EXTERNAL Version
+        external_version = fixture.get(
+            Version,
+            identifier='pr-version',
+            verbose_name='pr-version',
+            slug='pr-9999',
+            project=self.public,
+            active=True,
+            type=EXTERNAL
+        )
         # This also creates a Version `latest` Automatically for this project
         translation = fixture.get(
             Project,
@@ -317,7 +327,7 @@ def test_sitemap_xml(self):
         self.assertNotContains(
             response,
             self.public.get_docs_url(
-                version_slug=pr_version.slug,
+                version_slug=external_version.slug,
                 lang_slug=self.public.language,
                 private=True,
             ),