Issue #389 eliminate deprecated datetime.utcnow() usage

and port some ad-hoc time patching to time_machine

Author: soxofaan

CHANGELOG.md

@@ -24,6 +24,7 @@ and start a new "In Progress" section above it.
 - Add `namespace` option to `non_standard_process`
 - Improve API alignment between `JobRegistryInterface`/`ElasticJobRegistry` and `DoubleJobRegistry` ([Open-EO/openeo-geopyspark-driver#863](https://github.com/Open-EO/openeo-geopyspark-driver/issues/863), [Open-EO/openeo-geopyspark-driver#1123](https://github.com/Open-EO/openeo-geopyspark-driver/issues/1123))
 - `export_workspace`: merge `"derived_from"` links of STAC Collections ([Open-EO/openeo-geopyspark-driver#1050](https://github.com/Open-EO/openeo-geopyspark-driver/issues/1050))
+- Eliminate usage of deprecated `datetime.utcnow()` ([#389](https://github.com/Open-EO/openeo-python-driver/issues/389))
 
 ## 0.132.0
 

openeo_driver/dummy/dummy_backend.py

@@ -2,7 +2,7 @@
 import json
 import numbers
 import unittest.mock
-from datetime import datetime
+import datetime
 from functools import lru_cache
 from pathlib import Path
 from typing import Any, Dict, Iterable, List, Optional, Sequence, Tuple, Union
@@ -73,18 +73,12 @@
 from openeo_driver.util.http import UrlSafeStructCodec
 from openeo_driver.utils import EvalEnv, WhiteListEvalEnv, generate_unique_id
 
-DEFAULT_DATETIME = datetime(2020, 4, 23, 16, 20, 27)
 
 # TODO: eliminate this global state with proper pytest fixture usage!
 _collections = {}
 _load_collection_calls = {}
 
 
-def utcnow() -> datetime:
-    # To simplify testing, we break time.
-    # TODO: just start using `time_machine` module for time mocking
-    return DEFAULT_DATETIME
-
 
 def get_collection(collection_id: str) -> 'DummyDataCube':
     return _collections[collection_id]
@@ -145,7 +139,7 @@ class DummySecondaryServices(SecondaryServices):
             configuration={"version": "0.5.8"},
             attributes={},
             title="Test service",
-            created=datetime(2020, 4, 9, 15, 5, 8)
+            created=datetime.datetime(2020, 4, 9, 15, 5, 8),
         )
     ]
 
@@ -710,7 +704,7 @@ def create_job(
             id=job_id,
             status=JOB_STATUS.CREATED,
             process=process,
-            created=utcnow(),
+            created=datetime.datetime.now(tz=datetime.timezone.utc),
             job_options=job_options,
             title=metadata.get("title"),
             description=metadata.get("description"),

openeo_driver/util/view_helpers.py

@@ -4,11 +4,6 @@
 import flask
 
 
-def _utcnow() -> datetime.datetime:
-    # Allow patching utcnow for unit testing
-    # TODO: just start using `time_machine` module for time mocking
-    return datetime.datetime.utcnow()
-
 
 def cache_control(
         max_age=None, no_cache=None, no_store=None,
@@ -32,7 +27,7 @@ def add_cache_control_headers(response: flask.Response) -> flask.Response:
             for key, value in settings.items():
                 setattr(response.cache_control, key, value)
             if max_age is not None:
-                response.expires = _utcnow() + datetime.timedelta(seconds=max_age)
+                response.expires = datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(seconds=max_age)
         return response
 
     def decorator(func):

openeo_driver/views.py

@@ -26,7 +26,7 @@
     send_from_directory,
     url_for,
 )
-from openeo.util import Rfc3339, TimingLogger, deep_get, dict_no_none
+from openeo.util import Rfc3339, TimingLogger, deep_get, dict_no_none, rfc3339
 from openeo.utils.version import ComparableVersion
 from pyproj import CRS
 from shapely.geometry import mapping
@@ -1125,9 +1125,7 @@ def job_results_canonical_url() -> str:
                     "license": "proprietary",  # TODO?
                     "extent": {
                         "spatial": {"bbox": [[-180, -90, 180, 90]]},
-                        "temporal": {
-                            "interval": [[to_datetime(dt.datetime.utcnow()), to_datetime(dt.datetime.utcnow())]]
-                        },
+                        "temporal": {"interval": [[rfc3339.utcnow(), rfc3339.utcnow()]]},
                     },
                     "links": [
                         {

tests/test_server.py

@@ -1,12 +1,12 @@
 import re
-from datetime import datetime
+import datetime
 
 from openeo_driver.server import build_backend_deploy_metadata
 
 
 def test_build_backend_deploy_metadata():
     data = build_backend_deploy_metadata(packages=["openeo", "openeo_driver", "foobarblerghbwop"])
-    assert data["date"].startswith(datetime.utcnow().strftime("%Y-%m-%dT%H"))
+    assert data["date"].startswith(datetime.datetime.now(datetime.timezone.utc).strftime("%Y-%m-%dT%H"))
     assert re.match(r"\d+\.\d+\.\d+", data["versions"]["openeo"])
     assert re.match(r"\d+\.\d+\.\d+", data["versions"]["openeo_driver"])
     assert data["versions"]["foobarblerghbwop"] == "n/a"

tests/test_view_helpers.py

@@ -1,5 +1,4 @@
 import datetime
-from unittest import mock
 
 import flask
 import pytest
@@ -8,6 +7,9 @@
 
 
 class TestCacheControl:
+    @pytest.fixture(autouse=True)
+    def set_time(self, time_machine):
+        time_machine.move_to("2022-06-01T15:50:00", tick=False)
 
     def test_default(self, ):
         app = flask.Flask(__name__)
@@ -22,12 +24,6 @@ def hello():
         assert "Cache-Control" not in resp.headers
         assert "Expires" not in resp.headers
 
-    def _patch_utcnow(self):
-        return mock.patch(
-            "openeo_driver.util.view_helpers._utcnow",
-            return_value=datetime.datetime(2022, 6, 1, 15, 50, 00),
-        )
-
     @pytest.mark.parametrize("max_age", [
         123,
         datetime.timedelta(minutes=2, seconds=3),
@@ -40,9 +36,8 @@ def test_max_age(self, max_age):
         def hello():
             return flask.jsonify(hello="world")
 
-        with self._patch_utcnow():
-            with app.test_client() as client:
-                resp = client.get("/hello")
+        with app.test_client() as client:
+            resp = client.get("/hello")
         assert resp.headers["Cache-Control"] == "max-age=123"
         assert resp.headers["Expires"] == "Wed, 01 Jun 2022 15:52:03 GMT"
 
@@ -63,14 +58,13 @@ def hi():
         def bye():
             return flask.jsonify(bye="world")
 
-        with self._patch_utcnow():
-            with app.test_client() as client:
-                resp = client.get("/hello")
-                assert resp.headers["Cache-Control"] == "max-age=123"
-                resp = client.get("/hi")
-                assert resp.headers["Cache-Control"] == "max-age=1234"
-                resp = client.get("/bye")
-                assert "Cache-Control" not in resp.headers
+        with app.test_client() as client:
+            resp = client.get("/hello")
+            assert resp.headers["Cache-Control"] == "max-age=123"
+            resp = client.get("/hi")
+            assert resp.headers["Cache-Control"] == "max-age=1234"
+            resp = client.get("/bye")
+            assert "Cache-Control" not in resp.headers
 
     @pytest.mark.parametrize(["status", "caching"], [
         (200, True),
@@ -87,9 +81,8 @@ def test_no_cache_on_failure(self, status, caching):
         def hello():
             return flask.Response(response="hello", status=status)
 
-        with self._patch_utcnow():
-            with app.test_client() as client:
-                resp = client.get("/hello")
+        with app.test_client() as client:
+            resp = client.get("/hello")
 
         if caching:
             assert resp.headers["Cache-Control"] == "max-age=123"
@@ -106,8 +99,7 @@ def test_multiple_directives(self):
         def hello():
             return flask.jsonify(hello="world")
 
-        with self._patch_utcnow():
-            with app.test_client() as client:
-                resp = client.get("/hello")
+        with app.test_client() as client:
+            resp = client.get("/hello")
         assert resp.headers["Cache-Control"] == "max-age=123, no-cache, public, must-revalidate"
         assert resp.headers["Expires"] == "Wed, 01 Jun 2022 15:52:03 GMT"

tests/test_views.py

@@ -3,7 +3,7 @@
 import re
 import urllib.parse
 from contextlib import ExitStack, contextmanager
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from pathlib import Path
 from typing import Optional
 from unittest import mock
@@ -1322,6 +1322,7 @@ def _fresh_job_registry(next_job_id="job-1234", output_root: Optional[Path] = No
                     )
             yield dummy_backend.DummyBatchJobs._job_registry
 
+    @time_machine.travel("2024-01-02T13:14:15Z", tick=False)
     def test_create_job_100(self, api100):
         with self._fresh_job_registry(next_job_id="job-245"):
             resp = api100.post('/jobs', headers=self.AUTH_HEADER, json={
@@ -1337,7 +1338,7 @@ def test_create_job_100(self, api100):
         assert job_info.id == "job-245"
         assert job_info.process == {"process_graph": {"foo": {"process_id": "foo", "arguments": {}}}}
         assert job_info.status == "created"
-        assert job_info.created == dummy_backend.DEFAULT_DATETIME
+        assert job_info.created == datetime(2024, 1, 2, 13, 14, 15, tzinfo=timezone.utc)
         assert job_info.job_options is None
         assert job_info.title == "Foo job"
         assert job_info.description == "Run the `foo` process!"
@@ -1434,6 +1435,7 @@ def test_create_job_100_with_job_options_and_defaults_from_remote_process_defini
         job_info = dummy_backend.DummyBatchJobs._job_registry[TEST_USER, "job-256"]
         assert job_info.job_options == expected_job_options
 
+    @time_machine.travel("2024-01-02T13:14:15Z")
     def test_create_job_get_metadata(self, api100):
         with self._fresh_job_registry(next_job_id="job-245"):
             resp = api100.post(
@@ -1451,7 +1453,7 @@ def test_create_job_get_metadata(self, api100):
 
             resp = api100.get("/jobs/job-245", headers=self.AUTH_HEADER)
             assert resp.assert_status_code(200).json == {
-                "created": "2020-04-23T16:20:27Z",
+                "created": "2024-01-02T13:14:15Z",
                 "id": "job-245",
                 "process": {"process_graph": {"foo": {"arguments": {}, "process_id": "foo"}}},
                 "progress": 0,

tests/test_workspace.py

@@ -200,7 +200,7 @@ def _collection(
         extent=Extent(spatial_extent, temporal_extent),
     )
 
-    item = Item(id=asset_filename, geometry=None, bbox=None, datetime=dt.datetime.utcnow(), properties={})
+    item = Item(id=asset_filename, geometry=None, bbox=None, datetime=dt.datetime.now(dt.timezone.utc), properties={})
 
     asset_path = root_path / item.id / asset_filename
     asset = Asset(href=asset_path.name)  # relative to item