Merge pull request ceph#66008 from afreen23/fix-timezone-format

mgr/dashboard: Fix timestamps in APIs

Reviewed-by: Ernesto Puerta <[email protected]>

Author: afreen23

src/pybind/mgr/dashboard/controllers/rbd.py

@@ -4,7 +4,7 @@
 
 import logging
 import math
-from datetime import datetime
+from datetime import datetime, timezone
 from functools import partial
 from typing import Any, Dict
 
@@ -347,9 +347,8 @@ def _trash_pool_list(self, pool_name):
                 for trash in images:
                     trash['pool_name'] = pool_name
                     trash['namespace'] = namespace
-                    trash['deletion_time'] = "{}Z".format(trash['deletion_time'].isoformat())
-                    trash['deferment_end_time'] = "{}Z".format(
-                        trash['deferment_end_time'].isoformat())
+                    trash['deletion_time'] = trash['deletion_time'].isoformat()
+                    trash['deferment_end_time'] = trash['deferment_end_time'].isoformat()
                     result.append(trash)
             return result
 
@@ -385,7 +384,7 @@ def list(self, pool_name=None):
     @allow_empty_body
     def purge(self, pool_name=None):
         """Remove all expired images from trash."""
-        now = "{}Z".format(datetime.utcnow().isoformat())
+        now = datetime.now(timezone.utc).isoformat()
         pools = self._trash_list(pool_name)
 
         for pool in pools:

src/pybind/mgr/dashboard/services/progress.py

@@ -9,7 +9,7 @@
 
 
 import logging
-from datetime import datetime
+from datetime import datetime, timezone
 
 from .. import mgr
 from . import rbd  # pylint: disable=no-name-in-module
@@ -40,8 +40,8 @@ def _progress_event_to_dashboard_task_common(event, task):
             task.update({
                 'name': "rbd/{}".format(action),
                 'metadata': metadata,
-                'begin_time': "{}Z".format(datetime.fromtimestamp(event["started_at"])
-                                           .isoformat()),
+                'begin_time': datetime.fromtimestamp(
+                    event["started_at"], tz=timezone.utc).isoformat(),
             })
             return
 
@@ -50,8 +50,8 @@ def _progress_event_to_dashboard_task_common(event, task):
         # from the progress module
         'name': "progress/{}".format(event['message']),
         'metadata': dict(event.get('refs', {})),
-        'begin_time': "{}Z".format(datetime.fromtimestamp(event["started_at"])
-                                   .isoformat()),
+        'begin_time': datetime.fromtimestamp(
+            event["started_at"], tz=timezone.utc).isoformat(),
     })
 
 
