Refactor: SnapshotSave

Author: SrMouraSilva

mod/controller/rest/snapshot.py

@@ -52,3 +52,17 @@ 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 SnapshotSave(JsonRequestHandler):
+
+    # TODO: Replace POST /snapshot/save
+    #            to POST /pedalboards/current/snapshots/current
+    def post(self):
+        """
+        Update the current snapshot status
+
+        :return: `true` if it was successfully updated
+        """
+        ok = SESSION.host.snapshot_save()
+        self.write(ok)

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, SnapshotList
+from mod.controller.rest.snapshot import SnapshotName, SnapshotList, SnapshotSave
 
 try:
     from signal import signal, SIGUSR1, SIGUSR2
@@ -1555,11 +1555,6 @@ def post(self, mode):
         ok = yield gen.Task(SESSION.web_set_sync_mode, transport_sync)
         self.write(ok)
 
-class SnapshotSave(JsonRequestHandler):
-    def post(self):
-        ok = SESSION.host.snapshot_save()
-        self.write(ok)
-
 class SnapshotSaveAs(JsonRequestHandler):
     @web.asynchronous
     @gen.engine

test/controller/snapshot_list_test.py

@@ -7,7 +7,6 @@
 
 from tornado.testing import AsyncHTTPTestCase
 
-from mod.settings import DEFAULT_SNAPSHOT_NAME
 from mod.webserver import application
 
 

test/controller/snapshot_save_test.py

@@ -0,0 +1,68 @@
+#!/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.httpclient import HTTPRequest
+from tornado.testing import AsyncHTTPTestCase
+
+from mod.webserver import application
+
+
+class SnapshotSaveTestCase(AsyncHTTPTestCase):
+    def get_app(self):
+        return application
+
+    def test_save(self):
+        # Create a snapshot
+        name = str(uuid4())
+        snapshot_index = self._save_as(name)
+
+        # Load and save snapshot created
+        self.fetch("/snapshot/load?id=" + str(snapshot_index))
+        response = self.post("/snapshot/save")
+
+        # Assert is saved
+        self.assertEqual(response.code, 200)
+        self.assertTrue(json.loads(response.body))
+
+        # Clear
+        self.fetch("/snapshot/remove?id=" + str(snapshot_index))
+
+    def test_save_deleted_snapshot(self):
+        # Create two snapshots
+        # because it is necessary to exists at least one
+        snapshot_1 = str(uuid4())
+        snapshot_2 = str(uuid4())
+
+        snapshot_1_index = self._save_as(snapshot_1)
+        snapshot_2_index = self._save_as(snapshot_2)
+
+        # Save snapshot created
+        self.fetch("/snapshot/load?id=" + str(snapshot_2_index))
+        response = self.post("/snapshot/save")
+
+        # Assert is saved
+        self.assertEqual(response.code, 200)
+        self.assertTrue(json.loads(response.body))
+
+        # Delete created snapshot
+        self.fetch("/snapshot/remove?id=" + str(snapshot_2_index))
+
+        # Try to save deleted snapshot
+        response = self.post("/snapshot/save")
+        self.assertEqual(response.code, 200)
+        self.assertFalse(json.loads(response.body))
+
+        # Clear
+        self.fetch("/snapshot/remove?id=" + str(snapshot_1_index))
+
+    def post(self, url):
+        self.http_client.fetch(HTTPRequest(self.get_url(url), "POST", allow_nonstandard_methods=True), self.stop)
+        return self.wait()
+
+    def _save_as(self, name):
+        response = json.loads(self.fetch("/snapshot/saveas?title=" + name).body)
+        return response['id']