Merge #1581

1581: Expose enable_state id in v3 API r=rehandalal a=mythmon

The `carry_over` field of `EnabledStateSerializer` gives back an ID, but the ID of enabled states wasn't exposed anymore. This fixes that, and also adds a test.

Co-authored-by: Mike Cooper <[email protected]>

Author: bors[bot]

normandy/base/tests/__init__.py

@@ -29,9 +29,13 @@ def contains(cls, *values):
     @classmethod
     def iso8601(cls):
         def is_iso8601_date(s):
-            # Will throw is it does not match
-            datetime.strptime(s, "%Y-%m-%dT%H:%M:%S.%fZ")
-            return True
+            if not isinstance(s, str):
+                return False
+            try:
+                datetime.strptime(s, "%Y-%m-%dT%H:%M:%S.%fZ")
+                return True
+            except ValueError:
+                return False
 
         return cls(is_iso8601_date, name="datetime")
 

normandy/recipes/api/v3/serializers.py

@@ -52,7 +52,7 @@ class EnabledStateSerializer(CustomizableSerializerMixin, serializers.ModelSeria
 
     class Meta:
         model = EnabledState
-        fields = ["revision_id", "created", "creator", "enabled", "carryover_from"]
+        fields = ["id", "revision_id", "created", "creator", "enabled", "carryover_from"]
 
 
 class RecipeRevisionSerializer(serializers.ModelSerializer):

normandy/recipes/tests/__init__.py

@@ -4,7 +4,7 @@
 
 import factory
 
-from normandy.base.tests import FuzzyUnicode
+from normandy.base.tests import FuzzyUnicode, UserFactory
 from normandy.base.utils import sri_hash
 from normandy.recipes.models import (
     Action,
@@ -169,6 +169,7 @@ class EnabledStateFactory(factory.DjangoModelFactory):
     class Meta:
         model = EnabledState
 
+    creator = factory.SubFactory(UserFactory)
     revision = factory.SubFactory(RecipeRevisionFactory)
 
 

normandy/recipes/tests/api/v3/test_serializers.py

@@ -1,6 +1,7 @@
 import pytest
 from rest_framework import serializers
 
+from normandy.base.tests import UserFactory, Whatever
 from normandy.recipes.tests import (
     ARGUMENTS_SCHEMA,
     ActionFactory,
@@ -9,6 +10,7 @@
 )
 from normandy.recipes.api.v3.serializers import (
     ActionSerializer,
+    EnabledStateSerializer,
     RecipeRevisionSerializer,
     RecipeSerializer,
 )
@@ -181,3 +183,55 @@ def test_it_uses_cdn_url(self, rf, settings):
         action = ActionFactory()
         serializer = ActionSerializer(action, context={"request": rf.get("/")})
         assert serializer.data["implementation_url"].startswith(settings.CDN_URL)
+
+
+@pytest.mark.django_db()
+class TestEnabledStateSerializer:
+    def test_it_works(self):
+        author = UserFactory()
+        reviewer = UserFactory()
+
+        recipe = RecipeFactory(name="first", user=author)
+        revision1 = recipe.latest_revision
+        approval_request = revision1.request_approval(author)
+        approval_request.approve(reviewer, "r+")
+        revision1.enable(author)
+        state1 = revision1.enabled_state
+        assert state1 is not None
+
+        recipe.revise("second", user=author)
+        revision2 = recipe.latest_revision
+        approval_request = revision2.request_approval(author)
+        approval_request.approve(reviewer, "r+")
+        state2 = revision2.enabled_state
+        assert state2 is not None
+
+        serializer = EnabledStateSerializer(state1)
+        assert serializer.data == {
+            "id": state1.id,
+            "carryover_from": None,
+            "created": Whatever.iso8601(),
+            "creator": {
+                "id": author.id,
+                "first_name": author.first_name,
+                "last_name": author.last_name,
+                "email": author.email,
+            },
+            "enabled": True,
+            "revision_id": revision1.id,
+        }
+
+        serializer = EnabledStateSerializer(state2)
+        assert serializer.data == {
+            "id": state2.id,
+            "carryover_from": state1.id,
+            "created": Whatever.iso8601(),
+            "creator": {
+                "id": reviewer.id,
+                "first_name": reviewer.first_name,
+                "last_name": reviewer.last_name,
+                "email": reviewer.email,
+            },
+            "enabled": True,
+            "revision_id": revision2.id,
+        }