fix(controller): standardize API datetime field format

This brings the datetime field's formatting more in line with the rest
of the platform.

Author: Matthew Fisher

controller/api/models.py

@@ -128,7 +128,8 @@ def log(self, message):
         existing logging configurations.
         """
         with open(os.path.join(settings.DEIS_LOG_DIR, self.id + '.log'), 'a') as f:
-            msg = "{} deis[api]: {}\n".format(time.strftime('%Y-%m-%d %H:%M:%S'), message)
+            msg = "{} deis[api]: {}\n".format(time.strftime(settings.DEIS_DATETIME_FORMAT),
+                                              message)
             f.write(msg.encode('utf-8'))
 
     def create(self, *args, **kwargs):

controller/api/serializers.py

@@ -80,11 +80,12 @@ class AppSerializer(serializers.ModelSerializer):
     id = serializers.SlugField(default=utils.generate_app_name)
     url = serializers.Field(source='url')
     structure = JSONFieldSerializer(source='structure', required=False)
+    created = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
+    updated = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
 
     class Meta:
         """Metadata options for a :class:`AppSerializer`."""
         model = models.App
-        read_only_fields = ('created', 'updated')
 
     def validate_id(self, attrs, source):
         """
@@ -105,11 +106,13 @@ class BuildSerializer(serializers.ModelSerializer):
     owner = serializers.Field(source='owner.username')
     app = serializers.SlugRelatedField(slug_field='id')
     procfile = JSONFieldSerializer(source='procfile', required=False)
+    created = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
+    updated = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
 
     class Meta:
         """Metadata options for a :class:`BuildSerializer`."""
         model = models.Build
-        read_only_fields = ('uuid', 'created', 'updated')
+        read_only_fields = ('uuid',)
 
 
 class ConfigSerializer(serializers.ModelSerializer):
@@ -121,11 +124,13 @@ class ConfigSerializer(serializers.ModelSerializer):
     memory = JSONFieldSerializer(source='memory', required=False)
     cpu = JSONFieldSerializer(source='cpu', required=False)
     tags = JSONFieldSerializer(source='tags', required=False)
+    created = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
+    updated = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
 
     class Meta:
         """Metadata options for a :class:`ConfigSerializer`."""
         model = models.Config
-        read_only_fields = ('uuid', 'created', 'updated')
+        read_only_fields = ('uuid',)
 
     def validate_memory(self, attrs, source):
         for k, v in attrs.get(source, {}).items():
@@ -174,11 +179,13 @@ class ReleaseSerializer(serializers.ModelSerializer):
     app = serializers.SlugRelatedField(slug_field='id')
     config = serializers.SlugRelatedField(slug_field='uuid')
     build = serializers.SlugRelatedField(slug_field='uuid')
+    created = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
+    updated = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
 
     class Meta:
         """Metadata options for a :class:`ReleaseSerializer`."""
         model = models.Release
-        read_only_fields = ('uuid', 'created', 'updated')
+        read_only_fields = ('uuid',)
 
 
 class ContainerSerializer(serializers.ModelSerializer):
@@ -187,11 +194,12 @@ class ContainerSerializer(serializers.ModelSerializer):
     owner = serializers.Field(source='owner.username')
     app = OwnerSlugRelatedField(slug_field='id')
     release = serializers.SlugRelatedField(slug_field='uuid')
+    created = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
+    updated = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
 
     class Meta:
         """Metadata options for a :class:`ContainerSerializer`."""
         model = models.Container
-        read_only_fields = ('created', 'updated')
 
     def transform_release(self, obj, value):
         return "v{}".format(obj.release.version)
@@ -201,24 +209,26 @@ class KeySerializer(serializers.ModelSerializer):
     """Serialize a :class:`~api.models.Key` model."""
 
     owner = serializers.Field(source='owner.username')
+    created = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
+    updated = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
 
     class Meta:
         """Metadata options for a KeySerializer."""
         model = models.Key
-        read_only_fields = ('created', 'updated')
 
 
 class DomainSerializer(serializers.ModelSerializer):
     """Serialize a :class:`~api.models.Domain` model."""
 
     owner = serializers.Field(source='owner.username')
     app = serializers.SlugRelatedField(slug_field='id')
+    created = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
+    updated = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
 
     class Meta:
         """Metadata options for a :class:`DomainSerializer`."""
         model = models.Domain
         fields = ('domain', 'owner', 'created', 'updated', 'app')
-        read_only_fields = ('created', 'updated')
 
     def validate_domain(self, attrs, source):
         """
@@ -250,8 +260,10 @@ class PushSerializer(serializers.ModelSerializer):
 
     owner = serializers.Field(source='owner.username')
     app = serializers.SlugRelatedField(slug_field='id')
+    created = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
+    updated = serializers.DateTimeField(format=settings.DEIS_DATETIME_FORMAT, read_only=True)
 
     class Meta:
         """Metadata options for a :class:`PushSerializer`."""
         model = models.Push
-        read_only_fields = ('uuid', 'created', 'updated')
+        read_only_fields = ('uuid',)

controller/deis/settings.py

@@ -256,6 +256,9 @@
 DEFAULT_BUILD = 'deis/helloworld'
 DEIS_DOMAIN = 'deisapp.local'
 
+# standard datetime format used for logging, model timestamps, etc.
+DEIS_DATETIME_FORMAT = '%Y-%m-%d %H:%M:%S'
+
 # default scheduler settings
 SCHEDULER_MODULE = 'mock'
 SCHEDULER_TARGET = ''  # path to scheduler endpoint (e.g. /var/run/fleet.sock)