Rewrote unit tests for variable endpoint and more error checking

src/evagram/website/backend/api/test_views.py

@@ -14,42 +14,84 @@ def test_initial_load(self):
         self.assertTrue("observations" in response.json())
         self.assertTrue("variables" in response.json())
 
-    def test_get_plot_components(self):
+    def test_get_single_plot(self):
         response = self.client.get(
-            "/api/get-plot-components/?experiment_id=12&observation_id=1&variable_id=1&group_id=1")
-        self.assertEqual("experiment_id=12&observation_id=1&variable_id=1&group_id=1",
+            "/api/get-plots-by-field/?owner_id=1&experiment_id=12&observation_id=1"
+            "&variable_name=brightnessTemperature&channel=4&group_id=1")
+        self.assertEqual("owner_id=1&experiment_id=12&observation_id=1&"
+                         "variable_name=brightnessTemperature&channel=4&group_id=1",
                          response.request['QUERY_STRING'])
         self.assertEqual(200, response.status_code)
         # check if plot components in response match with plot id in database
-        plot = Plots.objects.get(pk=response.json()["plot_id"])
-        self.assertEqual(plot.div, response.json()["div"])
-        self.assertEqual(plot.script, response.json()["script"])
+        plot = Plots.objects.get(pk=response.json()[0]["plot_id"])
+        self.assertEqual(plot.div, response.json()[0]["div"])
+        self.assertEqual(plot.script, response.json()[0]["script"])
 
     def test_plot_insufficient_params(self):
-        response = self.client.get("/api/get-plot-components/?experiment_id=12&observation_id=1")
-        self.assertEqual("experiment_id=12&observation_id=1", response.request['QUERY_STRING'])
+        response = self.client.get("/api/get-plots-by-field/?owner_id=1")
+        self.assertEqual("owner_id=1", response.request['QUERY_STRING'])
+        self.assertEqual(400, response.status_code)
+
+    def test_plot_invalid_username(self):
+        response = self.client.get(
+            "/api/get-plots-by-field/?owner_id=null&experiment_id=12&observation_id=1"
+            "&variable_name=brightnessTemperature&channel=4&group_id=1")
+        self.assertEqual("owner_id=null&experiment_id=12&observation_id=1"
+                         "&variable_name=brightnessTemperature&channel=4&group_id=1",
+                         response.request['QUERY_STRING'])
         self.assertEqual(400, response.status_code)
-        self.assertEqual("Missing request parameter detected: 'variable_id'",
-                         response.json()['error'])
 
-    def test_plot_invalid_plot_fks(self):
+    def test_plot_username_not_found(self):
         response = self.client.get(
-            "/api/get-plot-components/?experiment_id=-12&observation_id=1&variable_id=1&group_id=1")
-        self.assertEqual("experiment_id=-12&observation_id=1&variable_id=1&group_id=1",
+            "/api/get-plots-by-field/?owner_id=-1&experiment_id=12&observation_id=1"
+            "&variable_name=brightnessTemperature&channel=4&group_id=1")
+        self.assertEqual("owner_id=-1&experiment_id=12&observation_id=1"
+                         "&variable_name=brightnessTemperature&channel=4&group_id=1",
                          response.request['QUERY_STRING'])
         self.assertEqual(400, response.status_code)
-        self.assertEqual("Plots matching query does not exist.", response.json()['error'])
 
-    def test_plot_bad_input(self):
+    def test_plot_value_error(self):
         response = self.client.get(
-            "/api/get-plot-components/?experiment_id=xyz&observation_id=1&variable_id=1&group_id=1")
-        self.assertEqual("experiment_id=xyz&observation_id=1&variable_id=1&group_id=1",
+            "/api/get-plots-by-field/?owner_id=1&experiment_id=xyz&observation_id=1"
+            "&variable_name=brightnessTemperature&channel=4&group_id=1")
+        self.assertEqual("owner_id=1&experiment_id=xyz&observation_id=1"
+                         "&variable_name=brightnessTemperature&channel=4&group_id=1",
                          response.request['QUERY_STRING'])
         self.assertEqual(400, response.status_code)
-        self.assertEqual("Field 'experiment_id' expected a number but got 'xyz'.",
-                         response.json()['error'])
 
