From 4038ab0ca87fe3c48c1c7639f463b23d5ae19c73 Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Wed, 6 Mar 2024 16:30:58 -0600 Subject: [PATCH 01/23] initial implementation working for stand alone apps home and app_library now redirected to the configured app admin capabilities still working need to figure out a way to get the admin dropdown menu in the stand alone app and clean up header buttons --- tethys_apps/harvester.py | 18 ++++++++++++------ tethys_apps/urls.py | 11 ++++++++--- tethys_apps/utilities.py | 7 ++++++- tethys_portal/settings.py | 4 ++++ tethys_portal/urls.py | 26 +++++++++++++++++++++----- tethys_portal/views/home.py | 4 +--- 6 files changed, 52 insertions(+), 18 deletions(-) diff --git a/tethys_apps/harvester.py b/tethys_apps/harvester.py index cc0ec3830..e5315fa25 100644 --- a/tethys_apps/harvester.py +++ b/tethys_apps/harvester.py @@ -83,18 +83,21 @@ def harvest_apps(self): except Exception: """DO NOTHING""" - def get_url_patterns(self): + def get_url_patterns(self, url_namespaces=None): """ Generate the url pattern lists for each app and namespace them accordingly. """ app_url_patterns = dict() ext_url_patterns = dict() ws_url_patterns = dict() + apps = self.apps + if url_namespaces: + apps = [app for app in apps if app.url_namespace in url_namespaces] - for app in self.apps: + for app in apps: app_url_patterns.update(app.url_patterns["http"]) - for app in self.apps: + for app in apps: ws_url_patterns.update(app.url_patterns["websocket"]) for extension in self.extensions: @@ -108,17 +111,20 @@ def get_url_patterns(self): return url_patterns - def get_handler_patterns(self): + def get_handler_patterns(self, url_namespaces=None): """ Generate the url handler pattern lists for each app and namespace them accordingly. """ http_handler_patterns = dict() ws_handler_patterns = dict() + apps = self.apps + if url_namespaces: + apps = [app for app in apps if app.url_namespace in url_namespaces] - for app in self.apps: + for app in apps: http_handler_patterns.update(app.handler_patterns["http"]) - for app in self.apps: + for app in apps: ws_handler_patterns.update(app.handler_patterns["websocket"]) handler_patterns = { diff --git a/tethys_apps/urls.py b/tethys_apps/urls.py index 64512a808..b86b3f2ff 100644 --- a/tethys_apps/urls.py +++ b/tethys_apps/urls.py @@ -18,16 +18,21 @@ prefix_url = f"{settings.PREFIX_URL}" urlpatterns = [ - re_path(r"^$", library, name="app_library"), re_path( r"^send-beta-feedback/$", send_beta_feedback_email, name="send_beta_feedback" ), ] +if settings.STANDALONE_APP_CONTROLLER: + standalone_app_namespace, _ = settings.STANDALONE_APP_CONTROLLER.split(":") + url_namespaces = [standalone_app_namespace] +else: + urlpatterns.append(re_path(r"^$", library, name="app_library")) + url_namespaces = None # Append the app urls urlpatterns harvester = SingletonHarvester() -normal_url_patterns = harvester.get_url_patterns() -handler_url_patterns = harvester.get_handler_patterns() +normal_url_patterns = harvester.get_url_patterns(url_namespaces=url_namespaces) +handler_url_patterns = harvester.get_handler_patterns(url_namespaces=url_namespaces) # configure handler HTTP routes http_handler_patterns = [] diff --git a/tethys_apps/utilities.py b/tethys_apps/utilities.py index dc3c14c27..2ce77b199 100644 --- a/tethys_apps/utilities.py +++ b/tethys_apps/utilities.py @@ -19,6 +19,7 @@ from django.core import signing from django.core.exceptions import ObjectDoesNotExist, MultipleObjectsReturned from django.utils._os import safe_join +from django.conf import settings from tethys_apps.exceptions import TethysAppSettingNotAssigned from .harvester import SingletonHarvester @@ -126,6 +127,10 @@ def get_active_app(request=None, url=None, get_class=False): from tethys_apps.models import TethysApp apps_root = "apps" + app_root_index_add = 1 + if settings.STANDALONE_APP_CONTROLLER: + app_root_index_add = 0 + apps_root = settings.STANDALONE_APP_CONTROLLER.split(":")[0].replace("_", "-") if request is not None: the_url = request.path @@ -140,7 +145,7 @@ def get_active_app(request=None, url=None, get_class=False): # Find the app key if apps_root in url_parts: # The app root_url is the path item following (+1) the apps_root item - app_root_url_index = url_parts.index(apps_root) + 1 + app_root_url_index = url_parts.index(apps_root) + app_root_index_add app_root_url = url_parts[app_root_url_index] if app_root_url: diff --git a/tethys_portal/settings.py b/tethys_portal/settings.py index af3b78e47..0a3bee0bc 100644 --- a/tethys_portal/settings.py +++ b/tethys_portal/settings.py @@ -90,6 +90,10 @@ REGISTER_CONTROLLER = TETHYS_PORTAL_CONFIG.pop("REGISTER_CONTROLLER", None) +STANDALONE_APP_CONTROLLER = TETHYS_PORTAL_CONFIG.pop("STANDALONE_APP_CONTROLLER", None) +if STANDALONE_APP_CONTROLLER: + BYPASS_TETHYS_HOME_PAGE = True + ADDITIONAL_URLPATTERNS = TETHYS_PORTAL_CONFIG.pop("ADDITIONAL_URLPATTERNS", []) SESSION_CONFIG = portal_config_settings.pop("SESSION_CONFIG", {}) diff --git a/tethys_portal/urls.py b/tethys_portal/urls.py index 6beea748b..72d9eda2c 100644 --- a/tethys_portal/urls.py +++ b/tethys_portal/urls.py @@ -14,14 +14,16 @@ from django.urls import reverse_lazy, include, re_path from django.shortcuts import redirect from django.views.decorators.cache import never_cache +from django.views.generic import RedirectView from django.contrib import admin from django.contrib.auth.views import ( PasswordResetDoneView, PasswordResetConfirmView, PasswordResetCompleteView, ) +from django.conf import settings -from tethys_apps.urls import extension_urls +from tethys_apps.urls import extension_urls, urlpatterns as tethys_app_urlpatterns from tethys_portal.views import ( accounts as tethys_portal_accounts, @@ -179,12 +181,26 @@ # re_path(r'^500/$', tethys_portal_error.handler_500, name='error_500'), # ] -urlpatterns = [ - re_path(r"^$", tethys_portal_home.home, name="home"), +if settings.STANDALONE_APP_CONTROLLER: + standalone_app_namespace, _ = settings.STANDALONE_APP_CONTROLLER.split(":") + standalone_app_namespace_hyphen = standalone_app_namespace.replace("_", "-") + standalone_app_urlpatterns = tethys_app_urlpatterns[1] + urlpatterns = [ + re_path(r"^{0}/".format(standalone_app_namespace_hyphen), include((standalone_app_urlpatterns.url_patterns, standalone_app_namespace), namespace=standalone_app_namespace)), + re_path(r"^$", RedirectView.as_view(url=f"/{standalone_app_namespace_hyphen}/"), name="home"), + re_path(r"^$", RedirectView.as_view(url=f"/{standalone_app_namespace_hyphen}/"), name="app_library") + ] +else: + urlpatterns = [ + re_path(r"^$", include("tethys_apps.urls"), name="home"), + re_path(r"^apps/", include("tethys_apps.urls")) + ] + + +urlpatterns.extend([ re_path(r"^admin/", admin_urls), re_path(r"^accounts/", include((account_urls, "accounts"), namespace="accounts")), re_path(r"^user/", include((user_urls, "user"), namespace="user")), - re_path(r"^apps/", include("tethys_apps.urls")), re_path(r"^extensions/", include(extension_urls)), re_path(r"^developer/", include(developer_urls)), re_path( @@ -208,7 +224,7 @@ name="update_dask_job_status", ), re_path(r"^api/", include((api_urls, "api"), namespace="api")), -] +]) if has_module(psa_views): oauth2_urls = [ diff --git a/tethys_portal/views/home.py b/tethys_portal/views/home.py index 89669b78d..9cf8ffc9c 100644 --- a/tethys_portal/views/home.py +++ b/tethys_portal/views/home.py @@ -21,8 +21,6 @@ def home(request): ): return redirect("app_library") - ENABLE_OPEN_PORTAL = getattr(settings, "ENABLE_OPEN_PORTAL", False) - template = get_custom_template("Home Page Template", "tethys_portal/home.html") return render( @@ -30,6 +28,6 @@ def home(request): template, { "ENABLE_OPEN_SIGNUP": settings.ENABLE_OPEN_SIGNUP, - "ENABLE_OPEN_PORTAL": ENABLE_OPEN_PORTAL, + "ENABLE_OPEN_PORTAL": settings.ENABLE_OPEN_PORTAL, }, ) From 1e4023ba53cbdceec859e447e3f5b9e573925add Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Thu, 7 Mar 2024 17:33:22 -0600 Subject: [PATCH 02/23] new site setting for standalone_app_mode adder user menu button to app base header when in standalone app mode --- .../templates/tethys_apps/app_base.html | 75 +++++++++++++++++-- tethys_cli/site_commands.py | 5 ++ tethys_config/init.py | 4 + 3 files changed, 76 insertions(+), 8 deletions(-) diff --git a/tethys_apps/templates/tethys_apps/app_base.html b/tethys_apps/templates/tethys_apps/app_base.html index 7b6c1d76f..cf59d9fc4 100644 --- a/tethys_apps/templates/tethys_apps/app_base.html +++ b/tethys_apps/templates/tethys_apps/app_base.html @@ -112,6 +112,25 @@ background: var(--app-primary-color, '#7ec1f7'); } + #app-header .btn-user-profile { + background-color: rgba(255, 255, 255, 0.08); + border: none; + color: {{ site_globals.primary_text_color }}; + } + + #app-header .btn-user-profile:hover { + background-color: rgba(255, 255, 255, 0.30); + } + + #app-header .user-menu-button .dropdown-menu .dropdown-item { + color:#3f3f3f; + } + + #app-header .user-menu-button .dropdown-menu .dropdown-item:active { + background-color: {{ site_globals.primary_color }}; + color: #dddddd; + } + #app-navigation .nav li a { color: var(--app-primary-color, '#7ec1f7'); } @@ -192,16 +211,56 @@ {% endif %} {% endblock %} {% block settings_button_override %} - {% if request.user.is_staff %} -
- -
- {% endif %} + {% if request.user.is_staff %} +
+ +
+ {% endif %} {% endblock %} {% block exit_button_override %} -
- -
+ {% if site_globals.standalone_app_mode == "false" %} +
+ +
+ {% endif %} + {% endblock %} + {% block user_menu %} + {% if user.is_authenticated and user.is_active and site_globals.standalone_app_mode == "true" %} +
+ + + +
+ {% else %} + Log In + {% endif %} {% endblock %} {% endblock %} diff --git a/tethys_cli/site_commands.py b/tethys_cli/site_commands.py index 794aa665a..bdbd2768f 100644 --- a/tethys_cli/site_commands.py +++ b/tethys_cli/site_commands.py @@ -28,6 +28,11 @@ def add_site_parser(subparsers): help="Title of the web page that appears in browser tabs and bookmarks of the site. " 'Default is "Tethys Portal".', ) + site_parser.add_argument( + "--standalone-app-mode", + dest="standalone_app_mode", + help="Boolean determining if the portal will act as a standalone app or host for multiple apps", + ) site_parser.add_argument( "--favicon", dest="favicon", diff --git a/tethys_config/init.py b/tethys_config/init.py index a7f25138f..9e80843cb 100644 --- a/tethys_config/init.py +++ b/tethys_config/init.py @@ -104,6 +104,10 @@ def setting_defaults(category): name="Site Title", content="Tethys Portal", date_modified=now ) + category.setting_set.create( + name="Standalone App Mode", content="false", date_modified=now + ) + category.setting_set.create( name="Favicon", content="/tethys_portal/images/default_favicon.png", From ba5d1cc9194f5c230489f942aea4fb36480bde89 Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Fri, 8 Mar 2024 12:25:09 -0600 Subject: [PATCH 03/23] updated setting name to STANDALONE_APP and removed the necessity to add the controller name since that can be controlled by the application itself add some logic to the site commands, if a standalone app is given, then update site settings accordingly fixed some old url patterns for non standalone_app_mode that had been messed up updated header.html to not show App Library button if standalone app is enabled --- tethys_apps/urls.py | 5 ++--- tethys_apps/utilities.py | 15 +++++++++------ tethys_cli/site_commands.py | 18 +++++++++++++++++- tethys_portal/settings.py | 4 ++-- tethys_portal/templates/header.html | 2 +- tethys_portal/urls.py | 13 ++++++------- 6 files changed, 37 insertions(+), 20 deletions(-) diff --git a/tethys_apps/urls.py b/tethys_apps/urls.py index b86b3f2ff..d58d9796d 100644 --- a/tethys_apps/urls.py +++ b/tethys_apps/urls.py @@ -22,9 +22,8 @@ r"^send-beta-feedback/$", send_beta_feedback_email, name="send_beta_feedback" ), ] -if settings.STANDALONE_APP_CONTROLLER: - standalone_app_namespace, _ = settings.STANDALONE_APP_CONTROLLER.split(":") - url_namespaces = [standalone_app_namespace] +if settings.STANDALONE_APP: + url_namespaces = [settings.STANDALONE_APP] else: urlpatterns.append(re_path(r"^$", library, name="app_library")) url_namespaces = None diff --git a/tethys_apps/utilities.py b/tethys_apps/utilities.py index 2ce77b199..ffacdfd65 100644 --- a/tethys_apps/utilities.py +++ b/tethys_apps/utilities.py @@ -128,9 +128,9 @@ def get_active_app(request=None, url=None, get_class=False): apps_root = "apps" app_root_index_add = 1 - if settings.STANDALONE_APP_CONTROLLER: + if settings.STANDALONE_APP: app_root_index_add = 0 - apps_root = settings.STANDALONE_APP_CONTROLLER.split(":")[0].replace("_", "-") + apps_root = settings.STANDALONE_APP.replace("_", "-") if request is not None: the_url = request.path @@ -143,10 +143,13 @@ def get_active_app(request=None, url=None, get_class=False): app = None # Find the app key - if apps_root in url_parts: - # The app root_url is the path item following (+1) the apps_root item - app_root_url_index = url_parts.index(apps_root) + app_root_index_add - app_root_url = url_parts[app_root_url_index] + if apps_root in url_parts or (the_url == "/" and settings.STANDALONE_APP): + if settings.STANDALONE_APP: + app_root_url = apps_root + else: + # The app root_url is the path item following (+1) the apps_root item + app_root_url_index = url_parts.index(apps_root) + app_root_index_add + app_root_url = url_parts[app_root_url_index] if app_root_url: try: diff --git a/tethys_cli/site_commands.py b/tethys_cli/site_commands.py index bdbd2768f..cb6678c07 100644 --- a/tethys_cli/site_commands.py +++ b/tethys_cli/site_commands.py @@ -308,7 +308,10 @@ def gen_site_content(args): portal_yaml = Path(get_tethys_home_dir()) / "portal_config.yml" if portal_yaml.exists(): with portal_yaml.open() as f: - site_settings = yaml.safe_load(f).get("site_settings", {}) + portal_config_json = yaml.safe_load(f) + portal_config_json = update_site_settings_if_standalone_mode(portal_config_json) + site_settings = portal_config_json.get("site_settings", {}) + for category in SITE_SETTING_CATEGORIES: category_settings = site_settings.pop(category, {}) update_site_settings_content( @@ -371,6 +374,19 @@ def update_site_settings_content(settings_dict, warn_if_setting_not_found=False) obj.update(content=content, date_modified=timezone.now()) +def update_site_settings_if_standalone_mode(portal_config_json): + tethys_portal_config = portal_config_json.get('settings', {}).get('TETHYS_PORTAL_CONFIG', {}) + standalone_app = tethys_portal_config.get('STANDALONE_APP') + + if standalone_app: + standalone_app_title = standalone_app.replace("_", " ").replace("-", " ").title() + site_settings = portal_config_json.get("site_settings", {}) + site_settings["GENERAL_SETTINGS"]['STANDALONE_APP_MODE'] = "true" + site_settings["GENERAL_SETTINGS"]['BRAND_TEXT'] = standalone_app_title + + return portal_config_json + + def uncodify(code_name): setting_name = code_name.replace("_", " ").title() setting_name = setting_name.replace("Css", "CSS").replace("To ", "to ") diff --git a/tethys_portal/settings.py b/tethys_portal/settings.py index 0a3bee0bc..6b22a3276 100644 --- a/tethys_portal/settings.py +++ b/tethys_portal/settings.py @@ -90,8 +90,8 @@ REGISTER_CONTROLLER = TETHYS_PORTAL_CONFIG.pop("REGISTER_CONTROLLER", None) -STANDALONE_APP_CONTROLLER = TETHYS_PORTAL_CONFIG.pop("STANDALONE_APP_CONTROLLER", None) -if STANDALONE_APP_CONTROLLER: +STANDALONE_APP = TETHYS_PORTAL_CONFIG.pop("STANDALONE_APP", None) +if STANDALONE_APP: BYPASS_TETHYS_HOME_PAGE = True ADDITIONAL_URLPATTERNS = TETHYS_PORTAL_CONFIG.pop("ADDITIONAL_URLPATTERNS", []) diff --git a/tethys_portal/templates/header.html b/tethys_portal/templates/header.html index 449fbb5bf..f89ecfeec 100644 --- a/tethys_portal/templates/header.html +++ b/tethys_portal/templates/header.html @@ -28,7 +28,7 @@
    {% block header_nav_items %} {% url 'app_library' as app_library_url %} - {% if ENABLE_OPEN_PORTAL or user.is_authenticated and user.is_active %} + {% if ENABLE_OPEN_PORTAL or user.is_authenticated and user.is_active and site_globals.standalone_app_mode == "false" %}
  • {% if site_globals.apps_library_title %}{{ site_globals.apps_library_title }}{% else %}Apps{% endif %}
    • diff --git a/tethys_portal/urls.py b/tethys_portal/urls.py index 72d9eda2c..37f77a373 100644 --- a/tethys_portal/urls.py +++ b/tethys_portal/urls.py @@ -181,18 +181,17 @@ # re_path(r'^500/$', tethys_portal_error.handler_500, name='error_500'), # ] -if settings.STANDALONE_APP_CONTROLLER: - standalone_app_namespace, _ = settings.STANDALONE_APP_CONTROLLER.split(":") - standalone_app_namespace_hyphen = standalone_app_namespace.replace("_", "-") +if settings.STANDALONE_APP: + standalone_app_hyphen = settings.STANDALONE_APP.replace("_", "-") standalone_app_urlpatterns = tethys_app_urlpatterns[1] urlpatterns = [ - re_path(r"^{0}/".format(standalone_app_namespace_hyphen), include((standalone_app_urlpatterns.url_patterns, standalone_app_namespace), namespace=standalone_app_namespace)), - re_path(r"^$", RedirectView.as_view(url=f"/{standalone_app_namespace_hyphen}/"), name="home"), - re_path(r"^$", RedirectView.as_view(url=f"/{standalone_app_namespace_hyphen}/"), name="app_library") + re_path(r"^{0}/".format(standalone_app_hyphen), include((standalone_app_urlpatterns.url_patterns, settings.STANDALONE_APP), namespace=settings.STANDALONE_APP)), + re_path(r"^$", RedirectView.as_view(url=f"/{standalone_app_hyphen}/"), name="home"), + re_path(r"^$", RedirectView.as_view(url=f"/{standalone_app_hyphen}/"), name="app_library") ] else: urlpatterns = [ - re_path(r"^$", include("tethys_apps.urls"), name="home"), + re_path(r"^$", tethys_portal_home.home, name="home"), re_path(r"^apps/", include("tethys_apps.urls")) ] From 85532883ec88f91ad25b3b4110a5019eaa4f4591 Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Fri, 8 Mar 2024 12:40:45 -0600 Subject: [PATCH 04/23] additional updates and url fixes --- tethys_apps/utilities.py | 4 +--- tethys_portal/urls.py | 2 +- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/tethys_apps/utilities.py b/tethys_apps/utilities.py index ffacdfd65..136bb3be0 100644 --- a/tethys_apps/utilities.py +++ b/tethys_apps/utilities.py @@ -127,9 +127,7 @@ def get_active_app(request=None, url=None, get_class=False): from tethys_apps.models import TethysApp apps_root = "apps" - app_root_index_add = 1 if settings.STANDALONE_APP: - app_root_index_add = 0 apps_root = settings.STANDALONE_APP.replace("_", "-") if request is not None: @@ -148,7 +146,7 @@ def get_active_app(request=None, url=None, get_class=False): app_root_url = apps_root else: # The app root_url is the path item following (+1) the apps_root item - app_root_url_index = url_parts.index(apps_root) + app_root_index_add + app_root_url_index = url_parts.index(apps_root) + 1 app_root_url = url_parts[app_root_url_index] if app_root_url: diff --git a/tethys_portal/urls.py b/tethys_portal/urls.py index 37f77a373..1adea5df4 100644 --- a/tethys_portal/urls.py +++ b/tethys_portal/urls.py @@ -187,7 +187,7 @@ urlpatterns = [ re_path(r"^{0}/".format(standalone_app_hyphen), include((standalone_app_urlpatterns.url_patterns, settings.STANDALONE_APP), namespace=settings.STANDALONE_APP)), re_path(r"^$", RedirectView.as_view(url=f"/{standalone_app_hyphen}/"), name="home"), - re_path(r"^$", RedirectView.as_view(url=f"/{standalone_app_hyphen}/"), name="app_library") + re_path(r"^apps/", RedirectView.as_view(url=f"/{standalone_app_hyphen}/"), name="app_library") ] else: urlpatterns = [ From 02c5b67ffa41658b82e57049642aba18962080e1 Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Fri, 8 Mar 2024 12:45:02 -0600 Subject: [PATCH 05/23] liniting --- tethys_cli/site_commands.py | 4 ++-- tethys_portal/urls.py | 1 - 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/tethys_cli/site_commands.py b/tethys_cli/site_commands.py index cb6678c07..a85fa56a1 100644 --- a/tethys_cli/site_commands.py +++ b/tethys_cli/site_commands.py @@ -377,13 +377,13 @@ def update_site_settings_content(settings_dict, warn_if_setting_not_found=False) def update_site_settings_if_standalone_mode(portal_config_json): tethys_portal_config = portal_config_json.get('settings', {}).get('TETHYS_PORTAL_CONFIG', {}) standalone_app = tethys_portal_config.get('STANDALONE_APP') - + if standalone_app: standalone_app_title = standalone_app.replace("_", " ").replace("-", " ").title() site_settings = portal_config_json.get("site_settings", {}) site_settings["GENERAL_SETTINGS"]['STANDALONE_APP_MODE'] = "true" site_settings["GENERAL_SETTINGS"]['BRAND_TEXT'] = standalone_app_title - + return portal_config_json diff --git a/tethys_portal/urls.py b/tethys_portal/urls.py index 1adea5df4..e71fbfc63 100644 --- a/tethys_portal/urls.py +++ b/tethys_portal/urls.py @@ -21,7 +21,6 @@ PasswordResetConfirmView, PasswordResetCompleteView, ) -from django.conf import settings from tethys_apps.urls import extension_urls, urlpatterns as tethys_app_urlpatterns From a520a823c981db41253ec1201b0788b51c0e56e0 Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Fri, 8 Mar 2024 13:27:41 -0600 Subject: [PATCH 06/23] keep brand text for portal customization update the apps library title instead --- tethys_cli/site_commands.py | 12 ++++++++++-- tethys_portal/templates/header.html | 2 +- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/tethys_cli/site_commands.py b/tethys_cli/site_commands.py index a85fa56a1..bc17af352 100644 --- a/tethys_cli/site_commands.py +++ b/tethys_cli/site_commands.py @@ -3,6 +3,7 @@ from pathlib import Path from django.utils import timezone +from django.core.exceptions import ObjectDoesNotExist from tethys_cli.cli_helpers import setup_django from tethys_cli.cli_colors import write_msg, write_warning @@ -379,10 +380,17 @@ def update_site_settings_if_standalone_mode(portal_config_json): standalone_app = tethys_portal_config.get('STANDALONE_APP') if standalone_app: - standalone_app_title = standalone_app.replace("_", " ").replace("-", " ").title() + from tethys_apps.models import TethysApp + try: + # Get the app from the database + app = TethysApp.objects.get(package=standalone_app) + standalone_app_title = app.name + except ObjectDoesNotExist: + raise Exception('Could not locate app with package "{0}".'.format(standalone_app)) + site_settings = portal_config_json.get("site_settings", {}) site_settings["GENERAL_SETTINGS"]['STANDALONE_APP_MODE'] = "true" - site_settings["GENERAL_SETTINGS"]['BRAND_TEXT'] = standalone_app_title + site_settings["GENERAL_SETTINGS"]['APPS_LIBRARY_TITLE'] = standalone_app_title return portal_config_json diff --git a/tethys_portal/templates/header.html b/tethys_portal/templates/header.html index f89ecfeec..449fbb5bf 100644 --- a/tethys_portal/templates/header.html +++ b/tethys_portal/templates/header.html @@ -28,7 +28,7 @@
      {% block header_nav_items %} {% url 'app_library' as app_library_url %} - {% if ENABLE_OPEN_PORTAL or user.is_authenticated and user.is_active and site_globals.standalone_app_mode == "false" %} + {% if ENABLE_OPEN_PORTAL or user.is_authenticated and user.is_active %}
    • {% if site_globals.apps_library_title %}{{ site_globals.apps_library_title }}{% else %}Apps{% endif %}
      • From 2184f344fab80e27dbe43cfaf90703942347a46c Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Mon, 11 Mar 2024 09:42:38 -0500 Subject: [PATCH 07/23] cleaned up urls and fixed testing issues with urls --- .../unit_tests/test_tethys_apps/test_urls.py | 71 ++++++++ .../test_tethys_cli/test_site_commands.py | 155 ++++++++++++++++++ tethys_apps/urls.py | 3 + tethys_cli/site_commands.py | 23 ++- tethys_portal/urls.py | 4 +- 5 files changed, 247 insertions(+), 9 deletions(-) diff --git a/tests/unit_tests/test_tethys_apps/test_urls.py b/tests/unit_tests/test_tethys_apps/test_urls.py index fb2694a59..2beadd044 100644 --- a/tests/unit_tests/test_tethys_apps/test_urls.py +++ b/tests/unit_tests/test_tethys_apps/test_urls.py @@ -61,6 +61,7 @@ def reload_urlconf(self, urlconf=None): if urlconf is None: urlconf = self.settings.ROOT_URLCONF if urlconf in self.sys.modules: + self.reload(self.sys.modules['tethys_apps.urls']) self.reload(self.sys.modules[urlconf]) else: self.import_module(urlconf) @@ -109,3 +110,73 @@ def test_urls(self): self.assertEqual( "tethysext.test_extension.controllers", resolver.func.__module__ ) + + +@override_settings(STANDALONE_APP="test_app") +class TestUrlsWithStandaloneApp(TethysTestCase): + import sys + from importlib import reload, import_module + from django.conf import settings + from django.urls import clear_url_caches + + @classmethod + def reload_urlconf(self, urlconf=None): + self.clear_url_caches() + if urlconf is None: + urlconf = self.settings.ROOT_URLCONF + if urlconf in self.sys.modules: + self.reload(self.sys.modules['tethys_apps.urls']) + self.reload(self.sys.modules[urlconf]) + else: + self.import_module(urlconf) + + def set_up(self): + self.reload_urlconf() + pass + + @override_settings(STANDALONE_APP=None) + def tearDown(self): + self.reload_urlconf() + pass + + def test_urls(self): + # This executes the code at the module level + url = reverse("home") + resolver = resolve(url) + self.assertEqual("/", url) + self.assertEqual("RedirectView", resolver.func.__name__) + self.assertEqual("/test-app/", resolver.func.view_initkwargs['url']) + + url = reverse("app_library") + resolver = resolve(url) + self.assertEqual("/apps/", url) + self.assertEqual("RedirectView", resolver.func.__name__) + self.assertEqual("/test-app/", resolver.func.view_initkwargs['url']) + + url = reverse("send_beta_feedback") + resolver = resolve(url) + self.assertEqual("/send-beta-feedback/", url) + self.assertEqual("send_beta_feedback_email", resolver.func.__name__) + self.assertEqual("tethys_apps.views", resolver.func.__module__) + + url = reverse("test_app:home") + resolver = resolve(url) + self.assertEqual("/test-app/", url) + self.assertEqual("home", resolver.func.__name__) + self.assertEqual("tethysapp.test_app.controllers", resolver.func.__module__) + + url = reverse("test_extension:home", kwargs={"var1": "foo", "var2": "bar"}) + resolver = resolve(url) + self.assertEqual("/extensions/test-extension/foo/bar/", url) + self.assertEqual("home", resolver.func.__name__) + self.assertEqual( + "tethysext.test_extension.controllers", resolver.func.__module__ + ) + + url = reverse("test_extension:home", args=["foo", "bar"]) + resolver = resolve(url) + self.assertEqual("/extensions/test-extension/foo/bar/", url) + self.assertEqual("home", resolver.func.__name__) + self.assertEqual( + "tethysext.test_extension.controllers", resolver.func.__module__ + ) diff --git a/tests/unit_tests/test_tethys_cli/test_site_commands.py b/tests/unit_tests/test_tethys_cli/test_site_commands.py index 71ba0c541..9a47d24ca 100644 --- a/tests/unit_tests/test_tethys_cli/test_site_commands.py +++ b/tests/unit_tests/test_tethys_cli/test_site_commands.py @@ -1,11 +1,13 @@ import unittest import os from unittest import mock +from django.core.exceptions import ObjectDoesNotExist from tethys_cli.site_commands import ( gen_site_content, update_site_settings_content, uncodify, + update_site_settings_if_standalone_mode ) @@ -154,3 +156,156 @@ def test_update_site_settings_content_invalid_setting(self, mock_filter, mock_wa def test_uncodify(self): result = uncodify("my_css_to_render") self.assertEqual("My CSS to Render", result) + + def test_update_site_settings_if_standalone_mode_no_settings(self): + portal_config_json = { + 'version': 2.0, + 'name': None, + 'apps': None, + 'settings': None, + 'site_settings': { + 'GENERAL_SETTINGS': { + 'BRAND_TEXT': 'New Title' + } + } + } + + updated_portal_config_json = update_site_settings_if_standalone_mode(portal_config_json) + + expected_portal_config_json = { + 'version': 2.0, + 'name': None, + 'apps': None, + 'settings': None, + 'site_settings': { + 'GENERAL_SETTINGS': { + 'BRAND_TEXT': 'New Title' + } + } + } + self.assertTrue(updated_portal_config_json == expected_portal_config_json) + + def test_update_site_settings_if_standalone_mode_no_portal_config(self): + portal_config_json = { + 'version': 2.0, + 'name': None, + 'apps': None, + 'settings': { + 'TETHYS_PORTAL_CONFIG': None + }, + 'site_settings': { + 'GENERAL_SETTINGS': { + 'BRAND_TEXT': 'New Title' + } + } + } + + updated_portal_config_json = update_site_settings_if_standalone_mode(portal_config_json) + + expected_portal_config_json = { + 'version': 2.0, + 'name': None, + 'apps': None, + 'settings': { + 'TETHYS_PORTAL_CONFIG': None + }, + 'site_settings': { + 'GENERAL_SETTINGS': { + 'BRAND_TEXT': 'New Title' + } + } + } + self.assertTrue(updated_portal_config_json == expected_portal_config_json) + + def test_update_site_settings_if_standalone_mode_no_standalone(self): + portal_config_json = { + 'version': 2.0, + 'name': None, + 'apps': None, + 'settings': { + 'TETHYS_PORTAL_CONFIG': { + 'STANDALONE_APP': None + } + }, + 'site_settings': { + 'GENERAL_SETTINGS': { + 'BRAND_TEXT': 'New Title' + } + } + } + + updated_portal_config_json = update_site_settings_if_standalone_mode(portal_config_json) + + expected_portal_config_json = { + 'version': 2.0, + 'name': None, + 'apps': None, + 'settings': { + 'TETHYS_PORTAL_CONFIG': { + 'STANDALONE_APP': None + } + }, + 'site_settings': { + 'GENERAL_SETTINGS': { + 'BRAND_TEXT': 'New Title' + } + } + } + self.assertTrue(updated_portal_config_json == expected_portal_config_json) + + @mock.patch("tethys_apps.models.TethysApp") + def test_update_site_settings_if_standalone_mode_standalone(self, mock_tethysapp): + portal_config_json = { + 'version': 2.0, + 'name': None, + 'apps': None, + 'settings': { + "TETHYS_PORTAL_CONFIG": { + "STANDALONE_APP": 'standalone_app_test' + } + }, + 'site_settings': None + } + mock_app = mock.MagicMock() + mock_app.name = "Standalone App Test" + mock_tethysapp.objects.get.return_value = mock_app + updated_portal_config_json = update_site_settings_if_standalone_mode(portal_config_json) + + expected_portal_config_json = { + 'version': 2.0, + 'name': None, + 'apps': None, + 'settings': { + "TETHYS_PORTAL_CONFIG": { + "STANDALONE_APP": 'standalone_app_test' + } + }, + 'site_settings': { + "GENERAL_SETTINGS": { + "STANDALONE_APP_MODE": 'true', + "APPS_LIBRARY_TITLE": 'Standalone App Test' + } + } + } + self.assertTrue(updated_portal_config_json == expected_portal_config_json) + + @mock.patch("tethys_apps.models.TethysApp") + def test_update_site_settings_if_standalone_mode_app_dne(self, mock_tethysapp): + portal_config_json = { + 'version': 2.0, + 'name': None, + 'apps': None, + 'settings': { + "TETHYS_PORTAL_CONFIG": { + "STANDALONE_APP": 'standalone_app_test' + } + }, + 'site_settings': None + } + mock_tethysapp.objects.get.side_effect = [ObjectDoesNotExist] + with self.assertRaises(Exception) as context: + update_site_settings_if_standalone_mode(portal_config_json) + + self.assertTrue('Could not locate app with package "standalone_app_test".' in context.exception.args) + + diff --git a/tethys_apps/urls.py b/tethys_apps/urls.py index d58d9796d..c7a040aa2 100644 --- a/tethys_apps/urls.py +++ b/tethys_apps/urls.py @@ -10,6 +10,7 @@ import logging from django.urls import include, re_path from channels.routing import URLRouter +from django.views.generic import RedirectView from tethys_apps.harvester import SingletonHarvester from tethys_apps.views import library, send_beta_feedback_email from django.conf import settings @@ -23,6 +24,8 @@ ), ] if settings.STANDALONE_APP: + standalone_app_hyphen = settings.STANDALONE_APP.replace("_", "-") + urlpatterns.append(re_path(r"^apps/", RedirectView.as_view(url=f"/{standalone_app_hyphen}/"), name="app_library")) url_namespaces = [settings.STANDALONE_APP] else: urlpatterns.append(re_path(r"^$", library, name="app_library")) diff --git a/tethys_cli/site_commands.py b/tethys_cli/site_commands.py index bc17af352..42a9ead4b 100644 --- a/tethys_cli/site_commands.py +++ b/tethys_cli/site_commands.py @@ -376,9 +376,15 @@ def update_site_settings_content(settings_dict, warn_if_setting_not_found=False) def update_site_settings_if_standalone_mode(portal_config_json): - tethys_portal_config = portal_config_json.get('settings', {}).get('TETHYS_PORTAL_CONFIG', {}) - standalone_app = tethys_portal_config.get('STANDALONE_APP') + tethys_portal_settings = portal_config_json.get('settings') + if not tethys_portal_settings: + return portal_config_json + + tethys_portal_config_settings = tethys_portal_settings.get('TETHYS_PORTAL_CONFIG') + if not tethys_portal_config_settings: + return portal_config_json + standalone_app = tethys_portal_config_settings.get('STANDALONE_APP') if standalone_app: from tethys_apps.models import TethysApp try: @@ -386,11 +392,16 @@ def update_site_settings_if_standalone_mode(portal_config_json): app = TethysApp.objects.get(package=standalone_app) standalone_app_title = app.name except ObjectDoesNotExist: - raise Exception('Could not locate app with package "{0}".'.format(standalone_app)) + raise Exception(f'Could not locate app with package "{standalone_app}".') - site_settings = portal_config_json.get("site_settings", {}) - site_settings["GENERAL_SETTINGS"]['STANDALONE_APP_MODE'] = "true" - site_settings["GENERAL_SETTINGS"]['APPS_LIBRARY_TITLE'] = standalone_app_title + if not portal_config_json.get("site_settings"): + portal_config_json["site_settings"] = {} + + if not portal_config_json["site_settings"].get("GENERAL_SETTINGS"): + portal_config_json["site_settings"]["GENERAL_SETTINGS"] = {} + + portal_config_json["site_settings"]["GENERAL_SETTINGS"]['STANDALONE_APP_MODE'] = "true" + portal_config_json["site_settings"]["GENERAL_SETTINGS"]['APPS_LIBRARY_TITLE'] = standalone_app_title return portal_config_json diff --git a/tethys_portal/urls.py b/tethys_portal/urls.py index e71fbfc63..4909bd3df 100644 --- a/tethys_portal/urls.py +++ b/tethys_portal/urls.py @@ -182,11 +182,9 @@ if settings.STANDALONE_APP: standalone_app_hyphen = settings.STANDALONE_APP.replace("_", "-") - standalone_app_urlpatterns = tethys_app_urlpatterns[1] urlpatterns = [ - re_path(r"^{0}/".format(standalone_app_hyphen), include((standalone_app_urlpatterns.url_patterns, settings.STANDALONE_APP), namespace=settings.STANDALONE_APP)), re_path(r"^$", RedirectView.as_view(url=f"/{standalone_app_hyphen}/"), name="home"), - re_path(r"^apps/", RedirectView.as_view(url=f"/{standalone_app_hyphen}/"), name="app_library") + re_path(r"^", include("tethys_apps.urls")) ] else: urlpatterns = [ From 283c1eeb5d367f2e9b32f56fbcd94d6d77f51e3b Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Mon, 11 Mar 2024 11:21:13 -0500 Subject: [PATCH 08/23] added new python tests black formatted and linted --- tests/unit_tests/__init__.py | 1 + .../test_models/test_TethysApp.py | 1 + .../unit_tests/test_tethys_apps/test_urls.py | 8 +- .../test_tethys_apps/test_utilities.py | 15 ++ .../test_tethys_cli/test_site_commands.py | 175 +++++++----------- .../test_models/test_CondorScheduler.py | 1 + .../test_dask/test_DaskJobResult.py | 1 + .../test_dask/test_DaskScheduler.py | 1 + .../test_gizmo_options/test_base.py | 1 + .../test_tethys_portal/test_settings.py | 12 ++ tethys_apps/admin.py | 1 + tethys_apps/app_installation.py | 1 + tethys_apps/apps.py | 1 + tethys_apps/base/__init__.py | 1 + tethys_apps/base/bokeh_handler.py | 1 + tethys_apps/base/handoff.py | 9 +- tethys_apps/base/url_map.py | 1 + tethys_apps/context_processors.py | 1 + tethys_apps/decorators.py | 1 + tethys_apps/harvester.py | 7 +- .../management/commands/collectworkspaces.py | 1 + .../management/commands/pre_collectstatic.py | 1 + tethys_apps/management/commands/syncstores.py | 1 + .../commands/tethys_app_uninstall.py | 1 + tethys_apps/models.py | 1 + tethys_apps/static_finders.py | 1 + tethys_apps/template_loaders.py | 1 + tethys_apps/urls.py | 9 +- tethys_apps/utilities.py | 1 + tethys_apps/views.py | 1 + tethys_cli/__init__.py | 1 + tethys_cli/db_commands.py | 1 + tethys_cli/docker_commands.py | 1 + tethys_cli/gen_commands.py | 1 + tethys_cli/settings_commands.py | 1 + tethys_cli/site_commands.py | 27 ++- tethys_compute/__init__.py | 1 + tethys_compute/admin.py | 1 + tethys_compute/apps.py | 1 + tethys_compute/job_manager.py | 1 + tethys_compute/models/__init__.py | 1 + tethys_compute/models/basic_job.py | 1 + tethys_compute/models/condor/condor_base.py | 1 + tethys_compute/models/condor/condor_job.py | 1 + tethys_compute/models/condor/condor_py_job.py | 1 + .../models/condor/condor_py_workflow.py | 1 + .../models/condor/condor_scheduler.py | 1 + .../models/condor/condor_workflow.py | 1 + .../models/condor/condor_workflow_job_node.py | 1 + .../models/condor/condor_workflow_node.py | 1 + tethys_compute/models/dask/dask_job.py | 1 + tethys_compute/models/dask/dask_scheduler.py | 1 + tethys_compute/models/scheduler.py | 1 + tethys_compute/models/tethys_job.py | 1 + tethys_compute/scheduler_manager.py | 1 + tethys_config/__init__.py | 1 + tethys_config/admin.py | 1 + tethys_config/apps.py | 1 + tethys_config/context_processors.py | 1 + tethys_config/models.py | 1 + tethys_gizmos/admin.py | 1 + tethys_gizmos/gizmo_options/__init__.py | 1 + tethys_gizmos/gizmo_options/base.py | 1 + tethys_gizmos/gizmo_options/button.py | 1 + tethys_gizmos/gizmo_options/datatable_view.py | 1 + tethys_gizmos/gizmo_options/date_picker.py | 1 + tethys_gizmos/gizmo_options/map_view.py | 1 + tethys_gizmos/gizmo_options/message_box.py | 1 + tethys_gizmos/gizmo_options/range_slider.py | 1 + tethys_gizmos/gizmo_options/select_input.py | 1 + tethys_gizmos/gizmo_options/table_view.py | 1 + tethys_gizmos/gizmo_options/text_input.py | 1 + tethys_gizmos/gizmo_options/toggle_switch.py | 1 + tethys_gizmos/templatetags/tethys_gizmos.py | 1 + tethys_gizmos/urls.py | 1 + tethys_layouts/mixins/map_layout.py | 12 +- tethys_layouts/views/map_layout.py | 1 + tethys_layouts/views/tethys_layout.py | 1 + tethys_portal/__init__.py | 1 + tethys_portal/asgi.py | 1 + tethys_portal/forms.py | 1 + tethys_portal/middleware.py | 1 + tethys_portal/urls.py | 71 +++---- tethys_portal/utilities.py | 1 + tethys_portal/views/accounts.py | 1 + tethys_portal/views/api.py | 10 +- tethys_portal/views/error.py | 1 + tethys_portal/views/home.py | 1 + tethys_portal/views/user.py | 1 + tethys_quotas/__init__.py | 1 + tethys_quotas/admin.py | 1 + tethys_quotas/apps.py | 1 + tethys_quotas/decorators.py | 1 + tethys_quotas/handlers/base.py | 1 + tethys_quotas/handlers/workspace.py | 1 + tethys_quotas/models/__init__.py | 1 + tethys_quotas/models/entity_quota.py | 1 + tethys_quotas/models/resource_quota.py | 1 + tethys_quotas/models/tethys_app_quota.py | 1 + tethys_quotas/models/user_quota.py | 1 + tethys_quotas/utilities.py | 1 + tethys_sdk/__init__.py | 1 + tethys_sdk/app_settings.py | 1 + tethys_sdk/compute.py | 1 + tethys_sdk/gizmos.py | 1 + tethys_sdk/handoff.py | 1 + tethys_sdk/jobs.py | 1 + tethys_sdk/layouts.py | 1 + tethys_sdk/permissions.py | 1 + tethys_sdk/services.py | 22 ++- tethys_sdk/testing.py | 1 + tethys_sdk/workspaces.py | 1 + tethys_services/__init__.py | 1 + tethys_services/admin.py | 1 + tethys_services/apps.py | 1 + tethys_services/backends/arcgis_portal.py | 1 + tethys_services/backends/hydroshare.py | 1 + tethys_services/backends/hydroshare_beta.py | 1 + .../backends/hydroshare_playground.py | 1 + tethys_services/models.py | 1 + tethys_services/urls.py | 1 + tethys_services/utilities.py | 1 + tethys_services/views.py | 1 + 123 files changed, 319 insertions(+), 169 deletions(-) diff --git a/tests/unit_tests/__init__.py b/tests/unit_tests/__init__.py index d3ed76d4f..ea66f1d5d 100644 --- a/tests/unit_tests/__init__.py +++ b/tests/unit_tests/__init__.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + import uuid import factory from unittest import mock diff --git a/tests/unit_tests/test_tethys_apps/test_models/test_TethysApp.py b/tests/unit_tests/test_tethys_apps/test_models/test_TethysApp.py index a94c665a2..078bdf270 100644 --- a/tests/unit_tests/test_tethys_apps/test_models/test_TethysApp.py +++ b/tests/unit_tests/test_tethys_apps/test_models/test_TethysApp.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + from tethys_sdk.testing import TethysTestCase from tethys_apps.models import ( TethysApp, diff --git a/tests/unit_tests/test_tethys_apps/test_urls.py b/tests/unit_tests/test_tethys_apps/test_urls.py index 2beadd044..e7fcd6329 100644 --- a/tests/unit_tests/test_tethys_apps/test_urls.py +++ b/tests/unit_tests/test_tethys_apps/test_urls.py @@ -61,7 +61,7 @@ def reload_urlconf(self, urlconf=None): if urlconf is None: urlconf = self.settings.ROOT_URLCONF if urlconf in self.sys.modules: - self.reload(self.sys.modules['tethys_apps.urls']) + self.reload(self.sys.modules["tethys_apps.urls"]) self.reload(self.sys.modules[urlconf]) else: self.import_module(urlconf) @@ -125,7 +125,7 @@ def reload_urlconf(self, urlconf=None): if urlconf is None: urlconf = self.settings.ROOT_URLCONF if urlconf in self.sys.modules: - self.reload(self.sys.modules['tethys_apps.urls']) + self.reload(self.sys.modules["tethys_apps.urls"]) self.reload(self.sys.modules[urlconf]) else: self.import_module(urlconf) @@ -145,13 +145,13 @@ def test_urls(self): resolver = resolve(url) self.assertEqual("/", url) self.assertEqual("RedirectView", resolver.func.__name__) - self.assertEqual("/test-app/", resolver.func.view_initkwargs['url']) + self.assertEqual("/test-app/", resolver.func.view_initkwargs["url"]) url = reverse("app_library") resolver = resolve(url) self.assertEqual("/apps/", url) self.assertEqual("RedirectView", resolver.func.__name__) - self.assertEqual("/test-app/", resolver.func.view_initkwargs['url']) + self.assertEqual("/test-app/", resolver.func.view_initkwargs["url"]) url = reverse("send_beta_feedback") resolver = resolve(url) diff --git a/tests/unit_tests/test_tethys_apps/test_utilities.py b/tests/unit_tests/test_tethys_apps/test_utilities.py index 4fa33b160..426e621fe 100644 --- a/tests/unit_tests/test_tethys_apps/test_utilities.py +++ b/tests/unit_tests/test_tethys_apps/test_utilities.py @@ -4,6 +4,7 @@ from tethys_sdk.testing import TethysTestCase from tethys_apps import utilities from django.core.signing import Signer +from django.test import override_settings class TethysAppsUtilitiesTests(unittest.TestCase): @@ -141,6 +142,20 @@ def test_get_active_app_request(self, mock_app): result = utilities.get_active_app(request=mock_request) self.assertEqual(mock_app.objects.get(), result) + @override_settings(STANDALONE_APP="test_app") + @mock.patch("tethys_apps.models.TethysApp") + def test_get_active_app_request_standalone_app(self, mock_app): + # Mock up for TethysApp, and request + mock_tethysapp = mock.MagicMock() + mock_app.objects.get.return_value = mock_tethysapp + mock_request = mock.MagicMock() + mock_request.path = "/test-app/" + + # Result should be mock for mock_app.objects.get.return_value + result = utilities.get_active_app(request=mock_request) + self.assertEqual(mock_tethysapp, result) + mock_app.objects.get.assert_called_with(root_url="test-app") + @mock.patch("tethys_apps.models.TethysApp") def test_get_active_app_url(self, mock_app): # Mock up for TethysApp diff --git a/tests/unit_tests/test_tethys_cli/test_site_commands.py b/tests/unit_tests/test_tethys_cli/test_site_commands.py index 9a47d24ca..0efeb105d 100644 --- a/tests/unit_tests/test_tethys_cli/test_site_commands.py +++ b/tests/unit_tests/test_tethys_cli/test_site_commands.py @@ -7,7 +7,7 @@ gen_site_content, update_site_settings_content, uncodify, - update_site_settings_if_standalone_mode + update_site_settings_if_standalone_mode, ) @@ -159,153 +159,120 @@ def test_uncodify(self): def test_update_site_settings_if_standalone_mode_no_settings(self): portal_config_json = { - 'version': 2.0, - 'name': None, - 'apps': None, - 'settings': None, - 'site_settings': { - 'GENERAL_SETTINGS': { - 'BRAND_TEXT': 'New Title' - } - } + "version": 2.0, + "name": None, + "apps": None, + "settings": None, + "site_settings": {"GENERAL_SETTINGS": {"BRAND_TEXT": "New Title"}}, } - updated_portal_config_json = update_site_settings_if_standalone_mode(portal_config_json) + updated_portal_config_json = update_site_settings_if_standalone_mode( + portal_config_json + ) expected_portal_config_json = { - 'version': 2.0, - 'name': None, - 'apps': None, - 'settings': None, - 'site_settings': { - 'GENERAL_SETTINGS': { - 'BRAND_TEXT': 'New Title' - } - } + "version": 2.0, + "name": None, + "apps": None, + "settings": None, + "site_settings": {"GENERAL_SETTINGS": {"BRAND_TEXT": "New Title"}}, } self.assertTrue(updated_portal_config_json == expected_portal_config_json) def test_update_site_settings_if_standalone_mode_no_portal_config(self): portal_config_json = { - 'version': 2.0, - 'name': None, - 'apps': None, - 'settings': { - 'TETHYS_PORTAL_CONFIG': None - }, - 'site_settings': { - 'GENERAL_SETTINGS': { - 'BRAND_TEXT': 'New Title' - } - } + "version": 2.0, + "name": None, + "apps": None, + "settings": {"TETHYS_PORTAL_CONFIG": None}, + "site_settings": {"GENERAL_SETTINGS": {"BRAND_TEXT": "New Title"}}, } - updated_portal_config_json = update_site_settings_if_standalone_mode(portal_config_json) + updated_portal_config_json = update_site_settings_if_standalone_mode( + portal_config_json + ) expected_portal_config_json = { - 'version': 2.0, - 'name': None, - 'apps': None, - 'settings': { - 'TETHYS_PORTAL_CONFIG': None - }, - 'site_settings': { - 'GENERAL_SETTINGS': { - 'BRAND_TEXT': 'New Title' - } - } + "version": 2.0, + "name": None, + "apps": None, + "settings": {"TETHYS_PORTAL_CONFIG": None}, + "site_settings": {"GENERAL_SETTINGS": {"BRAND_TEXT": "New Title"}}, } self.assertTrue(updated_portal_config_json == expected_portal_config_json) def test_update_site_settings_if_standalone_mode_no_standalone(self): portal_config_json = { - 'version': 2.0, - 'name': None, - 'apps': None, - 'settings': { - 'TETHYS_PORTAL_CONFIG': { - 'STANDALONE_APP': None - } - }, - 'site_settings': { - 'GENERAL_SETTINGS': { - 'BRAND_TEXT': 'New Title' - } - } + "version": 2.0, + "name": None, + "apps": None, + "settings": {"TETHYS_PORTAL_CONFIG": {"STANDALONE_APP": None}}, + "site_settings": {"GENERAL_SETTINGS": {"BRAND_TEXT": "New Title"}}, } - updated_portal_config_json = update_site_settings_if_standalone_mode(portal_config_json) + updated_portal_config_json = update_site_settings_if_standalone_mode( + portal_config_json + ) expected_portal_config_json = { - 'version': 2.0, - 'name': None, - 'apps': None, - 'settings': { - 'TETHYS_PORTAL_CONFIG': { - 'STANDALONE_APP': None - } - }, - 'site_settings': { - 'GENERAL_SETTINGS': { - 'BRAND_TEXT': 'New Title' - } - } + "version": 2.0, + "name": None, + "apps": None, + "settings": {"TETHYS_PORTAL_CONFIG": {"STANDALONE_APP": None}}, + "site_settings": {"GENERAL_SETTINGS": {"BRAND_TEXT": "New Title"}}, } self.assertTrue(updated_portal_config_json == expected_portal_config_json) @mock.patch("tethys_apps.models.TethysApp") def test_update_site_settings_if_standalone_mode_standalone(self, mock_tethysapp): portal_config_json = { - 'version': 2.0, - 'name': None, - 'apps': None, - 'settings': { - "TETHYS_PORTAL_CONFIG": { - "STANDALONE_APP": 'standalone_app_test' - } - }, - 'site_settings': None + "version": 2.0, + "name": None, + "apps": None, + "settings": { + "TETHYS_PORTAL_CONFIG": {"STANDALONE_APP": "standalone_app_test"} + }, + "site_settings": None, } mock_app = mock.MagicMock() mock_app.name = "Standalone App Test" mock_tethysapp.objects.get.return_value = mock_app - updated_portal_config_json = update_site_settings_if_standalone_mode(portal_config_json) + updated_portal_config_json = update_site_settings_if_standalone_mode( + portal_config_json + ) expected_portal_config_json = { - 'version': 2.0, - 'name': None, - 'apps': None, - 'settings': { - "TETHYS_PORTAL_CONFIG": { - "STANDALONE_APP": 'standalone_app_test' - } - }, - 'site_settings': { + "version": 2.0, + "name": None, + "apps": None, + "settings": { + "TETHYS_PORTAL_CONFIG": {"STANDALONE_APP": "standalone_app_test"} + }, + "site_settings": { "GENERAL_SETTINGS": { - "STANDALONE_APP_MODE": 'true', - "APPS_LIBRARY_TITLE": 'Standalone App Test' + "STANDALONE_APP_MODE": "true", + "APPS_LIBRARY_TITLE": "Standalone App Test", } - } + }, } self.assertTrue(updated_portal_config_json == expected_portal_config_json) @mock.patch("tethys_apps.models.TethysApp") def test_update_site_settings_if_standalone_mode_app_dne(self, mock_tethysapp): portal_config_json = { - 'version': 2.0, - 'name': None, - 'apps': None, - 'settings': { - "TETHYS_PORTAL_CONFIG": { - "STANDALONE_APP": 'standalone_app_test' - } - }, - 'site_settings': None + "version": 2.0, + "name": None, + "apps": None, + "settings": { + "TETHYS_PORTAL_CONFIG": {"STANDALONE_APP": "standalone_app_test"} + }, + "site_settings": None, } mock_tethysapp.objects.get.side_effect = [ObjectDoesNotExist] with self.assertRaises(Exception) as context: update_site_settings_if_standalone_mode(portal_config_json) - self.assertTrue('Could not locate app with package "standalone_app_test".' in context.exception.args) - - + self.assertTrue( + 'Could not locate app with package "standalone_app_test".' + in context.exception.args + ) diff --git a/tests/unit_tests/test_tethys_compute/test_models/test_CondorScheduler.py b/tests/unit_tests/test_tethys_compute/test_models/test_CondorScheduler.py index da34163c5..ec3893103 100644 --- a/tests/unit_tests/test_tethys_compute/test_models/test_CondorScheduler.py +++ b/tests/unit_tests/test_tethys_compute/test_models/test_CondorScheduler.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + from tethys_apps.base.testing.testing import TethysTestCase from tethys_compute.models import Scheduler, CondorScheduler diff --git a/tests/unit_tests/test_tethys_compute/test_models/test_dask/test_DaskJobResult.py b/tests/unit_tests/test_tethys_compute/test_models/test_dask/test_DaskJobResult.py index c14bea3fb..8b32e024a 100644 --- a/tests/unit_tests/test_tethys_compute/test_models/test_dask/test_DaskJobResult.py +++ b/tests/unit_tests/test_tethys_compute/test_models/test_dask/test_DaskJobResult.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + from tethys_sdk.testing import TethysTestCase from tethys_compute.models.dask.dask_scheduler import DaskScheduler from tethys_compute.models.dask.dask_job import DaskJob diff --git a/tests/unit_tests/test_tethys_compute/test_models/test_dask/test_DaskScheduler.py b/tests/unit_tests/test_tethys_compute/test_models/test_dask/test_DaskScheduler.py index acaa5cbf3..d2285235a 100644 --- a/tests/unit_tests/test_tethys_compute/test_models/test_dask/test_DaskScheduler.py +++ b/tests/unit_tests/test_tethys_compute/test_models/test_dask/test_DaskScheduler.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + from tethys_apps.base.testing.testing import TethysTestCase from tethys_compute.models import Scheduler, DaskScheduler from unittest import mock diff --git a/tests/unit_tests/test_tethys_gizmos/test_gizmo_options/test_base.py b/tests/unit_tests/test_tethys_gizmos/test_gizmo_options/test_base.py index 58758127c..3d680b92a 100644 --- a/tests/unit_tests/test_tethys_gizmos/test_gizmo_options/test_base.py +++ b/tests/unit_tests/test_tethys_gizmos/test_gizmo_options/test_base.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + import unittest import tethys_gizmos.gizmo_options.base as basetest diff --git a/tests/unit_tests/test_tethys_portal/test_settings.py b/tests/unit_tests/test_tethys_portal/test_settings.py index a6ea5fb7a..b90acf1ec 100644 --- a/tests/unit_tests/test_tethys_portal/test_settings.py +++ b/tests/unit_tests/test_tethys_portal/test_settings.py @@ -260,3 +260,15 @@ def test_bokeh_django_staticfiles_finder(self, _): self.assertIn( "bokeh_django.static.BokehExtensionFinder", settings.STATICFILES_FINDERS ) + + @mock.patch( + "tethys_portal.settings.yaml.safe_load", + return_value={ + "settings": {"TETHYS_PORTAL_CONFIG": {"STANDALONE_APP": "test_app"}} + }, + ) + def test_portal_config_settings_standalone_app(self, _): + reload(settings) + + self.assertTrue(settings.STANDALONE_APP == "test_app") + self.assertTrue(settings.BYPASS_TETHYS_HOME_PAGE) diff --git a/tethys_apps/admin.py b/tethys_apps/admin.py index e8b7ad865..a9ddb27b4 100644 --- a/tethys_apps/admin.py +++ b/tethys_apps/admin.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import json import logging from django import forms diff --git a/tethys_apps/app_installation.py b/tethys_apps/app_installation.py index 4c52eb2e1..75cef1352 100644 --- a/tethys_apps/app_installation.py +++ b/tethys_apps/app_installation.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import os diff --git a/tethys_apps/apps.py b/tethys_apps/apps.py index 108cae352..3da1fd33a 100644 --- a/tethys_apps/apps.py +++ b/tethys_apps/apps.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import sys from django.apps import AppConfig diff --git a/tethys_apps/base/__init__.py b/tethys_apps/base/__init__.py index 377f89e55..07357728c 100644 --- a/tethys_apps/base/__init__.py +++ b/tethys_apps/base/__init__.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + # DO NOT ERASE from tethys_apps.base.app_base import TethysAppBase, TethysExtensionBase # noqa: F401 from tethys_apps.base.bokeh_handler import with_request, with_workspaces # noqa: F401 diff --git a/tethys_apps/base/bokeh_handler.py b/tethys_apps/base/bokeh_handler.py index cbe0c4433..c36a8a22f 100644 --- a/tethys_apps/base/bokeh_handler.py +++ b/tethys_apps/base/bokeh_handler.py @@ -6,6 +6,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + # Native Imports from functools import wraps diff --git a/tethys_apps/base/handoff.py b/tethys_apps/base/handoff.py index 3dc94403a..944605d51 100644 --- a/tethys_apps/base/handoff.py +++ b/tethys_apps/base/handoff.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import inspect import json from django.shortcuts import redirect @@ -124,10 +125,10 @@ def handoff( json.dumps(error), content_type="application/javascript" ) - error[ - "message" - ] = "HTTP 400 Bad Request: No handoff handler '{0}' for app '{1}' found.".format( - manager.app.name, handler_name + error["message"] = ( + "HTTP 400 Bad Request: No handoff handler '{0}' for app '{1}' found.".format( + manager.app.name, handler_name + ) ) return HttpResponseBadRequest( json.dumps(error), content_type="application/javascript" diff --git a/tethys_apps/base/url_map.py b/tethys_apps/base/url_map.py index 37f9339f8..fd89546fe 100644 --- a/tethys_apps/base/url_map.py +++ b/tethys_apps/base/url_map.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + DEFAULT_EXPRESSION = r"[0-9A-Za-z-_.]+" diff --git a/tethys_apps/context_processors.py b/tethys_apps/context_processors.py index 049d3ce44..eebf6d508 100644 --- a/tethys_apps/context_processors.py +++ b/tethys_apps/context_processors.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from tethys_apps.utilities import get_active_app from tethys_portal.dependencies import vendor_static_dependencies diff --git a/tethys_apps/decorators.py b/tethys_apps/decorators.py index 12c837bb4..591ba11c9 100644 --- a/tethys_apps/decorators.py +++ b/tethys_apps/decorators.py @@ -7,6 +7,7 @@ * License: ******************************************************************************** """ + from functools import wraps from urllib.parse import urlparse diff --git a/tethys_apps/harvester.py b/tethys_apps/harvester.py index e5315fa25..47f6e0ec0 100644 --- a/tethys_apps/harvester.py +++ b/tethys_apps/harvester.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import inspect import logging import pkgutil @@ -214,9 +215,9 @@ def _harvest_extension_instances(self, extension_packages): # compile valid apps if validated_ext_instance: valid_ext_instances.append(validated_ext_instance) - valid_extension_modules[ - extension_name - ] = extension_package + valid_extension_modules[extension_name] = ( + extension_package + ) # Notify user that the app has been loaded loaded_extensions.append(extension_name) diff --git a/tethys_apps/management/commands/collectworkspaces.py b/tethys_apps/management/commands/collectworkspaces.py index a673ff0be..d38881a4b 100644 --- a/tethys_apps/management/commands/collectworkspaces.py +++ b/tethys_apps/management/commands/collectworkspaces.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import os import shutil diff --git a/tethys_apps/management/commands/pre_collectstatic.py b/tethys_apps/management/commands/pre_collectstatic.py index e0cb0075e..e276a015e 100644 --- a/tethys_apps/management/commands/pre_collectstatic.py +++ b/tethys_apps/management/commands/pre_collectstatic.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import os import shutil diff --git a/tethys_apps/management/commands/syncstores.py b/tethys_apps/management/commands/syncstores.py index 6c9a5ee5f..b083e9bbb 100644 --- a/tethys_apps/management/commands/syncstores.py +++ b/tethys_apps/management/commands/syncstores.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.core.management.base import BaseCommand from tethys_cli.cli_colors import TC_BLUE, TC_WARNING, TC_ENDC diff --git a/tethys_apps/management/commands/tethys_app_uninstall.py b/tethys_apps/management/commands/tethys_app_uninstall.py index fab965052..0783ee99b 100644 --- a/tethys_apps/management/commands/tethys_app_uninstall.py +++ b/tethys_apps/management/commands/tethys_app_uninstall.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import os import site import subprocess diff --git a/tethys_apps/models.py b/tethys_apps/models.py index ae8b01df0..ad1b45610 100644 --- a/tethys_apps/models.py +++ b/tethys_apps/models.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.dispatch import receiver import logging import uuid diff --git a/tethys_apps/static_finders.py b/tethys_apps/static_finders.py index a2adcc7b3..4ea35bae1 100644 --- a/tethys_apps/static_finders.py +++ b/tethys_apps/static_finders.py @@ -7,6 +7,7 @@ * License: ******************************************************************************** """ + import os from collections import OrderedDict as SortedDict from django.contrib.staticfiles import utils diff --git a/tethys_apps/template_loaders.py b/tethys_apps/template_loaders.py index b9a962d79..5b3226b32 100644 --- a/tethys_apps/template_loaders.py +++ b/tethys_apps/template_loaders.py @@ -7,6 +7,7 @@ * License: ******************************************************************************** """ + import io import errno from django.core.exceptions import SuspiciousFileOperation diff --git a/tethys_apps/urls.py b/tethys_apps/urls.py index c7a040aa2..6574a8ca2 100644 --- a/tethys_apps/urls.py +++ b/tethys_apps/urls.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import logging from django.urls import include, re_path from channels.routing import URLRouter @@ -25,7 +26,13 @@ ] if settings.STANDALONE_APP: standalone_app_hyphen = settings.STANDALONE_APP.replace("_", "-") - urlpatterns.append(re_path(r"^apps/", RedirectView.as_view(url=f"/{standalone_app_hyphen}/"), name="app_library")) + urlpatterns.append( + re_path( + r"^apps/", + RedirectView.as_view(url=f"/{standalone_app_hyphen}/"), + name="app_library", + ) + ) url_namespaces = [settings.STANDALONE_APP] else: urlpatterns.append(re_path(r"^$", library, name="app_library")) diff --git a/tethys_apps/utilities.py b/tethys_apps/utilities.py index 136bb3be0..28c9c9073 100644 --- a/tethys_apps/utilities.py +++ b/tethys_apps/utilities.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import importlib import logging import os diff --git a/tethys_apps/views.py b/tethys_apps/views.py index ccbed923e..29938d139 100644 --- a/tethys_apps/views.py +++ b/tethys_apps/views.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import logging from django.shortcuts import render from django.http import HttpResponse, JsonResponse diff --git a/tethys_cli/__init__.py b/tethys_cli/__init__.py index 9dbad7c7a..397853a24 100644 --- a/tethys_cli/__init__.py +++ b/tethys_cli/__init__.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + # Commandline interface for Tethys import argparse diff --git a/tethys_cli/db_commands.py b/tethys_cli/db_commands.py index fee76b98a..dd6c424aa 100644 --- a/tethys_cli/db_commands.py +++ b/tethys_cli/db_commands.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from pathlib import Path import shutil import argparse diff --git a/tethys_cli/docker_commands.py b/tethys_cli/docker_commands.py index c78aa5b9e..b564f2b10 100644 --- a/tethys_cli/docker_commands.py +++ b/tethys_cli/docker_commands.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import os import json from abc import ABC, abstractmethod diff --git a/tethys_cli/gen_commands.py b/tethys_cli/gen_commands.py index 3d2745071..049a94006 100644 --- a/tethys_cli/gen_commands.py +++ b/tethys_cli/gen_commands.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import json import os import string diff --git a/tethys_cli/settings_commands.py b/tethys_cli/settings_commands.py index 753cfe23c..4be4c3181 100644 --- a/tethys_cli/settings_commands.py +++ b/tethys_cli/settings_commands.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from pathlib import Path from pprint import pformat from argparse import Namespace diff --git a/tethys_cli/site_commands.py b/tethys_cli/site_commands.py index 42a9ead4b..9878c5a33 100644 --- a/tethys_cli/site_commands.py +++ b/tethys_cli/site_commands.py @@ -310,7 +310,9 @@ def gen_site_content(args): if portal_yaml.exists(): with portal_yaml.open() as f: portal_config_json = yaml.safe_load(f) - portal_config_json = update_site_settings_if_standalone_mode(portal_config_json) + portal_config_json = update_site_settings_if_standalone_mode( + portal_config_json + ) site_settings = portal_config_json.get("site_settings", {}) for category in SITE_SETTING_CATEGORIES: @@ -376,32 +378,37 @@ def update_site_settings_content(settings_dict, warn_if_setting_not_found=False) def update_site_settings_if_standalone_mode(portal_config_json): - tethys_portal_settings = portal_config_json.get('settings') + tethys_portal_settings = portal_config_json.get("settings") if not tethys_portal_settings: return portal_config_json - - tethys_portal_config_settings = tethys_portal_settings.get('TETHYS_PORTAL_CONFIG') + + tethys_portal_config_settings = tethys_portal_settings.get("TETHYS_PORTAL_CONFIG") if not tethys_portal_config_settings: return portal_config_json - standalone_app = tethys_portal_config_settings.get('STANDALONE_APP') + standalone_app = tethys_portal_config_settings.get("STANDALONE_APP") if standalone_app: from tethys_apps.models import TethysApp + try: # Get the app from the database app = TethysApp.objects.get(package=standalone_app) standalone_app_title = app.name except ObjectDoesNotExist: raise Exception(f'Could not locate app with package "{standalone_app}".') - + if not portal_config_json.get("site_settings"): portal_config_json["site_settings"] = {} - + if not portal_config_json["site_settings"].get("GENERAL_SETTINGS"): portal_config_json["site_settings"]["GENERAL_SETTINGS"] = {} - - portal_config_json["site_settings"]["GENERAL_SETTINGS"]['STANDALONE_APP_MODE'] = "true" - portal_config_json["site_settings"]["GENERAL_SETTINGS"]['APPS_LIBRARY_TITLE'] = standalone_app_title + + portal_config_json["site_settings"]["GENERAL_SETTINGS"][ + "STANDALONE_APP_MODE" + ] = "true" + portal_config_json["site_settings"]["GENERAL_SETTINGS"][ + "APPS_LIBRARY_TITLE" + ] = standalone_app_title return portal_config_json diff --git a/tethys_compute/__init__.py b/tethys_compute/__init__.py index 9918d7901..f74c0ced3 100644 --- a/tethys_compute/__init__.py +++ b/tethys_compute/__init__.py @@ -7,4 +7,5 @@ * License: BSD 2-Clause ******************************************************************************** """ + default_app_config = "tethys_compute.apps.TethysComputeConfig" diff --git a/tethys_compute/admin.py b/tethys_compute/admin.py index cd078d20f..ce4e91d25 100644 --- a/tethys_compute/admin.py +++ b/tethys_compute/admin.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.contrib import admin from django.utils.html import format_html from django import forms diff --git a/tethys_compute/apps.py b/tethys_compute/apps.py index 832ac2034..aaba8606e 100644 --- a/tethys_compute/apps.py +++ b/tethys_compute/apps.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.apps import AppConfig diff --git a/tethys_compute/job_manager.py b/tethys_compute/job_manager.py index 9c022f842..ea3aa10a3 100644 --- a/tethys_compute/job_manager.py +++ b/tethys_compute/job_manager.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import logging diff --git a/tethys_compute/models/__init__.py b/tethys_compute/models/__init__.py index 371bd881e..7865ed1ba 100644 --- a/tethys_compute/models/__init__.py +++ b/tethys_compute/models/__init__.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.dispatch import receiver from django.db.models.signals import post_save diff --git a/tethys_compute/models/basic_job.py b/tethys_compute/models/basic_job.py index a2d295f3c..8dce775b0 100644 --- a/tethys_compute/models/basic_job.py +++ b/tethys_compute/models/basic_job.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + from tethys_compute.models.tethys_job import TethysJob diff --git a/tethys_compute/models/condor/condor_base.py b/tethys_compute/models/condor/condor_base.py index 9f299b3b4..1cc5c5b3d 100644 --- a/tethys_compute/models/condor/condor_base.py +++ b/tethys_compute/models/condor/condor_base.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + import os from abc import abstractmethod from pathlib import Path diff --git a/tethys_compute/models/condor/condor_job.py b/tethys_compute/models/condor/condor_job.py index 694c44fc5..6cbf5cf97 100644 --- a/tethys_compute/models/condor/condor_job.py +++ b/tethys_compute/models/condor/condor_job.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + import shutil import logging diff --git a/tethys_compute/models/condor/condor_py_job.py b/tethys_compute/models/condor/condor_py_job.py index 6baf2e2e3..434f858fe 100644 --- a/tethys_compute/models/condor/condor_py_job.py +++ b/tethys_compute/models/condor/condor_py_job.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + from tethys_portal.optional_dependencies import optional_import import os diff --git a/tethys_compute/models/condor/condor_py_workflow.py b/tethys_compute/models/condor/condor_py_workflow.py index 4cd4769c2..4f1f7b09c 100644 --- a/tethys_compute/models/condor/condor_py_workflow.py +++ b/tethys_compute/models/condor/condor_py_workflow.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + from tethys_portal.optional_dependencies import optional_import from django.db import models diff --git a/tethys_compute/models/condor/condor_scheduler.py b/tethys_compute/models/condor/condor_scheduler.py index ef38db763..a3b5fb824 100644 --- a/tethys_compute/models/condor/condor_scheduler.py +++ b/tethys_compute/models/condor/condor_scheduler.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + from django.db import models from tethys_compute.models.scheduler import Scheduler diff --git a/tethys_compute/models/condor/condor_workflow.py b/tethys_compute/models/condor/condor_workflow.py index 68ab94020..2f55efb24 100644 --- a/tethys_compute/models/condor/condor_workflow.py +++ b/tethys_compute/models/condor/condor_workflow.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + import shutil import logging import os diff --git a/tethys_compute/models/condor/condor_workflow_job_node.py b/tethys_compute/models/condor/condor_workflow_job_node.py index 9700d9a42..d0e0ba033 100644 --- a/tethys_compute/models/condor/condor_workflow_job_node.py +++ b/tethys_compute/models/condor/condor_workflow_job_node.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + from django.db.models.signals import pre_save from django.dispatch import receiver diff --git a/tethys_compute/models/condor/condor_workflow_node.py b/tethys_compute/models/condor/condor_workflow_node.py index fef7c190c..da2560f17 100644 --- a/tethys_compute/models/condor/condor_workflow_node.py +++ b/tethys_compute/models/condor/condor_workflow_node.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + from abc import abstractmethod from django.db import models diff --git a/tethys_compute/models/dask/dask_job.py b/tethys_compute/models/dask/dask_job.py index 4f0be22a9..d08dac141 100644 --- a/tethys_compute/models/dask/dask_job.py +++ b/tethys_compute/models/dask/dask_job.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + import logging import datetime import json diff --git a/tethys_compute/models/dask/dask_scheduler.py b/tethys_compute/models/dask/dask_scheduler.py index ea751b6b5..441df0471 100644 --- a/tethys_compute/models/dask/dask_scheduler.py +++ b/tethys_compute/models/dask/dask_scheduler.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + import logging from django.db import models from tethys_compute.models.scheduler import Scheduler diff --git a/tethys_compute/models/scheduler.py b/tethys_compute/models/scheduler.py index 480bd34d8..7d8144d7b 100644 --- a/tethys_compute/models/scheduler.py +++ b/tethys_compute/models/scheduler.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + from django.db import models from model_utils.managers import InheritanceManager diff --git a/tethys_compute/models/tethys_job.py b/tethys_compute/models/tethys_job.py index 20676c75e..b71ddc106 100644 --- a/tethys_compute/models/tethys_job.py +++ b/tethys_compute/models/tethys_job.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + import logging import datetime import inspect diff --git a/tethys_compute/scheduler_manager.py b/tethys_compute/scheduler_manager.py index 33874657a..75f1e5aa4 100644 --- a/tethys_compute/scheduler_manager.py +++ b/tethys_compute/scheduler_manager.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from tethys_compute.models import Scheduler from tethys_compute.models.condor.condor_scheduler import CondorScheduler from tethys_compute.models.dask.dask_scheduler import DaskScheduler diff --git a/tethys_config/__init__.py b/tethys_config/__init__.py index d7f518841..0771ad4cd 100644 --- a/tethys_config/__init__.py +++ b/tethys_config/__init__.py @@ -7,5 +7,6 @@ * License: BSD 2-Clause ******************************************************************************** """ + # Load the custom app config default_app_config = "tethys_config.apps.TethysPortalConfig" diff --git a/tethys_config/admin.py b/tethys_config/admin.py index eb93ff469..84e587907 100644 --- a/tethys_config/admin.py +++ b/tethys_config/admin.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.contrib import admin from django.forms import Textarea from django.db import models diff --git a/tethys_config/apps.py b/tethys_config/apps.py index fd1195f62..7e5ce3a2a 100644 --- a/tethys_config/apps.py +++ b/tethys_config/apps.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.apps import AppConfig diff --git a/tethys_config/context_processors.py b/tethys_config/context_processors.py index 5b34caff8..453074a84 100644 --- a/tethys_config/context_processors.py +++ b/tethys_config/context_processors.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import datetime as dt from tethys_portal.optional_dependencies import optional_import, has_module diff --git a/tethys_config/models.py b/tethys_config/models.py index 008fa4031..30328efc6 100644 --- a/tethys_config/models.py +++ b/tethys_config/models.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.db import models diff --git a/tethys_gizmos/admin.py b/tethys_gizmos/admin.py index bd1fee0b0..41ed3b83b 100644 --- a/tethys_gizmos/admin.py +++ b/tethys_gizmos/admin.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + # from django.contrib import admin # Register your models here. diff --git a/tethys_gizmos/gizmo_options/__init__.py b/tethys_gizmos/gizmo_options/__init__.py index d8e78b1f8..3290a5b64 100644 --- a/tethys_gizmos/gizmo_options/__init__.py +++ b/tethys_gizmos/gizmo_options/__init__.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + # flake8: noqa from .date_picker import * from .button import * diff --git a/tethys_gizmos/gizmo_options/base.py b/tethys_gizmos/gizmo_options/base.py index ee0975b8f..a7989671c 100644 --- a/tethys_gizmos/gizmo_options/base.py +++ b/tethys_gizmos/gizmo_options/base.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import re diff --git a/tethys_gizmos/gizmo_options/button.py b/tethys_gizmos/gizmo_options/button.py index 4b5ec74ea..7a219deb4 100644 --- a/tethys_gizmos/gizmo_options/button.py +++ b/tethys_gizmos/gizmo_options/button.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from .base import TethysGizmoOptions __all__ = ["ButtonGroup", "Button"] diff --git a/tethys_gizmos/gizmo_options/datatable_view.py b/tethys_gizmos/gizmo_options/datatable_view.py index 1fd1a1d3f..0ba09db56 100644 --- a/tethys_gizmos/gizmo_options/datatable_view.py +++ b/tethys_gizmos/gizmo_options/datatable_view.py @@ -6,6 +6,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import re from json import dumps from tethys_portal.dependencies import vendor_static_dependencies diff --git a/tethys_gizmos/gizmo_options/date_picker.py b/tethys_gizmos/gizmo_options/date_picker.py index 1c2ee5d1e..5a8bdf49c 100644 --- a/tethys_gizmos/gizmo_options/date_picker.py +++ b/tethys_gizmos/gizmo_options/date_picker.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from .base import TethysGizmoOptions from tethys_portal.dependencies import vendor_static_dependencies diff --git a/tethys_gizmos/gizmo_options/map_view.py b/tethys_gizmos/gizmo_options/map_view.py index 57d5d1f70..d6306415e 100644 --- a/tethys_gizmos/gizmo_options/map_view.py +++ b/tethys_gizmos/gizmo_options/map_view.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import logging from tethys_portal.dependencies import vendor_static_dependencies from .base import TethysGizmoOptions, SecondaryGizmoOptions diff --git a/tethys_gizmos/gizmo_options/message_box.py b/tethys_gizmos/gizmo_options/message_box.py index a8b9fa7b0..47191e240 100644 --- a/tethys_gizmos/gizmo_options/message_box.py +++ b/tethys_gizmos/gizmo_options/message_box.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from .base import TethysGizmoOptions __all__ = ["MessageBox"] diff --git a/tethys_gizmos/gizmo_options/range_slider.py b/tethys_gizmos/gizmo_options/range_slider.py index 197da8b23..291031421 100644 --- a/tethys_gizmos/gizmo_options/range_slider.py +++ b/tethys_gizmos/gizmo_options/range_slider.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from .base import TethysGizmoOptions __all__ = ["RangeSlider"] diff --git a/tethys_gizmos/gizmo_options/select_input.py b/tethys_gizmos/gizmo_options/select_input.py index f5260cfa4..2d50127a5 100644 --- a/tethys_gizmos/gizmo_options/select_input.py +++ b/tethys_gizmos/gizmo_options/select_input.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import json from tethys_portal.dependencies import vendor_static_dependencies from .base import TethysGizmoOptions diff --git a/tethys_gizmos/gizmo_options/table_view.py b/tethys_gizmos/gizmo_options/table_view.py index d98202e97..245a26b69 100644 --- a/tethys_gizmos/gizmo_options/table_view.py +++ b/tethys_gizmos/gizmo_options/table_view.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from .base import TethysGizmoOptions __all__ = ["TableView"] diff --git a/tethys_gizmos/gizmo_options/text_input.py b/tethys_gizmos/gizmo_options/text_input.py index a4d74ef89..2c43c3634 100644 --- a/tethys_gizmos/gizmo_options/text_input.py +++ b/tethys_gizmos/gizmo_options/text_input.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from .base import TethysGizmoOptions __all__ = ["TextInput"] diff --git a/tethys_gizmos/gizmo_options/toggle_switch.py b/tethys_gizmos/gizmo_options/toggle_switch.py index ebd978dd8..a449f2b0a 100644 --- a/tethys_gizmos/gizmo_options/toggle_switch.py +++ b/tethys_gizmos/gizmo_options/toggle_switch.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from tethys_portal.dependencies import vendor_static_dependencies from .base import TethysGizmoOptions diff --git a/tethys_gizmos/templatetags/tethys_gizmos.py b/tethys_gizmos/templatetags/tethys_gizmos.py index 06eebd732..9032b40e6 100644 --- a/tethys_gizmos/templatetags/tethys_gizmos.py +++ b/tethys_gizmos/templatetags/tethys_gizmos.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import os import json import time diff --git a/tethys_gizmos/urls.py b/tethys_gizmos/urls.py index 78dc432dd..dc2c97dca 100644 --- a/tethys_gizmos/urls.py +++ b/tethys_gizmos/urls.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.urls import re_path, include from tethys_gizmos.views.gizmos import jobs_table as jobs_table_views diff --git a/tethys_layouts/mixins/map_layout.py b/tethys_layouts/mixins/map_layout.py index 4100c855c..22d20bc26 100644 --- a/tethys_layouts/mixins/map_layout.py +++ b/tethys_layouts/mixins/map_layout.py @@ -998,14 +998,14 @@ def generate_custom_color_ramp_divisions( divisions[f"{prefix}{i}"] = f"{(m * i + b):.{value_precision}f}" if color_ramp in cls.COLOR_RAMPS.keys(): - divisions[ - f"{color_prefix}{i}" - ] = f"{cls.COLOR_RAMPS[color_ramp][(i - first_division) % len(cls.COLOR_RAMPS[color_ramp])]}" + divisions[f"{color_prefix}{i}"] = ( + f"{cls.COLOR_RAMPS[color_ramp][(i - first_division) % len(cls.COLOR_RAMPS[color_ramp])]}" + ) else: # use default color ramp - divisions[ - f"{color_prefix}{i}" - ] = f"{cls.COLOR_RAMPS['Default'][(i - first_division) % len(cls.COLOR_RAMPS['Default'])]}" + divisions[f"{color_prefix}{i}"] = ( + f"{cls.COLOR_RAMPS['Default'][(i - first_division) % len(cls.COLOR_RAMPS['Default'])]}" + ) if no_data_value is not None: divisions["val_no_data"] = no_data_value return divisions diff --git a/tethys_layouts/views/map_layout.py b/tethys_layouts/views/map_layout.py index a9b18dfe4..ba0a89113 100644 --- a/tethys_layouts/views/map_layout.py +++ b/tethys_layouts/views/map_layout.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2021 ******************************************************************************** """ + from tethys_portal.optional_dependencies import optional_import from abc import ABCMeta import collections diff --git a/tethys_layouts/views/tethys_layout.py b/tethys_layouts/views/tethys_layout.py index a72213a16..b890ca93b 100644 --- a/tethys_layouts/views/tethys_layout.py +++ b/tethys_layouts/views/tethys_layout.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2021 ******************************************************************************** """ + import logging from django.http import HttpResponseNotFound, HttpResponse diff --git a/tethys_portal/__init__.py b/tethys_portal/__init__.py index 4eec5d35a..b7ef34eb3 100644 --- a/tethys_portal/__init__.py +++ b/tethys_portal/__init__.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + try: from ._version import version as __version__ from ._version import version_tuple # noqa: F401 diff --git a/tethys_portal/asgi.py b/tethys_portal/asgi.py index 153c0938c..334a2cb8e 100644 --- a/tethys_portal/asgi.py +++ b/tethys_portal/asgi.py @@ -2,6 +2,7 @@ ASGI entrypoint. Configures Django and then runs the application defined in the ASGI_APPLICATION setting. """ + import os from channels.auth import AuthMiddlewareStack from channels.routing import ProtocolTypeRouter, URLRouter diff --git a/tethys_portal/forms.py b/tethys_portal/forms.py index 25a0e7538..cd250bd6d 100644 --- a/tethys_portal/forms.py +++ b/tethys_portal/forms.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django import forms from django.contrib.auth.models import User from django.contrib.auth.password_validation import validate_password diff --git a/tethys_portal/middleware.py b/tethys_portal/middleware.py index 7c0bf5177..52fce23d8 100644 --- a/tethys_portal/middleware.py +++ b/tethys_portal/middleware.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.conf import settings from django.contrib import messages from django.core.exceptions import PermissionDenied diff --git a/tethys_portal/urls.py b/tethys_portal/urls.py index 4909bd3df..83953b9ce 100644 --- a/tethys_portal/urls.py +++ b/tethys_portal/urls.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import logging from importlib import import_module @@ -22,7 +23,7 @@ PasswordResetCompleteView, ) -from tethys_apps.urls import extension_urls, urlpatterns as tethys_app_urlpatterns +from tethys_apps.urls import extension_urls from tethys_portal.views import ( accounts as tethys_portal_accounts, @@ -183,44 +184,50 @@ if settings.STANDALONE_APP: standalone_app_hyphen = settings.STANDALONE_APP.replace("_", "-") urlpatterns = [ - re_path(r"^$", RedirectView.as_view(url=f"/{standalone_app_hyphen}/"), name="home"), - re_path(r"^", include("tethys_apps.urls")) + re_path( + r"^$", RedirectView.as_view(url=f"/{standalone_app_hyphen}/"), name="home" + ), + re_path(r"^", include("tethys_apps.urls")), ] else: urlpatterns = [ re_path(r"^$", tethys_portal_home.home, name="home"), - re_path(r"^apps/", include("tethys_apps.urls")) + re_path(r"^apps/", include("tethys_apps.urls")), ] -urlpatterns.extend([ - re_path(r"^admin/", admin_urls), - re_path(r"^accounts/", include((account_urls, "accounts"), namespace="accounts")), - re_path(r"^user/", include((user_urls, "user"), namespace="user")), - re_path(r"^extensions/", include(extension_urls)), - re_path(r"^developer/", include(developer_urls)), - re_path( - r"^handoff/(?P[\w-]+)/$", - tethys_apps_views.handoff_capabilities, - name="handoff_capabilities", - ), - re_path( - r"^handoff/(?P[\w-]+)/(?P[\w-]+)/$", - tethys_apps_views.handoff, - name="handoff", - ), - re_path( - r"^update-job-status/(?P[\w-]+)/$", - tethys_apps_views.update_job_status, - name="update_job_status", - ), - re_path( - r"^update-dask-job-status/(?P[\w-]+)/$", - tethys_apps_views.update_dask_job_status, - name="update_dask_job_status", - ), - re_path(r"^api/", include((api_urls, "api"), namespace="api")), -]) +urlpatterns.extend( + [ + re_path(r"^admin/", admin_urls), + re_path( + r"^accounts/", include((account_urls, "accounts"), namespace="accounts") + ), + re_path(r"^user/", include((user_urls, "user"), namespace="user")), + re_path(r"^extensions/", include(extension_urls)), + re_path(r"^developer/", include(developer_urls)), + re_path( + r"^handoff/(?P[\w-]+)/$", + tethys_apps_views.handoff_capabilities, + name="handoff_capabilities", + ), + re_path( + r"^handoff/(?P[\w-]+)/(?P[\w-]+)/$", + tethys_apps_views.handoff, + name="handoff", + ), + re_path( + r"^update-job-status/(?P[\w-]+)/$", + tethys_apps_views.update_job_status, + name="update_job_status", + ), + re_path( + r"^update-dask-job-status/(?P[\w-]+)/$", + tethys_apps_views.update_dask_job_status, + name="update_dask_job_status", + ), + re_path(r"^api/", include((api_urls, "api"), namespace="api")), + ] +) if has_module(psa_views): oauth2_urls = [ diff --git a/tethys_portal/utilities.py b/tethys_portal/utilities.py index 16dee3e33..f6ec49d19 100644 --- a/tethys_portal/utilities.py +++ b/tethys_portal/utilities.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import datetime from uuid import UUID from django.contrib.auth import login diff --git a/tethys_portal/views/accounts.py b/tethys_portal/views/accounts.py index 752d35006..620135853 100644 --- a/tethys_portal/views/accounts.py +++ b/tethys_portal/views/accounts.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.conf import settings from django.shortcuts import render, redirect from django.contrib.auth import authenticate, login, logout diff --git a/tethys_portal/views/api.py b/tethys_portal/views/api.py index 9ab155315..27fd12d2d 100644 --- a/tethys_portal/views/api.py +++ b/tethys_portal/views/api.py @@ -57,7 +57,7 @@ def get_app(request, app): "icon": static(app.icon), "exitUrl": reverse("app_library"), "rootUrl": reverse(app.index_url), - "settingsUrl": f'{reverse("admin:index")}tethys_apps/tethysapp/{ app.id }/change/', + "settingsUrl": f'{reverse("admin:index")}tethys_apps/tethysapp/{app.id}/change/', } if request.user.is_authenticated: @@ -73,9 +73,11 @@ def get_app(request, app): pass metadata["customSettings"][s.name] = { - "type": s.type - if s.type_custom_setting == "SIMPLE" - else s.type_custom_setting, + "type": ( + s.type + if s.type_custom_setting == "SIMPLE" + else s.type_custom_setting + ), "value": v, } diff --git a/tethys_portal/views/error.py b/tethys_portal/views/error.py index 6f1a254e5..3346894ca 100644 --- a/tethys_portal/views/error.py +++ b/tethys_portal/views/error.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.shortcuts import render diff --git a/tethys_portal/views/home.py b/tethys_portal/views/home.py index 9cf8ffc9c..e794581b3 100644 --- a/tethys_portal/views/home.py +++ b/tethys_portal/views/home.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.shortcuts import render, redirect from django.conf import settings from tethys_config.models import get_custom_template diff --git a/tethys_portal/views/user.py b/tethys_portal/views/user.py index 9a2a3b01c..977bf223c 100644 --- a/tethys_portal/views/user.py +++ b/tethys_portal/views/user.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.conf import settings as django_settings from django.shortcuts import render, redirect from django.contrib.auth import logout diff --git a/tethys_quotas/__init__.py b/tethys_quotas/__init__.py index 5ec3de4b8..8e4d35f1c 100644 --- a/tethys_quotas/__init__.py +++ b/tethys_quotas/__init__.py @@ -6,4 +6,5 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + default_app_config = "tethys_quotas.apps.TethysQuotasConfig" diff --git a/tethys_quotas/admin.py b/tethys_quotas/admin.py index 221ede63a..334feb15f 100644 --- a/tethys_quotas/admin.py +++ b/tethys_quotas/admin.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + from django.urls import reverse from django.contrib.contenttypes.models import ContentType from django.utils.html import format_html diff --git a/tethys_quotas/apps.py b/tethys_quotas/apps.py index b8b78aaea..374f78cf7 100644 --- a/tethys_quotas/apps.py +++ b/tethys_quotas/apps.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + import logging from django.apps import AppConfig from django.db.utils import ProgrammingError, OperationalError diff --git a/tethys_quotas/decorators.py b/tethys_quotas/decorators.py index 56051fdca..844705216 100644 --- a/tethys_quotas/decorators.py +++ b/tethys_quotas/decorators.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + import logging from django.utils.functional import wraps from django.http import HttpRequest diff --git a/tethys_quotas/handlers/base.py b/tethys_quotas/handlers/base.py index 2a2ba97a0..1f2bcf888 100644 --- a/tethys_quotas/handlers/base.py +++ b/tethys_quotas/handlers/base.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + from abc import abstractmethod from tethys_quotas.utilities import get_resource_available diff --git a/tethys_quotas/handlers/workspace.py b/tethys_quotas/handlers/workspace.py index 9a07b29da..fe137c339 100644 --- a/tethys_quotas/handlers/workspace.py +++ b/tethys_quotas/handlers/workspace.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + from django.contrib.auth.models import User from tethys_apps.models import TethysApp from tethys_apps.base.workspace import _get_user_workspace, _get_app_workspace diff --git a/tethys_quotas/models/__init__.py b/tethys_quotas/models/__init__.py index 800718d98..343d9999a 100644 --- a/tethys_quotas/models/__init__.py +++ b/tethys_quotas/models/__init__.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from tethys_quotas.models.resource_quota import ResourceQuota # noqa: F401 from tethys_quotas.models.entity_quota import EntityQuota # noqa: F401 from tethys_quotas.models.user_quota import UserQuota # noqa: F401 diff --git a/tethys_quotas/models/entity_quota.py b/tethys_quotas/models/entity_quota.py index 7bc053f2b..84d85a331 100644 --- a/tethys_quotas/models/entity_quota.py +++ b/tethys_quotas/models/entity_quota.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + import logging from django.db import models diff --git a/tethys_quotas/models/resource_quota.py b/tethys_quotas/models/resource_quota.py index 76037614c..2bb9ddf78 100644 --- a/tethys_quotas/models/resource_quota.py +++ b/tethys_quotas/models/resource_quota.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + import logging import inspect from django.contrib.auth.models import User diff --git a/tethys_quotas/models/tethys_app_quota.py b/tethys_quotas/models/tethys_app_quota.py index 7ed15e6b4..c19ae8624 100644 --- a/tethys_quotas/models/tethys_app_quota.py +++ b/tethys_quotas/models/tethys_app_quota.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + import logging from django.db import models diff --git a/tethys_quotas/models/user_quota.py b/tethys_quotas/models/user_quota.py index 753292027..37ccbaab7 100644 --- a/tethys_quotas/models/user_quota.py +++ b/tethys_quotas/models/user_quota.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + import logging from django.db import models diff --git a/tethys_quotas/utilities.py b/tethys_quotas/utilities.py index 0cb419505..07ec08187 100644 --- a/tethys_quotas/utilities.py +++ b/tethys_quotas/utilities.py @@ -6,6 +6,7 @@ * Copyright: (c) Aquaveo 2018 ******************************************************************************** """ + import logging from django.conf import settings from django.core.exceptions import PermissionDenied diff --git a/tethys_sdk/__init__.py b/tethys_sdk/__init__.py index 569467060..eaa3077bc 100644 --- a/tethys_sdk/__init__.py +++ b/tethys_sdk/__init__.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + # flake8: noqa # This module provides a centralized location for SDK imports. from tethys_portal import __version__ diff --git a/tethys_sdk/app_settings.py b/tethys_sdk/app_settings.py index cb8583539..8f3139121 100644 --- a/tethys_sdk/app_settings.py +++ b/tethys_sdk/app_settings.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + # flake8: noqa # DO NOT ERASE from tethys_apps.models import ( diff --git a/tethys_sdk/compute.py b/tethys_sdk/compute.py index 327a0bf3a..f3e5ddfef 100644 --- a/tethys_sdk/compute.py +++ b/tethys_sdk/compute.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + # flake8: noqa # DO NOT ERASE from tethys_compute.scheduler_manager import ( diff --git a/tethys_sdk/gizmos.py b/tethys_sdk/gizmos.py index 1ce3abd79..582e3154d 100644 --- a/tethys_sdk/gizmos.py +++ b/tethys_sdk/gizmos.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + # flake8: noqa # DO NOT ERASE from tethys_gizmos.gizmo_options import * diff --git a/tethys_sdk/handoff.py b/tethys_sdk/handoff.py index dd4b0f39d..5cf6d0331 100644 --- a/tethys_sdk/handoff.py +++ b/tethys_sdk/handoff.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + # flake8: noqa # DO NOT ERASE from tethys_apps.base.handoff import HandoffHandler diff --git a/tethys_sdk/jobs.py b/tethys_sdk/jobs.py index 42dd8c594..65c6c9a13 100644 --- a/tethys_sdk/jobs.py +++ b/tethys_sdk/jobs.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + # flake8: noqa # DO NOT ERASE from tethys_compute.models import ( diff --git a/tethys_sdk/layouts.py b/tethys_sdk/layouts.py index 609e7abbc..7512c9173 100644 --- a/tethys_sdk/layouts.py +++ b/tethys_sdk/layouts.py @@ -6,6 +6,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + # flake8: noqa # DO NOT ERASE from tethys_layouts.views.map_layout import MapLayout diff --git a/tethys_sdk/permissions.py b/tethys_sdk/permissions.py index 1db34e771..68552b59c 100644 --- a/tethys_sdk/permissions.py +++ b/tethys_sdk/permissions.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + # flake8: noqa # DO NOT ERASE from tethys_apps.base import Permission, PermissionGroup, has_permission diff --git a/tethys_sdk/services.py b/tethys_sdk/services.py index f8dc80bba..77e0303f7 100644 --- a/tethys_sdk/services.py +++ b/tethys_sdk/services.py @@ -1 +1,21 @@ -""" ******************************************************************************** * Name: services.py * Author: Nathan Swain * Created On: 7 August 2015 * Copyright: (c) Brigham Young University 2015 * License: BSD 2-Clause ******************************************************************************** """ # flake8: noqa # DO NOT ERASE from tethys_services.utilities import ( list_dataset_engines, get_dataset_engine, list_spatial_dataset_engines, get_spatial_dataset_engine, list_wps_service_engines, get_wps_service_engine, ensure_oauth2, ) \ No newline at end of file +""" +******************************************************************************** +* Name: services.py +* Author: Nathan Swain +* Created On: 7 August 2015 +* Copyright: (c) Brigham Young University 2015 +* License: BSD 2-Clause +******************************************************************************** +""" + +# flake8: noqa +# DO NOT ERASE +from tethys_services.utilities import ( + list_dataset_engines, + get_dataset_engine, + list_spatial_dataset_engines, + get_spatial_dataset_engine, + list_wps_service_engines, + get_wps_service_engine, + ensure_oauth2, +) diff --git a/tethys_sdk/testing.py b/tethys_sdk/testing.py index 50769cc67..035fd0f5b 100644 --- a/tethys_sdk/testing.py +++ b/tethys_sdk/testing.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + # flake8: noqa # DO NOT ERASE from tethys_apps.base.testing.testing import TethysTestCase diff --git a/tethys_sdk/workspaces.py b/tethys_sdk/workspaces.py index 01afab79e..3bf487de6 100644 --- a/tethys_sdk/workspaces.py +++ b/tethys_sdk/workspaces.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + # flake8: noqa # DO NOT ERASE from tethys_apps.base.workspace import ( diff --git a/tethys_services/__init__.py b/tethys_services/__init__.py index 65d0712c2..727d2dc3b 100644 --- a/tethys_services/__init__.py +++ b/tethys_services/__init__.py @@ -7,5 +7,6 @@ * License: BSD 2-Clause ******************************************************************************** """ + # Load the custom app config default_app_config = "tethys_services.apps.TethysServicesConfig" diff --git a/tethys_services/admin.py b/tethys_services/admin.py index 5dd26a984..b8d88d90a 100644 --- a/tethys_services/admin.py +++ b/tethys_services/admin.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.contrib import admin from django.utils.translation import gettext_lazy as _ from .models import ( diff --git a/tethys_services/apps.py b/tethys_services/apps.py index 9f4d12e79..e6e5dc54c 100644 --- a/tethys_services/apps.py +++ b/tethys_services/apps.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.apps import AppConfig diff --git a/tethys_services/backends/arcgis_portal.py b/tethys_services/backends/arcgis_portal.py index 8e63a0a09..a885d8f68 100644 --- a/tethys_services/backends/arcgis_portal.py +++ b/tethys_services/backends/arcgis_portal.py @@ -6,6 +6,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from social_core.backends.arcgis import ArcGISOAuth2 from django.conf import settings diff --git a/tethys_services/backends/hydroshare.py b/tethys_services/backends/hydroshare.py index 5c09f2cfe..5eb297f24 100644 --- a/tethys_services/backends/hydroshare.py +++ b/tethys_services/backends/hydroshare.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from datetime import datetime import time from social_core.backends.oauth import BaseOAuth2 diff --git a/tethys_services/backends/hydroshare_beta.py b/tethys_services/backends/hydroshare_beta.py index 8e76fbca8..f98c13b02 100644 --- a/tethys_services/backends/hydroshare_beta.py +++ b/tethys_services/backends/hydroshare_beta.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from .hydroshare import HydroShareOAuth2 diff --git a/tethys_services/backends/hydroshare_playground.py b/tethys_services/backends/hydroshare_playground.py index 88d05ae0c..0a85c8241 100644 --- a/tethys_services/backends/hydroshare_playground.py +++ b/tethys_services/backends/hydroshare_playground.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from .hydroshare import HydroShareOAuth2 diff --git a/tethys_services/models.py b/tethys_services/models.py index 47a69863c..d678ddc9c 100644 --- a/tethys_services/models.py +++ b/tethys_services/models.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.db import models from django.core.exceptions import ObjectDoesNotExist, ValidationError from urllib.error import HTTPError, URLError diff --git a/tethys_services/urls.py b/tethys_services/urls.py index 7fd18903a..c13e955ea 100644 --- a/tethys_services/urls.py +++ b/tethys_services/urls.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.urls import re_path, include from tethys_services import views as tethys_services_views diff --git a/tethys_services/utilities.py b/tethys_services/utilities.py index f9a686376..ee4e33627 100644 --- a/tethys_services/utilities.py +++ b/tethys_services/utilities.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + import logging from urllib.error import HTTPError, URLError from functools import wraps diff --git a/tethys_services/views.py b/tethys_services/views.py index 7d572cd69..b96f9647c 100644 --- a/tethys_services/views.py +++ b/tethys_services/views.py @@ -7,6 +7,7 @@ * License: BSD 2-Clause ******************************************************************************** """ + from django.shortcuts import render from tethys_apps.decorators import login_required From ebb47233aa7bff10091d0d67903eb1d0a08eede9 Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Mon, 11 Mar 2024 17:31:42 -0500 Subject: [PATCH 09/23] updated the STANDALONE_APP setting to be a boolean MULTIPLE_APP_MODE instead MULTIPLE_APP_MODE defaults to False so this new standalone app behavior would be the default moved away from updating site settings to use context processor instead --- .../unit_tests/test_tethys_apps/test_urls.py | 4 +- .../test_tethys_apps/test_utilities.py | 12 +- .../test_tethys_cli/test_site_commands.py | 121 ------------------ .../test_context_processors.py | 25 ++++ .../templates/tethys_apps/app_base.html | 6 +- tethys_apps/urls.py | 22 ++-- tethys_apps/utilities.py | 30 +++-- tethys_cli/site_commands.py | 44 ------- tethys_portal/context_processors.py | 12 ++ tethys_portal/settings.py | 4 +- tethys_portal/templates/header.html | 2 +- tethys_portal/urls.py | 14 +- 12 files changed, 86 insertions(+), 210 deletions(-) create mode 100644 tests/unit_tests/test_tethys_portal/test_context_processors.py diff --git a/tests/unit_tests/test_tethys_apps/test_urls.py b/tests/unit_tests/test_tethys_apps/test_urls.py index e7fcd6329..1ea0b770c 100644 --- a/tests/unit_tests/test_tethys_apps/test_urls.py +++ b/tests/unit_tests/test_tethys_apps/test_urls.py @@ -112,7 +112,7 @@ def test_urls(self): ) -@override_settings(STANDALONE_APP="test_app") +@override_settings(MULTIPLE_APP_MODE=False) class TestUrlsWithStandaloneApp(TethysTestCase): import sys from importlib import reload, import_module @@ -134,7 +134,7 @@ def set_up(self): self.reload_urlconf() pass - @override_settings(STANDALONE_APP=None) + @override_settings(MULTIPLE_APP_MODE=True) def tearDown(self): self.reload_urlconf() pass diff --git a/tests/unit_tests/test_tethys_apps/test_utilities.py b/tests/unit_tests/test_tethys_apps/test_utilities.py index 426e621fe..ddbad2e4f 100644 --- a/tests/unit_tests/test_tethys_apps/test_utilities.py +++ b/tests/unit_tests/test_tethys_apps/test_utilities.py @@ -142,19 +142,17 @@ def test_get_active_app_request(self, mock_app): result = utilities.get_active_app(request=mock_request) self.assertEqual(mock_app.objects.get(), result) - @override_settings(STANDALONE_APP="test_app") - @mock.patch("tethys_apps.models.TethysApp") - def test_get_active_app_request_standalone_app(self, mock_app): + @override_settings(MULTIPLE_APP_MODE=False) + @mock.patch("tethys_apps.utilities.get_first_installed_tethys_app") + def test_get_active_app_request_standalone_app(self, mock_first_app): # Mock up for TethysApp, and request - mock_tethysapp = mock.MagicMock() - mock_app.objects.get.return_value = mock_tethysapp + mock_tethysapp = mock.MagicMock(root_url="test-app") + mock_first_app.return_value = mock_tethysapp mock_request = mock.MagicMock() mock_request.path = "/test-app/" - # Result should be mock for mock_app.objects.get.return_value result = utilities.get_active_app(request=mock_request) self.assertEqual(mock_tethysapp, result) - mock_app.objects.get.assert_called_with(root_url="test-app") @mock.patch("tethys_apps.models.TethysApp") def test_get_active_app_url(self, mock_app): diff --git a/tests/unit_tests/test_tethys_cli/test_site_commands.py b/tests/unit_tests/test_tethys_cli/test_site_commands.py index 0efeb105d..384d55954 100644 --- a/tests/unit_tests/test_tethys_cli/test_site_commands.py +++ b/tests/unit_tests/test_tethys_cli/test_site_commands.py @@ -7,7 +7,6 @@ gen_site_content, update_site_settings_content, uncodify, - update_site_settings_if_standalone_mode, ) @@ -156,123 +155,3 @@ def test_update_site_settings_content_invalid_setting(self, mock_filter, mock_wa def test_uncodify(self): result = uncodify("my_css_to_render") self.assertEqual("My CSS to Render", result) - - def test_update_site_settings_if_standalone_mode_no_settings(self): - portal_config_json = { - "version": 2.0, - "name": None, - "apps": None, - "settings": None, - "site_settings": {"GENERAL_SETTINGS": {"BRAND_TEXT": "New Title"}}, - } - - updated_portal_config_json = update_site_settings_if_standalone_mode( - portal_config_json - ) - - expected_portal_config_json = { - "version": 2.0, - "name": None, - "apps": None, - "settings": None, - "site_settings": {"GENERAL_SETTINGS": {"BRAND_TEXT": "New Title"}}, - } - self.assertTrue(updated_portal_config_json == expected_portal_config_json) - - def test_update_site_settings_if_standalone_mode_no_portal_config(self): - portal_config_json = { - "version": 2.0, - "name": None, - "apps": None, - "settings": {"TETHYS_PORTAL_CONFIG": None}, - "site_settings": {"GENERAL_SETTINGS": {"BRAND_TEXT": "New Title"}}, - } - - updated_portal_config_json = update_site_settings_if_standalone_mode( - portal_config_json - ) - - expected_portal_config_json = { - "version": 2.0, - "name": None, - "apps": None, - "settings": {"TETHYS_PORTAL_CONFIG": None}, - "site_settings": {"GENERAL_SETTINGS": {"BRAND_TEXT": "New Title"}}, - } - self.assertTrue(updated_portal_config_json == expected_portal_config_json) - - def test_update_site_settings_if_standalone_mode_no_standalone(self): - portal_config_json = { - "version": 2.0, - "name": None, - "apps": None, - "settings": {"TETHYS_PORTAL_CONFIG": {"STANDALONE_APP": None}}, - "site_settings": {"GENERAL_SETTINGS": {"BRAND_TEXT": "New Title"}}, - } - - updated_portal_config_json = update_site_settings_if_standalone_mode( - portal_config_json - ) - - expected_portal_config_json = { - "version": 2.0, - "name": None, - "apps": None, - "settings": {"TETHYS_PORTAL_CONFIG": {"STANDALONE_APP": None}}, - "site_settings": {"GENERAL_SETTINGS": {"BRAND_TEXT": "New Title"}}, - } - self.assertTrue(updated_portal_config_json == expected_portal_config_json) - - @mock.patch("tethys_apps.models.TethysApp") - def test_update_site_settings_if_standalone_mode_standalone(self, mock_tethysapp): - portal_config_json = { - "version": 2.0, - "name": None, - "apps": None, - "settings": { - "TETHYS_PORTAL_CONFIG": {"STANDALONE_APP": "standalone_app_test"} - }, - "site_settings": None, - } - mock_app = mock.MagicMock() - mock_app.name = "Standalone App Test" - mock_tethysapp.objects.get.return_value = mock_app - updated_portal_config_json = update_site_settings_if_standalone_mode( - portal_config_json - ) - - expected_portal_config_json = { - "version": 2.0, - "name": None, - "apps": None, - "settings": { - "TETHYS_PORTAL_CONFIG": {"STANDALONE_APP": "standalone_app_test"} - }, - "site_settings": { - "GENERAL_SETTINGS": { - "STANDALONE_APP_MODE": "true", - "APPS_LIBRARY_TITLE": "Standalone App Test", - } - }, - } - self.assertTrue(updated_portal_config_json == expected_portal_config_json) - - @mock.patch("tethys_apps.models.TethysApp") - def test_update_site_settings_if_standalone_mode_app_dne(self, mock_tethysapp): - portal_config_json = { - "version": 2.0, - "name": None, - "apps": None, - "settings": { - "TETHYS_PORTAL_CONFIG": {"STANDALONE_APP": "standalone_app_test"} - }, - "site_settings": None, - } - mock_tethysapp.objects.get.side_effect = [ObjectDoesNotExist] - with self.assertRaises(Exception) as context: - update_site_settings_if_standalone_mode(portal_config_json) - - self.assertTrue( - 'Could not locate app with package "standalone_app_test".' - in context.exception.args - ) diff --git a/tests/unit_tests/test_tethys_portal/test_context_processors.py b/tests/unit_tests/test_tethys_portal/test_context_processors.py new file mode 100644 index 000000000..cbea05af2 --- /dev/null +++ b/tests/unit_tests/test_tethys_portal/test_context_processors.py @@ -0,0 +1,25 @@ +import unittest +from unittest import mock +from django.test import override_settings +from tethys_portal import context_processors + + +class TestStaticDependency(unittest.TestCase): + def setUp(self): + pass + + def tearDown(self): + pass + + @override_settings(MULTIPLE_APP_MODE=False) + def test_check_single_app_mode_single(self): + single_app_mode, single_app_name = context_processors.check_single_app_mode() + + self.assertTrue(single_app_mode) + self.assertTrue(single_app_name == "Test App") + + def test_check_single_app_mode_multiple(self): + single_app_mode, single_app_name = context_processors.check_single_app_mode() + + self.assertFalse(single_app_mode) + self.assertTrue(single_app_name is None) diff --git a/tethys_apps/templates/tethys_apps/app_base.html b/tethys_apps/templates/tethys_apps/app_base.html index cf59d9fc4..845aa025d 100644 --- a/tethys_apps/templates/tethys_apps/app_base.html +++ b/tethys_apps/templates/tethys_apps/app_base.html @@ -218,14 +218,14 @@ {% endif %} {% endblock %} {% block exit_button_override %} - {% if site_globals.standalone_app_mode == "false" %} + {% if not single_app_mode %}
      {% endif %} {% endblock %} {% block user_menu %} - {% if user.is_authenticated and user.is_active and site_globals.standalone_app_mode == "true" %} + {% if user.is_authenticated and user.is_active and single_app_mode %}
    Log In {% endif %} {% endblock %} diff --git a/tethys_apps/urls.py b/tethys_apps/urls.py index 6574a8ca2..d48bd8ccc 100644 --- a/tethys_apps/urls.py +++ b/tethys_apps/urls.py @@ -14,6 +14,7 @@ from django.views.generic import RedirectView from tethys_apps.harvester import SingletonHarvester from tethys_apps.views import library, send_beta_feedback_email +from tethys_apps.utilities import get_first_installed_tethys_app from django.conf import settings tethys_log = logging.getLogger("tethys." + __name__) @@ -24,19 +25,22 @@ r"^send-beta-feedback/$", send_beta_feedback_email, name="send_beta_feedback" ), ] -if settings.STANDALONE_APP: - standalone_app_hyphen = settings.STANDALONE_APP.replace("_", "-") - urlpatterns.append( +if settings.MULTIPLE_APP_MODE: + urlpatterns.append(re_path(r"^$", library, name="app_library")) + url_namespaces = None +else: + standalone_app = get_first_installed_tethys_app() + urlpatterns.extend([ re_path( r"^apps/", - RedirectView.as_view(url=f"/{standalone_app_hyphen}/"), + RedirectView.as_view(url=f"/{standalone_app.root_url}/"), name="app_library", + ), + re_path( + r"^$", RedirectView.as_view(url=f"/{standalone_app.root_url}/"), name="home" ) - ) - url_namespaces = [settings.STANDALONE_APP] -else: - urlpatterns.append(re_path(r"^$", library, name="app_library")) - url_namespaces = None + ]) + url_namespaces = [standalone_app.url_namespace] # Append the app urls urlpatterns harvester = SingletonHarvester() diff --git a/tethys_apps/utilities.py b/tethys_apps/utilities.py index 28c9c9073..1162ef3b1 100644 --- a/tethys_apps/utilities.py +++ b/tethys_apps/utilities.py @@ -127,10 +127,6 @@ def get_active_app(request=None, url=None, get_class=False): """ from tethys_apps.models import TethysApp - apps_root = "apps" - if settings.STANDALONE_APP: - apps_root = settings.STANDALONE_APP.replace("_", "-") - if request is not None: the_url = request.path elif url is not None: @@ -141,16 +137,19 @@ def get_active_app(request=None, url=None, get_class=False): url_parts = the_url.split("/") app = None + if settings.MULTIPLE_APP_MODE: + apps_root = "apps" + else: + configured_single_app = get_first_installed_tethys_app() + apps_root = configured_single_app.root_url + # Find the app key - if apps_root in url_parts or (the_url == "/" and settings.STANDALONE_APP): - if settings.STANDALONE_APP: - app_root_url = apps_root - else: + if apps_root in url_parts: + if settings.MULTIPLE_APP_MODE: # The app root_url is the path item following (+1) the apps_root item app_root_url_index = url_parts.index(apps_root) + 1 app_root_url = url_parts[app_root_url_index] - - if app_root_url: + try: # Get the app from the database app = TethysApp.objects.get(root_url=app_root_url) @@ -162,6 +161,8 @@ def get_active_app(request=None, url=None, get_class=False): tethys_log.warning( 'Multiple apps found with root url "{0}".'.format(app_root_url) ) + else: + app = configured_single_app if get_class: app = get_app_class(app) @@ -612,6 +613,15 @@ def get_installed_tethys_items(apps=False, extensions=False): return paths +def get_first_installed_tethys_app(): + """ + Returns a list apps installed in the tethysapp directory. + """ + from tethys_apps.models import TethysApp + + return TethysApp.objects.first() + + def get_installed_tethys_apps(): """ Returns a list apps installed in the tethysapp directory. diff --git a/tethys_cli/site_commands.py b/tethys_cli/site_commands.py index 9878c5a33..daf2c7110 100644 --- a/tethys_cli/site_commands.py +++ b/tethys_cli/site_commands.py @@ -29,11 +29,6 @@ def add_site_parser(subparsers): help="Title of the web page that appears in browser tabs and bookmarks of the site. " 'Default is "Tethys Portal".', ) - site_parser.add_argument( - "--standalone-app-mode", - dest="standalone_app_mode", - help="Boolean determining if the portal will act as a standalone app or host for multiple apps", - ) site_parser.add_argument( "--favicon", dest="favicon", @@ -310,9 +305,6 @@ def gen_site_content(args): if portal_yaml.exists(): with portal_yaml.open() as f: portal_config_json = yaml.safe_load(f) - portal_config_json = update_site_settings_if_standalone_mode( - portal_config_json - ) site_settings = portal_config_json.get("site_settings", {}) for category in SITE_SETTING_CATEGORIES: @@ -377,42 +369,6 @@ def update_site_settings_content(settings_dict, warn_if_setting_not_found=False) obj.update(content=content, date_modified=timezone.now()) -def update_site_settings_if_standalone_mode(portal_config_json): - tethys_portal_settings = portal_config_json.get("settings") - if not tethys_portal_settings: - return portal_config_json - - tethys_portal_config_settings = tethys_portal_settings.get("TETHYS_PORTAL_CONFIG") - if not tethys_portal_config_settings: - return portal_config_json - - standalone_app = tethys_portal_config_settings.get("STANDALONE_APP") - if standalone_app: - from tethys_apps.models import TethysApp - - try: - # Get the app from the database - app = TethysApp.objects.get(package=standalone_app) - standalone_app_title = app.name - except ObjectDoesNotExist: - raise Exception(f'Could not locate app with package "{standalone_app}".') - - if not portal_config_json.get("site_settings"): - portal_config_json["site_settings"] = {} - - if not portal_config_json["site_settings"].get("GENERAL_SETTINGS"): - portal_config_json["site_settings"]["GENERAL_SETTINGS"] = {} - - portal_config_json["site_settings"]["GENERAL_SETTINGS"][ - "STANDALONE_APP_MODE" - ] = "true" - portal_config_json["site_settings"]["GENERAL_SETTINGS"][ - "APPS_LIBRARY_TITLE" - ] = standalone_app_title - - return portal_config_json - - def uncodify(code_name): setting_name = code_name.replace("_", " ").title() setting_name = setting_name.replace("Css", "CSS").replace("To ", "to ") diff --git a/tethys_portal/context_processors.py b/tethys_portal/context_processors.py index 531a5ac5c..08fc6c12b 100644 --- a/tethys_portal/context_processors.py +++ b/tethys_portal/context_processors.py @@ -9,9 +9,12 @@ """ from .optional_dependencies import has_module +from django.conf import settings +from tethys_apps.utilities import get_first_installed_tethys_app def tethys_portal_context(request): + single_app_mode, single_app_name = check_single_app_mode() context = { "has_analytical": has_module("analytical"), "has_recaptcha": has_module("snowpenguin.django.recaptcha2"), @@ -20,6 +23,15 @@ def tethys_portal_context(request): "has_gravatar": has_module("django_gravatar"), "has_session_security": has_module("session_security"), "has_oauth2_provider": has_module("oauth2_provider"), + "single_app_mode": single_app_mode, + "single_app_name": single_app_name } return context + + +def check_single_app_mode(): + if settings.MULTIPLE_APP_MODE: + return False, None + else: + return True, get_first_installed_tethys_app().name diff --git a/tethys_portal/settings.py b/tethys_portal/settings.py index 6b22a3276..52055b47a 100644 --- a/tethys_portal/settings.py +++ b/tethys_portal/settings.py @@ -90,8 +90,8 @@ REGISTER_CONTROLLER = TETHYS_PORTAL_CONFIG.pop("REGISTER_CONTROLLER", None) -STANDALONE_APP = TETHYS_PORTAL_CONFIG.pop("STANDALONE_APP", None) -if STANDALONE_APP: +MULTIPLE_APP_MODE = TETHYS_PORTAL_CONFIG.pop("MULTIPLE_APP_MODE", False) +if not MULTIPLE_APP_MODE: BYPASS_TETHYS_HOME_PAGE = True ADDITIONAL_URLPATTERNS = TETHYS_PORTAL_CONFIG.pop("ADDITIONAL_URLPATTERNS", []) diff --git a/tethys_portal/templates/header.html b/tethys_portal/templates/header.html index 449fbb5bf..8a85e83e2 100644 --- a/tethys_portal/templates/header.html +++ b/tethys_portal/templates/header.html @@ -30,7 +30,7 @@ {% url 'app_library' as app_library_url %} {% if ENABLE_OPEN_PORTAL or user.is_authenticated and user.is_active %}
  • - {% if site_globals.apps_library_title %}{{ site_globals.apps_library_title }}{% else %}Apps{% endif %} + {% if single_app_name %}{{ single_app_name }}{% elif site_globals.apps_library_title %}{{ site_globals.apps_library_title }}{% else %}Apps{% endif %}
    • {% endif %} {% endblock %} diff --git a/tethys_portal/urls.py b/tethys_portal/urls.py index 83953b9ce..0b3dc8b62 100644 --- a/tethys_portal/urls.py +++ b/tethys_portal/urls.py @@ -15,7 +15,6 @@ from django.urls import reverse_lazy, include, re_path from django.shortcuts import redirect from django.views.decorators.cache import never_cache -from django.views.generic import RedirectView from django.contrib import admin from django.contrib.auth.views import ( PasswordResetDoneView, @@ -181,21 +180,16 @@ # re_path(r'^500/$', tethys_portal_error.handler_500, name='error_500'), # ] -if settings.STANDALONE_APP: - standalone_app_hyphen = settings.STANDALONE_APP.replace("_", "-") +if settings.MULTIPLE_APP_MODE: urlpatterns = [ - re_path( - r"^$", RedirectView.as_view(url=f"/{standalone_app_hyphen}/"), name="home" - ), - re_path(r"^", include("tethys_apps.urls")), + re_path(r"^$", tethys_portal_home.home, name="home"), + re_path(r"^apps/", include("tethys_apps.urls")), ] else: urlpatterns = [ - re_path(r"^$", tethys_portal_home.home, name="home"), - re_path(r"^apps/", include("tethys_apps.urls")), + re_path(r"^", include("tethys_apps.urls")), ] - urlpatterns.extend( [ re_path(r"^admin/", admin_urls), From 5681a0197af081fd0f2515deabc4ead3f2a0423d Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Tue, 12 Mar 2024 09:28:49 -0500 Subject: [PATCH 10/23] reverted old site_command code black format and lint --- .../test_tethys_cli/test_site_commands.py | 1 - .../test_context_processors.py | 1 - tethys_apps/urls.py | 24 +++++++++++-------- tethys_apps/utilities.py | 2 +- tethys_cli/site_commands.py | 5 +--- tethys_config/init.py | 4 ---- tethys_portal/context_processors.py | 2 +- 7 files changed, 17 insertions(+), 22 deletions(-) diff --git a/tests/unit_tests/test_tethys_cli/test_site_commands.py b/tests/unit_tests/test_tethys_cli/test_site_commands.py index 384d55954..71ba0c541 100644 --- a/tests/unit_tests/test_tethys_cli/test_site_commands.py +++ b/tests/unit_tests/test_tethys_cli/test_site_commands.py @@ -1,7 +1,6 @@ import unittest import os from unittest import mock -from django.core.exceptions import ObjectDoesNotExist from tethys_cli.site_commands import ( gen_site_content, diff --git a/tests/unit_tests/test_tethys_portal/test_context_processors.py b/tests/unit_tests/test_tethys_portal/test_context_processors.py index cbea05af2..568c09bb4 100644 --- a/tests/unit_tests/test_tethys_portal/test_context_processors.py +++ b/tests/unit_tests/test_tethys_portal/test_context_processors.py @@ -1,5 +1,4 @@ import unittest -from unittest import mock from django.test import override_settings from tethys_portal import context_processors diff --git a/tethys_apps/urls.py b/tethys_apps/urls.py index d48bd8ccc..758c1bff2 100644 --- a/tethys_apps/urls.py +++ b/tethys_apps/urls.py @@ -30,16 +30,20 @@ url_namespaces = None else: standalone_app = get_first_installed_tethys_app() - urlpatterns.extend([ - re_path( - r"^apps/", - RedirectView.as_view(url=f"/{standalone_app.root_url}/"), - name="app_library", - ), - re_path( - r"^$", RedirectView.as_view(url=f"/{standalone_app.root_url}/"), name="home" - ) - ]) + urlpatterns.extend( + [ + re_path( + r"^apps/", + RedirectView.as_view(url=f"/{standalone_app.root_url}/"), + name="app_library", + ), + re_path( + r"^$", + RedirectView.as_view(url=f"/{standalone_app.root_url}/"), + name="home", + ), + ] + ) url_namespaces = [standalone_app.url_namespace] # Append the app urls urlpatterns diff --git a/tethys_apps/utilities.py b/tethys_apps/utilities.py index 1162ef3b1..1d5d52928 100644 --- a/tethys_apps/utilities.py +++ b/tethys_apps/utilities.py @@ -149,7 +149,7 @@ def get_active_app(request=None, url=None, get_class=False): # The app root_url is the path item following (+1) the apps_root item app_root_url_index = url_parts.index(apps_root) + 1 app_root_url = url_parts[app_root_url_index] - + try: # Get the app from the database app = TethysApp.objects.get(root_url=app_root_url) diff --git a/tethys_cli/site_commands.py b/tethys_cli/site_commands.py index daf2c7110..794aa665a 100644 --- a/tethys_cli/site_commands.py +++ b/tethys_cli/site_commands.py @@ -3,7 +3,6 @@ from pathlib import Path from django.utils import timezone -from django.core.exceptions import ObjectDoesNotExist from tethys_cli.cli_helpers import setup_django from tethys_cli.cli_colors import write_msg, write_warning @@ -304,9 +303,7 @@ def gen_site_content(args): portal_yaml = Path(get_tethys_home_dir()) / "portal_config.yml" if portal_yaml.exists(): with portal_yaml.open() as f: - portal_config_json = yaml.safe_load(f) - site_settings = portal_config_json.get("site_settings", {}) - + site_settings = yaml.safe_load(f).get("site_settings", {}) for category in SITE_SETTING_CATEGORIES: category_settings = site_settings.pop(category, {}) update_site_settings_content( diff --git a/tethys_config/init.py b/tethys_config/init.py index 9e80843cb..a7f25138f 100644 --- a/tethys_config/init.py +++ b/tethys_config/init.py @@ -104,10 +104,6 @@ def setting_defaults(category): name="Site Title", content="Tethys Portal", date_modified=now ) - category.setting_set.create( - name="Standalone App Mode", content="false", date_modified=now - ) - category.setting_set.create( name="Favicon", content="/tethys_portal/images/default_favicon.png", diff --git a/tethys_portal/context_processors.py b/tethys_portal/context_processors.py index 08fc6c12b..c673621f1 100644 --- a/tethys_portal/context_processors.py +++ b/tethys_portal/context_processors.py @@ -24,7 +24,7 @@ def tethys_portal_context(request): "has_session_security": has_module("session_security"), "has_oauth2_provider": has_module("oauth2_provider"), "single_app_mode": single_app_mode, - "single_app_name": single_app_name + "single_app_name": single_app_name, } return context From ba0392cd5af066aac11445c8d80d38dda44cf515 Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Tue, 12 Mar 2024 10:42:32 -0500 Subject: [PATCH 11/23] added standalone app settings so users can decide which app to set as the standalone if they want --- .../test_tethys_apps/test_utilities.py | 26 ++++++++++++++++++- tethys_apps/urls.py | 4 +-- tethys_apps/utilities.py | 13 +++++++--- tethys_portal/context_processors.py | 4 +-- tethys_portal/settings.py | 1 + 5 files changed, 40 insertions(+), 8 deletions(-) diff --git a/tests/unit_tests/test_tethys_apps/test_utilities.py b/tests/unit_tests/test_tethys_apps/test_utilities.py index ddbad2e4f..7596b7dd5 100644 --- a/tests/unit_tests/test_tethys_apps/test_utilities.py +++ b/tests/unit_tests/test_tethys_apps/test_utilities.py @@ -143,7 +143,7 @@ def test_get_active_app_request(self, mock_app): self.assertEqual(mock_app.objects.get(), result) @override_settings(MULTIPLE_APP_MODE=False) - @mock.patch("tethys_apps.utilities.get_first_installed_tethys_app") + @mock.patch("tethys_apps.utilities.get_configured_standalone_app") def test_get_active_app_request_standalone_app(self, mock_first_app): # Mock up for TethysApp, and request mock_tethysapp = mock.MagicMock(root_url="test-app") @@ -1038,3 +1038,27 @@ def test_secrets_signed_unsigned_value_with_secrets( custom_secret_setting.name(), secret_signed_mock, app_target_name, False ) self.assertEqual(unsigned_secret, mock_val) + + @override_settings(MULTIPLE_APP_MODE=False) + def test_get_configured_standalone_app_no_app_name(self): + from tethys_apps.models import TethysApp + + with mock.patch( + "tethys_apps.models.TethysApp", wraps=TethysApp + ) as mock_tethysapp: + result = utilities.get_configured_standalone_app() + + self.assertEqual(result.package, "test_app") + mock_tethysapp.objects.first.assert_called_once() + + @override_settings(MULTIPLE_APP_MODE=False, STANDALONE_APP="test_app") + def test_get_configured_standalone_app_given_app_name(self): + from tethys_apps.models import TethysApp + + with mock.patch( + "tethys_apps.models.TethysApp", wraps=TethysApp + ) as mock_tethysapp: + result = utilities.get_configured_standalone_app() + + self.assertEqual(result.package, "test_app") + mock_tethysapp.objects.get.assert_called_with(package="test_app") diff --git a/tethys_apps/urls.py b/tethys_apps/urls.py index 758c1bff2..edac0409c 100644 --- a/tethys_apps/urls.py +++ b/tethys_apps/urls.py @@ -14,7 +14,7 @@ from django.views.generic import RedirectView from tethys_apps.harvester import SingletonHarvester from tethys_apps.views import library, send_beta_feedback_email -from tethys_apps.utilities import get_first_installed_tethys_app +from tethys_apps.utilities import get_configured_standalone_app from django.conf import settings tethys_log = logging.getLogger("tethys." + __name__) @@ -29,7 +29,7 @@ urlpatterns.append(re_path(r"^$", library, name="app_library")) url_namespaces = None else: - standalone_app = get_first_installed_tethys_app() + standalone_app = get_configured_standalone_app() urlpatterns.extend( [ re_path( diff --git a/tethys_apps/utilities.py b/tethys_apps/utilities.py index 1d5d52928..f275b1cab 100644 --- a/tethys_apps/utilities.py +++ b/tethys_apps/utilities.py @@ -140,7 +140,7 @@ def get_active_app(request=None, url=None, get_class=False): if settings.MULTIPLE_APP_MODE: apps_root = "apps" else: - configured_single_app = get_first_installed_tethys_app() + configured_single_app = get_configured_standalone_app() apps_root = configured_single_app.root_url # Find the app key @@ -613,13 +613,20 @@ def get_installed_tethys_items(apps=False, extensions=False): return paths -def get_first_installed_tethys_app(): +def get_configured_standalone_app(): """ Returns a list apps installed in the tethysapp directory. """ from tethys_apps.models import TethysApp - return TethysApp.objects.first() + standalone_app = settings.STANDALONE_APP + + if standalone_app: + app = TethysApp.objects.get(package=standalone_app) + else: + app = TethysApp.objects.first() + + return app def get_installed_tethys_apps(): diff --git a/tethys_portal/context_processors.py b/tethys_portal/context_processors.py index c673621f1..58594b547 100644 --- a/tethys_portal/context_processors.py +++ b/tethys_portal/context_processors.py @@ -10,7 +10,7 @@ from .optional_dependencies import has_module from django.conf import settings -from tethys_apps.utilities import get_first_installed_tethys_app +from tethys_apps.utilities import get_configured_standalone_app def tethys_portal_context(request): @@ -34,4 +34,4 @@ def check_single_app_mode(): if settings.MULTIPLE_APP_MODE: return False, None else: - return True, get_first_installed_tethys_app().name + return True, get_configured_standalone_app().name diff --git a/tethys_portal/settings.py b/tethys_portal/settings.py index 52055b47a..62c6d962b 100644 --- a/tethys_portal/settings.py +++ b/tethys_portal/settings.py @@ -91,6 +91,7 @@ REGISTER_CONTROLLER = TETHYS_PORTAL_CONFIG.pop("REGISTER_CONTROLLER", None) MULTIPLE_APP_MODE = TETHYS_PORTAL_CONFIG.pop("MULTIPLE_APP_MODE", False) +STANDALONE_APP = TETHYS_PORTAL_CONFIG.pop("STANDALONE_APP", None) if not MULTIPLE_APP_MODE: BYPASS_TETHYS_HOME_PAGE = True From 6f2cba4690fd6f74340a4587e17eb3a5f0867b9d Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Thu, 14 Mar 2024 15:40:17 -0600 Subject: [PATCH 12/23] MULTIPLE_APP_MODE defaults to True now so no breaking changes happen fixed tests with the new MULTIPLE_APP_MODE default Added an ObjectDoesNotExist exception for when no apps are installed --- .../test_cli/test_install_commands.py | 2 +- .../unit_tests/test_tethys_apps/test_utilities.py | 14 ++++++++++++++ .../unit_tests/test_tethys_portal/test_settings.py | 4 ++-- tethys_apps/utilities.py | 2 ++ tethys_portal/settings.py | 2 +- 5 files changed, 20 insertions(+), 4 deletions(-) diff --git a/tests/unit_tests/test_tethys_apps/test_cli/test_install_commands.py b/tests/unit_tests/test_tethys_apps/test_cli/test_install_commands.py index e10ea24ee..9e70c68d9 100644 --- a/tests/unit_tests/test_tethys_apps/test_cli/test_install_commands.py +++ b/tests/unit_tests/test_tethys_apps/test_cli/test_install_commands.py @@ -3,7 +3,7 @@ from django.core.exceptions import ValidationError from unittest import mock from conda.cli.python_api import Commands -from tethys_apps.cli import install_commands +from tethys_cli import install_commands FNULL = open(os.devnull, "w") diff --git a/tests/unit_tests/test_tethys_apps/test_utilities.py b/tests/unit_tests/test_tethys_apps/test_utilities.py index 898ff8209..3708bd530 100644 --- a/tests/unit_tests/test_tethys_apps/test_utilities.py +++ b/tests/unit_tests/test_tethys_apps/test_utilities.py @@ -1064,6 +1064,20 @@ def test_get_configured_standalone_app_given_app_name(self): self.assertEqual(result.package, "test_app") mock_tethysapp.objects.get.assert_called_with(package="test_app") + @override_settings(MULTIPLE_APP_MODE=False) + def test_get_configured_standalone_app_no_app_name_no_installed(self): + from tethys_apps.models import TethysApp + from django.core.exceptions import ObjectDoesNotExist + + with mock.patch( + "tethys_apps.models.TethysApp", wraps=TethysApp + ) as mock_tethysapp: + mock_tethysapp.objects.first.return_value = [] + with self.assertRaises(ObjectDoesNotExist): + utilities.get_configured_standalone_app() + + mock_tethysapp.objects.first.assert_called_once() + def test_update_decorated_websocket_consumer_class(self): class TestConsumer(WebsocketConsumer): def authorized_connect(self): diff --git a/tests/unit_tests/test_tethys_portal/test_settings.py b/tests/unit_tests/test_tethys_portal/test_settings.py index b90acf1ec..90bf5e877 100644 --- a/tests/unit_tests/test_tethys_portal/test_settings.py +++ b/tests/unit_tests/test_tethys_portal/test_settings.py @@ -264,11 +264,11 @@ def test_bokeh_django_staticfiles_finder(self, _): @mock.patch( "tethys_portal.settings.yaml.safe_load", return_value={ - "settings": {"TETHYS_PORTAL_CONFIG": {"STANDALONE_APP": "test_app"}} + "settings": {"TETHYS_PORTAL_CONFIG": {"MULTIPLE_APP_MODE": False}} }, ) def test_portal_config_settings_standalone_app(self, _): reload(settings) - self.assertTrue(settings.STANDALONE_APP == "test_app") + self.assertTrue(settings.STANDALONE_APP is None) self.assertTrue(settings.BYPASS_TETHYS_HOME_PAGE) diff --git a/tethys_apps/utilities.py b/tethys_apps/utilities.py index 13eb532a8..03796dad7 100644 --- a/tethys_apps/utilities.py +++ b/tethys_apps/utilities.py @@ -630,6 +630,8 @@ def get_configured_standalone_app(): app = TethysApp.objects.get(package=standalone_app) else: app = TethysApp.objects.first() + if not app: + raise ObjectDoesNotExist("No Tethys Apps have been installed") return app diff --git a/tethys_portal/settings.py b/tethys_portal/settings.py index 62c6d962b..bb53b4421 100644 --- a/tethys_portal/settings.py +++ b/tethys_portal/settings.py @@ -90,7 +90,7 @@ REGISTER_CONTROLLER = TETHYS_PORTAL_CONFIG.pop("REGISTER_CONTROLLER", None) -MULTIPLE_APP_MODE = TETHYS_PORTAL_CONFIG.pop("MULTIPLE_APP_MODE", False) +MULTIPLE_APP_MODE = TETHYS_PORTAL_CONFIG.pop("MULTIPLE_APP_MODE", True) STANDALONE_APP = TETHYS_PORTAL_CONFIG.pop("STANDALONE_APP", None) if not MULTIPLE_APP_MODE: BYPASS_TETHYS_HOME_PAGE = True From ea2c917884689b84545049f6eb0d255d0946181f Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Thu, 14 Mar 2024 15:41:37 -0600 Subject: [PATCH 13/23] linted and black format --- tests/unit_tests/test_tethys_apps/test_utilities.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/unit_tests/test_tethys_apps/test_utilities.py b/tests/unit_tests/test_tethys_apps/test_utilities.py index 3708bd530..d57db2689 100644 --- a/tests/unit_tests/test_tethys_apps/test_utilities.py +++ b/tests/unit_tests/test_tethys_apps/test_utilities.py @@ -1074,7 +1074,7 @@ def test_get_configured_standalone_app_no_app_name_no_installed(self): ) as mock_tethysapp: mock_tethysapp.objects.first.return_value = [] with self.assertRaises(ObjectDoesNotExist): - utilities.get_configured_standalone_app() + utilities.get_configured_standalone_app() mock_tethysapp.objects.first.assert_called_once() From 19feefaae562af4ef700735357a5119bce15b343 Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Thu, 14 Mar 2024 16:30:17 -0600 Subject: [PATCH 14/23] removed namespace for standalone apps updated get_active_app to just grab the standalone app if MULTIPLE_APP_MODE is turned off --- .../unit_tests/test_tethys_apps/test_urls.py | 8 ++--- tethys_apps/urls.py | 25 ++++++++++----- tethys_apps/utilities.py | 32 ++++++++----------- 3 files changed, 34 insertions(+), 31 deletions(-) diff --git a/tests/unit_tests/test_tethys_apps/test_urls.py b/tests/unit_tests/test_tethys_apps/test_urls.py index 1ea0b770c..cbf3ffcb3 100644 --- a/tests/unit_tests/test_tethys_apps/test_urls.py +++ b/tests/unit_tests/test_tethys_apps/test_urls.py @@ -144,14 +144,14 @@ def test_urls(self): url = reverse("home") resolver = resolve(url) self.assertEqual("/", url) - self.assertEqual("RedirectView", resolver.func.__name__) - self.assertEqual("/test-app/", resolver.func.view_initkwargs["url"]) + self.assertEqual("home", resolver.func.__name__) + self.assertEqual("tethysapp.test_app.controllers", resolver.func.__module__) url = reverse("app_library") resolver = resolve(url) self.assertEqual("/apps/", url) self.assertEqual("RedirectView", resolver.func.__name__) - self.assertEqual("/test-app/", resolver.func.view_initkwargs["url"]) + self.assertEqual("", resolver.func.view_initkwargs["url"]) url = reverse("send_beta_feedback") resolver = resolve(url) @@ -161,7 +161,7 @@ def test_urls(self): url = reverse("test_app:home") resolver = resolve(url) - self.assertEqual("/test-app/", url) + self.assertEqual("/", url) self.assertEqual("home", resolver.func.__name__) self.assertEqual("tethysapp.test_app.controllers", resolver.func.__module__) diff --git a/tethys_apps/urls.py b/tethys_apps/urls.py index edac0409c..91b12ff98 100644 --- a/tethys_apps/urls.py +++ b/tethys_apps/urls.py @@ -34,14 +34,9 @@ [ re_path( r"^apps/", - RedirectView.as_view(url=f"/{standalone_app.root_url}/"), + RedirectView.as_view(url=f""), name="app_library", - ), - re_path( - r"^$", - RedirectView.as_view(url=f"/{standalone_app.root_url}/"), - name="home", - ), + ) ] ) url_namespaces = [standalone_app.url_namespace] @@ -52,6 +47,7 @@ handler_url_patterns = harvester.get_handler_patterns(url_namespaces=url_namespaces) # configure handler HTTP routes +## Nathan, what would be an example of these? http_handler_patterns = [] for namespace, urls in handler_url_patterns["http_handler_patterns"].items(): root_pattern = r"^apps/{0}/".format(namespace.replace("_", "-")) @@ -61,7 +57,20 @@ # Add app url patterns to urlpatterns, namespaced per app appropriately for namespace, urls in normal_url_patterns["app_url_patterns"].items(): - root_pattern = r"^{0}/".format(namespace.replace("_", "-")) + if settings.MULTIPLE_APP_MODE: + root_pattern = r"^{0}/".format(namespace.replace("_", "-")) + else: + root_pattern = "" + home_urls = [url for url in urls if url.name == "home"] + urlpatterns.append( + re_path( + r"", + include(home_urls[:1]), + name="home", + ), + ) + + urlpatterns.append( re_path(root_pattern, include((urls, namespace), namespace=namespace)) ) diff --git a/tethys_apps/utilities.py b/tethys_apps/utilities.py index 03796dad7..bc7d796eb 100644 --- a/tethys_apps/utilities.py +++ b/tethys_apps/utilities.py @@ -132,25 +132,19 @@ def get_active_app(request=None, url=None, get_class=False): """ from tethys_apps.models import TethysApp - if request is not None: - the_url = request.path - elif url is not None: - the_url = url - else: - return None - - url_parts = the_url.split("/") - app = None - + # Find the app key if settings.MULTIPLE_APP_MODE: - apps_root = "apps" - else: - configured_single_app = get_configured_standalone_app() - apps_root = configured_single_app.root_url + if request is not None: + the_url = request.path + elif url is not None: + the_url = url + else: + return None - # Find the app key - if apps_root in url_parts: - if settings.MULTIPLE_APP_MODE: + url_parts = the_url.split("/") + app = None + apps_root = "apps" + if apps_root in url_parts: # The app root_url is the path item following (+1) the apps_root item app_root_url_index = url_parts.index(apps_root) + 1 app_root_url = url_parts[app_root_url_index] @@ -166,8 +160,8 @@ def get_active_app(request=None, url=None, get_class=False): tethys_log.warning( 'Multiple apps found with root url "{0}".'.format(app_root_url) ) - else: - app = configured_single_app + else: + app = get_configured_standalone_app() if get_class: app = get_app_class(app) From cc66aab217e954d82971e7293fff5520cd64573f Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Thu, 14 Mar 2024 16:30:54 -0600 Subject: [PATCH 15/23] lint and black format --- tethys_apps/urls.py | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/tethys_apps/urls.py b/tethys_apps/urls.py index 91b12ff98..0c753ed76 100644 --- a/tethys_apps/urls.py +++ b/tethys_apps/urls.py @@ -34,7 +34,7 @@ [ re_path( r"^apps/", - RedirectView.as_view(url=f""), + RedirectView.as_view(url=""), name="app_library", ) ] @@ -47,7 +47,6 @@ handler_url_patterns = harvester.get_handler_patterns(url_namespaces=url_namespaces) # configure handler HTTP routes -## Nathan, what would be an example of these? http_handler_patterns = [] for namespace, urls in handler_url_patterns["http_handler_patterns"].items(): root_pattern = r"^apps/{0}/".format(namespace.replace("_", "-")) @@ -62,15 +61,14 @@ else: root_pattern = "" home_urls = [url for url in urls if url.name == "home"] - urlpatterns.append( + urlpatterns.append( re_path( r"", include(home_urls[:1]), name="home", ), ) - - + urlpatterns.append( re_path(root_pattern, include((urls, namespace), namespace=namespace)) ) From b1057315edeef5bae673bab3d3afdd2acce832ab Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Thu, 14 Mar 2024 16:50:48 -0600 Subject: [PATCH 16/23] cleaned up redirect functions for apps --- tests/unit_tests/test_tethys_apps/test_urls.py | 2 +- tethys_apps/urls.py | 14 ++++++-------- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/tests/unit_tests/test_tethys_apps/test_urls.py b/tests/unit_tests/test_tethys_apps/test_urls.py index cbf3ffcb3..bd6336c1a 100644 --- a/tests/unit_tests/test_tethys_apps/test_urls.py +++ b/tests/unit_tests/test_tethys_apps/test_urls.py @@ -151,7 +151,7 @@ def test_urls(self): resolver = resolve(url) self.assertEqual("/apps/", url) self.assertEqual("RedirectView", resolver.func.__name__) - self.assertEqual("", resolver.func.view_initkwargs["url"]) + self.assertEqual("home", resolver.func.view_initkwargs["pattern_name"]) url = reverse("send_beta_feedback") resolver = resolve(url) diff --git a/tethys_apps/urls.py b/tethys_apps/urls.py index 0c753ed76..fb30eb51a 100644 --- a/tethys_apps/urls.py +++ b/tethys_apps/urls.py @@ -30,14 +30,12 @@ url_namespaces = None else: standalone_app = get_configured_standalone_app() - urlpatterns.extend( - [ - re_path( - r"^apps/", - RedirectView.as_view(url=""), - name="app_library", - ) - ] + urlpatterns.append( + re_path( + r"^apps/", + RedirectView.as_view(pattern_name="home"), + name="app_library", + ) ) url_namespaces = [standalone_app.url_namespace] From ba4e9f6058cc4d3e052576984cf7647a42304e07 Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Mon, 18 Mar 2024 12:53:25 -0700 Subject: [PATCH 17/23] fixed extension and websocket urls for single app mode --- .../unit_tests/test_tethys_apps/test_urls.py | 10 +------ .../test_tethys_portal/test_asgi.py | 2 +- tethys_apps/urls.py | 27 ++++++++++++++----- 3 files changed, 23 insertions(+), 16 deletions(-) diff --git a/tests/unit_tests/test_tethys_apps/test_urls.py b/tests/unit_tests/test_tethys_apps/test_urls.py index bd6336c1a..c791d0964 100644 --- a/tests/unit_tests/test_tethys_apps/test_urls.py +++ b/tests/unit_tests/test_tethys_apps/test_urls.py @@ -167,15 +167,7 @@ def test_urls(self): url = reverse("test_extension:home", kwargs={"var1": "foo", "var2": "bar"}) resolver = resolve(url) - self.assertEqual("/extensions/test-extension/foo/bar/", url) - self.assertEqual("home", resolver.func.__name__) - self.assertEqual( - "tethysext.test_extension.controllers", resolver.func.__module__ - ) - - url = reverse("test_extension:home", args=["foo", "bar"]) - resolver = resolve(url) - self.assertEqual("/extensions/test-extension/foo/bar/", url) + self.assertEqual("/extensions/foo/bar/", url) self.assertEqual("home", resolver.func.__name__) self.assertEqual( "tethysext.test_extension.controllers", resolver.func.__module__ diff --git a/tests/unit_tests/test_tethys_portal/test_asgi.py b/tests/unit_tests/test_tethys_portal/test_asgi.py index 77dca2dda..64f543166 100644 --- a/tests/unit_tests/test_tethys_portal/test_asgi.py +++ b/tests/unit_tests/test_tethys_portal/test_asgi.py @@ -63,7 +63,7 @@ def test_websocket_path(self): ) def test_handlers_path(self): - expected_path = r"^test/prefix/apps/0/" + expected_path = r"^test/prefix/apps/test-app/" # Get the URLRouter for "http" from the application asgi_app = asgi.application.application_mapping["http"] diff --git a/tethys_apps/urls.py b/tethys_apps/urls.py index fb30eb51a..249e1b9d4 100644 --- a/tethys_apps/urls.py +++ b/tethys_apps/urls.py @@ -47,9 +47,16 @@ # configure handler HTTP routes http_handler_patterns = [] for namespace, urls in handler_url_patterns["http_handler_patterns"].items(): - root_pattern = r"^apps/{0}/".format(namespace.replace("_", "-")) + + if settings.MULTIPLE_APP_MODE: + root_pattern = f'apps/{namespace.replace("_", "-")}/' + else: + root_pattern = "" + if prefix_url is not None and prefix_url != "/": - root_pattern = rf"^{prefix_url}/apps/{0}/".format(namespace.replace("_", "-")) + root_pattern = f"{prefix_url}/{root_pattern}" + root_pattern = rf"^{root_pattern}" + http_handler_patterns.append(re_path(root_pattern, URLRouter(urls))) # Add app url patterns to urlpatterns, namespaced per app appropriately @@ -75,7 +82,11 @@ ext_url_patterns = normal_url_patterns["ext_url_patterns"] extension_urls = [] for namespace, urls in ext_url_patterns.items(): - root_pattern = r"^{0}/".format(namespace.replace("_", "-")) + if settings.MULTIPLE_APP_MODE: + root_pattern = r"^{0}/".format(namespace.replace("_", "-")) + else: + root_pattern = r"^" + extension_urls.append( re_path(root_pattern, include((urls, namespace), namespace=namespace)) ) @@ -88,12 +99,16 @@ def prepare_websocket_urls(app_websocket_url_patterns): prepared_urls = [] for namespace, urls in app_websocket_url_patterns.items(): - root_url = namespace.replace("_", "-") + if settings.MULTIPLE_APP_MODE: + root_url = f'apps/{namespace.replace("_", "-")}/' + else: + root_url = "" + for u in urls: url_str = str(u.pattern).replace("^", "") - namespaced_url_str = f"^apps/{root_url}/{url_str}" + namespaced_url_str = fr"^{root_url}{url_str}" if prefix_url is not None and prefix_url != "/": - namespaced_url_str = f"^{prefix_url}/apps/{root_url}/{url_str}" + namespaced_url_str = fr"^{prefix_url}/{root_url}{url_str}" namespaced_url = re_path(namespaced_url_str, u.callback, name=u.name) prepared_urls.append(namespaced_url) From d328d825acedb8c29322b01b2d47c70e72237896 Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Mon, 18 Mar 2024 13:06:17 -0700 Subject: [PATCH 18/23] reverted some conditional statements for get_active_app --- tethys_apps/urls.py | 8 ++++---- tethys_apps/utilities.py | 23 ++++++++++++----------- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/tethys_apps/urls.py b/tethys_apps/urls.py index 249e1b9d4..b062d7170 100644 --- a/tethys_apps/urls.py +++ b/tethys_apps/urls.py @@ -47,12 +47,12 @@ # configure handler HTTP routes http_handler_patterns = [] for namespace, urls in handler_url_patterns["http_handler_patterns"].items(): - + if settings.MULTIPLE_APP_MODE: root_pattern = f'apps/{namespace.replace("_", "-")}/' else: root_pattern = "" - + if prefix_url is not None and prefix_url != "/": root_pattern = f"{prefix_url}/{root_pattern}" root_pattern = rf"^{root_pattern}" @@ -106,9 +106,9 @@ def prepare_websocket_urls(app_websocket_url_patterns): for u in urls: url_str = str(u.pattern).replace("^", "") - namespaced_url_str = fr"^{root_url}{url_str}" + namespaced_url_str = rf"^{root_url}{url_str}" if prefix_url is not None and prefix_url != "/": - namespaced_url_str = fr"^{prefix_url}/{root_url}{url_str}" + namespaced_url_str = rf"^{prefix_url}/{root_url}{url_str}" namespaced_url = re_path(namespaced_url_str, u.callback, name=u.name) prepared_urls.append(namespaced_url) diff --git a/tethys_apps/utilities.py b/tethys_apps/utilities.py index bc7d796eb..479326cec 100644 --- a/tethys_apps/utilities.py +++ b/tethys_apps/utilities.py @@ -149,17 +149,18 @@ def get_active_app(request=None, url=None, get_class=False): app_root_url_index = url_parts.index(apps_root) + 1 app_root_url = url_parts[app_root_url_index] - try: - # Get the app from the database - app = TethysApp.objects.get(root_url=app_root_url) - except ObjectDoesNotExist: - tethys_log.warning( - 'Could not locate app with root url "{0}".'.format(app_root_url) - ) - except MultipleObjectsReturned: - tethys_log.warning( - 'Multiple apps found with root url "{0}".'.format(app_root_url) - ) + if app_root_url: + try: + # Get the app from the database + app = TethysApp.objects.get(root_url=app_root_url) + except ObjectDoesNotExist: + tethys_log.warning( + 'Could not locate app with root url "{0}".'.format(app_root_url) + ) + except MultipleObjectsReturned: + tethys_log.warning( + 'Multiple apps found with root url "{0}".'.format(app_root_url) + ) else: app = get_configured_standalone_app() From 6bb51bdf6b8e0b280dd25ad49382892a103435d7 Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Fri, 22 Mar 2024 13:10:09 -0700 Subject: [PATCH 19/23] added new portal configurations to the documentation --- docs/tethys_portal/configuration.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/tethys_portal/configuration.rst b/docs/tethys_portal/configuration.rst index db2685521..c0162604b 100644 --- a/docs/tethys_portal/configuration.rst +++ b/docs/tethys_portal/configuration.rst @@ -84,6 +84,8 @@ STATIC_ROOT the Django `STATIC_ROOT Date: Fri, 22 Mar 2024 13:20:43 -0700 Subject: [PATCH 20/23] black formatted --- tests/unit_tests/test_tethys_portal/test_settings.py | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/unit_tests/test_tethys_portal/test_settings.py b/tests/unit_tests/test_tethys_portal/test_settings.py index 16c3d30a9..8f6b97e3a 100644 --- a/tests/unit_tests/test_tethys_portal/test_settings.py +++ b/tests/unit_tests/test_tethys_portal/test_settings.py @@ -272,6 +272,7 @@ def test_portal_config_settings_standalone_app(self, _): self.assertTrue(settings.STANDALONE_APP is None) self.assertTrue(settings.BYPASS_TETHYS_HOME_PAGE) + @mock.patch("tethys_portal.optional_dependencies.optional_import") def test_bokehjsdir_compatibility(self, mock_oi): mock_bokeh_settings = mock.MagicMock() From 1f8a778f74a05a834483b2d9edbda08b62230410 Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Mon, 1 Apr 2024 14:02:50 -0500 Subject: [PATCH 21/23] removed old test file --- .../test_cli/test_install_commands.py | 588 ------------------ 1 file changed, 588 deletions(-) delete mode 100644 tests/unit_tests/test_tethys_apps/test_cli/test_install_commands.py diff --git a/tests/unit_tests/test_tethys_apps/test_cli/test_install_commands.py b/tests/unit_tests/test_tethys_apps/test_cli/test_install_commands.py deleted file mode 100644 index 9e70c68d9..000000000 --- a/tests/unit_tests/test_tethys_apps/test_cli/test_install_commands.py +++ /dev/null @@ -1,588 +0,0 @@ -import os -from django.test import TestCase -from django.core.exceptions import ValidationError -from unittest import mock -from conda.cli.python_api import Commands -from tethys_cli import install_commands - -FNULL = open(os.devnull, "w") - - -class TestServiceInstallHelpers(TestCase): - @mock.patch("builtins.open", side_effect=IOError("test")) - @mock.patch("tethys_apps.cli.install_commands.exit") - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - def test_open_file_error(self, mock_pretty_output, mock_exit, _): - mock_exit.side_effect = SystemExit - - self.assertRaises(SystemExit, install_commands.open_file, "foo") - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertEqual("test", po_call_args[0][0][0]) - self.assertIn( - "An unexpected error occurred reading the file.", po_call_args[1][0][0] - ) - - mock_exit.assert_called_with(1) - - def test_get_service_from_id_fail(self): - self.assertFalse(install_commands.get_service_from_id(9384)) - - def test_get_service_from_name_fail(self): - self.assertFalse(install_commands.get_service_from_name("sdfsdf")) - - @mock.patch( - "tethys_services.models.PersistentStoreService.objects.get", return_value=True - ) - def test_get_service_from_id_persistent(self, mock_get): - self.assertEqual( - install_commands.get_service_from_id(1).get("service_type"), "persistent" - ) - mock_get.assert_called_with(id=1) - - @mock.patch( - "tethys_services.models.SpatialDatasetService.objects.get", return_value=True - ) - def test_get_service_from_id_spatial(self, mock_get): - self.assertEqual( - install_commands.get_service_from_id(1).get("service_type"), "spatial" - ) - mock_get.assert_called_with(id=1) - - @mock.patch("tethys_services.models.DatasetService.objects.get", return_value=True) - def test_get_service_from_id_dataset(self, mock_get): - self.assertEqual( - install_commands.get_service_from_id(1).get("service_type"), "dataset" - ) - mock_get.assert_called_with(id=1) - - @mock.patch( - "tethys_services.models.WebProcessingService.objects.get", return_value=True - ) - def test_get_service_from_id_wps(self, mock_get): - self.assertEqual( - install_commands.get_service_from_id(1).get("service_type"), "wps" - ) - mock_get.assert_called_with(id=1) - - @mock.patch( - "tethys_services.models.PersistentStoreService.objects.get", return_value=True - ) - def test_get_service_from_name_persistent(self, mock_get): - self.assertEqual( - install_commands.get_service_from_name("nonexisting").get("service_type"), - "persistent", - ) - mock_get.assert_called_with(name="nonexisting") - - @mock.patch( - "tethys_services.models.SpatialDatasetService.objects.get", return_value=True - ) - def test_get_service_from_name_spatial(self, mock_get): - self.assertEqual( - install_commands.get_service_from_name("nonexisting").get("service_type"), - "spatial", - ) - mock_get.assert_called_with(name="nonexisting") - - @mock.patch("tethys_services.models.DatasetService.objects.get", return_value=True) - def test_get_service_from_name_dataset(self, mock_get): - self.assertEqual( - install_commands.get_service_from_name("nonexisting").get("service_type"), - "dataset", - ) - mock_get.assert_called_with(name="nonexisting") - - @mock.patch( - "tethys_services.models.WebProcessingService.objects.get", return_value=True - ) - def test_get_service_from_name_wps(self, mock_get): - self.assertEqual( - install_commands.get_service_from_name("nonexisting").get("service_type"), - "wps", - ) - mock_get.assert_called_with(name="nonexisting") - - @mock.patch("tethys_apps.cli.install_commands.input") - def test_get_interactive_input(self, mock_input): - install_commands.get_interactive_input() - mock_input.assert_called_with("") - - @mock.patch("tethys_apps.cli.install_commands.input") - def test_get_service_name_input(self, mock_input): - install_commands.get_service_name_input() - mock_input.assert_called_with("") - - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - def test_print_unconfigured_settings(self, mock_pretty_output): - class MockSetting: - def __init__(self, name, required): - self.name = name - self.required = required - - app_name = "foo" - mock_setting = [MockSetting("test_name", True)] - install_commands.print_unconfigured_settings(app_name, mock_setting) - - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertEqual( - f"\nThe following settings were not configured for app: {app_name}:\n", - po_call_args[0][0][0], - ) - self.assertIn("test_name", po_call_args[2][0][0]) - - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - @mock.patch("tethys_apps.cli.install_commands.call") - def test_run_sync_stores(self, mock_call, mock_pretty_output): - from tethys_apps.models import PersistentStoreConnectionSetting - - app_name = "foo" - - install_commands.run_sync_stores(app_name, [PersistentStoreConnectionSetting()]) - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertEqual( - f"Running syncstores for app {app_name}", po_call_args[0][0][0] - ) - mock_call.assert_called_with( - ["tethys", "syncstores", app_name], - ) - - @mock.patch( - "tethys_apps.cli.install_commands.get_service_from_name", - return_value={"service_type": "service_type", "linkParam": "linkParam"}, - ) - @mock.patch("tethys_apps.cli.install_commands.link_service_to_app_setting") - def test_find_and_link(self, mock_link_service_to_app_setting, _): - service_type = "service_type" - setting_name = "setting_name" - service_name = "service_name" - app_name = "app_name" - - install_commands.find_and_link( - service_type, setting_name, service_name, app_name - ) - - mock_link_service_to_app_setting.assert_called_with( - "service_type", service_name, app_name, "linkParam", setting_name - ) - - @mock.patch( - "tethys_apps.cli.install_commands.get_service_from_name", return_value=False - ) - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - def test_find_and_link_warning(self, mock_pretty_output, _): - service_type = "service_type" - setting_name = "setting_name" - service_name = "service_name" - app_name = "app_name" - - install_commands.find_and_link( - service_type, setting_name, service_name, app_name - ) - - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertEqual( - f"Warning: Could not find service of type: {service_type} with the name/id: {service_name}", - po_call_args[0][0][0], - ) - - -class TestInstallServicesCommands(TestCase): - @mock.patch("tethys_apps.cli.install_commands.find_and_link") - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - @mock.patch("tethys_apps.models.CustomSettingBase") - def test_configure_services( - self, mock_customsettings, mock_pretty_output, mock_find_and_link - ): - app_name = "foo" - custom_service_name = "custom_service_name" - custom_setting_name = "custom_setting_name" - persistent_service_name = "persistent_service_name" - persistent_setting_name = "persistent_setting_name" - services = { - "version": 1, - "custom_setting": {custom_setting_name: custom_service_name}, - "persistent": {persistent_setting_name: persistent_service_name}, - } - - mock_customsetting = mock.MagicMock(value=1) - mock_customsetting.save.side_effect = ValidationError("error") - mock_customsettings.objects.get.return_value = mock_customsetting - - install_commands.configure_services(services, app_name) - - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertIn( - f"Incorrect value type given for custom setting '{custom_setting_name}'", - po_call_args[0][0][0], - ) - - mock_find_and_link.assert_called_with( - "persistent", persistent_setting_name, persistent_service_name, app_name - ) - - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - @mock.patch("tethys_apps.cli.install_commands.os") - def test_run_portal_install_path_none(self, mock_os, _): - mock_os.path.exists.return_value = False - - self.assertFalse(install_commands.run_portal_install(None, "foo")) - - @mock.patch("tethys_apps.cli.install_commands.configure_services") - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - @mock.patch("tethys_apps.cli.install_commands.open_file") - @mock.patch("tethys_apps.cli.install_commands.os") - def test_run_portal_install( - self, mock_os, mock_open_file, mock_pretty_output, mock_configure_services - ): - app_name = "foo" - services = {"persistent": {"test_setting": "test_service"}} - portal_options_services = {"apps": {app_name: {"services": services}}} - portal_options_empty_services = {"apps": {app_name: {"services": ""}}} - portal_options_no_services = {"apps": {app_name: ""}} - - mock_open_file.side_effect = [ - portal_options_services, - portal_options_empty_services, - portal_options_no_services, - ] - mock_os.path.exists.return_value = True - - self.assertTrue(install_commands.run_portal_install(None, app_name)) - mock_configure_services.assert_called_with(services, app_name) - self.assertFalse(install_commands.run_portal_install(None, app_name)) - self.assertFalse(install_commands.run_portal_install(None, app_name)) - - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertIn( - f"No app configuration found for app: {app_name}", po_call_args[2][0][0] - ) - self.assertIn( - "No apps configuration found in portal config file.", po_call_args[4][0][0] - ) - - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - @mock.patch("tethys_apps.cli.install_commands.os") - def test_run_services_path_none(self, mock_os, mock_pretty_output): - args = mock.MagicMock(services_file=None) - - mock_os.path.exists.return_value = False - - install_commands.run_services("foo", args) - - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertEqual("No Services file found.", po_call_args[0][0][0]) - - @mock.patch("tethys_apps.cli.install_commands.configure_services") - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - @mock.patch("tethys_apps.cli.install_commands.open_file") - @mock.patch("tethys_apps.cli.install_commands.os") - def test_run_services(self, mock_os, mock_open_file, mock_pretty_output, _): - args = mock.MagicMock(services_file="services_file") - - mock_os.path.exists.return_value = True - mock_open_file.side_effect = ["service_file", ""] - install_commands.run_services("foo", args) - install_commands.run_services("foo", args) - - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertEqual("No Services listed in Services file.", po_call_args[0][0][0]) - - -class TestInstallCommands(TestCase): - def setUp(self): - from tethys_apps.models import TethysApp - - self.src_dir = os.path.dirname( - os.path.dirname(os.path.dirname(os.path.dirname(__file__))) - ) - self.root_app_path = os.path.join(self.src_dir, "apps", "tethysapp-test_app") - self.app_model = TethysApp(name="test_app", package="test_app") - self.app_model.save() - pass - - def tearDown(self): - self.app_model.delete() - pass - - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - @mock.patch("builtins.input", side_effect=["x", "n"]) - @mock.patch("tethys_apps.cli.install_commands.exit") - @mock.patch("tethys_apps.cli.install_commands.call") - def test_install_file_not_generate(self, mock_call, mock_exit, _, __): - args = mock.MagicMock(file=None, quiet=False) - - mock_exit.side_effect = SystemExit - - self.assertRaises(SystemExit, install_commands.install_command, args) - self.assertEqual(3, len(mock_call.call_args_list)) - - mock_exit.assert_called_with(0) - - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - @mock.patch("builtins.input", side_effect=["y"]) - @mock.patch("tethys_apps.cli.install_commands.call") - @mock.patch("tethys_apps.cli.install_commands.exit") - def test_install_file_generate(self, mock_exit, mock_call, _, __): - args = mock.MagicMock(file=None, quiet=False) - check_call = ["tethys", "gen", "install"] - - mock_exit.side_effect = SystemExit - - self.assertRaises(SystemExit, install_commands.install_command, args) - mock_call.assert_called_with(check_call) - mock_exit.assert_called_with(0) - - @mock.patch("tethys_apps.cli.install_commands.run_services") - @mock.patch("tethys_apps.cli.install_commands.call") - @mock.patch("tethys_apps.cli.install_commands.exit") - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - def test_no_conda_input_file(self, mock_pretty_output, mock_exit, _, __): - file_path = os.path.join(self.root_app_path, "install-no-dep.yml") - args = mock.MagicMock(file=file_path, verbose=False) - mock_exit.side_effect = SystemExit - - self.assertRaises(SystemExit, install_commands.install_command, args) - - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertIn("Running application install....", po_call_args[0][0][0]) - self.assertIn( - "Quiet mode: No additional service setting validation will be performed.", - po_call_args[1][0][0], - ) - self.assertIn("Services Configuration Completed.", po_call_args[2][0][0]) - self.assertIn("Skipping syncstores.", po_call_args[3][0][0]) - mock_exit.assert_called_with(0) - - @mock.patch("tethys_apps.cli.install_commands.run_services") - @mock.patch("tethys_apps.cli.install_commands.call") - @mock.patch("tethys_apps.cli.install_commands.exit") - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - def test_input_file_with_post(self, mock_pretty_output, mock_exit, _, __): - file_path = os.path.join(self.root_app_path, "install-with-post.yml") - args = mock.MagicMock(file=file_path, verbose=False) - mock_exit.side_effect = SystemExit - - self.assertRaises(SystemExit, install_commands.install_command, args) - - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertIn("Running application install....", po_call_args[1][0][0]) - self.assertIn( - "Quiet mode: No additional service setting validation will be performed.", - po_call_args[2][0][0], - ) - self.assertIn("Services Configuration Completed.", po_call_args[3][0][0]) - self.assertIn("Skipping syncstores.", po_call_args[4][0][0]) - self.assertIn("Running post installation tasks...", po_call_args[5][0][0]) - self.assertIn("Post Script Result: b'test\\n'", po_call_args[6][0][0]) - mock_exit.assert_called_with(0) - - @mock.patch("tethys_apps.cli.install_commands.run_services") - @mock.patch("tethys_apps.cli.install_commands.run_sync_stores") - @mock.patch("tethys_apps.cli.install_commands.run_interactive_services") - @mock.patch("tethys_apps.cli.install_commands.call") - @mock.patch( - "tethys_apps.cli.install_commands.run_portal_install", return_value=False - ) - @mock.patch("tethys_apps.cli.install_commands.run_services") - @mock.patch("tethys_apps.cli.install_commands.exit") - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - def test_skip_input_file( - self, mock_pretty_output, mock_exit, _, __, ___, ____, _____, ______ - ): - file_path = os.path.join(self.root_app_path, "install-skip-setup.yml") - mock_exit.side_effect = SystemExit - - args = mock.MagicMock(file=file_path, verbose=False) - self.assertRaises(SystemExit, install_commands.install_command, args) - - args = mock.MagicMock(file=file_path, develop=False) - self.assertRaises(SystemExit, install_commands.install_command, args) - - args = mock.MagicMock( - file=file_path, - verbose=False, - develop=False, - force_services=False, - quiet=False, - no_sync=False, - ) - self.assertRaises(SystemExit, install_commands.install_command, args) - - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertEqual( - "Skipping package installation, Skip option found.", po_call_args[0][0][0] - ) - mock_exit.assert_called_with(0) - - @mock.patch("tethys_apps.cli.install_commands.run_services") - @mock.patch("tethys_apps.cli.install_commands.call") - @mock.patch("tethys_apps.cli.install_commands.conda_run", return_value=["", "", 1]) - @mock.patch("tethys_apps.cli.install_commands.exit") - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - def test_conda_and_pip_package_install( - self, mock_pretty_output, mock_exit, mock_conda_run, mock_call, _ - ): - file_path = os.path.join(self.root_app_path, "install-dep.yml") - args = mock.MagicMock( - file=file_path, develop=False, verbose=False, services_file=None - ) - mock_exit.side_effect = SystemExit - - self.assertRaises(SystemExit, install_commands.install_command, args) - - mock_conda_run.assert_called_with( - Commands.INSTALL, - "-c", - "tacaswell", - "geojson", - use_exception_handler=False, - stdout=None, - stderr=None, - ) - - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertEqual("Running conda installation tasks...", po_call_args[0][0][0]) - self.assertIn( - "Warning: Packages installation ran into an error.", po_call_args[1][0][0] - ) - self.assertEqual("Running pip installation tasks...", po_call_args[2][0][0]) - self.assertEqual("Running application install....", po_call_args[3][0][0]) - self.assertEqual( - "Quiet mode: No additional service setting validation will be performed.", - po_call_args[4][0][0], - ) - self.assertEqual("Services Configuration Completed.", po_call_args[5][0][0]) - - self.assertEqual(["pip", "install", "see"], mock_call.mock_calls[0][1][0]) - self.assertEqual(["pip", "install", "."], mock_call.mock_calls[1][1][0]) - self.assertEqual(["tethys", "manage", "sync"], mock_call.mock_calls[2][1][0]) - - mock_exit.assert_called_with(0) - - @mock.patch("builtins.input", side_effect=["x", 5]) - @mock.patch("tethys_apps.cli.install_commands.get_app_settings") - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - def test_interactive_custom_setting_set( - self, mock_pretty_output, mock_get_settings, _ - ): - mock_cs = mock.MagicMock() - mock_cs.name = "mock_cs" - mock_cs.save.side_effect = [ValidationError("error"), mock.DEFAULT] - mock_get_settings.return_value = {"unlinked_settings": [mock_cs]} - - install_commands.run_interactive_services("foo") - - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertIn("Configuring mock_cs", po_call_args[2][0][0]) - self.assertIn("Type", po_call_args[3][0][0]) - self.assertIn("Enter the desired value", po_call_args[4][0][0]) - self.assertIn("Incorrect value type", po_call_args[5][0][0]) - self.assertIn("Enter the desired value", po_call_args[6][0][0]) - self.assertEqual( - mock_cs.name + " successfully set with value: 5.", po_call_args[7][0][0] - ) - - @mock.patch("builtins.input", side_effect=[""]) - @mock.patch("tethys_apps.cli.install_commands.get_app_settings") - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - def test_interactive_custom_setting_skip( - self, mock_pretty_output, mock_get_settings, _ - ): - mock_cs = mock.MagicMock() - mock_cs.name = "mock_cs" - mock_get_settings.return_value = {"unlinked_settings": [mock_cs]} - - install_commands.run_interactive_services("foo") - - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertIn("Configuring mock_cs", po_call_args[2][0][0]) - self.assertIn("Type", po_call_args[3][0][0]) - self.assertIn("Enter the desired value", po_call_args[4][0][0]) - self.assertEqual(f"Skipping setup of {mock_cs.name}", po_call_args[5][0][0]) - - @mock.patch("builtins.input", side_effect=KeyboardInterrupt) - @mock.patch("tethys_apps.cli.install_commands.exit") - @mock.patch("tethys_apps.cli.install_commands.get_app_settings") - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - def test_interactive_custom_setting_interrupt( - self, mock_pretty_output, mock_get_settings, mock_exit, _ - ): - mock_cs = mock.MagicMock() - mock_cs.name = "mock_cs" - mock_get_settings.return_value = {"unlinked_settings": [mock_cs]} - - mock_exit.side_effect = SystemExit - - self.assertRaises(SystemExit, install_commands.run_interactive_services, "foo") - - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertIn("Configuring mock_cs", po_call_args[2][0][0]) - self.assertIn("Type", po_call_args[3][0][0]) - self.assertIn("Enter the desired value", po_call_args[4][0][0]) - self.assertEqual("\nInstall Command cancelled.", po_call_args[5][0][0]) - - mock_exit.assert_called_with(0) - - @mock.patch("builtins.input", side_effect=["1", "1", "", KeyboardInterrupt]) - @mock.patch( - "tethys_apps.cli.install_commands.get_setting_type", return_value="persistent" - ) - @mock.patch( - "tethys_apps.cli.install_commands.get_service_from_id", side_effect=ValueError - ) - @mock.patch( - "tethys_apps.cli.install_commands.get_service_from_name", - side_effect=[False, {"service_type": "st", "linkParam": "lp"}], - ) - @mock.patch("tethys_apps.cli.install_commands.exit") - @mock.patch("tethys_apps.cli.install_commands.services_list_command") - @mock.patch("tethys_apps.cli.install_commands.get_app_settings") - @mock.patch("tethys_apps.cli.install_commands.link_service_to_app_setting") - @mock.patch("tethys_apps.cli.cli_colors.pretty_output") - def test_interactive_service_setting_all( - self, - mock_pretty_output, - mock_lstas, - mock_get_settings, - mock_slc, - mock_exit, - ____, - ___, - __, - _, - ): - mock_ss = mock.MagicMock() - del mock_ss.value - mock_ss.name = "mock_ss" - mock_ss.save.side_effect = [ValidationError("error"), mock.DEFAULT] - mock_get_settings.return_value = { - "unlinked_settings": [mock_ss, mock_ss, mock_ss, mock_ss] - } - - mock_s = mock.MagicMock() - mock_slc.side_effect = [[[]], [[mock_s]], [[mock_s]], [[mock_s]]] - - mock_exit.side_effect = SystemExit - - self.assertRaises(SystemExit, install_commands.run_interactive_services, "foo") - - po_call_args = mock_pretty_output().__enter__().write.call_args_list - self.assertIn("Configuring mock_ss", po_call_args[2][0][0]) - self.assertIn("Type", po_call_args[3][0][0]) - self.assertIn("No compatible services found.", po_call_args[4][0][0]) - self.assertIn("Enter the service ID/Name", po_call_args[7][0][0]) - self.assertIn("Incorrect service ID/Name.", po_call_args[8][0][0]) - self.assertIn("Enter the service ID/Name", po_call_args[9][0][0]) - self.assertIn(f"Skipping setup of {mock_ss.name}", po_call_args[13][0][0]) - self.assertEqual("\nInstall Command cancelled.", po_call_args[17][0][0]) - - mock_lstas.assert_called_with("st", "1", "foo", "lp", "mock_ss") - mock_exit.assert_called_with(0) - - def test_get_setting_type(self): - from tethys_apps.models import PersistentStoreDatabaseSetting - - self.assertEqual( - "persistent", - install_commands.get_setting_type(PersistentStoreDatabaseSetting()), - ) From 3476d6796824bdb7b17c4745a513ee8f4e9f41f1 Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Mon, 1 Apr 2024 14:43:05 -0500 Subject: [PATCH 22/23] moved user menu to its own template --- .../templates/tethys_apps/app_base.html | 42 +------------------ tethys_portal/templates/header.html | 33 +-------------- .../tethys_portal/user/user_header_menu.html | 32 ++++++++++++++ 3 files changed, 34 insertions(+), 73 deletions(-) create mode 100644 tethys_portal/templates/tethys_portal/user/user_header_menu.html diff --git a/tethys_apps/templates/tethys_apps/app_base.html b/tethys_apps/templates/tethys_apps/app_base.html index 845aa025d..ad2b5b81a 100644 --- a/tethys_apps/templates/tethys_apps/app_base.html +++ b/tethys_apps/templates/tethys_apps/app_base.html @@ -122,15 +122,6 @@ background-color: rgba(255, 255, 255, 0.30); } - #app-header .user-menu-button .dropdown-menu .dropdown-item { - color:#3f3f3f; - } - - #app-header .user-menu-button .dropdown-menu .dropdown-item:active { - background-color: {{ site_globals.primary_color }}; - color: #dddddd; - } - #app-navigation .nav li a { color: var(--app-primary-color, '#7ec1f7'); } @@ -226,38 +217,7 @@ {% endblock %} {% block user_menu %} {% if user.is_authenticated and user.is_active and single_app_mode %} -
    - - - -
    + {% include "tethys_portal/user/user_header_menu.html" %} {% endif %} {% endblock %} diff --git a/tethys_portal/templates/header.html b/tethys_portal/templates/header.html index 8a85e83e2..6551fe131 100644 --- a/tethys_portal/templates/header.html +++ b/tethys_portal/templates/header.html @@ -37,38 +37,7 @@
{% block user_menu %} {% if user.is_authenticated and user.is_active %} -
- - - -
+ {% include "tethys_portal/user/user_header_menu.html" %} {% else %} Log In {% endif %} diff --git a/tethys_portal/templates/tethys_portal/user/user_header_menu.html b/tethys_portal/templates/tethys_portal/user/user_header_menu.html new file mode 100644 index 000000000..d9eb04a54 --- /dev/null +++ b/tethys_portal/templates/tethys_portal/user/user_header_menu.html @@ -0,0 +1,32 @@ +
+ + + +
\ No newline at end of file From 1825cc4629bb6d369e4caaa8c2f055f9053b8367 Mon Sep 17 00:00:00 2001 From: Corey Krewson Date: Mon, 1 Apr 2024 15:01:29 -0500 Subject: [PATCH 23/23] black formatted and linted --- tethys_portal/context_processors.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tethys_portal/context_processors.py b/tethys_portal/context_processors.py index 144fc7e95..457a5dad9 100644 --- a/tethys_portal/context_processors.py +++ b/tethys_portal/context_processors.py @@ -19,9 +19,9 @@ def tethys_portal_context(request): if hasattr(settings, "SOCIAL_AUTH_SAML_ENABLED_IDPS") else {} ) - + single_app_mode, single_app_name = check_single_app_mode() - + context = { "has_analytical": has_module("analytical"), "has_recaptcha": has_module("snowpenguin.django.recaptcha2"),