fix datetime parsing when no fractional seconds present (#38)

WaciX · web-flow · commit 38755e0c0ffb · 2024-04-06T10:45:22.000-04:00
* fix datetime parsing when no fractional seconds present

* ci fix
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -63,13 +63,15 @@ jobs:
 
       - name: Pull dependencies
         run: |
-          poetry env use system
+          poetry env use 3.7
           poetry install --no-cache --no-root
           poetry self add poetry-plugin-export
           mkdir package/lib
           poetry export -f requirements.txt --output package/lib/requirements.txt
-          poetry env use 3.7
-          poetry install --no-cache --no-root --with dev,splunkslim
+          poetry install --no-cache --no-root --with dev,test,splunkslim
+
+      - name: Tests
+        run: poetry run pytest
 
       - name: Build Splunk App
         run: |
diff --git a/globalConfig.json b/globalConfig.json
@@ -23,9 +23,9 @@
     "meta": {
         "name": "bitwarden_event_logs_beta",
         "restRoot": "bitwarden_event_logs",
-        "version": "2.0.3",
+        "version": "1.2.0",
         "displayName": "Bitwarden Event Logs (beta)",
         "schemaVersion": "0.0.3",
-        "_uccVersion": "5.39.0"
+        "_uccVersion": "5.41.0"
     }
 }
