Refactor update creation api

This merge request does the following:

• Raise DRF errors rather than returning response to take advantage of the DRF exception handling mechanism
• Create serialisers for PUT request to simplify the code
• Improve validation checks in several places
• Fixes several issues in DRF infrastructure uses
• Fixes JSON fields handling
• Remove routes that do no fully qualify objects
• Implement a custom DRF exception handler that will allow to log errors
• Improve testing
• Improve permission management

beat/web/dataformats/tests/tests_api.py

@@ -519,9 +519,10 @@ class DataFormatUpdate(DataFormatsAPIBase):
 
     def test_no_update_without_content(self):
         self.login_jackdoe()
-        url = reverse("api_dataformats:object", args=["jackdoe", "format2"])
+        url = reverse("api_dataformats:object", args=["jackdoe", "format2", 1])
         response = self.client.put(url)
-        self.checkResponse(response, 400)
+
+        self.checkResponse(response, 200, content_type="application/json")
 
     def test_fail_to_update_a_shared_dataformat(self):
         self.login_johndoe()
@@ -536,7 +537,7 @@ class DataFormatUpdate(DataFormatsAPIBase):
 
         self.checkResponse(response, 403)
 
-    def test_successfull_update(self):
+    def test_successful_update(self):
         self.login_johndoe()
 
         response = self.client.put(
@@ -545,7 +546,7 @@ class DataFormatUpdate(DataFormatsAPIBase):
             content_type="application/json",
         )
 