-    def test_update_user_valid_pk(self):
+    def test_plot_input_cascade(self):
+        # Tests if the experiment_id is handled before the observation_id
+        response = self.client.get(
+            "/api/get-plots-by-field/?owner_id=1&experiment_id=null&observation_id=1"
+            "&variable_name=null&channel=null&group_id=null")
+        self.assertEqual("owner_id=1&experiment_id=null&observation_id=1"
+                         "&variable_name=null&channel=null&group_id=null",
+                         response.request['QUERY_STRING'])
+        # If diagnostics were queried out of order by observation_id,
+        # the queryset will be empty because experiment_id=null
+        self.assertNotEqual(0, len(response.data))
+
+    def test_plot_channel_error(self):
+        # Tests if channel was not provided and variable requires it
+        response = self.client.get(
+            "/api/get-plots-by-field/?owner_id=1&experiment_id=12&observation_id=1"
+            "&variable_name=brightnessTemperature&channel=null&group_id=null")
+        self.assertEqual("owner_id=1&experiment_id=12&observation_id=1"
+                         "&variable_name=brightnessTemperature&channel=null&group_id=null",
+                         response.request['QUERY_STRING'])
+        self.assertEqual(404, response.status_code)
+
+    def test_plot_channel_is_optional(self):
+        # Tests if channel was not provided but variable takes optional channel value
+        response = self.client.get(
+            "/api/get-plots-by-field/?owner_id=1&experiment_id=12&observation_id=1"
+            "&variable_name=windEastward&channel=null&group_id=null")
+        self.assertEqual("owner_id=1&experiment_id=12&observation_id=1"
+                         "&variable_name=windEastward&channel=null&group_id=null",
+                         response.request['QUERY_STRING'])
+        self.assertEqual(200, response.status_code)
+
+    def test_update_user_option_valid_params(self):
         response = self.client.get("/api/update-user-option/?owner_id=1")
         self.assertEqual("owner_id=1", response.request['QUERY_STRING'])
         self.assertEqual(200, response.status_code)
@@ -58,102 +100,84 @@ def test_update_user_valid_pk(self):
         self.assertTrue("variables" in response.json())
         self.assertTrue("groups" in response.json())
 
-    def test_update_user_invalid_pk(self):
+    def test_update_user_option_object_not_found(self):
         response = self.client.get("/api/update-user-option/?owner_id=-1")
         self.assertEqual("owner_id=-1", response.request['QUERY_STRING'])
-        self.assertEqual(400, response.status_code)
-        self.assertEqual("Owners matching query does not exist.", response.json()['error'])
+        self.assertEqual(404, response.status_code)
 
-    def test_update_user_bad_input(self):
+    def test_update_user_option_value_error(self):
         response = self.client.get("/api/update-user-option/?owner_id=owner")
         self.assertEqual("owner_id=owner", response.request['QUERY_STRING'])
         self.assertEqual(400, response.status_code)
-        self.assertEqual("Field 'owner_id' expected a number but got 'owner'.",
-                         response.json()['error'])
 
-    def test_update_user_insufficient_params(self):
+    def test_update_user_option_insufficient_params(self):
         response = self.client.get("/api/update-user-option/")
         self.assertEqual("", response.request['QUERY_STRING'])
         self.assertEqual(400, response.status_code)
         self.assertEqual("Missing request parameter detected: 'owner_id'", response.json()['error'])
 
-    def test_update_experiment_valid_pk(self):
+    def test_update_experiment_option_valid_params(self):
         response = self.client.get("/api/update-experiment-option/?experiment_id=1")
         self.assertEqual("experiment_id=1", response.request['QUERY_STRING'])
         self.assertEqual(200, response.status_code)
         self.assertTrue("observations" in response.json())
         self.assertTrue("variables" in response.json())
         self.assertTrue("groups" in response.json())
 
-    def test_update_experiment_invalid_pk(self):
+    def test_update_experiment_option_object_not_found(self):
         response = self.client.get("/api/update-experiment-option/?experiment_id=-1")
         self.assertEqual("experiment_id=-1", response.request['QUERY_STRING'])
-        self.assertEqual(400, response.status_code)
-        self.assertEqual("Experiments matching query does not exist.", response.json()['error'])
+        self.assertEqual(404, response.status_code)
 
-    def test_update_experiment_bad_input(self):
+    def test_update_experiment_option_value_error(self):
         response = self.client.get("/api/update-experiment-option/?experiment_id=!")
         self.assertEqual("experiment_id=!", response.request['QUERY_STRING'])
         self.assertEqual(400, response.status_code)
-        self.assertEqual("Field 'experiment_id' expected a number but got '!'.",
-                         response.json()['error'])
 
-    def test_update_experiment_insufficient_params(self):
+    def test_update_experiment_option_insufficient_params(self):
         response = self.client.get("/api/update-experiment-option/?key1=value1")
         self.assertEqual("key1=value1", response.request['QUERY_STRING'])
         self.assertEqual(400, response.status_code)
