Serve WebUI via get_resource for freezed app

gns3server/handlers/index_handler.py

@@ -22,7 +22,7 @@ from gns3server.controller import Controller
 from gns3server.compute.port_manager import PortManager
 from gns3server.compute.project_manager import ProjectManager
 from gns3server.version import __version__
-from gns3server.utils.static import get_static_path
+from gns3server.utils.get_resource import get_resource 
 
 
 class IndexHandler:
@@ -81,16 +81,16 @@ class IndexHandler:
     async def webui(request, response):
         filename = request.match_info["filename"]
         filename = os.path.normpath(filename).strip("/")
-        filename = os.path.join('web-ui', filename)
+        filename = os.path.join('static', 'web-ui', filename)
 
         # Raise error if user try to escape
         if filename[0] == ".":
             raise aiohttp.web.HTTPForbidden()
 
-        static = get_static_path(filename)
+        static = get_resource(filename)
 
-        if not os.path.exists(static):
+        if static is None or not os.path.exists(static):
-            static = get_static_path(os.path.join('web-ui', 'index.html'))
+            static = get_resource(os.path.join('static', 'web-ui', 'index.html'))
 
         await response.stream_file(static)
 

gns3server/utils/static.py

@@ -1,38 +0,0 @@
-#!/usr/bin/env python
-#
-# Copyright (C) 2018 GNS3 Technologies Inc.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-import os
-
-
-def get_static_path(filename):
-    """
-    Returns full static path for given filename
-    :param filename: relative filename
-    :return: absolute path
-    """
-
-    static_directory = get_static_dir()
-    return os.path.join(static_directory, filename)
-
-
-def get_static_dir():
-    """
-    Returns location of static directory
-    :return: absolute path
-    """
-    current_dir = os.path.dirname(os.path.abspath(__file__))
-    return os.path.abspath(os.path.join(current_dir, '..', 'static'))

gns3server/web/web_server.py

@@ -41,8 +41,6 @@ from ..compute.port_manager import PortManager
 from ..compute.qemu import Qemu
 from ..controller import Controller
 
-from gns3server.utils.static import get_static_dir
-
 # do not delete this import
 import gns3server.handlers
 

tests/handlers/test_index.py

@@ -21,7 +21,12 @@ from unittest.mock import patch
 
 from gns3server.version import __version__
 from gns3server.controller import Controller
-from gns3server.utils import static
+from gns3server.utils.get_resource import get_resource
+
+
+def get_static(filename):
+    current_dir = os.path.dirname(os.path.abspath(__file__))
+    return os.path.join(os.path.abspath(os.path.join(current_dir, '..', '..', 'gns3server', 'static')), filename)
 
 
 def test_index(http_root):
@@ -51,23 +56,20 @@ def test_project(http_root, async_run):
 
 
 def test_web_ui(http_root, tmpdir):
-    with patch('gns3server.utils.static.get_static_dir') as mock:
+    with patch('gns3server.utils.get_resource.get_resource') as mock:
         mock.return_value = str(tmpdir)
         os.makedirs(str(tmpdir / 'web-ui'))
-        tmpfile = static.get_static_path('web-ui/testing.txt')
+        tmpfile = get_static('web-ui/testing.txt')
         with open(tmpfile, 'w+') as f:
             f.write('world')
         response = http_root.get('/static/web-ui/testing.txt')
         assert response.status == 200
+    os.remove(get_static('web-ui/testing.txt'))
 
 
 def test_web_ui_not_found(http_root, tmpdir):
-    with patch('gns3server.utils.static.get_static_dir') as mock:
+    with patch('gns3server.utils.get_resource.get_resource') as mock:
         mock.return_value = str(tmpdir)
-        os.makedirs(str(tmpdir / 'web-ui'))
-        tmpfile = static.get_static_path('web-ui/index.html')
-        with open(tmpfile, 'w+') as f:
-            f.write('world')
 
         response = http_root.get('/static/web-ui/not-found.txt')
         # should serve web-ui/index.html

tests/utils/test_static.py

@@ -1,25 +0,0 @@
-#!/usr/bin/env python
-#
-# Copyright (C) 2018 GNS3 Technologies Inc.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-import os
-
-from gns3server.utils.static import get_static_path
-
-
-def test_get_static_path():
-    expected = os.path.join('gns3server', 'static', 'test')
-    assert get_static_path('test').endswith(expected)