feat: implement all date functions

src/azure_data_factory_testing_framework/functions/functions_date_implementation.py

@@ -1,9 +1,263 @@
-from datetime import datetime
+from datetime import datetime, timedelta
+from typing import Union
 
+from dateutil.relativedelta import relativedelta
 
-def utcnow() -> str:
-    return datetime.utcnow().isoformat()
 
+def _datetime_from_isoformat(timestamp: str, fmt: str = None) -> datetime:
+    return datetime.fromisoformat(timestamp.rstrip("Z"))
 
-def ticks(date_time: str) -> float:
-    return datetime.fromisoformat(date_time).timestamp()
+
+def _datetime_to_isoformat(date_time: datetime, fmt: str = None) -> str:
+    # TODO: Implement other fmt's if valuable. Use cases where you need to assert certain format should be rare.
+    return date_time.isoformat(timespec="microseconds") + "Z"
+
+
+def _add_time_delta_to_iso_timestamp(timestamp: str, time_delta: Union[timedelta, relativedelta]) -> str:
+    date_time = _datetime_from_isoformat(timestamp) + time_delta
+    return _datetime_to_isoformat(date_time)
+
+
+def utcnow(fmt: str = None) -> str:
+    """Return the current timestamp.
+
+    Args:
+        fmt (str, optional): Optionally, you can specify a different format with the <format> parameter.
+
+    Note: This function does not implement formatting for now and
+    """
+    return _datetime_to_isoformat(datetime.utcnow())
+
+
+def ticks(timestamp: str) -> int:
+    """Return the ticks property value for a specified timestamp. A tick is a 100-nanosecond interval.
+
+    Args:
+        timestamp (str): The string for a timestamp
+    """
+    date_time = _datetime_from_isoformat(timestamp)
+    delta = date_time - datetime(1, 1, 1)
+    return int(delta.total_seconds()) * 10000000 + delta.microseconds * 10
+
+
+def add_days(timestamp: str, days: int, fmt: str = None) -> str:
+    """Add a number of days to a timestamp.
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+        days (int): The positive or negative number of days to add
+        fmt (str, optional): Optionally, you can specify a different format with the <format> parameter.
+    """
+    return _add_time_delta_to_iso_timestamp(timestamp, timedelta(days=days))
+
+
+def add_hours(timestamp: str, hours: int, fmt: str = None) -> str:
+    """Add a number of hours to a timestamp.
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+        hours (int): The positive or negative number of hours to add
+        fmt (str, optional): Optionally, you can specify a different format with the <format> parameter.
+    """
+    return _add_time_delta_to_iso_timestamp(timestamp, timedelta(hours=hours))
+
+
+def add_minutes(timestamp: str, minutes: int, fmt: str = None) -> str:
+    """Add a number of minutes to a timestamp.
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+        minutes (int): The positive or negative number of minutes to add
+        fmt (str, optional): Optionally, you can specify a different format with the <format> parameter.
+    """
+    return _add_time_delta_to_iso_timestamp(timestamp, timedelta(minutes=minutes))
+
+
+def add_seconds(timestamp: str, seconds: int, fmt: str = None) -> str:
+    """Add a number of seconds to a timestamp.
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+        seconds (int): The positive or negative number of seconds to add
+        fmt (str, optional): Optionally, you can specify a different format with the <format> parameter.
+    """
+    return _add_time_delta_to_iso_timestamp(timestamp, timedelta(seconds=seconds))
+
+
+def add_to_time(timestamp: str, interval: int, time_unit: str, fmt: str = None) -> str:
+    """Add a number of time units to a timestamp. See also getFutureTime.
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+        interval (int): The number of specified time units to add
+        time_unit (str): The unit of time to use with interval: "Second", "Minute", "Hour", "Day", "Week", "Month", "Year"
+        fmt (str, optional): Optionally, you can specify a different format with the <format> parameter.
+    """
+    if time_unit == "Second":
+        return add_seconds(timestamp, interval, fmt)
+    elif time_unit == "Minute":
+        return add_minutes(timestamp, interval, fmt)
+    elif time_unit == "Hour":
+        return add_hours(timestamp, interval, fmt)
+    elif time_unit == "Day":
+        return add_days(timestamp, interval, fmt)
+    elif time_unit == "Week":
+        return _add_time_delta_to_iso_timestamp(timestamp, timedelta(weeks=interval))
+    elif time_unit == "Month":
+        return _add_time_delta_to_iso_timestamp(timestamp, relativedelta(months=interval))
+    elif time_unit == "Year":
+        return _add_time_delta_to_iso_timestamp(timestamp, relativedelta(years=interval))
+    else:
+        raise ValueError(f"Invalid time unit: {time_unit}")
+
+
+def convert_from_utc(timestamp: str, destination_timezone: str, fmt: str = None) -> str:
+    """Convert a timestamp from Universal Time Coordinated (UTC) to the target time zone.
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+        destination_timezone (str): The name for the target time zone.
+        For time zone names, see Microsoft Time Zone Values, but you might have to remove any punctuation from the time zone name.
+        fmt (str, optional): Optionally, you can specify a different format with the <format> parameter.
+    """
+    # TODO: Implement other fmt's if valuable. Use cases where you need to assert certain format should be rare.
+    return timestamp
+
+
+def convert_time_zone(timestamp: str, source_timezone: str, destination_timezone: str, fmt: str = None) -> str:
+    """Convert a timestamp from the source time zone to the target time zone.
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+        source_timezone (str): The name for the source time zone.
+        For time zone names, see Microsoft Time Zone Values, but you might have to remove any punctuation from the time zone name.
+        destination_timezone (str): The name for the target time zone.
+        For time zone names, see Microsoft Time Zone Values, but you might have to remove any punctuation from the time zone name.
+        fmt (str, optional): Optionally, you can specify a different format with the <format> parameter.
+    """
+    # TODO: Implement other fmt's if valuable. Use cases where you need to assert certain format should be rare.
+    return timestamp
+
+
+def convert_to_utc(timestamp: str, source_timezone: str, fmt: str = None) -> str:
+    """Convert a timestamp from the source time zone to Universal Time Coordinated (UTC).
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+        source_timezone (str): The name for the source time zone.
+        For time zone names, see Microsoft Time Zone Values, but you might have to remove any punctuation from the time zone name.
+        fmt (str, optional): Optionally, you can specify a different format with the <format> parameter.
+    """
+    # TODO: Implement other fmt's if valuable. Use cases where you need to assert certain format should be rare.
+    return timestamp
+
+
+def day_of_month(timestamp: str) -> int:
+    """Return the day of the month component from a timestamp.
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+    """
+    date_time = _datetime_from_isoformat(timestamp)
+    return date_time.day
+
+
+def day_of_week(timestamp: str) -> int:
+    """Return the day of the week component from a timestamp.
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+    """
+    date_time = _datetime_from_isoformat(timestamp)
+    return date_time.weekday() + 1
+
+
+def day_of_year(timestamp: str) -> int:
+    """Return the day of the year component from a timestamp.
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+    """
+    date_time = _datetime_from_isoformat(timestamp)
+    return date_time.timetuple().tm_yday
+
+
+def format_date_time(timestamp: str, fmt: str = None) -> str:
+    """Return the timestamp as a string in optional format.
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+        fmt (str): The format to use when converting the timestamp to a string
+    """
+    date_time = _datetime_from_isoformat(timestamp)
+    return _datetime_to_isoformat(date_time, fmt)
+
+
+def get_future_time(interval: int, time_unit: str, fmt: str = None) -> str:
+    """Return the current timestamp plus the specified time units. See also addToTime.
+
+    Args:
+        interval (str): The number of specified time units to add
+        time_unit (str): The unit of time to use with interval: "Second", "Minute", "Hour", "Day", "Week", "Month", "Year"
+        fmt (str, optional): Optionally, you can specify a different format with the <format> parameter.
+    """
+    return add_to_time(utcnow(), interval, time_unit, fmt)
+
+
+def get_past_time(interval: int, time_unit: str, fmt: str = None) -> str:
+    """Return the current timestamp minus the specified time units. See also subtractFromTime.
+
+    Args:
+        interval (str): The number of specified time units to subtract
+        time_unit (str): The unit of time to use with interval: "Second", "Minute", "Hour", "Day", "Week", "Month", "Year"
+        fmt (str, optional): Optionally, you can specify a different format with the <format> parameter.
+    """
+    return add_to_time(utcnow(), -interval, time_unit, fmt)
+
+
+def start_of_day(timestamp: str, fmt: str = None) -> str:
+    """Return the start of the day for a timestamp.
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+        fmt (str, optional): Optionally, you can specify a different format with the <format> parameter.
+    """
+    date_time = _datetime_from_isoformat(timestamp)
+    date_time = date_time.replace(hour=0, minute=0, second=0, microsecond=0)
+    return _datetime_to_isoformat(date_time, fmt)
+
+
+def start_of_hour(timestamp: str, fmt: str = None) -> str:
+    """Return the start of the hour for a timestamp.
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+        fmt (str, optional): Optionally, you can specify a different format with the <format> parameter.
+    """
+    date_time = _datetime_from_isoformat(timestamp)
+    date_time = date_time.replace(minute=0, second=0, microsecond=0)
+    return _datetime_to_isoformat(date_time, fmt)
+
+
+def start_of_month(timestamp: str, fmt: str = None) -> str:
+    """Return the start of the month for a timestamp.
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+        fmt (str, optional): Optionally, you can specify a different format with the <format> parameter.
+    """
+    date_time = _datetime_from_isoformat(timestamp)
+    date_time = date_time.replace(day=1, hour=0, minute=0, second=0, microsecond=0)
+    return _datetime_to_isoformat(date_time, fmt)
+
+
+def subtract_from_time(timestamp: str, interval: int, time_unit: str, fmt: str = None) -> str:
+    """Subtract a number of time units from a timestamp. See also getPastTime.
+
+    Args:
+        timestamp (str): The string that contains the timestamp
+        interval (int): The number of specified time units to subtract
+        time_unit (str): The unit of time to use with interval: "Second", "Minute", "Hour", "Day", "Week", "Month", "Year"
+        fmt (str, optional): Optionally, you can specify a different format with the <format> parameter.
+    """
+    return add_to_time(timestamp, -interval, time_unit, fmt)