@@ -64,8 +64,8 @@ def _progress_event_to_dashboard_task(event, completed=False):
         })
     else:
         task.update({
-            'end_time': "{}Z".format(datetime.fromtimestamp(event['finished_at'])
-                                     .isoformat()),
+            'end_time': datetime.fromtimestamp(
+                event['finished_at'], tz=timezone.utc).isoformat(),
             'duration': event['finished_at'] - event['started_at'],
             'progress': 100,
             'success': 'failed' not in event,

src/pybind/mgr/dashboard/services/rbd.py

@@ -349,8 +349,7 @@ def _rbd_image(cls, ioctx, pool_name, namespace, image_name,  # pylint: disable=
             del stat['parent_pool']
             del stat['parent_name']
 
-            stat['timestamp'] = "{}Z".format(img.create_timestamp()
-                                             .isoformat())
+            stat['timestamp'] = img.create_timestamp().isoformat()
 
             stat['stripe_count'] = img.stripe_count()
             stat['stripe_unit'] = img.stripe_unit()
@@ -373,8 +372,7 @@ def _rbd_image(cls, ioctx, pool_name, namespace, image_name,  # pylint: disable=
                 if mirror_mode:
                     snap['mirror_mode'] = mirror_mode
 
-                snap['timestamp'] = "{}Z".format(
-                    img.get_snap_timestamp(snap['id']).isoformat())
+                snap['timestamp'] = img.get_snap_timestamp(snap['id']).isoformat()
 
                 snap['is_protected'] = None
                 if snap['namespace'] == rbd.RBD_SNAP_NAMESPACE_TYPE_USER:
@@ -471,8 +469,8 @@ def _rbd_image_stat_removing(cls, ioctx, pool_name, namespace, image_id):
             img['unique_id'] = img_spec
             img['pool_name'] = pool_name
             img['namespace'] = namespace
-            img['deletion_time'] = "{}Z".format(img['deletion_time'].isoformat())
-            img['deferment_end_time'] = "{}Z".format(img['deferment_end_time'].isoformat())
+            img['deletion_time'] = img['deletion_time'].isoformat()
+            img['deferment_end_time'] = img['deferment_end_time'].isoformat()
             return img
         raise rbd.ImageNotFound('No image {} in status `REMOVING` found.'.format(img_spec),
                                 errno=errno.ENOENT)

src/pybind/mgr/dashboard/tests/test_rbd_service.py

@@ -78,8 +78,8 @@ def test_rbd_image_stat_removing(self):
             'unique_id': 'test_pool/3c1a5ee60a88',
             'name': 'test_rbd',
             'source': 'REMOVING',
-            'deletion_time': '{}Z'.format(time.isoformat()),
-            'deferment_end_time': '{}Z'.format(time.isoformat()),
+            'deletion_time': time.isoformat(),
+            'deferment_end_time': time.isoformat(),
             'pool_name': 'test_pool',
             'namespace': ''
         })
@@ -124,8 +124,8 @@ def test_rbd_pool_list(self, rbd_image_ref_mock, rbd_image_stat_mock,
             'unique_id': 'test_pool/3c1a5ee60a88',
             'name': 'test_rbd',
             'source': 'REMOVING',
-            'deletion_time': '{}Z'.format(time.isoformat()),
-            'deferment_end_time': '{}Z'.format(time.isoformat()),
+            'deletion_time': time.isoformat(),
+            'deferment_end_time': time.isoformat(),
             'pool_name': 'test_pool',
             'namespace': ''
         }
@@ -142,8 +142,8 @@ def test_rbd_pool_list(self, rbd_image_ref_mock, rbd_image_stat_mock,
             'unique_id': 'test_pool/3c1a5ee60a88',
             'name': 'test_rbd',
             'source': 'REMOVING',
-            'deletion_time': '{}Z'.format(time.isoformat()),
-            'deferment_end_time': '{}Z'.format(time.isoformat()),
+            'deletion_time': time.isoformat(),
+            'deferment_end_time': time.isoformat(),
             'pool_name': 'test_pool',
             'namespace': ''
         }], 1))

src/pybind/mgr/dashboard/tools.py

@@ -8,7 +8,7 @@
 import threading
 import time
 import urllib
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 
 import cherrypy
 from ceph.utils import strtobool
@@ -491,13 +491,13 @@ def list_serializable(cls, ns_glob=None):
         return [{
             'name': t.name,
             'metadata': t.metadata,
-            'begin_time': "{}Z".format(datetime.fromtimestamp(t.begin_time).isoformat()),
+            'begin_time': datetime.fromtimestamp(t.begin_time, tz=timezone.utc).isoformat(),
             'progress': t.progress
         } for t in ex_t if t.begin_time], [{
             'name': t.name,
             'metadata': t.metadata,
-            'begin_time': "{}Z".format(datetime.fromtimestamp(t.begin_time).isoformat()),
-            'end_time': "{}Z".format(datetime.fromtimestamp(t.end_time).isoformat()),
+            'begin_time': datetime.fromtimestamp(t.begin_time, tz=timezone.utc).isoformat(),
+            'end_time': datetime.fromtimestamp(t.end_time, tz=timezone.utc).isoformat(),
             'duration': t.duration,
             'progress': t.progress,
             'success': not t.exception,