✨(back) display in admin video duration and size

In the admin, we want to display for an organization, consumer site and
playlist the addition of videos size and duration.

Author: lunika

CHANGELOG.md

@@ -12,6 +12,7 @@ Versioning](https://semver.org/spec/v2.0.0.html).
 
 - Reject transcoding job for video with too high resolution
 - Add fields to video to store its size and duration
+- Display in admin video duration and size
 
 ### Fixed
 

src/backend/marsha/core/admin.py

@@ -5,6 +5,7 @@
 from django.contrib import admin
 from django.contrib.auth.admin import UserAdmin as DefaultUserAdmin
 from django.contrib.sites.models import Site
+from django.db.models import Sum
 from django.urls import reverse
 from django.utils.html import format_html
 from django.utils.translation import gettext_lazy as _
@@ -79,6 +80,27 @@ def _link_field(obj):
     return _link_field
 
 
+def display_human_size(size):
+    """Format a size in bytes into a human readable string."""
+    if size is None:
+        return "-"
+
+    suffixes = ["B", "KB", "MB", "GB", "TB", "PB"]
+    while size >= 1024:
+        size /= 1024
+        suffixes.pop(0)
+
+    return f"{size:.2f} {suffixes[0]}"
+
+
+def display_human_duration(duration):
+    """Format a duration in seconds into a human readable string."""
+    if duration is None:
+        return "-"
+
+    return str(datetime.timedelta(seconds=duration))
+
+
 class BaseFileAdmin(admin.ModelAdmin):
     """Base admin class for file model."""
 
@@ -227,8 +249,34 @@ class ConsumerSiteAdmin(admin.ModelAdmin):
         "video_show_download_default",
         "inactive_resources",
         "inactive_features",
+        "duration_usage",
+        "size_usage",
     )
-    readonly_fields = ["id", "created_on", "updated_on"]
+    readonly_fields = [
+        "id",
+        "created_on",
+        "updated_on",
+        "duration_usage",
+        "size_usage",
+    ]
+
+    @admin.display(description=_("Size"))
+    def size_usage(self, instance):
+        """Return the size of the videos in the consumer site."""
+        size_usage = Video.objects.filter(playlist__consumer_site=instance).aggregate(
+            Sum("size")
+        )["size__sum"]
+
+        return display_human_size(size_usage)
+
+    @admin.display(description=_("Duration"))
+    def duration_usage(self, instance):
+        """Return the duration of the videos in the consumer site."""
+        duration_usage = Video.objects.filter(
+            playlist__consumer_site=instance
+        ).aggregate(Sum("duration"))["duration__sum"]
+
+        return display_human_duration(duration_usage)
 
 
 class OrganizationUsersInline(admin.TabularInline):
@@ -254,6 +302,29 @@ class OrganizationAdmin(admin.ModelAdmin):
     list_display = ("name",)
     inlines = [OrganizationUsersInline, OrganizationConsumerSitesInline]
 
+    readonly_fields = [
+        "duration_usage",
+        "size_usage",
+    ]
+
+    @admin.display(description=_("Size"))
+    def size_usage(self, instance):
+        """Return the size of the videos in the organization."""
+        size_usage = Video.objects.filter(playlist__organization=instance).aggregate(
+            Sum("size")
+        )["size__sum"]
+
+        return display_human_size(size_usage)
+
+    @admin.display(description=_("Duration"))
+    def duration_usage(self, instance):
+        """Return the duration of the videos in the organization."""
+        duration_usage = Video.objects.filter(
+            playlist__organization=instance
+        ).aggregate(Sum("duration"))["duration__sum"]
+
+        return display_human_duration(duration_usage)
+
 
 class AudioTrackInline(admin.TabularInline):
     """Inline for audio tracks of a video."""
@@ -317,24 +388,12 @@ class VideoAdmin(BaseFileAdmin):
     @admin.display(description=_("Size"))
     def display_size(self, obj):
         """Return the size of the video."""
