From: Zack Cerza <zack@redhat.com>
Date: Mon, 8 Jul 2024 22:24:10 +0000 (-0600)
Subject: util.time: Add new submodule with parse_offset()
X-Git-Tag: 1.2.0~2^2~6
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=1a958e39fb781141d24125bc2e7555df8f53a910;p=teuthology.git

util.time: Add new submodule with parse_offset()

Signed-off-by: Zack Cerza <zack@redhat.com>
---

diff --git a/teuthology/util/test/test_time.py b/teuthology/util/test/test_time.py
new file mode 100644
index 000000000..33958506b
--- /dev/null
+++ b/teuthology/util/test/test_time.py
@@ -0,0 +1,30 @@
+import pytest
+
+from datetime import timedelta
+from typing import Type
+
+from teuthology.util import time
+
+
+@pytest.mark.parametrize(
+    ["offset", "result"],
+    [
+        ["1s", timedelta(seconds=1)],
+        ["1m", timedelta(minutes=1)],
+        ["1h", timedelta(hours=1)],
+        ["1d", timedelta(days=1)],
+        ["1w", timedelta(weeks=1)],
+        ["365d", timedelta(days=365)],
+        ["1x", ValueError],
+        ["-1m", ValueError],
+        ["0xde", ValueError],
+        ["frog", ValueError],
+        ["7dwarfs", ValueError],
+    ]
+)
+def test_parse_offset(offset: str, result: timedelta | Type[Exception]):
+    if isinstance(result, timedelta):
+        assert time.parse_offset(offset) == result
+    else:
+        with pytest.raises(result):
+            time.parse_offset(offset)
diff --git a/teuthology/util/time.py b/teuthology/util/time.py
new file mode 100644
index 000000000..4fbafe84d
--- /dev/null
+++ b/teuthology/util/time.py
@@ -0,0 +1,34 @@
+import re
+
+from datetime import timedelta
+
+def parse_offset(offset: str) -> timedelta:
+    """
+    offset: A string consisting of digits followed by one of the following
+            characters:
+                s: seconds
+                m: minutes
+                h: hours
+                d: days
+                w: weeks
+    """
+    err_msg = "Offsets must either be an ISO 8601-formatted timestamp or " \
+        f"a relative value like '2w', '1d', '7h', '45m', '90s'. Got: {offset}"
+    match = re.match(r'(\d+)(s|m|h|d|w)$', offset)
+    if match is None:
+        raise ValueError(err_msg)
+    num = int(match.groups()[0])
+    unit = match.groups()[1]
+    match unit:
+        case 's':
+            return timedelta(seconds=num)
+        case 'm':
+            return timedelta(minutes=num)
+        case 'h':
+            return timedelta(hours=num)
+        case 'd':
+            return timedelta(days=num)
+        case 'w':
+            return timedelta(weeks=num)
+        case _:
+            raise ValueError(err_msg)