fix: fixed serialization of datetime to iso format (#629)

Author: jsam

renku/models/_jsonld.py

@@ -228,14 +228,18 @@ def asjsonld(
     )
     rv = dict_factory()
 
-    def convert_value(v):
-        """Convert special types."""
-        if isinstance(v, Path):
-            v = str(v)
-            return os.path.relpath(v, str(basedir)) if basedir else v
-        if isinstance(v, datetime):
-            return str(v)
-        return v
+    def convert_value(value):
+        """Convert non-serializable types."""
+        if isinstance(value, Path):
+            result = str(value)
+            if basedir:
+                result = os.path.relpath(result, str(basedir))
+            return result
+
+        if isinstance(value, datetime):
+            return value.isoformat()
+
+        return value
 
     for a in attrs:
         v = getattr(inst, a.name)

renku/utils/datetime8601.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2019 - Swiss Data Science Center (SDSC)
+# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
+# Eidgenössische Technische Hochschule Zürich (ETHZ).
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Renku datetime utilities."""
+import re
+
+regex = (
+    r'^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]['
+    r'0-9])T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?(Z|['
+    r'+-](?:2[0-3]|[01][0-9]):[0-5][0-9])?$'
+)
+match_iso8601 = re.compile(regex).match
+
+
+def validate_iso8601(str_val):
+    """Check if datetime string is in ISO8601 format."""
+    try:
+        if match_iso8601(str_val) is not None:
+            return True
+    except re.error:
+        pass
+    return False

tests/cli/test_datasets.py

@@ -24,6 +24,7 @@
 
 import git
 import pytest
+import yaml
 
 from renku import cli
 from renku._compat import Path
@@ -32,6 +33,7 @@
 from renku.cli._format.dataset_files import FORMATS as DATASET_FILES_FORMATS
 from renku.cli._format.datasets import FORMATS as DATASETS_FORMATS
 from renku.models.refs import LinkReference
+from renku.utils.datetime8601 import validate_iso8601
 
 
 def test_datasets_create_clean(data_repository, runner, project, client):
@@ -851,3 +853,55 @@ def test_dataset_edit_dirty(runner, client, project):
         cli.cli, ['dataset', 'edit', dataset.identifier], input='wq'
     )
     assert 0 == result.exit_code
+
+
+def test_dataset_date_created_format(runner, client, project):
+    """Check format of date created field."""
+    # Create a dataset.
+    result = runner.invoke(cli.cli, ['dataset', 'create', 'dataset'])
+    assert 0 == result.exit_code
+    assert 'OK' in result.output
+
+    path = client.dataset_path('dataset')
+    assert path.exists()
+
+    with path.open(mode='r') as fp:
+        import dateutil.parser as dp
+        data_yaml = yaml.safe_load(fp)
+
+        assert 'created' in data_yaml
+        assert dp.parse(data_yaml['created'])
+        assert validate_iso8601(data_yaml['created'])
+
+
+def test_dataset_file_date_created_format(tmpdir, runner, client, project):
+    """Check format of date created field."""
+    # Create a dataset.
+    result = runner.invoke(cli.cli, ['dataset', 'create', 'dataset'])
+    assert 0 == result.exit_code
+    assert 'OK' in result.output
+
+    path = client.dataset_path('dataset')
+    assert path.exists()
+
+    # Create data file.
+    new_file = tmpdir.join('datafile.csv')
+    new_file.write('1,2,3')
+
+    # Add data to dataset.
+    result = runner.invoke(
+        cli.cli, ['dataset', 'add', 'dataset',
+                  str(new_file)]
+    )
+    assert 0 == result.exit_code
+
+    with path.open(mode='r') as fp:
+        import dateutil.parser as dp
+        data_yaml = yaml.safe_load(fp)
+
+        assert 'created' in data_yaml
+        assert 'files' in data_yaml
+        assert dp.parse(data_yaml['files'][0]['added'])
+        assert dp.parse(data_yaml['created'])
+        assert validate_iso8601(data_yaml['created'])
+        assert validate_iso8601(data_yaml['files'][0]['added'])