BUG: Fixed key errors in plot card view.

Happened when surface has a successful
analysis although all analyses for the
related measurement fail.

Closes #739.

Author: mcrot

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog for *TopoBank*
 
+## 0.16.1 (not published yet)
+
+- BUG: Missing manifest entry problem during installation
+  fixed by using another package for fontawesone 5 
+  icons (#740)
+- BUG: Fixes error messages in special cases of successful
+  surface analysis but no successful analysis for 
+  measurements (#739)
+
 ## 0.16.0 (2021-10-18)
 
 - ENH: Enhanced search by supporting "weblike" search 

topobank/analysis/tests/test_cards.py

@@ -1,10 +1,14 @@
 import pytest
 
 from django.shortcuts import reverse
+from django.contrib.contenttypes.models import ContentType
 
-from topobank.manager.tests.utils import Topography1DFactory, UserFactory
+from topobank.manager.tests.utils import Topography1DFactory, UserFactory, SurfaceFactory
 from topobank.manager.utils import subjects_to_json
-from .utils import AnalysisFunctionFactory
+from topobank.manager.models import Analysis, Topography, Surface
+
+from .utils import AnalysisFunctionFactory, TopographyAnalysisFactory, SurfaceAnalysisFactory,\
+    AnalysisFunctionImplementationFactory
 from ..views import card_view_class, SimpleCardView, PlotCardView, PowerSpectrumCardView
 
 
@@ -84,6 +88,52 @@ def test_card_templates_for_power_spectrum(client, mocker, handle_usage_statisti
     assert response.template_name == ['analysis/powerspectrum_card_detail.html']
 
 
+@pytest.mark.django_db
+def test_plot_card_if_no_successful_topo_analysis(client, handle_usage_statistics):
+    #
+    # Create database objects
+    #
+    password = "secret"
+    user = UserFactory(password=password)
+    topography_ct = ContentType.objects.get_for_model(Topography)
+    surface_ct = ContentType.objects.get_for_model(Surface)
+    func1 = AnalysisFunctionFactory(card_view_flavor='power spectrum')
+    AnalysisFunctionImplementationFactory(function=func1, subject_type=topography_ct)
+    AnalysisFunctionImplementationFactory(function=func1, subject_type=surface_ct)
+
+    surf = SurfaceFactory(creator=user)
+    topo = Topography1DFactory(surface=surf)  # also generates the surface
+
+    # There is a successful surface analysis, but no successful topography analysis
+    SurfaceAnalysisFactory(task_state='su', subject_id=topo.surface.id,
+                           subject_type_id=surface_ct.id, function=func1, users=[user])
+
+    # add a failed analysis for the topography
+    TopographyAnalysisFactory(task_state='fa', subject_id=topo.id,
+                              subject_type_id=topography_ct.id, function=func1, users=[user])
+
+
+    assert Analysis.objects.filter(function=func1, subject_id=topo.id, subject_type_id=topography_ct.id,
+                                   task_state='su').count() == 0
+    assert Analysis.objects.filter(function=func1, subject_id=topo.id, subject_type_id=topography_ct.id,
+                                   task_state='fa').count() == 1
+    assert Analysis.objects.filter(function=func1, subject_id=topo.surface.id, subject_type_id=surface_ct.id,
+                                   task_state='su').count() == 1
+
+    # login and request plot card view
+    assert client.login(username=user.username, password=password)
+
+    response = client.post(reverse('analysis:card'), data={
+        'function_id': func1.id,
+        'card_id': 'card',
+        'template_flavor': 'list',
+        'subjects_ids_json': subjects_to_json([topo, topo.surface]),  # also request results for surface here
+    }, HTTP_X_REQUESTED_WITH='XMLHttpRequest')  # we need an AJAX request
+
+    # should return without errors
+    assert response.status_code == 200
+
+
 def test_card_view_class():
     assert card_view_class('simple') == SimpleCardView
     assert card_view_class('plot') == PlotCardView

topobank/analysis/views.py

@@ -354,18 +354,6 @@ def get_context_data(self, **kwargs):
 
         analyses_success = context['analyses_success']
 
-        if len(analyses_success) == 0:
-            #
-            # Prepare plot, controls, and table with special values..
-            #
-            context.update(
-                dict(plot_script="",
-                     plot_div="No successfully finished analyses available",
-                     special_values=[],
-                     topography_colors=json.dumps(list()),
-                     series_dashes=json.dumps(list())))
-            return context
-
         #
         # order analyses such that surface analyses are coming last (plotted on top)
         #
@@ -378,6 +366,23 @@ def get_context_data(self, **kwargs):
                 # only show average for surface if more than one topography
                 analyses_success_list.append(surface_analysis)
 
+        # Special case: It can happen that there is one surface with a successful analysis
+        # but the only measurement's analysis has no success. In this case there is also
+        # no successful analysis to display because the surface has only one measurement.
+
+        if len(analyses_success_list) == 0:
+            #
+            # Prepare plot, controls, and table with special values..
+            #
+            context.update(
+                dict(plot_script="",
+                     plot_div="No successfully finished analyses available",
+                     special_values=[],
+                     topography_colors=json.dumps(list()),
+                     series_dashes=json.dumps(list())))
+            return context
+
+
         #
         # Build order of subjects such that surfaces are first (used for checkbox on subjects)
         #
@@ -407,6 +412,7 @@ def get_context_data(self, **kwargs):
             num_surface_subjects = len(subject_checkbox_groups[surface_ct])
         else:
             num_surface_subjects = 0
+        has_at_least_one_topography_subject = topography_ct in subject_checkbox_groups.keys()
 
         #
         # Use first analysis to determine some properties for the whole plot
@@ -736,11 +742,14 @@ def get_axis_type(key):
         else:
             surface_btn_group = Div(visible=False)
 
-        topography_btn_group = CheckboxGroup(
-                labels=subject_checkbox_groups[topography_ct],
-                css_classes=["topobank-subject-checkbox", "topobank-topography-checkbox"],
-                visible=False,
-                active=list(range(len(subject_checkbox_groups[topography_ct]))))
+        if has_at_least_one_topography_subject:
+            topography_btn_group = CheckboxGroup(
+                    labels=subject_checkbox_groups[topography_ct],
+                    css_classes=["topobank-subject-checkbox", "topobank-topography-checkbox"],
+                    visible=False,
+                    active=list(range(len(subject_checkbox_groups[topography_ct]))))
+        else:
+            topography_btn_group = Div(visible=False)
 
         subject_select_all_btn = Button(label="Select all",
                                         width_policy='min',