Merge pull request #3147 from rtfd/build-cold-storage

Add cold storage option on builds & configurable BuildViewSet

Author: ericholscher

readthedocs/builds/admin.py

@@ -12,7 +12,7 @@ class BuildCommandResultInline(admin.TabularInline):
 
 
 class BuildAdmin(admin.ModelAdmin):
-    fields = ('project', 'version', 'type', 'state', 'error', 'success', 'length')
+    fields = ('project', 'version', 'type', 'state', 'error', 'success', 'length', 'cold_storage')
     list_display = ('project', 'success', 'type', 'state', 'date')
     raw_id_fields = ('project', 'version')
     inlines = (BuildCommandResultInline,)

readthedocs/builds/migrations/0003_add-cold-storage.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.9.12 on 2017-10-04 17:27
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('builds', '0002_build_command_initial'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='build',
+            name='cold_storage',
+            field=models.BooleanField(default=False, help_text='Build comamnds are stored outside the database.', verbose_name='Cold Storage'),
+        ),
+    ]

readthedocs/builds/models.py

@@ -348,6 +348,9 @@ class Build(models.Model):
 
     builder = models.CharField(_('Builder'), max_length=255, null=True, blank=True)
 
+    cold_storage = models.BooleanField(_('Cold Storage'), default=False,
+                                       help_text='Build comamnds are stored outside the database.')
+
     # Manager
 
     objects = BuildQuerySet.as_manager()

readthedocs/restapi/views/model_views.py

@@ -13,6 +13,7 @@
 from readthedocs.builds.constants import TAG
 from readthedocs.builds.models import Build, BuildCommandResult, Version
 from readthedocs.core.utils import trigger_build
+from readthedocs.core.utils.extend import SettingsOverrideObject
 from readthedocs.oauth.services import GitHubService, registry
 from readthedocs.oauth.models import RemoteOrganization, RemoteRepository
 from readthedocs.projects.models import Project, EmailHook, Domain
@@ -167,7 +168,7 @@ def get_queryset(self):
         return self.model.objects.api(self.request.user)
 
 
-class BuildViewSet(viewsets.ModelViewSet):
+class BuildViewSetBase(viewsets.ModelViewSet):
     permission_classes = [APIRestrictedPermission]
     renderer_classes = (JSONRenderer,)
     model = Build
@@ -186,7 +187,17 @@ def get_serializer_class(self):
         return BuildSerializer
 
 
+class BuildViewSet(SettingsOverrideObject):
+
+    """A pluggable class to allow for build cold storage."""
+
+    _default_class = BuildViewSetBase
+
+
 class BuildCommandViewSet(viewsets.ModelViewSet):
+
+    """This is currently a write-only way to update the commands on build."""
+
     permission_classes = [APIRestrictedPermission]
     renderer_classes = (JSONRenderer,)
     serializer_class = BuildCommandSerializer