Refactor: SnapshotList

Author: SrMouraSilva

mod/controller/rest/snapshot.py

@@ -8,7 +8,6 @@
 
 class SnapshotName(JsonRequestHandler):
 
-
     # TODO: Replace GET /snapshot/name
     #            to GET /pedalboards/<pedalboard id>/snapshots/
     def get(self):
@@ -31,3 +30,25 @@ def get(self):
             'ok': bool(name),   # FIXME: Always true
             'name': name
         })
+
+
+class SnapshotList(JsonRequestHandler):
+
+    # TODO: Replace GET /snapshot/list
+    #            to GET /pedalboards/<pedalboard id>/snapshots/
+    def get(self):
+        """
+        Get snapshots name of the loaded pedalboard
+
+        .. code-block:: json
+
+            {
+                0: "First snapshot",
+                1: "Second snapshot"
+            }
+
+        :return: names of the current pedalboard snapshots
+        """
+        snapshots = SESSION.host.pedalboard_snapshots
+        snapshots = dict((i, snapshots[i]['name']) for i in range(len(snapshots)) if snapshots[i] is not None)
+        self.write(snapshots)

mod/webserver.py

@@ -22,7 +22,7 @@
 
 from mod.controller.handler.json_request_handler import JsonRequestHandler
 from mod.controller.handler.timeless_request_handler import TimelessRequestHandler
-from mod.controller.rest.snapshot import SnapshotName
+from mod.controller.rest.snapshot import SnapshotName, SnapshotList
 
 try:
     from signal import signal, SIGUSR1, SIGUSR2
@@ -1600,12 +1600,6 @@ def get(self):
         ok  = SESSION.host.snapshot_remove(idx)
         self.write(ok)
 
-class SnapshotList(JsonRequestHandler):
-    def get(self):
-        snapshots = SESSION.host.pedalboard_snapshots
-        snapshots = dict((i, snapshots[i]['name']) for i in range(len(snapshots)) if snapshots[i] is not None)
-        self.write(snapshots)
-
 class SnapshotLoad(JsonRequestHandler):
     @web.asynchronous
     @gen.engine

test/controller/snapshot_list_test.py

@@ -0,0 +1,52 @@
+#!/usr/bin/env python3
+# SPDX-FileCopyrightText: 2012-2023 MOD Audio UG
+# SPDX-License-Identifier: AGPL-3.0-or-later
+# This test uses coroutine style.
+import json
+from uuid import uuid4
+
+from tornado.testing import AsyncHTTPTestCase
+
+from mod.settings import DEFAULT_SNAPSHOT_NAME
+from mod.webserver import application
+
+
+class SnapshotListTestCase(AsyncHTTPTestCase):
+    def get_app(self):
+        return application
+
+    # Pedalboard starts empty, but after there is one, it isn't possible to exclude all of them
+    # def test_empty(self):
+    #     response = self.fetch("/snapshot/list")
+    #
+    #     self.assertEqual(response.code, 200)
+    #     self.assert_equal([], response.body)
+
+    def test_populated_name(self):
+        original_snapshots = json.loads(self.fetch("/snapshot/list").body)
+
+        # Populate
+        expected_name_0 = str(uuid4())
+        expected_name_1 = str(uuid4())
+
+        self.fetch("/snapshot/saveas?title=" + expected_name_0)
+        self.fetch("/snapshot/saveas?title=" + expected_name_1)
+
+        response = self.fetch("/snapshot/list")
+
+        # Assert list
+        new_snapshots = self._names(original_snapshots) + [expected_name_0, expected_name_1]
+        self.assert_equal(new_snapshots, response.body)
+
+        # Clear created
+        for index in reversed(range(len(original_snapshots), len(new_snapshots)+1)):
+            self.fetch("/snapshot/remove?id=" + str(index))
+
+    def assert_equal(self, lista, body):
+        self.assertDictEqual(
+            {str(index): item for index, item in enumerate(lista)},
+            json.loads(body)
+        )
+
+    def _names(self, snapshots):
+        return list(snapshots.values())

…/controller/snapshot_controllers_test.py test/controller/snapshot_name_test.pytest/controller/snapshot_controllers_test.py renamed to test/controller/snapshot_name_test.py test/controller/snapshot_controllers_test.py renamed to test/controller/snapshot_name_test.py

@@ -3,6 +3,7 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # This test uses coroutine style.
 import json
+from uuid import uuid4
 
 from tornado.testing import AsyncHTTPTestCase
 
@@ -18,41 +19,31 @@ def test_name_missing_snapshot(self):
         response = self.fetch("/snapshot/name?id=1000")
 
         self.assertEqual(response.code, 200)
-        self.assertDictEqual(
-            {
-                'ok': True,   # FIXME: Always true
-                'name': DEFAULT_SNAPSHOT_NAME
-            },
-            json.loads(response.body)
-        )
+        self.assert_equal(DEFAULT_SNAPSHOT_NAME, response.body)
 
     def test_name_negative_snapshot(self):
         response = self.fetch("/snapshot/name?id=-1")
 
         self.assertEqual(response.code, 200)
-        self.assertDictEqual(
-            {
-                'ok': True,   # FIXME: Always true
-                'name': DEFAULT_SNAPSHOT_NAME
-            },
-            json.loads(response.body)
-        )
+        self.assert_equal(DEFAULT_SNAPSHOT_NAME, response.body)
 
     def test_name(self):
-        expected_name_0 = 'Title-0'
-        expected_name_1 = 'Title-1'
+        expected_name_0 = str(uuid4())
+        expected_name_1 = str(uuid4())
 
         self.fetch("/snapshot/saveas?title=" + expected_name_0)
         self.fetch("/snapshot/saveas?title=" + expected_name_1)
 
-        response_0 = self.fetch("/snapshot/name?id=0")
-        response_1 = self.fetch("/snapshot/name?id=1")
+        snapshots = self.saved_items()
+
+        response_0 = self.fetch("/snapshot/name?id=" + snapshots[expected_name_0])
+        response_1 = self.fetch("/snapshot/name?id=" + snapshots[expected_name_1])
 
         self.assert_equal(expected_name_0, response_0.body)
         self.assert_equal(expected_name_1, response_1.body)
 
-        self.fetch("/snapshot/remove?id=1")
-        self.fetch("/snapshot/remove?id=0")
+        for index in reversed(range(len(snapshots), 0)):
+            self.fetch("/snapshot/remove?id=" + str(index))
 
     def assert_equal(self, name, body):
         self.assertDictEqual(
@@ -62,3 +53,11 @@ def assert_equal(self, name, body):
             },
             json.loads(body)
         )
+
+    def saved_items(self):
+        items = self.fetch("/snapshot/list")
+
+        return {
+            value: key
+            for key, value in json.loads(items.body).items()
+        }