Implements Tethys Reactpy App Scaffold

.github/workflows/tethys.yml

@@ -220,7 +220,7 @@ jobs:
         run: |
           cd ..
           . ~/miniconda/etc/profile.d/conda.sh;
-          conda create -y -c conda-forge -n conda-build conda-build anaconda-client 
+          conda create -y -c conda-forge -n conda-build conda-build anaconda-client
           conda activate conda-build
           conda config --set anaconda_upload no
           mkdir -p ~/conda-bld
@@ -259,7 +259,7 @@ jobs:
         run: |
           cd ..
           . ~/miniconda/etc/profile.d/conda.sh;
-          conda create -y -c conda-forge -n conda-build conda-build anaconda-client 
+          conda create -y -c conda-forge -n conda-build conda-build anaconda-client
           conda activate conda-build
           conda config --set anaconda_upload no
           mkdir -p ~/conda-bld

environment.yml

@@ -21,8 +21,7 @@ dependencies:
 
   # core dependencies
   - django>=3.2,<6
-  - channels
-  - daphne
+  - channels["daphne"]
   - setuptools_scm
   - pip
   - requests # required by lots of things

micro_environment.yml

@@ -20,8 +20,7 @@ dependencies:
 
   # core dependencies
   - django>=3.2,<6
-  - channels
-  - daphne
+  - channels["daphne"]
   - setuptools_scm
   - pip
   - requests # required by lots of things

tests/apps/tethysapp-test_app/install-with-post.yml

@@ -11,4 +11,4 @@ requirements:
       - geojson
       - shapely
 post:
-  - ./test.sh
+  - ./test.py

tests/apps/tethysapp-test_app/test.py

@@ -0,0 +1 @@
+print("test")

tests/coverage.cfg

@@ -3,6 +3,8 @@
 [run]
 source = $TETHYS_TEST_DIR/../tethys_apps
          $TETHYS_TEST_DIR/../tethys_cli
+         $TETHYS_TEST_DIR/../tethys_components/library.py
+         $TETHYS_TEST_DIR/../tethys_components/utils.py
          $TETHYS_TEST_DIR/../tethys_compute
          $TETHYS_TEST_DIR/../tethys_config
          $TETHYS_TEST_DIR/../tethys_gizmos

tests/unit_tests/test_tethys_apps/test_base/test_app_base.py

@@ -6,6 +6,7 @@
 from django.db.utils import ProgrammingError
 from django.test import RequestFactory, override_settings
 from django.core.exceptions import ValidationError, ObjectDoesNotExist
