Skip builds when project is not active

Allow to make the check extensible from output by defining an
`is_active` method in the QuerySet.

Also, this commit fixes different places where the `None` returned
when `project.skip` was failing.

Author: humitos

readthedocs/builds/views.py

@@ -12,6 +12,7 @@
 import logging
 
 from builtins import object
+from django.contrib import messages
 from django.contrib.auth.decorators import login_required
 from django.urls import reverse
 from django.http import (
@@ -63,7 +64,18 @@ def post(self, request, project_slug):
             slug=version_slug,
         )
 
-        _, build = trigger_build(project=project, version=version)
+        update_docs_task, build = trigger_build(project=project, version=version)
+        if (update_docs_task, build) == (None, None):
+            # Build was skipped
+            messages.add_message(
+                request,
+                messages.WARNING,
+                "This project is currently disabled and can't trigger new builds.",
+            )
+            return HttpResponseRedirect(
+                reverse('builds_project_list', args=[project.slug]),
+            )
+
         return HttpResponseRedirect(
             reverse('builds_detail', args=[project.slug, build.pk]),
         )

readthedocs/core/utils/__init__.py

@@ -20,6 +20,7 @@
 from readthedocs.builds.constants import LATEST, BUILD_STATE_TRIGGERED
 from readthedocs.doc_builder.constants import DOCKER_LIMITS
 
+
 log = logging.getLogger(__name__)
 
 SYNC_USER = getattr(settings, 'SYNC_USER', getpass.getuser())
@@ -87,18 +88,22 @@ def prepare_build(
     :param record: whether or not record the build in a new Build object
     :param force: build the HTML documentation even if the files haven't changed
     :param immutable: whether or not create an immutable Celery signature
-    :returns: Celery signature of update_docs_task to be executed
+    :returns: Celery signature of update_docs_task and Build instance
+    :rtype: tuple
     """
     # Avoid circular import
-    from readthedocs.projects.tasks import update_docs_task
     from readthedocs.builds.models import Build
+    from readthedocs.projects.models import Project
+    from readthedocs.projects.tasks import update_docs_task
+
+    build = None
 
-    if project.skip:
-        log.info(
-            'Build not triggered because Project.skip=True: project=%s',
+    if not Project.objects.is_active(project):
+        log.warning(
+            'Build not triggered because Project is not active: project=%s',
             project.slug,
         )
-        return None
+        return (None, None)
 
     if not version:
         version = project.versions.get(slug=LATEST)
@@ -158,7 +163,8 @@ def trigger_build(project, version=None, record=True, force=False):
     :param version: version of the project to be built. Default: ``latest``
     :param record: whether or not record the build in a new Build object
     :param force: build the HTML documentation even if the files haven't changed
-    :returns: A tuple (Celery AsyncResult promise, Task Signature from ``prepare_build``)
+    :returns: Celery AsyncResult promise and Build instance
+    :rtype: tuple
     """
     update_docs_task, build = prepare_build(
         project,
@@ -168,9 +174,9 @@ def trigger_build(project, version=None, record=True, force=False):
         immutable=True,
     )
 
-    if update_docs_task is None:
-        # Current project is skipped
-        return None
+    if (update_docs_task, build) == (None, None):
+        # Build was skipped
+        return (None, None)
 
     return (update_docs_task.apply_async(), build)
 

readthedocs/projects/querysets.py

@@ -54,6 +54,24 @@ def private(self, user=None):
             return self._add_user_repos(queryset, user)
         return queryset
 
+    def is_active(self, project):
+        """
+        Check if the project is active.
+
+        The check consists on,
+          * the Project shouldn't be marked as skipped.
+
+        :param project: project to be checked
+        :type project: readthedocs.projects.models.Project
+
+        :returns: whether or not the project is active
+        :rtype: bool
+        """
+        if project.skip:
+            return False
+
+        return True
+
     # Aliases
 
     def dashboard(self, user=None):

readthedocs/projects/views/private.py

@@ -287,6 +287,9 @@ def done(self, form_list, **kwargs):
     def trigger_initial_build(self, project):
         """Trigger initial build."""
         update_docs, build = prepare_build(project)
+        if (update_docs, build) == (None, None):
+            return None
+
         task_promise = chain(
             attach_webhook.si(project.pk, self.request.user.pk),
             update_docs,

readthedocs/restapi/views/integrations.py

@@ -13,7 +13,7 @@
 
 import six
 from django.shortcuts import get_object_or_404
-from rest_framework import permissions
+from rest_framework import permissions, status
 from rest_framework.exceptions import NotFound, ParseError
 from rest_framework.renderers import JSONRenderer
 from rest_framework.response import Response
@@ -55,11 +55,14 @@ def post(self, request, project_slug):
         """Set up webhook post view with request and project objects."""
         self.request = request
         self.project = None
+        self.data = self.get_data()
         try:
             self.project = self.get_project(slug=project_slug)
+            if not Project.objects.is_active(self.project):
+                resp = {'detail': 'This project is currently disabled'}
+                return Response(resp, status=status.HTTP_406_NOT_ACCEPTABLE)
         except Project.DoesNotExist:
             raise NotFound('Project not found')
-        self.data = self.get_data()
         resp = self.handle_webhook()
         if resp is None:
             log.info('Unhandled webhook event')