#106: tests: aircox_streamer (#110)

- Writes tests for aircox streamer application;
- Add test utilities in aircox

Co-authored-by: bkfox <thomas bkfox net>
Reviewed-on: rc/aircox#110

aircox_streamer/viewsets.py

@@ -1,15 +1,15 @@
 from django.http import Http404
 from django.shortcuts import get_object_or_404
-from django.utils import timezone as tz
 from rest_framework import viewsets
 from rest_framework.decorators import action
 from rest_framework.exceptions import ValidationError
 from rest_framework.permissions import IsAdminUser
 from rest_framework.response import Response
 
-from aircox.models import Sound, Station
+from aircox.models import Sound
 
 from . import controllers
+
 from .serializers import (
     PlaylistSerializer,
     QueueSourceSerializer,
@@ -19,8 +19,7 @@ from .serializers import (
 )
 
 __all__ = [
-    "Streamers",
-    "BaseControllerAPIView",
+    "ControllerViewSet",
     "RequestViewSet",
     "StreamerViewSet",
     "SourceViewSet",
@@ -29,94 +28,45 @@ __all__ = [
 ]
 
 
-class Streamers:
-    date = None
-    """Next update datetime."""
-    streamers = None
-    """Stations by station id."""
-    timeout = None
-    """Timedelta to next update."""
-
-    def __init__(self, timeout=None):
-        self.timeout = timeout or tz.timedelta(seconds=2)
-
-    def load(self, force=False):
-        # FIXME: cf. TODO in aircox.controllers about model updates
-        stations = Station.objects.active()
-        if self.streamers is None or force:
-            self.streamers = {
-                station.pk: controllers.Streamer(station)
-                for station in stations
-            }
-            return
-
-        streamers = self.streamers
-        self.streamers = {
-            station.pk: controllers.Streamer(station)
-            if station.pk in streamers
-            else streamers[station.pk]
-            for station in stations
-        }
-
-    def fetch(self):
-        if self.streamers is None:
-            self.load()
-
-        now = tz.now()
-        if self.date is not None and now < self.date:
-            return
-
-        for streamer in self.streamers.values():
-            streamer.fetch()
-        self.date = now + self.timeout
-
-    def get(self, key, default=None):
-        return self.streamers.get(key, default)
-
-    def values(self):
-        return self.streamers.values()
-
-    def __getitem__(self, key):
-        return self.streamers[key]
-
-    def __contains__(self, key):
-        return key in self.streamers
-
-
-streamers = Streamers()
-
-
-class BaseControllerAPIView(viewsets.ViewSet):
+class ControllerViewSet(viewsets.ViewSet):
     permission_classes = (IsAdminUser,)
     serializer_class = None
+    streamers = controllers.streamers
+    """Streamers controller instance."""
     streamer = None
+    """User's Streamer instance."""
     object = None
+    """Object to serialize."""
 
-    def get_streamer(self, request, station_pk=None, **kwargs):
-        streamers.fetch()
-        id = int(request.station.pk if station_pk is None else station_pk)
-        if id not in streamers:
+    def get_streamer(self, station_pk=None):
+        """Get user's streamer."""
+        if station_pk is None:
+            station_pk = self.request.station.pk
+        self.streamers.fetch()
+        if station_pk not in self.streamers:
             raise Http404("station not found")
-        return streamers[id]
+        return self.streamers[station_pk]
 
     def get_serializer(self, **kwargs):
+        """Get serializer instance."""
         return self.serializer_class(self.object, **kwargs)
 
     def serialize(self, obj, **kwargs):
+        """Serializer controller data."""
         self.object = obj
         serializer = self.get_serializer(**kwargs)
         return serializer.data
 
     def dispatch(self, request, *args, station_pk=None, **kwargs):
-        self.streamer = self.get_streamer(request, station_pk, **kwargs)
+        self.streamer = self.get_streamer(station_pk)
         return super().dispatch(request, *args, **kwargs)
 
 
-class RequestViewSet(BaseControllerAPIView):
+class RequestViewSet(ControllerViewSet):
     serializer_class = RequestSerializer
 
 
-class StreamerViewSet(BaseControllerAPIView):
+class StreamerViewSet(ControllerViewSet):
     serializer_class = StreamerSerializer
 
     def retrieve(self, request, pk=None):
@@ -124,7 +74,7 @@ class StreamerViewSet(BaseControllerAPIView):
 
     def list(self, request, pk=None):
         return Response(
-            {"results": self.serialize(streamers.values(), many=True)}
+            {"results": self.serialize(self.streamers.values(), many=True)}
         )
 
     def dispatch(self, request, *args, pk=None, **kwargs):
@@ -135,7 +85,7 @@ class StreamerViewSet(BaseControllerAPIView):
         return super().dispatch(request, *args, **kwargs)
 
 
-class SourceViewSet(BaseControllerAPIView):
+class SourceViewSet(ControllerViewSet):
     serializer_class = SourceSerializer
     model = controllers.Source
 
@@ -151,8 +101,8 @@ class SourceViewSet(BaseControllerAPIView):
         return source
 
     def retrieve(self, request, pk=None):
-        self.object = self.get_source(pk)
-        return Response(self.serialize())
+        source = self.get_source(pk)
+        return Response(self.serialize(source))
 
     def list(self, request):
         return Response(
@@ -192,8 +142,8 @@ class QueueSourceViewSet(SourceViewSet):
     serializer_class = QueueSourceSerializer
     model = controllers.QueueSource
 
-    def get_sound_queryset(self):
-        return Sound.objects.station(self.request.station).archive()
+    def get_sound_queryset(self, request):
+        return Sound.objects.station(request.station).archive()
 
     @action(detail=True, methods=["POST"])
     def push(self, request, pk):
@@ -201,7 +151,7 @@ class QueueSourceViewSet(SourceViewSet):
             raise ValidationError('missing "sound_id" POST data')
 
         sound = get_object_or_404(
-            self.get_sound_queryset(), pk=request.data["sound_id"]
+            self.get_sound_queryset(request), pk=request.data["sound_id"]
         )
         return self._run(
             pk, lambda s: s.push(sound.file.path) if sound.file.path else None