+from argparse import Namespace
 
 from tethys_apps.exceptions import (
     TethysAppSettingDoesNotExist,
@@ -1543,3 +1544,36 @@ def test_remove_from_db_2(self, mock_ta, mock_log):
 
         # Check tethys log error
         mock_log.error.assert_called()
+
+    def test_navigation_links_not_auto(self):
+        app = tethys_app_base.TethysAppBase()
+        app.nav_links = ["test", "1", "2", "3"]
+        links = app.navigation_links
+        self.assertListEqual(links, app.nav_links)
+
+    def test_navigation_links_auto_excluded_page(self):
+        app = tethys_app_base.TethysAppBase()
+        app.nav_links = "auto"
+        app.index = "home"
+        app.root_url = "test-app"
+
+        app._registered_url_maps = [
+            Namespace(name="exclude_page", title="Exclude Page", index=-1),
+            Namespace(name="last_page", title="Last Page", index=3),
+            Namespace(name="third_page", title="Third Page", index=2),
+            Namespace(name="second_page", title="Second Page", index=1),
+            Namespace(name="home", title="Home", index=0),
+        ]
+
+        links = app.navigation_links
+
+        self.assertListEqual(
+            links,
+            [
+                {"title": "Home", "href": "/apps/test-app/"},
+                {"title": "Second Page", "href": "/apps/test-app/second-page/"},
+                {"title": "Third Page", "href": "/apps/test-app/third-page/"},
+                {"title": "Last Page", "href": "/apps/test-app/last-page/"},
+            ],
+        )
+        self.assertEqual(links, app.nav_links)

tests/unit_tests/test_tethys_apps/test_base/test_page_handler.py

@@ -0,0 +1,257 @@
+from unittest import TestCase, mock
+from importlib import reload
+
+from tethys_apps.base import page_handler
+import tethys_apps.base.controller as tethys_controller
+
+
+class TestPageHandler(TestCase):
+    @mock.patch("tethys_apps.base.page_handler.render")
+    @mock.patch("tethys_apps.base.page_handler.ComponentLibrary")
+    @mock.patch("tethys_apps.base.page_handler.get_active_app")
+    @mock.patch("tethys_apps.base.page_handler.get_layout_component")
+    def test_global_page_controller(
+        self, mock_get_layout, mock_get_app, mock_lib, mock_render
+    ):
+        # FUNCTION ARGS
+        request = mock.MagicMock()
+        layout = "test_layout"
+        component_func = mock.MagicMock()
+        component_source_code = "test123"
+        title = "test_title"
+        custom_css = ["custom.css"]
+        custom_js = ["custom.js"]
+
+        # MOCK INTERNALS
+        mock_get_app.return_value = "app object"
+        component_func.__name__ = "my_mock_component_func"
+        expected_return_value = "Expected return value"
+        mock_render.return_value = expected_return_value
+        mock_get_layout.return_value = "my_layout_func"
+
+        # EXECUTE FUNCTION
+        response = page_handler.global_page_controller(
+            request=request,
+            layout=layout,
+            component_func=component_func,
+            component_source_code=component_source_code,
+            title=title,
+            custom_css=custom_css,
+            custom_js=custom_js,
+        )
+
+        # EVALUATE EXECUTION
+        mock_get_app.assert_called_once_with(request=request, get_class=True)
+        mock_get_layout.assert_called_once_with(mock_get_app(), layout)
+        mock_lib.refresh.assert_called_with(new_identifier="my-mock-component-func")
+        mock_lib.load_dependencies_from_source_code.assert_called_with(
+            component_source_code
+        )
+        render_called_with_args = mock_render.call_args.args
+        self.assertEqual(render_called_with_args[0], request)
+        self.assertEqual(render_called_with_args[1], "tethys_apps/reactpy_base.html")
+        render_context = render_called_with_args[2]
+        self.assertListEqual(
+            list(render_context.keys()),
+            [
+                "app",
+                "layout_func",
+                "component_func",
+                "reactjs_version",
+                "title",
+                "custom_css",
+                "custom_js",
+            ],
+        )
+        self.assertEqual(render_context["app"], "app object")
+        self.assertEqual(render_context["layout_func"](), "my_layout_func")
+        self.assertEqual(render_context["component_func"](), component_func)
+        self.assertEqual(render_context["reactjs_version"], mock_lib.REACTJS_VERSION)
+        self.assertEqual(render_context["title"], title)
+        self.assertEqual(render_context["custom_css"], custom_css)
+        self.assertEqual(render_context["custom_js"], custom_js)
+        self.assertEqual(response, expected_return_value)
+
+    def test_has_reactpy(self):
+        mock_has_module = mock.patch("tethys_portal.optional_dependencies.has_module")
+        mock_has_module.return_value = True
+        mock_has_module.start()
+        try:
+            import reactpy
+
+            reload(page_handler)
+            self.assertEqual(page_handler.component, reactpy.component)
+        except ModuleNotFoundError as e:
+            self.assertRaises(ModuleNotFoundError, reload, page_handler)
+            self.assertTrue("reactpy" in str(e))
+
+        mock.patch.stopall()
+        reload(page_handler)
+
+    def test_page_component_wrapper__layout_none(self):
+        # FUNCTION ARGS
+        app = mock.MagicMock()
+        user = mock.MagicMock()
+        layout = None
+        component = mock.MagicMock()
+        component_return_val = "rendered_component"
+        component.return_value = component_return_val
+
+        return_value = page_handler.page_component_wrapper(app, user, layout, component)
+
+        self.assertEqual(return_value, component_return_val)
+
+    def test_page_component_wrapper__layout_not_none(self):
+        # FUNCTION ARGS
+        app = mock.MagicMock()
+        app.restered_url_maps = []
+        user = mock.MagicMock()
+        layout = mock.MagicMock()
+        layout_return_val = "returned_layout"
+        layout.return_value = layout_return_val
+        component = mock.MagicMock()
+        component_return_val = "rendered_component"
+        component.return_value = component_return_val
+
+        return_value = page_handler.page_component_wrapper(app, user, layout, component)
+
+        self.assertEqual(return_value, layout_return_val)
+        layout.assert_called_once_with(
+            {"app": app, "user": user, "nav-links": app.navigation_links},
+            component_return_val,
+        )
+
+    @mock.patch("tethys_apps.base.controller._process_url_kwargs")
+    @mock.patch("tethys_apps.base.controller.global_page_controller")
+    @mock.patch("tethys_apps.base.controller.permission_required")
+    @mock.patch("tethys_apps.base.controller.enforce_quota")
+    @mock.patch("tethys_apps.base.controller.ensure_oauth2")
+    @mock.patch("tethys_apps.base.controller.login_required_decorator")
+    @mock.patch("tethys_apps.base.controller._get_url_map_kwargs_list")
+    def test_page_with_permissions(
+        self,
+        mock_get_url_map_kwargs_list,
+        mock_login_required_decorator,
+        mock_ensure_oauth2,
+        mock_enforce_quota,
+        mock_permission_required,
+        mock_global_page_component,
+        mock_process_kwargs,
+    ):
+        layout = "MyLayout"
+        title = "My Cool Page"
+        index = 0
+        custom_css = ["custom.css"]
+        custom_js = ["custom.js"]
+        my_function = lambda x: x  # noqa E731
+        return_value = tethys_controller.page(
+            permissions_required=["test_permission"],
+            enforce_quotas=["test_quota"],
+            ensure_oauth2_provider=["test_oauth2_provider"],
+            layout=layout,
+            title=title,
+            index=index,
+            custom_css=custom_css,
+            custom_js=custom_js,
+        )(my_function)
+        self.assertTrue(callable(return_value))
+        mock_request = mock.MagicMock()
+        mock_process_kwargs.assert_called_once()
+        process_kwargs_args = mock_process_kwargs.call_args.args
+        self.assertTrue(callable(process_kwargs_args[0]))
+        self.assertEqual(
+            process_kwargs_args[0](mock_request), mock_login_required_decorator()()()
+        )
+        mock_permission_required.assert_called_once()
+        mock_enforce_quota.assert_called_once()
+        mock_ensure_oauth2.assert_called_once()
+        self.assertEqual(mock_login_required_decorator.call_count, 2)
+        mock_get_url_map_kwargs_list.assert_called_once_with(
+            function_or_class=my_function,
+            name=None,
+            url=None,
+            protocol="http",
+            regex=None,
+            title=title,
+            index=index,
+        )
+
+    @mock.patch("tethys_apps.base.controller._process_url_kwargs")
+    @mock.patch("tethys_apps.base.controller.global_page_controller")
+    @mock.patch("tethys_apps.base.controller._get_url_map_kwargs_list")
+    def test_page_with_defaults(
+        self,
+        mock_get_url_map_kwargs_list,
+        mock_global_page_component,
+        mock_process_kwargs,
+    ):
+        my_function = lambda x: x  # noqa: E731
+        return_value = tethys_controller.page()(my_function)
+        self.assertTrue(callable(return_value))
+        mock_request = mock.MagicMock()
+        mock_process_kwargs.assert_called_once()
+        process_kwargs_args = mock_process_kwargs.call_args.args
+        self.assertTrue(callable(process_kwargs_args[0]))
+        self.assertEqual(
+            process_kwargs_args[0](mock_request),
+            mock_global_page_component(
+                mock_request,
+                layout="default",
+                component_func=my_function,
+                component_source_code="lambda x: x",
+                title=mock_get_url_map_kwargs_list[0]["title"],
+                custom_css=[],
+                custom_js=[],
+            ),
+        )
+        mock_get_url_map_kwargs_list.assert_called_once_with(
+            function_or_class=my_function,
+            name=None,
+            url=None,
+            protocol="http",
+            regex=None,
+            title=None,
+            index=None,
+        )
+
+    @mock.patch("tethys_apps.base.controller._process_url_kwargs")
+    @mock.patch("tethys_apps.base.controller.global_page_controller")
+    @mock.patch("tethys_apps.base.controller._get_url_map_kwargs_list")
+    def test_page_with_handler(
+        self,
+        mock_get_url_map_kwargs_list,
+        mock_global_page_component,
+        mock_process_kwargs,
+    ):
+        component_function = lambda x: x  # noqa: E731
+        handler_function = mock.MagicMock()
+        return_value = tethys_controller.page(handler=handler_function)(
+            component_function
+        )
+        self.assertTrue(callable(return_value))
+        mock_request = mock.MagicMock()
+        mock_process_kwargs.assert_called_once()
+        process_kwargs_args = mock_process_kwargs.call_args.args
+        self.assertTrue(callable(process_kwargs_args[0]))
+        mock_global_page_component.assert_not_called()
+        self.assertEqual(
+            process_kwargs_args[0](mock_request),
+            handler_function(
+                mock_request,
+                layout="default",
+                component_func=component_function,
+                component_source_code="lambda x: x",
+                title=mock_get_url_map_kwargs_list[0]["title"],
+                custom_css=[],
+                custom_js=[],
+            ),
+        )
+        mock_get_url_map_kwargs_list.assert_called_once_with(
+            function_or_class=component_function,
+            name=None,
+            url=None,
+            protocol="http",
+            regex=None,
+            title=None,
+            index=None,
+        )

tests/unit_tests/test_tethys_apps/test_base/test_url_map.py

@@ -93,7 +93,7 @@ def test_UrlMap_repr(self):
             "<UrlMap: name=foo_name,"
             " url=^example/resource/(?P<variable_name>[0-9A-Za-z-_.]+)/$,"
             " controller=foo_app.controllers.foo, protocol=http,"
-            " handler=None, handler_type=None>"
+            " handler=None, handler_type=None, title=None, index=None>"
         )
         result = self.bound_UrlMap(
             name=self.name, url=url, controller=self.controller