-        self.assertEqual("Missing request parameter detected: 'experiment_id'",
-                         response.json()['error'])
 
-    def test_update_observation_valid_pk(self):
+    def test_update_observation_option_valid_params(self):
         response = self.client.get("/api/update-observation-option/?observation_id=1")
         self.assertEqual("observation_id=1", response.request['QUERY_STRING'])
         self.assertEqual(200, response.status_code)
         self.assertTrue("groups" in response.json())
         self.assertTrue("variables" in response.json())
+        self.assertTrue("variablesMap" in response.json())
 
-    def test_update_observation_invalid_pk(self):
+    def test_update_observation_option_object_not_found(self):
         response = self.client.get("/api/update-observation-option/?observation_id=-1")
         self.assertEqual("observation_id=-1", response.request['QUERY_STRING'])
-        self.assertEqual(400, response.status_code)
-        self.assertEqual("Observations matching query does not exist.", response.json()['error'])
+        self.assertEqual(404, response.status_code)
 
-    def test_update_observation_bad_input(self):
+    def test_update_observation_option_value_error(self):
         response = self.client.get("/api/update-observation-option/?observation_id=~")
         self.assertEqual("observation_id=~", response.request['QUERY_STRING'])
         self.assertEqual(400, response.status_code)
-        self.assertEqual("Field 'observation_id' expected a number but got '~'.",
-                         response.json()['error'])
 
-    def test_update_observation_insufficient_params(self):
+    def test_update_observation_option_insufficient_params(self):
         response = self.client.get("/api/update-observation-option/")
         self.assertEqual("", response.request['QUERY_STRING'])
         self.assertEqual(400, response.status_code)
-        self.assertEqual("Missing request parameter detected: 'observation_id'",
-                         response.json()['error'])
 
-    def test_update_variable_valid_pk(self):
-        response = self.client.get("/api/update-variable-option/?variable_id=1")
-        self.assertEqual("variable_id=1", response.request['QUERY_STRING'])
+    def test_update_variable_option_valid_params(self):
+        response = self.client.get(
+            "/api/update-variable-option/?variable_name=brightnessTemperature&channel=4")
+        self.assertEqual("variable_name=brightnessTemperature"
+                         "&channel=4", response.request['QUERY_STRING'])
         self.assertEqual(200, response.status_code)
         self.assertTrue("groups" in response.json())
+        self.assertTrue("channel" in response.json())
 
-    def test_update_variable_invalid_pk(self):
-        response = self.client.get("/api/update-variable-option/?variable_id=-1")
-        self.assertEqual("variable_id=-1", response.request['QUERY_STRING'])
-        self.assertEqual(400, response.status_code)
-        self.assertEqual("Variables matching query does not exist.", response.json()['error'])
-
-    def test_update_variable_bad_input(self):
-        response = self.client.get("/api/update-variable-option/?variable_id=~")
-        self.assertEqual("variable_id=~", response.request['QUERY_STRING'])
-        self.assertEqual(400, response.status_code)
-        self.assertEqual("Field 'variable_id' expected a number but got '~'.",
-                         response.json()['error'])
+    def test_update_variable_option_object_not_found(self):
+        response = self.client.get(
+            "/api/update-variable-option/?variable_name=variable&channel=null")
+        self.assertEqual("variable_name=variable&channel=null", response.request['QUERY_STRING'])
+        self.assertEqual(404, response.status_code)
 
-    def test_update_variable_insufficient_params(self):
+    def test_update_variable_option_insufficient_params(self):
         response = self.client.get("/api/update-variable-option/")
         self.assertEqual("", response.request['QUERY_STRING'])
         self.assertEqual(400, response.status_code)
-        self.assertEqual("Missing request parameter detected: 'variable_id'",
-                         response.json()['error'])

src/evagram/website/backend/api/views.py

@@ -46,43 +46,60 @@ def get_plots_by_field(request):
         # invalid input
         if owner_id == "null":
             serializer = PlotSerializer(plots, many=True)
-            return Response(serializer.data)
+            return Response(
+                {"error": "Please specify a username. The 'null' value is not a valid username."},
+                status=400)
 
         # get plots by owner field
         elif experiment_id == "null":
             experiments = Experiments.objects.filter(owner_id=owner_id)
             plots = Plots.objects.filter(experiment_id__in=experiments)
 