src/azure_data_factory_testing_framework/functions/functions_repository.py

@@ -11,11 +11,11 @@
 class FunctionsRepository:
     functions: Dict[str, Callable] = {
         "add": None,
-        "addDays": None,
-        "addHours": None,
-        "addMinutes": None,
-        "addSeconds": None,
-        "addToTime": None,
+        "addDays": date_functions.add_days,
+        "addHours": date_functions.add_hours,
+        "addMinutes": date_functions.add_minutes,
+        "addSeconds": date_functions.add_seconds,
+        "addToTime": date_functions.add_to_time,
         "and": logical_functions.and_,
         "array": conversion_functions.array,
         "base64": conversion_functions.base64,
@@ -26,16 +26,16 @@ class FunctionsRepository:
         "coalesce": conversion_functions.coalesce,
         "concat": string_functions.concat,
         "contains": collection_functions.contains,
-        "convertFromUtc": None,
-        "convertTimeZone": None,
-        "convertToUtc": None,
+        "convertFromUtc": date_functions.convert_from_utc,
+        "convertTimeZone": date_functions.convert_time_zone,
+        "convertToUtc": date_functions.convert_to_utc,
         "createArray": conversion_functions.create_array,
         "dataUri": conversion_functions.data_uri,
         "dataUriToBinary": conversion_functions.data_uri_to_binary,
         "dataUriToString": conversion_functions.data_uri_to_string,
-        "dayOfMonth": None,
-        "dayOfWeek": None,
-        "dayOfYear": None,
+        "dayOfMonth": date_functions.day_of_month,
+        "dayOfWeek": date_functions.day_of_week,
+        "dayOfYear": date_functions.day_of_year,
         "decodeBase64": conversion_functions.decode_base64,
         "decodeDataUri": conversion_functions.decode_data_uri,
         "decodeUriComponent": conversion_functions.decode_uri_component,
@@ -46,9 +46,9 @@ class FunctionsRepository:
         "equals": logical_functions.equals,
         "first": collection_functions.first,
         "float": conversion_functions.float_,
-        "formatDataTime": None,
-        "getFutureTime": None,
-        "getPastTime": None,
+        "formatDataTime": date_functions.format_date_time,
+        "getFutureTime": date_functions.get_future_time,
+        "getPastTime": date_functions.get_past_time,
         "greater": logical_functions.greater,
         "greaterOrEquals": logical_functions.greater_or_equals,
         "guid": string_functions.guid,
@@ -74,14 +74,14 @@ class FunctionsRepository:
         "replace": string_functions.replace,
         "skip": collection_functions.skip,
         "split": string_functions.split,
-        "startOfDay": None,
-        "startOfHour": None,
-        "startOfMonth": None,
+        "startOfDay": date_functions.start_of_day,
+        "startOfHour": date_functions.start_of_hour,
+        "startOfMonth": date_functions.start_of_month,
         "startsWith": string_functions.starts_with,
         "string": conversion_functions.string,
         "sub": math_functions.sub,
         "substring": string_functions.substring,
-        "substractFromTime": None,
+        "subtractFromTime": date_functions.subtract_from_time,
         "take": collection_functions.take,
         "ticks": date_functions.ticks,
         "toLower": string_functions.to_lower,
@@ -92,6 +92,7 @@ class FunctionsRepository:
         "uriComponentToBinary": conversion_functions.uri_component_to_binary,
         "uriComponentToString": conversion_functions.uri_component_to_string,
         "utcNow": date_functions.utcnow,
+        "utcnow": date_functions.utcnow,
         "xml": conversion_functions.xml,
         "xpath": conversion_functions.xpath,
     }