-        self.checkResponse(response, 204)
+        self.checkResponse(response, 200, content_type="application/json")
 
         dataformat = DataFormat.objects.get(
             author__username="johndoe", name="format_private"
@@ -558,7 +559,38 @@ class DataFormatUpdate(DataFormatsAPIBase):
             declaration = json.load(f)
         self.assertEqual(declaration["value"], "float64")
 
-    def test_successfull_update_of_description_only(self):
+    def test_successful_update_with_specific_return_field(self):
+        self.login_johndoe()
+
+        response = self.client.put(
+            self.url,
+            json.dumps({"description": "blah", "declaration": {"value": "float64"}}),
+            content_type="application/json",
+            QUERY_STRING="fields=description",
+        )
+
+        self.checkResponse(response, 200, content_type="application/json")
+        answer = response.json()
+        self.assertEqual(len(answer), 1)
+        self.assertTrue("description" in answer)
+
+    def test_successful_update_with_specific_return_several_fields(self):
+        self.login_johndoe()
+
+        response = self.client.put(
+            self.url,
+            json.dumps({"description": "blah", "declaration": {"value": "float64"}}),
+            content_type="application/json",
+            QUERY_STRING="fields=declaration,description",
+        )
+
+        self.checkResponse(response, 200, content_type="application/json")
+        answer = response.json()
+        self.assertEqual(len(answer), 2)
+        self.assertTrue("declaration" in answer)
+        self.assertTrue("description" in answer)
+
+    def test_successful_update_of_description_only(self):
         self.login_johndoe()
 
         response = self.client.put(
@@ -567,12 +599,12 @@ class DataFormatUpdate(DataFormatsAPIBase):
             content_type="application/json",
         )
 
-        self.checkResponse(response, 204)
+        self.checkResponse(response, 200, content_type="application/json")
 
         dataformat = DataFormat.objects.get(author__username="johndoe", name="format1")
         self.assertEqual(dataformat.description, b"blah")
 
-    def test_successfull_update_of_declaration_only(self):
+    def test_successful_update_of_declaration_only(self):
         self.login_johndoe()
 
         response = self.client.put(
@@ -581,7 +613,7 @@ class DataFormatUpdate(DataFormatsAPIBase):
             content_type="application/json",
         )
 
-        self.checkResponse(response, 204)
+        self.checkResponse(response, 200, content_type="application/json")
 
         dataformat = DataFormat.objects.get(
             author__username="johndoe", name="format_private"
@@ -593,7 +625,7 @@ class DataFormatUpdate(DataFormatsAPIBase):
             declaration = json.load(f)
         self.assertEqual(declaration["value"], "float64")
 
-    def test_successfull_update_of_declaration__extension_addition(self):
+    def test_successful_update_of_declaration__extension_addition(self):
         self.login_johndoe()
 
         (dataformat, errors) = DataFormat.objects.create_dataformat(
@@ -612,7 +644,7 @@ class DataFormatUpdate(DataFormatsAPIBase):
             content_type="application/json",
         )
 
-        self.checkResponse(response, 204)
+        self.checkResponse(response, 200, content_type="application/json")
 
         dataformat = DataFormat.objects.get(
             author__username="johndoe", name="format_private", version=1
@@ -629,7 +661,7 @@ class DataFormatUpdate(DataFormatsAPIBase):
         self.assertEqual(declaration["value"], "float64")
         self.assertEqual(declaration["#extends"], "johndoe/format4/1")
 
-    def test_successfull_update_of_declaration__extension_removal(self):
+    def test_successful_update_of_declaration__extension_removal(self):
         self.login_johndoe()
 
         (dataformat, errors) = DataFormat.objects.create_dataformat(
@@ -646,7 +678,7 @@ class DataFormatUpdate(DataFormatsAPIBase):
             content_type="application/json",
         )
 
-        self.checkResponse(response, 204)
+        self.checkResponse(response, 200, content_type="application/json")
 
         dataformat = DataFormat.objects.get(
             author__username="johndoe", name="format4", version=1
@@ -655,7 +687,7 @@ class DataFormatUpdate(DataFormatsAPIBase):
         self.assertTrue(dataformat.extend is None)
         self.assertEqual(dataformat.referenced_formats.count(), 0)
 
-    def test_successfull_update_of_declaration__extension_keeping(self):
+    def test_successful_update_of_declaration__extension_keeping(self):
         self.login_johndoe()
 
         (dataformat, errors) = DataFormat.objects.create_dataformat(
@@ -674,7 +706,7 @@ class DataFormatUpdate(DataFormatsAPIBase):
             content_type="application/json",
         )
 
-        self.checkResponse(response, 204)
+        self.checkResponse(response, 200, content_type="application/json")
 
         dataformat = DataFormat.objects.get(
             author__username="johndoe", name="format4", version=1
@@ -684,7 +716,7 @@ class DataFormatUpdate(DataFormatsAPIBase):
         self.assertEqual(dataformat.extend.name, "format1")
         self.assertEqual(dataformat.referenced_formats.count(), 0)
 
-    def test_successfull_update_of_declaration__composition_addition(self):
+    def test_successful_update_of_declaration__composition_addition(self):
         self.login_johndoe()
 
         (dataformat, errors) = DataFormat.objects.create_dataformat(
@@ -703,7 +735,7 @@ class DataFormatUpdate(DataFormatsAPIBase):
             content_type="application/json",
         )
 
-        self.checkResponse(response, 204)
+        self.checkResponse(response, 200, content_type="application/json")
 
         dataformat = DataFormat.objects.get(
             author__username="johndoe", name="format_private", version=1
@@ -723,7 +755,7 @@ class DataFormatUpdate(DataFormatsAPIBase):
         self.assertEqual(declaration["value"], "float64")
         self.assertEqual(declaration["field1"], "johndoe/format4/1")
 
-    def test_successfull_update_of_declaration__composition_removal(self):
+    def test_successful_update_of_declaration__composition_removal(self):
         self.login_johndoe()
 
         (dataformat, errors) = DataFormat.objects.create_dataformat(
@@ -740,7 +772,7 @@ class DataFormatUpdate(DataFormatsAPIBase):
             content_type="application/json",
         )
 
-        self.checkResponse(response, 204)
+        self.checkResponse(response, 200, content_type="application/json")
 
         dataformat = DataFormat.objects.get(
             author__username="johndoe", name="format4", version=1
@@ -749,7 +781,7 @@ class DataFormatUpdate(DataFormatsAPIBase):
         self.assertTrue(dataformat.extend is None)
         self.assertEqual(dataformat.referenced_formats.count(), 0)
 
-    def test_successfull_update_of_declaration__composition_keeping(self):
+    def test_successful_update_of_declaration__composition_keeping(self):
         self.login_johndoe()
 
         (dataformat, errors) = DataFormat.objects.create_dataformat(
@@ -768,7 +800,7 @@ class DataFormatUpdate(DataFormatsAPIBase):
             content_type="application/json",
         )
 
-        self.checkResponse(response, 204)
+        self.checkResponse(response, 200, content_type="application/json")
 
         dataformat = DataFormat.objects.get(
             author__username="johndoe", name="format4", version=1
@@ -960,7 +992,7 @@ class DataFormatDeletion(DataFormatsAPIBase):
         self.login_johndoe()
         url = reverse("api_dataformats:object", args=["johndoe", "format1", 1])
         response = self.client.delete(url)
-        self.checkResponse(response, 403)
+        self.checkResponse(response, 405)
 
     def test_no_deletion_of_not_owned_format(self):
         self.login_jackdoe()
@@ -1665,7 +1697,7 @@ class NotSharedDataFormat_ExtensionOfPublicForOneUserFormat_SharingAPI(
             self.url, json.dumps({}), content_type="application/json"
         )
 
-        data = self.checkResponse(response, 400, content_type="application/json")
+        data = self.checkResponse(response, 403, content_type="application/json")
 
         self.assertTrue(isinstance(data, list))
         self.assertTrue(len(data) > 0)
@@ -1699,7 +1731,7 @@ class NotSharedDataFormat_ExtensionOfPublicForOneUserFormat_SharingAPI(
             content_type="application/json",
         )
 
-        data = self.checkResponse(response, 400, content_type="application/json")
+        data = self.checkResponse(response, 403, content_type="application/json")
 
         self.assertTrue(isinstance(data, list))
         self.assertTrue(len(data) > 0)
@@ -1713,7 +1745,7 @@ class NotSharedDataFormat_ExtensionOfPublicForOneUserFormat_SharingAPI(
             content_type="application/json",
         )
 
-        data = self.checkResponse(response, 400, content_type="application/json")
+        data = self.checkResponse(response, 403, content_type="application/json")
 
         self.assertTrue(isinstance(data, list))
         self.assertTrue(len(data) > 0)
@@ -1727,7 +1759,7 @@ class NotSharedDataFormat_ExtensionOfPublicForOneUserFormat_SharingAPI(
             content_type="application/json",
         )
 
-        data = self.checkResponse(response, 400, content_type="application/json")
+        data = self.checkResponse(response, 403, content_type="application/json")
 
         self.assertTrue(isinstance(data, list))
         self.assertTrue(len(data) > 0)
@@ -1741,7 +1773,7 @@ class NotSharedDataFormat_ExtensionOfPublicForOneUserFormat_SharingAPI(
             content_type="application/json",
         )
 
-        data = self.checkResponse(response, 400, content_type="application/json")
+        data = self.checkResponse(response, 403, content_type="application/json")
 
         self.assertTrue(isinstance(data, list))
         self.assertTrue(len(data) > 0)