diff --git a/package.sh b/package.sh
@@ -12,7 +12,7 @@ rm -rf package/lib/*
 poetry export -f requirements.txt --output package/lib/requirements.txt
 cp -R src/* package/bin/
 
-ucc-gen build --ta-version ${VERSION}
+poetry run ucc-gen build --ta-version ${VERSION}
 ## cleanup python files
 rm -rf output/$APP_NAME/{bin,lib}/__pycache__
 rm -rf output/$APP_NAME/bin/{bitwarden_event_logs_rh_settings.py,import_declare_test.py}
@@ -21,7 +21,7 @@ rm -rf output/$APP_NAME/appserver/static/{css,js,openapi.json}
 rm -rf output/$APP_NAME/appserver/templates/base.html
 rm -rf output/$APP_NAME/default/{restmap.conf,web.conf,bitwarden_event_logs_settings.conf}
 rm -rf output/$APP_NAME/README/bitwarden_event_logs_settings.conf.spec
-ucc-gen package --path output/$APP_NAME/ -o output/
+poetry run ucc-gen package --path output/$APP_NAME/ -o output/
 
 mv output/${APP_NAME}-${VERSION}.tar.gz output/bitwarden_event_logs.tar.gz
 
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -12,6 +12,7 @@ readme = "README.md"
 keywords = ["splunk", "bitwarden"]
 
 [tool.poetry.dependencies]
+python = "~3.7"
 requests = { version = "2.31.0", python = "~3.7" }
 splunk-sdk = { version = "2.0.1", python = "~3.7" }
 splunktaucclib = { version = "6.0.8", python = "~3.7" }
@@ -21,6 +22,7 @@ python-dateutil = { version = "2.9.0.post0", python = "~3.7" }
 optional = true
 
 [tool.poetry.group.dev.dependencies]
+python = "^3.7"
 python-dotenv = { version = "0.21.1", python = "^3.7" }
 types-requests = { version = "2.31.0.6", python = "^3.7" }
 splunk-add-on-ucc-framework = { version = "5.41.0", python = "^3.7" }
@@ -30,8 +32,19 @@ splunk-appinspect = { version = "3.5.0", python = "^3.7" }
 optional = true
 
 [tool.poetry.group.splunkslim.dependencies]
+python = "^3.7"
 splunk-packaging-toolkit = { version = "1.0.1", python = "^3.7" }
 
+[tool.poetry.group.test]
+optional = true
+
+[tool.poetry.group.test.dependencies]
+python = "^3.7"
+pytest = { version = "7.4.4", python = "^3.7" }
+
+[tool.pytest.ini_options]
+pythonpath = "src"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
diff --git a/src/mappers.py b/src/mappers.py
@@ -1,4 +1,3 @@
-import re
 from datetime import datetime
 from typing import Dict, Any, Optional
 
@@ -74,22 +73,13 @@ def datetime_from_str(date_str: Optional[str]) -> Optional[datetime]:
 
     # no time
     if ":" not in date_str:
-        date_str = date_str + "T00:00:00"
+        return dateutil.parser.isoparse(date_str + "T00:00:00Z")
 
-    # no fractional seconds
-    if "." not in date_str:
-        date_str = date_str + ".0"
+    # no timezone
+    if "Z" not in date_str and "+" not in date_str:
+        return dateutil.parser.isoparse(date_str + "Z")
 
-    date_str_split = date_str.split(".")
-
-    fractional_seconds_str = date_str_split[1]
-    fractional_seconds_str = re.sub(r"\D", "", fractional_seconds_str)
-    if len(fractional_seconds_str) > 6:
-        fractional_seconds_str = fractional_seconds_str[:6]
-
-    new_date_str = f"{date_str_split[0]}.{fractional_seconds_str}Z"
-
-    return dateutil.parser.isoparse(new_date_str)
+    return dateutil.parser.isoparse(date_str)
 
 
 def datetime_to_str(date: datetime) -> str:
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/test_mappers.py b/tests/test_mappers.py
@@ -0,0 +1,106 @@
+from datetime import datetime, date, time, timezone
+
+from mappers import datetime_from_str, datetime_to_str
+
+DATETIME_NO_TIME = datetime.combine(date(2024, 4, 6), time(tzinfo=timezone.utc), tzinfo=timezone.utc)
+DATETIME_TIME_NO_FRACTIONAL = DATETIME_NO_TIME.replace(hour=13, minute=30, second=45)
+DATETIME_TIME_WITH_FRACTIONAL_LONG = DATETIME_TIME_NO_FRACTIONAL.replace(microsecond=123456)
+
+DATETIME_TIME_WITH_FRACTIONAL_SHORT = DATETIME_TIME_NO_FRACTIONAL.replace(microsecond=123000)
+
+
+def test_datetime_from_str_none_expect_none():
+    assert datetime_from_str(None) is None
+
+
+def test_datetime_from_str_empty_string_expect_none():
+    assert datetime_from_str('') is None
+
+
+def test_datetime_from_str_empty_string_not_trimmed_expect_none():
+    assert datetime_from_str(' \t\n') is None
+
+
+def test_datetime_from_str_date_without_time():
+    assert datetime_from_str('2024-04-06') == DATETIME_NO_TIME
+
+
+def test_datetime_from_str_datetime_no_fractional_seconds_no_timezone():
+    assert datetime_from_str('2024-04-06T13:30:45') == DATETIME_TIME_NO_FRACTIONAL
+
+
+def test_datetime_from_str_datetime_no_fractional_seconds_utc_z_timezone():
+    assert datetime_from_str('2024-04-06T13:30:45Z') == DATETIME_TIME_NO_FRACTIONAL
+
+
+def test_datetime_from_str_datetime_no_fractional_seconds_utc_offset_timezone():
+    assert datetime_from_str('2024-04-06T13:30:45+00:00') == DATETIME_TIME_NO_FRACTIONAL
+
+
+def test_datetime_from_str_datetime_0_digits_fractional_seconds_no_timezone():
+    assert datetime_from_str('2024-04-06T13:30:45.0') == DATETIME_TIME_NO_FRACTIONAL
+
+
+def test_datetime_from_str_datetime_0_digits_fractional_utc_z_timezone():
+    assert datetime_from_str('2024-04-06T13:30:45.0Z') == DATETIME_TIME_NO_FRACTIONAL
+
+
+def test_datetime_from_str_datetime_0_digits_fractional_utc_offset_timezone():
+    assert datetime_from_str('2024-04-06T13:30:45.0+00:00') == DATETIME_TIME_NO_FRACTIONAL
+
+
+def test_datetime_from_str_datetime_no_timezone():
+    assert datetime_from_str('2024-04-06T13:30:45.123456') == DATETIME_TIME_WITH_FRACTIONAL_LONG
+
+
+def test_datetime_from_str_datetime_utc_z_timezone():
+    assert datetime_from_str('2024-04-06T13:30:45.123456Z') == DATETIME_TIME_WITH_FRACTIONAL_LONG
+
+
+def test_datetime_from_str_datetime_utc_offset_timezone():
+    assert datetime_from_str('2024-04-06T13:30:45.123456+00:00') == DATETIME_TIME_WITH_FRACTIONAL_LONG
+
+
+def test_datetime_from_str_datetime_short_fractional_seconds_no_timezone():
+    assert datetime_from_str('2024-04-06T13:30:45.123') == DATETIME_TIME_WITH_FRACTIONAL_SHORT
+
+
+def test_datetime_from_str_datetime_short_fractional_seconds_utc_z_timezone():
+    assert datetime_from_str('2024-04-06T13:30:45.123Z') == DATETIME_TIME_WITH_FRACTIONAL_SHORT
+
+
+def test_datetime_from_str_datetime_short_fractional_seconds_utc_offset_timezone():
+    assert datetime_from_str('2024-04-06T13:30:45.123+00:00') == DATETIME_TIME_WITH_FRACTIONAL_SHORT
+
+
+def test_datetime_from_str_datetime_7_digits_fractional_seconds_no_timezone():
+    assert datetime_from_str('2024-04-06T13:30:45.1234567') == DATETIME_TIME_WITH_FRACTIONAL_LONG
+
+
+def test_datetime_from_str_datetime_7_digits_fractional_seconds_utc_z_timezone():
+    assert datetime_from_str('2024-04-06T13:30:45.1234567Z') == DATETIME_TIME_WITH_FRACTIONAL_LONG
+
+
+def test_datetime_from_str_datetime_7_digits_fractional_seconds_utc_offset_timezone():
+    assert datetime_from_str('2024-04-06T13:30:45.1234567+00:00') == DATETIME_TIME_WITH_FRACTIONAL_LONG
+
+
+def test_datetime_to_str_no_time_no_time():
+    assert datetime_to_str(DATETIME_NO_TIME) == '2024-04-06T00:00:00.000000Z'
+
+
+def test_datetime_to_str_no_fractional_seconds():
+    assert datetime_to_str(DATETIME_TIME_NO_FRACTIONAL) == '2024-04-06T13:30:45.000000Z'
+
+
+def test_datetime_to_str_short_fractional_seconds():
+    assert datetime_to_str(DATETIME_TIME_WITH_FRACTIONAL_SHORT) == '2024-04-06T13:30:45.123000Z'
+
+
+def test_datetime_to_str_long_fractional_seconds():
+    assert datetime_to_str(DATETIME_TIME_WITH_FRACTIONAL_LONG) == '2024-04-06T13:30:45.123456Z'
+
+
+def test_datetime_to_str_no_timezone():
+    datetime_no_tz = DATETIME_TIME_WITH_FRACTIONAL_LONG.replace(tzinfo=None)
+    assert datetime_to_str(datetime_no_tz) == '2024-04-06T13:30:45.123456Z'

Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,9 @@`
`23`	`23`	`"meta": {`
`24`	`24`	`"name": "bitwarden_event_logs_beta",`
`25`	`25`	`"restRoot": "bitwarden_event_logs",`
`26`		`- "version": "2.0.3",`
	`26`	`+ "version": "1.2.0",`
`27`	`27`	`"displayName": "Bitwarden Event Logs (beta)",`
`28`	`28`	`"schemaVersion": "0.0.3",`
`29`		`- "_uccVersion": "5.39.0"`
	`29`	`+ "_uccVersion": "5.41.0"`
`30`	`30`	`}`
`31`	`31`	`}`