Merge pull request #4275 from betagouv/raphodn/api-diagnostic-create-year-field-mandatory

API : Rendre le champ Diagnostic.year obligatoire à la création

Author: raphodn

api/serializers/diagnostic.py

@@ -79,6 +79,8 @@
 
 FIELDS = META_FIELDS + SIMPLE_APPRO_FIELDS + COMPLETE_APPRO_FIELDS + NON_APPRO_FIELDS
 
+REQUIRED_FIELDS = ("year",)
+
 
 class DiagnosticSerializer(serializers.ModelSerializer):
     def to_representation(self, instance):
@@ -189,7 +191,10 @@ class Meta:
     def __init__(self, *args, **kwargs):
         action = kwargs.pop("action", None)
         super().__init__(*args, **kwargs)
-        if action != "create":
+        if action == "create":
+            for field in REQUIRED_FIELDS:
+                self.fields[field].required = True
+        else:
             self.fields.pop("creation_mtm_source")
             self.fields.pop("creation_mtm_campaign")
             self.fields.pop("creation_mtm_medium")

api/tests/test_diagnostics.py

@@ -16,15 +16,17 @@ def test_unauthenticated_create_diagnostic_call(self):
         When calling this API unathenticated we expect a 403
         """
         canteen = CanteenFactory.create()
-        response = self.client.post(reverse("diagnostic_creation", kwargs={"canteen_pk": canteen.id}), {})
+        payload = {"year": 2020}
+        response = self.client.post(reverse("diagnostic_creation", kwargs={"canteen_pk": canteen.id}), payload)
         self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
 
     @authenticate
     def test_diagnostic_missing_canteen(self):
         """
         When calling this API on an unexistent canteen we expect a 404
         """
-        response = self.client.post(reverse("diagnostic_creation", kwargs={"canteen_pk": 999}), {})
+        payload = {"year": 2020}
+        response = self.client.post(reverse("diagnostic_creation", kwargs={"canteen_pk": 999}), payload)
         self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
 
     @authenticate
@@ -34,11 +36,41 @@ def test_diagnostic_forbidden_canteen(self):
         we expect a 403
         """
         canteen = CanteenFactory.create()
-        response = self.client.post(reverse("diagnostic_creation", kwargs={"canteen_pk": canteen.id}), {})
+        payload = {"year": 2020}
+        response = self.client.post(reverse("diagnostic_creation", kwargs={"canteen_pk": canteen.id}), payload)
         self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
 
     @authenticate
-    def test_create_diagnostic(self):
+    def test_create_empty_diagnostic_error(self):
+        """
+        When calling this API on a canteen that the user manages
+        we need to provide the required field(s)
+        """
+        canteen = CanteenFactory.create()
+        canteen.managers.add(authenticate.user)
+
+        payload = {}
+
+        response = self.client.post(reverse("diagnostic_creation", kwargs={"canteen_pk": canteen.id}), payload)
+        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+
+    @authenticate
+    def test_create_minimal_diagnostic(self):
+        """
+        When calling this API on a canteen that the user manages
+        we expect a diagnostic to be created
+        (minimal required fields)
+        """
+        canteen = CanteenFactory.create()
+        canteen.managers.add(authenticate.user)
+
+        payload = {"year": 2020}
+
+        response = self.client.post(reverse("diagnostic_creation", kwargs={"canteen_pk": canteen.id}), payload)
+        self.assertEqual(response.status_code, status.HTTP_201_CREATED)
+
+    @authenticate
+    def test_create_full_diagnostic(self):
         """
         When calling this API on a canteen that the user manages
         we expect a diagnostic to be created
@@ -249,17 +281,13 @@ def test_create_duplicate_diagnostic(self):
         """
         canteen = CanteenFactory.create()
         canteen.managers.add(authenticate.user)
-        self.client.post(
-            reverse("diagnostic_creation", kwargs={"canteen_pk": canteen.id}),
-            {"year": 2020, "value_bio_ht": 10},
-        )
 
-        payload = {
-            "year": 2020,
-            "value_bio_ht": 1000,
-        }
+        payload = {"year": 2020, "value_bio_ht": 10}
+        self.client.post(reverse("diagnostic_creation", kwargs={"canteen_pk": canteen.id}), payload)
+
         try:
             with transaction.atomic():
+                payload = {"year": 2020, "value_bio_ht": 1000}
                 response = self.client.post(
                     reverse("diagnostic_creation", kwargs={"canteen_pk": canteen.id}),
                     payload,
@@ -291,10 +319,10 @@ def test_create_diagnostic_bad_total(self):
     @authenticate
     def test_edit_diagnostic_unauthorized(self):
         """
-        The user can only edit diagnostics of canteens they
-        manage
+        The user can only edit diagnostics of canteens they manage
         """
-        diagnostic = DiagnosticFactory.create()
+        diagnostic = DiagnosticFactory.create(year=2019)
+
         payload = {"year": 2020}
 
         response = self.client.patch(
@@ -304,7 +332,10 @@ def test_edit_diagnostic_unauthorized(self):
             ),
             payload,
         )
+        diagnostic.refresh_from_db()
+
         self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
+        self.assertEqual(diagnostic.year, 2019)
 
     @authenticate
     def test_edit_diagnostic(self):
@@ -313,6 +344,7 @@ def test_edit_diagnostic(self):
         """
         diagnostic = DiagnosticFactory.create(year=2019)
         diagnostic.canteen.managers.add(authenticate.user)
+
         payload = {"year": 2020}
 
         response = self.client.patch(
@@ -327,10 +359,11 @@ def test_edit_diagnostic(self):
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         self.assertEqual(diagnostic.year, 2020)
 
-    def test_modify_diagnostic_via_oauth2(self):
+    def test_edit_diagnostic_via_oauth2(self):
         user, token = get_oauth2_token("canteen:write")
         diagnostic = DiagnosticFactory.create(year=2019)
         diagnostic.canteen.managers.add(user)
+
         payload = {"year": 2020}
 
         self.client.credentials(Authorization=f"Bearer {token}")
@@ -447,7 +480,6 @@ def test_edit_cancelled_diagnostic(self):
             ),
             payload,
         )
-
         diagnostic.refresh_from_db()
 
         self.assertEqual(response.status_code, status.HTTP_200_OK)
@@ -579,6 +611,7 @@ def test_total_leftovers_conversion_create_diagnostic(self):
         canteen.managers.add(authenticate.user)
 
         payload = {
+            "year": 2020,
             "total_leftovers": 1234.56,
         }
         response = self.client.post(