Add ability to rebuild a specific build

readthedocs/builds/views.py

@@ -7,6 +7,7 @@
 from django.contrib import messages
 from django.contrib.auth.decorators import login_required
 from django.http import (
+    HttpResponseBadRequest,
     HttpResponseForbidden,
     HttpResponseRedirect,
 )
@@ -54,14 +55,49 @@ def post(self, request, project_slug):
             return HttpResponseForbidden()
 
         version_slug = request.POST.get('version_slug')
-        version = get_object_or_404(
-            self._get_versions(project),
-            slug=version_slug,
-        )
+        build_pk = request.POST.get('build_pk')
+
+        if build_pk:
+            # Filter over external versions only when re-triggering a specific build
+            version = get_object_or_404(
+                Version.external.public(self.request.user),
+                slug=version_slug,
+                project=project,
+            )
+
+            build = get_object_or_404(
+                Build.objects.all(),
+                pk=build_pk,
+                version=version,
+            )
+            if build != Build.objects.filter(version=version).first():
+                # Return bad request if the build re-triggered is not the
+                # latest for that version
+                return HttpResponseBadRequest()
+        else:
+            # Use generic query when triggering a normal build
+            version = get_object_or_404(
+                self._get_versions(project),
+                slug=version_slug,
+            )
+
+        # Set either the build to re-trigger it or None
+        build_to_retrigger = version.builds.filter(pk=build_pk).first()
+        commit_to_retrigger = None
+        if build_to_retrigger:
+            commit_to_retrigger = build_to_retrigger.commit
+            log.info(
+                'Re-triggering build. project=%s version=%s commit=%s build=%s',
+                project.slug,
+                version.slug,
+                build_to_retrigger.commit,
+                build_to_retrigger.pk
+            )
 
         update_docs_task, build = trigger_build(
             project=project,
             version=version,
+            commit=commit_to_retrigger,
         )
         if (update_docs_task, build) == (None, None):
             # Build was skipped
@@ -111,6 +147,13 @@ def get_context_data(self, **kwargs):
         context['project'] = self.project
 
         build = self.get_object()
+        context['is_latest_build'] = (
+            build == Build.objects.filter(
+                project=build.project,
+                version=build.version,
+            ).first()
+        )
+
         if build.error != BuildEnvironmentError.GENERIC_WITH_BUILD_ID.format(build_id=build.pk):
             # Do not suggest to open an issue if the error is not generic
             return context

readthedocs/core/utils/__init__.py

@@ -13,8 +13,8 @@
 from django.utils.text import slugify as slugify_base
 
 from readthedocs.builds.constants import (
-    BUILD_STATE_FINISHED,
     BUILD_STATE_TRIGGERED,
+    BUILD_STATE_FINISHED,
     BUILD_STATUS_PENDING,
     EXTERNAL,
 )
@@ -65,7 +65,6 @@ def prepare_build(
     )
 
     build = None
-
     if not Project.objects.is_active(project):
         log.warning(
             'Build not triggered because Project is not active: project=%s',
@@ -234,11 +233,11 @@ def trigger_build(project, version=None, commit=None, record=True, force=False):
         commit,
     )
     update_docs_task, build = prepare_build(
-        project,
-        version,
-        commit,
-        record,
-        force,
+        project=project,
+        version=version,
+        commit=commit,
+        record=record,
+        force=force,
         immutable=True,
     )
 

readthedocs/rtd_tests/tests/test_views.py

@@ -265,6 +265,71 @@ def test_build_list_includes_external_versions(self):
         self.assertEqual(response.status_code, 200)
         self.assertIn(external_version_build, response.context['build_qs'])
 
+    @mock.patch('readthedocs.projects.tasks.update_docs_task')
+    def test_rebuild_specific_commit(self, mock):
+        builds_count = Build.objects.count()
+
+        version = self.pip.versions.first()
+        version.type = 'external'
+        version.save()
+
+        build = get(
+            Build,
+            version=version,
+            project=self.pip,
+            commit='a1b2c3',
+        )
+
+        r = self.client.post(
+            '/projects/pip/builds/',
+            {
+                'version_slug': version.slug,
+                'build_pk': build.pk,
+            }
+        )
+
+        self.assertEqual(r.status_code, 302)
+        self.assertEqual(Build.objects.count(), builds_count + 2)
+
+        newbuild = Build.objects.first()
+        self.assertEqual(
+            r._headers['location'][1],
+            f'/projects/pip/builds/{newbuild.pk}/',
+        )
+        self.assertEqual(newbuild.commit, 'a1b2c3')
+
+
+    @mock.patch('readthedocs.projects.tasks.update_docs_task')
+    def test_rebuild_invalid_specific_commit(self, mock):
+        version = self.pip.versions.first()
+        version.type = 'external'
+        version.save()
+
+        for i in range(3):
+            get(
+                Build,
+                version=version,
+                project=self.pip,
+                commit=f'a1b2c3-{i}',
+            )
+
+        build = Build.objects.filter(
+            version=version,
+            project=self.pip,
+        ).last()
+
+        r = self.client.post(
+            '/projects/pip/builds/',
+            {
+                'version_slug': version.slug,
+                'build_pk': build.pk,
+            }
+        )
+
+        # It should return 400 because we are re-triggering a build of a
+        # non-lastest build for that version
+        self.assertEqual(r.status_code, 400)
+
 
 class TestSearchAnalyticsView(TestCase):
 

readthedocs/templates/builds/build_detail.html

@@ -69,6 +69,23 @@
           </a>
         </li>
       </div>
+
+
+      {# Show rebuild button only if the version is external and it's the latest build for this version #}
+      {# see https://github.com/readthedocs/readthedocs.org/pull/6995#issuecomment-852918969 #}
+      {% if request.user|is_admin:project and build.version.type == "external" and is_latest_build %}
+      <div data-bind="visible: finished()">
+        <form method="post" name="rebuild_commit" action="{% url "builds_project_list" project.slug %}">
+          {% csrf_token %}
+            <a href="#" onclick="document.forms['rebuild_commit'].submit();">
+              Rebuild this build
+            </a>
+            <input type="hidden" name="version_slug" value="{{ build.version.slug }}">
+            <input type="hidden" name="build_pk" value="{{ build.pk }}">
+        </form>
+      </div>
+      {% endif %}
+
     </ul>
 
     <div class="build-id">