Add admin functions for wiping a version

readthedocs/builds/admin.py

@@ -2,10 +2,11 @@
 
 """Django admin interface for `~builds.models.Build` and related models."""
 
-from django.contrib import admin
+from django.contrib import admin, messages
 from guardian.admin import GuardedModelAdmin
 
-from readthedocs.builds.models import Build, BuildCommandResult, Version
+from readthedocs.builds.models import Build, Version, BuildCommandResult
+from readthedocs.core.utils.general import wipe_version_via_slug
 
 
 class BuildCommandResultInline(admin.TabularInline):
@@ -55,6 +56,19 @@ class VersionAdmin(GuardedModelAdmin):
     )
     list_filter = ('type', 'privacy_level', 'active', 'built')
     raw_id_fields = ('project',)
+    actions = ['wipe_selected_versions']
+
+    def wipe_selected_versions(self, request, queryset):
+        """Wipes the selected versions."""
+        for version in queryset:
+            wipe_version_via_slug(version.slug)
+            self.message_user(
+                request,
+                'Wiped {}.'.format(version.slug),
+                level=messages.SUCCESS
+            )
+
+    wipe_selected_versions.short_description = 'Wipe selected versions'
 
 
 admin.site.register(Build, BuildAdmin)

readthedocs/core/utils/general.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+
+import os
+
+from django.shortcuts import get_object_or_404
+
+from readthedocs.core.utils import broadcast
+from readthedocs.projects.tasks import remove_dirs
+from readthedocs.builds.models import Version
+
+
+def wipe_version_via_slug(version_slug):
+    """Wipes the given version."""
+    version = get_object_or_404(Version, slug=version_slug)
+    del_dirs = [
+        os.path.join(version.project.doc_path, 'checkouts', version.slug),
+        os.path.join(version.project.doc_path, 'envs', version.slug),
+        os.path.join(version.project.doc_path, 'conda', version.slug),
+    ]
+    for del_dir in del_dirs:
+        broadcast(type='build', task=remove_dirs, args=[(del_dir,)])

readthedocs/core/views/__init__.py

@@ -6,9 +6,6 @@
 documentation and header rendering, and server errors.
 """
 
-from __future__ import absolute_import
-from __future__ import division
-import os
 import logging
 
 from django.conf import settings
@@ -17,10 +14,9 @@
 from django.views.generic import TemplateView
 
 from readthedocs.builds.models import Version
-from readthedocs.core.utils import broadcast
 from readthedocs.projects.models import Project, ImportedFile
-from readthedocs.projects.tasks import remove_dirs
 from readthedocs.redirects.utils import get_redirect_response
+from readthedocs.core.utils.general import wipe_version_via_slug
 
 log = logging.getLogger(__name__)
 
@@ -83,13 +79,7 @@ def wipe_version(request, project_slug, version_slug):
         raise Http404('You must own this project to wipe it.')
 
     if request.method == 'POST':
-        del_dirs = [
-            os.path.join(version.project.doc_path, 'checkouts', version.slug),
-            os.path.join(version.project.doc_path, 'envs', version.slug),
-            os.path.join(version.project.doc_path, 'conda', version.slug),
-        ]
-        for del_dir in del_dirs:
-            broadcast(type='build', task=remove_dirs, args=[(del_dir,)])
+        wipe_version_via_slug(version)
         return redirect('project_version_list', project_slug)
     return render(
         request,

readthedocs/rtd_tests/tests/test_core_utils.py

@@ -1,11 +1,17 @@
 # -*- coding: utf-8 -*-
 """Test core util functions."""
 
+import os
 import mock
+
+from mock import call
+from django.http import Http404
 from django.test import TestCase
 from django_dynamic_fixture import get
 
 from readthedocs.builds.models import Version
+from readthedocs.core.utils.general import wipe_version_via_slug
+from readthedocs.projects.tasks import remove_dirs
 from readthedocs.core.utils import slugify, trigger_build
 from readthedocs.projects.models import Project
 
@@ -153,3 +159,29 @@ def test_slugify(self):
             slugify('A title_-_with separated parts', dns_safe=False),
             'a-title_-_with-separated-parts',
         )
+
+    @mock.patch('readthedocs.core.utils.general.broadcast')
+    def test_wipe_version_via_slug(self, mock_broadcast):
+        wipe_version_via_slug(self.version.slug)
+        expected_del_dirs = [
+            os.path.join(self.version.project.doc_path, 'checkouts', self.version.slug),
+            os.path.join(self.version.project.doc_path, 'envs', self.version.slug),
+            os.path.join(self.version.project.doc_path, 'conda', self.version.slug),
+        ]
+
+        mock_broadcast.assert_has_calls(
+            [
+                call(type='build', task=remove_dirs, args=[(expected_del_dirs[0],)]),
+                call(type='build', task=remove_dirs, args=[(expected_del_dirs[1],)]),
+                call(type='build', task=remove_dirs, args=[(expected_del_dirs[2],)]),
+            ],
+            any_order=False
+        )
+
+    @mock.patch('readthedocs.core.utils.general.broadcast')
+    def test_wipe_version_via_slug_wrong_param(self, mock_broadcast):
+        self.assertFalse(Version.objects.filter(slug='wrong-slug').exists())
+
+        with self.assertRaises(Http404):
+            wipe_version_via_slug('wrong-slug')
+        mock_broadcast.assert_not_called()

readthedocs/rtd_tests/tests/versions/test_admin_actions.py

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+
+import os
+import mock
+
+from mock import call
+import django_dynamic_fixture as fixture
+from django.test import TestCase
+from django.contrib.admin.helpers import ACTION_CHECKBOX_NAME
+from django.contrib.auth.models import User
+from django import urls
+
+from readthedocs.builds.models import Version
+from readthedocs.core.models import UserProfile
+from readthedocs.projects.models import Project
+from readthedocs.projects.tasks import remove_dirs
+
+
+class VersionAdminActionsTest(TestCase):
+
+    @classmethod
+    def setUpTestData(cls):
+        cls.owner = fixture.get(User)
+        cls.profile = fixture.get(UserProfile, user=cls.owner, banned=False)
+        cls.admin = fixture.get(User, is_staff=True, is_superuser=True)
+        cls.project = fixture.get(
+            Project,
+            main_language_project=None,
+            users=[cls.owner],
+        )
+        cls.version = fixture.get(Version, project=cls.project)
+
+    def setUp(self):
+        self.client.force_login(self.admin)
+
+    @mock.patch('readthedocs.core.utils.general.broadcast')
+    def test_wipe_selected_version(self, mock_broadcast):
+        action_data = {
+            ACTION_CHECKBOX_NAME: [self.version.pk],
+            'action': 'wipe_selected_versions',
+            'post': 'yes',
+        }
+        resp = self.client.post(
+            urls.reverse('admin:builds_version_changelist'),
+            action_data
+        )
+        expected_del_dirs = [
+            os.path.join(self.version.project.doc_path, 'checkouts', self.version.slug),
+            os.path.join(self.version.project.doc_path, 'envs', self.version.slug),
+            os.path.join(self.version.project.doc_path, 'conda', self.version.slug),
+        ]
+
+        mock_broadcast.assert_has_calls(
+            [
+                call(type='build', task=remove_dirs, args=[(expected_del_dirs[0],)]),
+                call(type='build', task=remove_dirs, args=[(expected_del_dirs[1],)]),
+                call(type='build', task=remove_dirs, args=[(expected_del_dirs[2],)]),
+            ],
+            any_order=False
+        )