Add TestXLSXDateField

Author: browniebroke

tests/test_fields.py

@@ -1,11 +1,20 @@
 from decimal import Decimal
+import datetime as dt
 
 import pytest
 from openpyxl.cell import Cell
 from openpyxl.worksheet.worksheet import Worksheet
-from rest_framework.fields import CharField, IntegerField, FloatField, DecimalField
+from rest_framework.fields import (
+    CharField,
+    IntegerField,
+    FloatField,
+    DecimalField,
+    DateTimeField,
+    DateField,
+    TimeField,
+)
 
-from drf_excel.fields import XLSXField, XLSXNumberField
+from drf_excel.fields import XLSXField, XLSXNumberField, XLSXDateField
 from drf_excel.utilities import XLSXStyle
 
 
@@ -144,3 +153,154 @@ def test_cell_float(self, style: XLSXStyle, worksheet: Worksheet):
         assert isinstance(cell, Cell)
         assert cell.value == 35.5
         assert cell.number_format == "0.00"
+
+
+class TestXLSXDateField:
+    @pytest.mark.parametrize(
+        ("original_value", "cleaned_value"),
+        [
+            # Successful parsing
+            ("2020-01-01", dt.datetime(2020, 1, 1, 0, 0)),
+            ("2020-02-03T13:01", dt.datetime(2020, 2, 3, 13, 1)),
+            ("2020-03-04T13:15:30", dt.datetime(2020, 3, 4, 13, 15, 30)),
+            ("2020-10-08T15:18:23.1234Z", dt.datetime(2020, 10, 8, 15, 18, 23, 123400)),
+            # Failed parsing
+            ("foo", "foo"),
+            (None, None),
+            (True, True),
+            (300, 300),
+            (99.99, 99.99),
+        ],
+    )
+    def test_init_datetime_field(self, style: XLSXStyle, original_value, cleaned_value):
+        f = XLSXDateField(
+            key="dt",
+            value=original_value,
+            field=DateTimeField(),
+            style=style,
+            mapping=None,
+            cell_style=style,
+        )
+        assert f.original_value == original_value
+        assert f.value == cleaned_value
+
+    @pytest.mark.parametrize(
+        ("original_value", "cleaned_value"),
+        [
+            # Successful parsing
+            ("2020-01-01", dt.date(2020, 1, 1)),
+            # Failed parsing
+            ("2020-02-03T13:01", None),
+            ("2020-03-04T13:15:30", None),
+            ("2020-10-08T15:18:23.1234Z", None),
+            ("foo", None),
+            (None, None),
+            (True, True),
+            (300, 300),
+            (99.99, 99.99),
+        ],
+    )
+    def test_init_date_field(self, style: XLSXStyle, original_value, cleaned_value):
+        f = XLSXDateField(
+            key="d",
+            value=original_value,
+            field=DateField(),
+            style=style,
+            mapping=None,
+            cell_style=style,
+        )
+        assert f.original_value == original_value
+        assert f.value == cleaned_value
+
+    @pytest.mark.parametrize(
+        ("original_value", "cleaned_value"),
+        [
+            # Successful parsing
+            ("13:01", dt.time(13, 1)),
+            ("13:15:30", dt.time(13, 15, 30)),
+            ("14:15:16.1234Z", dt.time(14, 15, 16, 123400)),
+            # Failed parsing
+            ("2020-01-01", "2020-01-01"),
+            ("2020-02-03T13:01", "2020-02-03T13:01"),
+            ("2020-03-04T13:15:30", "2020-03-04T13:15:30"),
+            ("2020-10-08T15:18:23.1234Z", "2020-10-08T15:18:23.1234Z"),
+            ("foo", "foo"),
+            (None, None),
+            (True, True),
+            (300, 300),
+            (99.99, 99.99),
+        ],
+    )
+    def test_init_time_field(self, style: XLSXStyle, original_value, cleaned_value):
+        f = XLSXDateField(
+            key="t",
+            value=original_value,
+            field=TimeField(),
+            style=style,
+            mapping=None,
+            cell_style=style,
+        )
+        assert f.original_value == original_value
+        assert f.value == cleaned_value
+
+    def test_cell_datetime_default_format(self, style: XLSXStyle, worksheet: Worksheet):
+        f = XLSXDateField(
+            key="dt",
+            value="2019-03-04T13:15:30",
+            field=DateTimeField(),
+            style=style,
+            mapping=None,
+            cell_style=style,
+        )
+        cell = f.cell(worksheet, 1, 1)
+        assert isinstance(cell, Cell)
+        assert cell.value == dt.datetime(2019, 3, 4, 13, 15, 30)
+        assert cell.number_format == "yyyy-mm-dd h:mm:ss"
+
+    def test_cell_datetime_custom_format(
+        self, style: XLSXStyle, worksheet: Worksheet, settings
+    ):
+        settings.DRF_EXCEL_DATETIME_FORMAT = "dd/mm/yyyy h:mm:ss"
+        f = XLSXDateField(
+            key="dt",
+            value="01-04-2015 05:16:09",
+            field=DateTimeField(format="%d-%m-%Y %H:%M:%S"),
+            style=style,
+            mapping=None,
+            cell_style=style,
+        )
+        cell = f.cell(worksheet, 1, 1)
+        assert isinstance(cell, Cell)
+        assert cell.value == dt.datetime(2015, 4, 1, 5, 16, 9)
+        assert cell.number_format == "dd/mm/yyyy h:mm:ss"
+
+    def test_cell_date_default_format(self, style: XLSXStyle, worksheet: Worksheet):
+        f = XLSXDateField(
+            key="dt",
+            value="2018-09-10",
+            field=DateField(),
+            style=style,
+            mapping=None,
+            cell_style=style,
+        )
+        cell = f.cell(worksheet, 1, 1)
+        assert isinstance(cell, Cell)
+        assert cell.value == dt.date(2018, 9, 10)
+        assert cell.number_format == "yyyy-mm-dd"
+
+    def test_cell_date_custom_format(
+        self, style: XLSXStyle, worksheet: Worksheet, settings
+    ):
+        settings.DRF_EXCEL_DATE_FORMAT = "dd/mm/yyyy"
+        f = XLSXDateField(
+            key="dt",
+            value="25/10/2017",
+            field=DateField(format="%d/%m/%Y"),
+            style=style,
+            mapping=None,
+            cell_style=style,
+        )
+        cell = f.cell(worksheet, 1, 1)
+        assert isinstance(cell, Cell)
+        assert cell.value == dt.date(2017, 10, 25)
+        assert cell.number_format == "dd/mm/yyyy"