Merge branch 'dev' into 1258-create-integration-point-for-target-detail-tabs

Author: jchate6

.github/workflows/run-tests.yml

@@ -18,6 +18,22 @@ jobs:
     - name: Style Checks
       run: poetry run flake8 tom_* --exclude=*/migrations/* --max-line-length=120
 
+  check_migrations:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: "3.12"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install "poetry>=2.0,<3.0"
+        poetry install
+    - name: Missing Migrations
+      run: |
+        poetry run python manage.py makemigrations --check
+
   run_tests:
     runs-on: ubuntu-latest
     strategy:

tom_alerts/brokers/tns.py

@@ -171,7 +171,7 @@ def fetch_tns_transients(cls, parameters):
             parameters: dictionary containing days_ago (str), min_date (str)
             and either:
 
-            - Right Ascention, declination (can be deg, deg or h:m:s, d:m:s) of the target,
+            - Right Ascension, declination (can be deg, deg or h:m:s, d:m:s) of the target,
                 and search radius and search radius unit ("arcmin", "arcsec", or "deg"), or
 
             - TNS name without the prefix (eg. 2024aa instead of AT2024aa)

tom_catalogs/templates/tom_catalogs/partials/catalog_query_menu.html

@@ -0,0 +1,4 @@
+{% comment %}}
+    Empty partial to serve as a placeholder for backwards compatibility in the case that
+    tom_dataservices is not installed.
+{% endcomment %}

tom_catalogs/templatetags/__init__.py

@@ -0,0 +1,17 @@
+from django import template
+from django.apps import apps
+from django.template.loader import get_template
+
+from tom_catalogs.harvester import get_service_classes
+
+
+def catalog_query_menu():
+    context = {'catalogs': get_service_classes().keys()}
+    return context
+
+
+# Added for backwards compatibility in case tom_dataservices is not installed.
+if 'tom_dataservices' not in [app.name for app in apps.get_app_configs()]:
+    register = template.Library()
+    t = get_template('tom_catalogs/partials/catalog_query_menu.html')
+    register.inclusion_tag(t)(catalog_query_menu)

tom_catalogs/templatetags/dataservices_extras.py

@@ -50,7 +50,7 @@
 
         </ul>
         <ul class="navbar-nav ml-auto" id="login-buttons">
-        {% navbar_login %}
+        {% include 'tom_common/partials/navbar_login.html' %}
         </ul>
       </div>
     </nav>

tom_common/templates/tom_common/base.html

@@ -1,3 +1,4 @@
-{% for nav_item in nav_item_list %}
-    {% include nav_item.partial %}
+{% load tom_common_extras %}
+{% for nav_item in nav_items_to_display %}
+    {% show_individual_app_partial nav_item %}
 {% endfor %}

tom_common/templates/tom_common/partials/navbar_app_addons.html

@@ -1,6 +1,5 @@
-{% for nav_item in nav_item_list %}
-    {% include nav_item.partial %}
-{% endfor %}
+{% load tom_common_extras %}
+{% navbar_app_addons 'right' %}
 {% if user.is_authenticated %}
 <li class="nav-item">
     {% if user.first_name or user.last_name %}

tom_common/templates/tom_common/partials/navbar_login.html

@@ -1,4 +1,5 @@
 import textwrap
+import logging
 
 from django import template
 from django.db.models import IntegerField
@@ -8,51 +9,48 @@
 from django.apps import apps
 from django.core.exceptions import FieldDoesNotExist
 from guardian.shortcuts import get_objects_for_user
+from django.utils.module_loading import import_string
 
 from tom_targets.models import Target
 
-register = template.Library()
-
+logger = logging.getLogger(__name__)
 
-@register.inclusion_tag('tom_common/partials/navbar_login.html', takes_context=True)
-def navbar_login(context):
-    """
-    Renders the username as a link to the user page, as well as the login button. Can be overridden to render additional
-    account-related buttons.
-    """
-    nav_item_list = []
-    for app in apps.get_app_configs():
-        try:
-            nav_items = app.nav_items()
-            if nav_items:
-                for item in nav_items:
-                    if item.get('position', 'left') == 'right':
-                        nav_item_list.append(item)
-        except AttributeError:
-            pass
-    return {'user': context['user'],
-            'nav_item_list': nav_item_list}
+register = template.Library()
 
 
 @register.inclusion_tag('tom_common/partials/navbar_app_addons.html', takes_context=True)
-def navbar_app_addons(context):
+def navbar_app_addons(context, position='left'):
     """
     Imports the navbar content from appropriate apps
     This should be a list of partials containing an <li> element that you would like displayed in the navbar with the
     following format:
      `<li class="nav-item"> <a class="nav-link" href="{% url 'namespace:view_name' %}">Link Text</a> </li>`
     """
-    nav_item_list = []
+    nav_items_to_display = []
     for app in apps.get_app_configs():
         try:
             nav_items = app.nav_items()
-            if nav_items:
-                for item in nav_items:
-                    if item.get('position', 'left') != 'right':
-                        nav_item_list.append(item)
         except AttributeError:
-            pass
-    return {'nav_item_list': nav_item_list}
+            continue
+        if nav_items:
+            for item in nav_items:
+                context_method_path = item.get('context', None)
+                if context_method_path:
+                    try:
+                        context_method = import_string(item.get('context'))
+                        new_context = context_method({})
+                    except ImportError as e:
+                        logger.warning(f'WARNING: Could not import context for {app.name} navbar item from '
+                                       f'{item["context"]}: \n'
+                                       f'{e}')
+                        continue
+                else:
+                    new_context = {}
+                if item.get('position', 'left') == position:
+                    nav_items_to_display.append({'partial': item['partial'], 'context': new_context})
+
+    context['nav_items_to_display'] = nav_items_to_display
+    return context
 
 
 @register.simple_tag

tom_common/templatetags/tom_common_extras.py

@@ -1,6 +1,33 @@
 from django.apps import AppConfig
+from django.urls import path, include
 
 
 class TomDataservicesConfig(AppConfig):
     default_auto_field = 'django.db.models.BigAutoField'
     name = 'tom_dataservices'
+    trimmed_name = 'dataservices'
+
+    def include_url_paths(self):
+        """
+        Integration point for adding URL patterns to the Tom Common URL configuration.
+        This method should return a list of URL patterns to be included in the main URL configuration.
+        """
+        urlpatterns = [
+            path(f'{self.label}/', include(f'{self.name}.urls', namespace=f'{self.trimmed_name}'))
+        ]
+        return urlpatterns
+
+    def nav_items(self):
+        """
+        Integration point for adding items to the navbar.
+        This method should return a list of partial templates to be included in the navbar.
+        """
+        return [{'partial': 'tom_dataservices/partials/navbar_list.html',
+                 'context': 'tom_dataservices.templatetags.dataservices_extras.dataservices_list'}]
+
+    def data_services(self):
+        """
+        integration point for including data services in the TOM
+        This method should return a list of dictionaries containing dot separated DataService classes
+        """
+        return [{'class': f'{self.name}.data_services.tns.TNSDataService'}]