Refactor: SnapshotName

SrMouraSilva · SrMouraSilva · commit e1663e71f014 · 2023-10-16T20:28:57.000-03:00
diff --git a/.github/workflows/irc.yml b/.github/workflows/irc.yml
@@ -4,6 +4,7 @@ on: [push]
 
 jobs:
   notification:
+    if: github.repository == 'moddevices/mod-ui'
     runs-on: ubuntu-latest
     name: IRC notification
     steps:
diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml
@@ -19,6 +19,9 @@ jobs:
           pip3 install pylint
       - name: Run pylint
         run: |
+          export MOD_DEV_HOST=1
+          export MOD_DEV_ENVIRONMENT=0
+          
           virtualenv modui-env
           source modui-env/bin/activate
           pylint -E mod/*.py 
diff --git a/.github/workflows/unittest.yml b/.github/workflows/unittest.yml
@@ -0,0 +1,58 @@
+name: unittest
+
+on: [push, pull_request]
+
+jobs:
+  unittest:
+    runs-on: ubuntu-22.04
+    name: unittest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install virtualenv
+        run: |
+          sudo apt install python3-virtualenv
+      - name: Setup utils
+        run: |
+          sudo apt install python3-dev build-essential libasound2-dev libjack-jackd2-dev liblilv-dev libjpeg-dev zlib1g-dev
+          make -C utils
+      - name: Setup unittest
+        run: |
+          virtualenv modui-env
+          source modui-env/bin/activate
+          pip3 install -r requirements.txt
+          # pytest
+          pip3 install pytest pytest-cov
+          sed -i -e 's/collections.MutableMapping/collections.abc.MutableMapping/' modui-env/lib/python3.10/site-packages/tornado/httputil.py
+          # mod
+          python3 setup.py develop
+      - name: Run unittest
+        run: |
+          virtualenv modui-env
+          source modui-env/bin/activate
+          pytest --cov=mod --cov-report=html --cov-report=term --cov-report=xml
+      - name: Archive coverage files
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage
+          path: |
+            .coverage
+            htmlcov/**
+            cobertura.xml
+      - name: Code Coverage Report
+        uses: irongut/CodeCoverageSummary@v1.3.0
+        with:
+          filename: coverage.xml
+          badge: true
+          fail_below_min: true
+          format: markdown
+          hide_branch_rate: false
+          hide_complexity: false
+          indicators: true
+          output: both
+          thresholds: '15 30'
+      - name: Add Coverage PR Comment
+        uses: marocchino/sticky-pull-request-comment@v2
+        if: github.event_name == 'pull_request'
+        with:
+          recreate: true
+          path: code-coverage-results.md
diff --git a/.gitignore b/.gitignore
@@ -37,3 +37,7 @@ utils/test
 *node_modules/
 .idea
 *.egg-info
+# Coverage
+.coverage
+coverage.xml
+htmlcov/
diff --git a/README.rst b/README.rst
@@ -58,3 +58,33 @@ And now you are ready to start the webserver::
 
 Setting the environment variables is needed when developing on a PC.
 Open your browser and point to http://localhost:8888/.
+
+Development
+-----------
+
+The source code is expected to be ran on a Python 3.4 version.
+
+The source code is organized with the following structure
+
+* ``html``: Frontend source code
+* ``mod``: Backend source code
+  * ``controller/``: Tornado related source code
+    * ``rest/``: REST classes
+    * ``websocket/``: web-socket classes
+    * ``dto/``: Utility model representation
+    * ``handler/``: Common tornado handlers
+    * ``file_receiver/``: Common tornado file receivers
+  * ``model/``: Model abstraction (snapshot, pedalboard, bank)
+  * ``service/``: High level layer for ``mod-host`` usage
+  * ``util/``: Common utility source code
+  * ``settings.py``: Application parameters
+  * ``host.py``: ``mod-host`` interface for communication with application
+  * ``webserver.py``: Web-server initialization
+* ``modtools``:
+* ``test``: Python unit tests
+* ``utils``: C++ utility code
+
+
+Some IDEs can improve the code completion if you install mod-ui as an local packaged on virtualenv::
+
+    $ python3 setup.py develop
diff --git a/mod/controller/__init__.py b/mod/controller/__init__.py
@@ -0,0 +1,3 @@
+#!/usr/bin/env python3
+# SPDX-FileCopyrightText: 2012-2023 MOD Audio UG
+# SPDX-License-Identifier: AGPL-3.0-or-later
diff --git a/mod/controller/handler/__init__.py b/mod/controller/handler/__init__.py
@@ -0,0 +1,3 @@
+#!/usr/bin/env python3
+# SPDX-FileCopyrightText: 2012-2023 MOD Audio UG
+# SPDX-License-Identifier: AGPL-3.0-or-later
diff --git a/mod/controller/handler/json_request_handler.py b/mod/controller/handler/json_request_handler.py
@@ -0,0 +1,41 @@
+#!/usr/bin/env python3
+# SPDX-FileCopyrightText: 2012-2023 MOD Audio UG
+# SPDX-License-Identifier: AGPL-3.0-or-later
+import json
+
+from tornado.util import unicode_type
+
+from mod.controller.handler.timeless_request_handler import TimelessRequestHandler
+
+
+class JsonRequestHandler(TimelessRequestHandler):
+    def write(self, data):
+        # FIXME: something is sending strings out, need to investigate what later..
+        # it's likely something using write(json.dumps(...))
+        # we want to prevent that as it causes issues under Mac OS
+
+        if isinstance(data, (bytes, unicode_type, dict)):
+            TimelessRequestHandler.write(self, data)
+            self.finish()
+            return
+
+        elif data is True:
+            data = "true"
+            self.set_header("Content-Type", "application/json; charset=UTF-8")
+
+        elif data is False:
+            data = "false"
+            self.set_header("Content-Type", "application/json; charset=UTF-8")
+
+        # TESTING for data types, remove this later
+        #elif not isinstance(data, list):
+            #print("=== TESTING: Got new data type for RequestHandler.write():", type(data), "msg:", data)
+            #data = json.dumps(data)
+            #self.set_header('Content-type', 'application/json')
+
+        else:
+            data = json.dumps(data)
+            self.set_header("Content-Type", "application/json; charset=UTF-8")
+
+        TimelessRequestHandler.write(self, data)
+        self.finish()
diff --git a/mod/controller/handler/timeless_request_handler.py b/mod/controller/handler/timeless_request_handler.py
@@ -0,0 +1,15 @@
+#!/usr/bin/env python3
+# SPDX-FileCopyrightText: 2012-2023 MOD Audio UG
+# SPDX-License-Identifier: AGPL-3.0-or-later
+from tornado import web
+
+
+class TimelessRequestHandler(web.RequestHandler):
+    def compute_etag(self):
+        return None
+
+    def set_default_headers(self):
+        self._headers.pop("Date")
+
+    def should_return_304(self):
+        return False
diff --git a/mod/controller/rest/__init__.py b/mod/controller/rest/__init__.py
@@ -0,0 +1,3 @@
+#!/usr/bin/env python3
+# SPDX-FileCopyrightText: 2012-2023 MOD Audio UG
+# SPDX-License-Identifier: AGPL-3.0-or-later
diff --git a/mod/controller/rest/snapshot.py b/mod/controller/rest/snapshot.py
@@ -0,0 +1,33 @@
+#!/usr/bin/env python3
+# SPDX-FileCopyrightText: 2012-2023 MOD Audio UG
+# SPDX-License-Identifier: AGPL-3.0-or-later
+from mod.controller.handler.json_request_handler import JsonRequestHandler
+from mod.session import SESSION
+from mod.settings import DEFAULT_SNAPSHOT_NAME
+
+
+class SnapshotName(JsonRequestHandler):
+
+
+    # TODO: Replace GET /snapshot/name
+    #            to GET /pedalboards/<pedalboard id>/snapshots/
+    def get(self):
+        """
+        Remove the snapshot name of identifier ``id`` of the loaded pedalboard;
+        If is requested by an invalid ``id``, will be returned the default snapshot name.
+
+        .. code-block:: json
+
+            {
+                "ok": true,
+                "name": "Pedalboard name"
+            }
+
+        :return: Snapshot name
+        """
+        idx = int(self.get_argument('id'))
+        name = SESSION.host.snapshot_name(idx) or DEFAULT_SNAPSHOT_NAME
+        self.write({
+            'ok': bool(name),   # FIXME: Always true
+            'name': name
+        })
diff --git a/mod/webserver.py b/mod/webserver.py
@@ -10,16 +10,19 @@
 import subprocess
 import sys
 import time
-
 from base64 import b64decode, b64encode
 from datetime import timedelta
 from random import randint
-from tornado import gen, iostream, web, websocket
+from uuid import uuid4
+
+from tornado import gen, web, websocket
 from tornado.escape import squeeze, url_escape, xhtml_escape
 from tornado.ioloop import IOLoop
 from tornado.template import Loader
-from tornado.util import unicode_type
-from uuid import uuid4
+
+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
 
 try:
     from signal import signal, SIGUSR1, SIGUSR2
@@ -36,13 +39,12 @@
                           LV2_PLUGIN_DIR, LV2_PEDALBOARDS_DIR, IMAGE_VERSION,
                           UPDATE_CC_FIRMWARE_FILE, UPDATE_MOD_OS_FILE, UPDATE_MOD_OS_HERLPER_FILE, USING_256_FRAMES_FILE,
                           DEFAULT_ICON_TEMPLATE, DEFAULT_SETTINGS_TEMPLATE, DEFAULT_ICON_IMAGE,
-                          DEFAULT_PEDALBOARD, DEFAULT_SNAPSHOT_NAME, DATA_DIR, KEYS_PATH, USER_FILES_DIR,
+                          DEFAULT_PEDALBOARD, DATA_DIR, KEYS_PATH, USER_FILES_DIR,
                           FAVORITES_JSON_FILE, PREFERENCES_JSON_FILE, USER_ID_JSON_FILE,
                           DEV_HOST, UNTITLED_PEDALBOARD_NAME, MODEL_CPU, MODEL_TYPE, PEDALBOARDS_LABS_HTTP_ADDRESS)
 
 from mod import (
-    TextFileFlusher, WINDOWS,
-    check_environment, jsoncall, safe_json_load,
+    TextFileFlusher, check_environment, jsoncall, safe_json_load,
     get_hardware_descriptor, get_unique_name, os_sync, symbolify,
 )
 from mod.bank import list_banks, save_banks, remove_pedalboard_from_banks
@@ -207,15 +209,6 @@ def reset_get_all_pedalboards_cache_with_refresh(ptype):
     reset_get_all_pedalboards_cache(ptype)
     IOLoop.instance().add_callback(_reset_get_all_pedalboards_cache_with_refresh_2)
 
-class TimelessRequestHandler(web.RequestHandler):
-    def compute_etag(self):
-        return None
-
-    def set_default_headers(self):
-        self._headers.pop("Date")
-
-    def should_return_304(self):
-        return False
 
 class TimelessStaticFileHandler(web.StaticFileHandler):
     def compute_etag(self):
@@ -235,37 +228,6 @@ def get_cache_time(self, path, modified, mime_type):
     def get_modified_time(self):
         return None
 
-class JsonRequestHandler(TimelessRequestHandler):
-    def write(self, data):
-        # FIXME: something is sending strings out, need to investigate what later..
-        # it's likely something using write(json.dumps(...))
-        # we want to prevent that as it causes issues under Mac OS
-
-        if isinstance(data, (bytes, unicode_type, dict)):
-            TimelessRequestHandler.write(self, data)
-            self.finish()
-            return
-
-        elif data is True:
-            data = "true"
-            self.set_header("Content-Type", "application/json; charset=UTF-8")
-
-        elif data is False:
-            data = "false"
-            self.set_header("Content-Type", "application/json; charset=UTF-8")
-
-        # TESTING for data types, remove this later
-        #elif not isinstance(data, list):
-            #print("=== TESTING: Got new data type for RequestHandler.write():", type(data), "msg:", data)
-            #data = json.dumps(data)
-            #self.set_header('Content-type', 'application/json')
-
-        else:
-            data = json.dumps(data)
-            self.set_header("Content-Type", "application/json; charset=UTF-8")
-
-        TimelessRequestHandler.write(self, data)
-        self.finish()
 
 class CachedJsonRequestHandler(JsonRequestHandler):
     def set_default_headers(self):
@@ -1644,15 +1606,6 @@ def get(self):
         snapshots = dict((i, snapshots[i]['name']) for i in range(len(snapshots)) if snapshots[i] is not None)
         self.write(snapshots)
 
-class SnapshotName(JsonRequestHandler):
-    def get(self):
-        idx  = int(self.get_argument('id'))
-        name = SESSION.host.snapshot_name(idx) or DEFAULT_SNAPSHOT_NAME
-        self.write({
-            'ok'  : bool(name),
-            'name': name
-        })
-
 class SnapshotLoad(JsonRequestHandler):
     @web.asynchronous
     @gen.engine
diff --git a/test/controller/__init__.py b/test/controller/__init__.py
@@ -0,0 +1,3 @@
+#!/usr/bin/env python3
+# SPDX-FileCopyrightText: 2012-2023 MOD Audio UG
+# SPDX-License-Identifier: AGPL-3.0-or-later
diff --git a/test/controller/snapshot_controllers_test.py b/test/controller/snapshot_controllers_test.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+#!/usr/bin/env python3`
	`2`	`+# SPDX-FileCopyrightText: 2012-2023 MOD Audio UG`
	`3`	`+# SPDX-License-Identifier: AGPL-3.0-or-later`