Merge pull request #181 from EC-DIGIT-CSIRC/sysdiagnose_date

chg: [init] sysdiagnose date in UTC, not local time.

Author: cvandeplas

src/sysdiagnose/__init__.py

@@ -6,6 +6,7 @@
 import os
 import re
 import tarfile
+from datetime import timezone
 from sysdiagnose.utils.base import BaseInterface, BaseParserInterface, BaseAnalyserInterface, SysdiagnoseConfig
 from sysdiagnose.utils.logger import set_json_logging, logger
 from io import TextIOWrapper
@@ -178,13 +179,14 @@ def create_case(self, sysdiagnose_file: str, force: bool = False, case_id: bool
         return case
 
     @staticmethod
-    def get_case_metadata(source_file: str) -> str:
+    def get_case_metadata(source_file: str) -> dict | None:
         """
-        Returns the sha256 hash of the sysdiagnose source file/folder.
-        The hash is calculated by concatenating the contents of the case metadata: udid, serial, ios version and date.
+        Returns the metadata related to the given sysdiagnose file/folder.
+        This includes serial number, unique device ID, iOS version, model, date of sysdiagnose creation,
+        and a case ID based on the serial number and date.
 
         :param source_file: Path to the sysdiagnose file/folder
-        :return: sha256 hash of the file/folder
+        :return: dictionary with metadata or None if the file is invalid
         """
         from sysdiagnose.parsers.remotectl_dumpstate import RemotectlDumpstateParser
         from sysdiagnose.parsers.sys import SystemVersionParser
@@ -239,7 +241,8 @@ def get_case_metadata(source_file: str) -> str:
             return None
 
         # Time to obtain the metadata
-
+        # Turn the sysdiagnose date into UTC
+        sysdiagnose_date_utc = sysdiagnose_date.astimezone(timezone.utc)
         if remotectl_dumpstate_json and 'error' not in remotectl_dumpstate_json:
             if 'Local device' in remotectl_dumpstate_json:
                 try:
@@ -249,8 +252,8 @@ def get_case_metadata(source_file: str) -> str:
                         'unique_device_id': remotectl_dumpstate_json['Local device']['Properties']['UniqueDeviceID'],
                         'ios_version': remotectl_dumpstate_json['Local device']['Properties']['OSVersion'],
                         'model': remotectl_dumpstate_json['Local device']['Properties']['ProductType'],
-                        'date': sysdiagnose_date.isoformat(timespec='microseconds'),
-                        'case_id': f"{serial_number}_{sysdiagnose_date.strftime('%Y%m%d_%H%M%S')}",
+                        'date': sysdiagnose_date_utc.isoformat(timespec='microseconds'),
+                        'case_id': f"{serial_number}_{sysdiagnose_date_utc.strftime('%Y%m%d_%H%M%S')}",
                         'source_file': source_file,
                         'source_sha256': ''
                     }
@@ -270,8 +273,8 @@ def get_case_metadata(source_file: str) -> str:
                 'unique_device_id': 'unknown',
                 'ios_version': sys_json['ProductVersion'],
                 'model': 'unknown',  # FIXME figure out a way to get the model from sysdiagnose
-                'date': sysdiagnose_date.isoformat(timespec='microseconds'),
-                'case_id': f"{serial_number}_{sysdiagnose_date.strftime('%Y%m%d_%H%M%S')}",
+                'date': sysdiagnose_date_utc.isoformat(timespec='microseconds'),
+                'case_id': f"{serial_number}_{sysdiagnose_date_utc.strftime('%Y%m%d_%H%M%S')}",
                 'source_file': source_file,
                 'source_sha256': ''
             }

tests/test_sysdiagnose.py

@@ -89,16 +89,16 @@ def test_case_metadata_remotectl(self):
             'unique_device_id': 'e22f7f830e5dcc1287a1690a2622c2b12afaa33c',
             'ios_version': '15.7.6',
             'model': 'iPhone9,3',
-            'date': '2023-05-24T13:29:15.000000-07:00',
-            'case_id': 'F4GT2K24HG7K_20230524_132915',
+            'date': '2023-05-24T20:29:15.000000+00:00',
+            'case_id': 'F4GT2K24HG7K_20230524_202915',
             'source_file': 'tests/testdata/iOS15/sysdiagnose_2023.05.24_13-29-15-0700_iPhone-OS_iPhone_19H349.tar.gz',
-            'source_sha256': '78054acba2a27820c2b7a360b512754d05cc831c5427191f47798ec1d1dd5add',
+            'source_sha256': '870dc007c0ee7b04960e6e88c1d25c11461b0f1f5fba0914a1d2a7947045dbf2',
         }
         metadata = Sysdiagnose.get_case_metadata('tests/testdata/iOS15/sysdiagnose_2023.05.24_13-29-15-0700_iPhone-OS_iPhone_19H349.tar.gz')
         self.assertEqual(metadata, expected_metadata)
 
         # check signature
-        expected_hash = '78054acba2a27820c2b7a360b512754d05cc831c5427191f47798ec1d1dd5add'
+        expected_hash = '870dc007c0ee7b04960e6e88c1d25c11461b0f1f5fba0914a1d2a7947045dbf2'
         hash = Sysdiagnose.calculate_metadata_signature(metadata)
         self.assertEqual(hash, expected_hash)