-        # get plots by experiment field
-        elif observation_id == "null":
-            plots = Plots.objects.filter(experiment_id=experiment_id)
-
-        # get plots by observation field
-        elif variable_name == "null":
-            plots = Plots.objects.filter(experiment_id=experiment_id, observation_id=observation_id)
-
-        # get plots by variable field
-        elif group_id == "null":
-            # lookup variable id by variable name and channel
-            if channel == "null":
-                channel = None
-            variable_id = Variables.objects.get(
-                variable_name=variable_name, channel=channel).variable_id
-            plots = Plots.objects.filter(
-                experiment_id=experiment_id, observation_id=observation_id, variable_id=variable_id)
-
-        elif group_id != "":
-            if channel == "null":
-                channel = None
-            variable_id = Variables.objects.get(variable_name=variable_name, channel=channel)
-            plots = Plots.objects.filter(experiment=experiment_id,
-                                         group=group_id,
-                                         observation=observation_id,
-                                         variable_id=variable_id)
+        # check if owner and experiment are selected
+        if owner_id != "null" and experiment_id != "null":
+            # verify experiment is part of owner
+            experiments = Experiments.objects.filter(owner_id=owner_id)
+            current_experiment = Experiments.objects.get(experiment_id=experiment_id)
+            error_msg = ("The selected experiment cannot be found with the given username. "
+                         "Please make sure both the username and experiment exists "
+                         "and experiment is a part of that username.")
+            assert current_experiment in experiments, error_msg
+            # get plots by experiment field
+            if observation_id == "null":
+                plots = Plots.objects.filter(experiment_id=experiment_id)
+
+            # get plots by observation field
+            elif variable_name == "null":
+                plots = Plots.objects.filter(experiment_id=experiment_id,
+                                             observation_id=observation_id)
+
+            # get plots by variable field
+            elif group_id == "null":
+                # lookup variable id by variable name and channel
+                if channel == "null":
+                    channel = None
+                variable_id = Variables.objects.get(
+                    variable_name=variable_name, channel=channel).variable_id
+                plots = Plots.objects.filter(
+                    experiment_id=experiment_id,
+                    observation_id=observation_id,
+                    variable_id=variable_id)
+
+            elif group_id != "":
+                if channel == "null":
+                    channel = None
+                variable_id = Variables.objects.get(variable_name=variable_name, channel=channel)
+                plots = Plots.objects.filter(experiment=experiment_id,
+                                             group=group_id,
+                                             observation=observation_id,
+                                             variable_id=variable_id)
 
         serializer = PlotSerializer(plots, many=True)
         return Response(serializer.data)
 
+    except AssertionError as e:
+        return Response({"error": str(e)}, status=400)
+
     except ValueError as e:
         return Response({"error": str(e)}, status=400)
 
@@ -91,7 +108,7 @@ def get_plots_by_field(request):
         return Response({"error": error_msg}, status=400)
 
     except ObjectDoesNotExist as e:
-        return Response({"error": str(e)}, status=400)
+        return Response({"error": str(e)}, status=404)
 
 
 @api_view(['GET'])
@@ -124,7 +141,7 @@ def update_user_option(request):
         return Response({"error": error_msg}, status=400)
 
     except ObjectDoesNotExist as e:
-        return Response({"error": str(e)}, status=400)
+        return Response({"error": str(e)}, status=404)
 
 
 @api_view(['GET'])
@@ -153,7 +170,7 @@ def update_experiment_option(request):
         return Response({"error": error_msg}, status=400)
 
     except ObjectDoesNotExist as e:
-        return Response({"error": str(e)}, status=400)
+        return Response({"error": str(e)}, status=404)
 
 
 @api_view(['GET'])
@@ -184,7 +201,7 @@ def update_observation_option(request):
         return Response({"error": error_msg}, status=400)
 
     except ObjectDoesNotExist as e:
-        return Response({"error": str(e)}, status=400)
+        return Response({"error": str(e)}, status=404)
 
 
 @api_view(['GET'])
@@ -218,6 +235,11 @@ def update_variable_option(request):
         data["groups"] = get_groups_by_variable(variable_id)
         return Response(data)
 
+    except AssertionError as e:
+        error_msg = ("Unable to locate the given variable name. "
+                     "Make sure a channel option is selected if exists.")
+        return Response({"error": error_msg}, status=404)
+
     except ValueError as e:
         return Response({"error": str(e)}, status=400)
 
@@ -226,7 +248,7 @@ def update_variable_option(request):
         return Response({"error": error_msg}, status=400)
 
     except ObjectDoesNotExist as e:
-        return Response({"error": str(e)}, status=400)
+        return Response({"error": str(e)}, status=404)
 
 
 def get_owners():