-        if obj.size is None:
-            return "-"
-
-        suffixes = ["B", "KB", "MB", "GB", "TB", "PB"]
-        size = obj.size
-        while size >= 1024:
-            size /= 1024
-            suffixes.pop(0)
-
-        return f"{size:.2f} {suffixes[0]}"
+        return display_human_size(obj.size)
 
     @admin.display(description=_("Duration"))
     def display_duration(self, obj):
         """Return the duration of the video."""
-        if obj.duration is None:
-            return "-"
-
-        return str(datetime.timedelta(seconds=obj.duration))
+        return display_human_duration(obj.duration)
 
 
 @admin.register(TimedTextTrack)
@@ -440,13 +499,17 @@ class PlaylistAdmin(admin.ModelAdmin):
         "retention_duration",
         "updated_on",
         "created_on",
+        "duration_usage",
+        "size_usage",
     )
     readonly_fields = [
         "id",
         "created_by",
         "created_on",
         "duplicated_from",
         "updated_on",
+        "duration_usage",
+        "size_usage",
     ]
     list_filter = (
         "consumer_site__domain",
@@ -467,6 +530,24 @@ class PlaylistAdmin(admin.ModelAdmin):
     )
     verbose_name = _("Playlist")
 
+    @admin.display(description=_("Size"))
+    def size_usage(self, instance):
+        """Return the size of the videos in the playlist."""
+        size_usage = Video.objects.filter(playlist=instance).aggregate(Sum("size"))[
+            "size__sum"
+        ]
+
+        return display_human_size(size_usage)
+
+    @admin.display(description=_("Duration"))
+    def duration_usage(self, instance):
+        """Return the duration of the videos in the playlist."""
+        duration_usage = Video.objects.filter(playlist=instance).aggregate(
+            Sum("duration")
+        )["duration__sum"]
+
+        return display_human_duration(duration_usage)
+
 
 @admin.register(LTIPassport)
 class LTIPassportAdmin(admin.ModelAdmin):

src/backend/marsha/core/tests/test_admin.py

@@ -4,7 +4,7 @@
 from django.test import TestCase
 from django.urls import NoReverseMatch
 
-from marsha.core.admin import link_field
+from marsha.core.admin import display_human_duration, display_human_size, link_field
 from marsha.core.factories import (
     ConsumerSiteLTIPassportFactory,
     PlaylistLTIPassportFactory,
@@ -16,8 +16,8 @@
 # pylint: disable=unused-argument
 
 
-class AdminLinkFieldTestCase(TestCase):
-    """Test the `link_field` helper works as expected."""
+class AdminTestCase(TestCase):
+    """Test all admin helpers."""
 
     def test_link_field_no_linked_object(self):
         """Assert `link_field` works properly when no instance is linked."""
@@ -64,3 +64,27 @@ class Meta:
             link_field("linked_object")(instance_with_linked_object)
         reverse_exception = exc_context_mgr.exception
         self.assertIn("one_app_amodel_change", str(reverse_exception))
+
+    def test_display_human_duration(self):
+        """Assert `display_human_duration` works properly."""
+
+        self.assertEqual(display_human_duration(0), "0:00:00")
+        self.assertEqual(display_human_duration(1), "0:00:01")
+        self.assertEqual(display_human_duration(60), "0:01:00")
+        self.assertEqual(display_human_duration(61), "0:01:01")
+        self.assertEqual(display_human_duration(3600), "1:00:00")
+        self.assertEqual(display_human_duration(3661), "1:01:01")
+        self.assertEqual(display_human_duration(7500), "2:05:00")
+        self.assertEqual(display_human_duration(None), "-")
+
+    def test_display_human_size(self):
+        """Assert `display_human_size` works properly."""
+
+        self.assertEqual(display_human_size(0), "0.00 B")
+        self.assertEqual(display_human_size(1), "1.00 B")
+        self.assertEqual(display_human_size(1024), "1.00 KB")
+        self.assertEqual(display_human_size(1024**2), "1.00 MB")
+        self.assertEqual(display_human_size(1024**3), "1.00 GB")
+        self.assertEqual(display_human_size(1024**4), "1.00 TB")
+        self.assertEqual(display_human_size(1024**5), "1.00 PB")
+        self.assertEqual(display_human_size(None), "-")