From baf0fbe22780ef410344eaed088f8f89eb1ca319 Mon Sep 17 00:00:00 2001
From: Michael Klatt <mdklatt@alumni.ou.edu>
Date: Thu, 1 Jun 2023 10:21:09 -0500
Subject: [PATCH] Added tests for the 'localtime' module

Need some working tests before attempting to fix #990.

Refs #990
---
 tests/test_localtime.py | 111 +++++++++++++++++++++++++++++-----------
 1 file changed, 82 insertions(+), 29 deletions(-)

diff --git a/tests/test_localtime.py b/tests/test_localtime.py
index 179550c66..3f87bf1ad 100644
--- a/tests/test_localtime.py
+++ b/tests/test_localtime.py
@@ -1,40 +1,93 @@
+""" Unit tests for the 'localtime' module.
+
+There are separate test cases for Unix and Win32, only one of which will be
+executed.
+
+"""
+import datetime
 import pytest
 import sys
 import os.path
 from pathlib import Path
 
-from zoneinfo import ZoneInfo
-from babel.localtime import _unix
+from babel.localtime import get_localzone, LOCALTZ
 
 
-@pytest.fixture
-def zoneinfo(fs) -> Path:
-    """ Make the real time zone info root path available in the fake FS.
+_timezones = {
+    "Etc/UTC": "UTC",
+    "America/New_York": "EDT",  # DST
+    "Europe/Paris": "CEST",  # DST
+}
+
+
+@pytest.mark.skipif(sys.platform == "win32", reason="Unix tests")
+@pytest.mark.usefixtures("fs")  # provided by 'pyfakefs'
+class TestUnixLocaltime:
+    """ Tests for the `localtime` module in a Unix environment.
+
+    Unix relies heavily on files to configure the system time zone, so the
+    'pyfakefs' library is used here to isolate tests from the local file
+    system: <https://pypi.org/project/pyfakefs/>.
 
     """
-    # TODO: Don't need the real dir, just a fake zoneinfo/Etc/UTC file
-    fs.add_real_symlink("/etc/localtime")
-    parts = list(Path("/etc/localtime").readlink().parts)
-    while parts and parts[-1] != "zoneinfo":
-        del parts[-1]
-    zoneinfo = Path(*parts)
-    fs.add_real_directory(zoneinfo)
-    return zoneinfo
-
-
-@pytest.mark.skipif(sys.platform == "win32", reason="Tests _unix.py")
-def test_unix_get_localzone(zoneinfo):
-    """
+    @pytest.fixture
+    def zoneinfo(self, fs) -> Path:
+        """ Provide access to the system TZ info directory.
+
+        :return: directory path
+        """
+        # Reproducing a working zoneinfo database in the test environment would
+        # be a hassle, so add access to the system database. This assumes the
+        # test system follows the convention of linking `/etc/localtime` to the
+        # system's TZ info file somewhere in a `zoneinfo/` hierarchy.
+        # <https://www.unix.com/man-page/linux/4/zoneinfo>
+        fs.add_real_symlink("/etc/localtime")
+        parts = list(Path("/etc/localtime").readlink().parts)
+        while parts and parts[-1] != "zoneinfo":
+            # Find the 'zoneinfo' root.
+            del parts[-1]
+        zoneinfo = Path(*parts)
+        fs.add_real_directory(zoneinfo)
+        return zoneinfo
+
+    @pytest.fixture(params=_timezones.items())
+    def timezone(self, zoneinfo, request) -> str:
+        """ Set the test time zone.
+
+        :return: time zone name, *i.e..* ZoneInfo.tzname()
+        """
+        # As with the `zoneinfo` fixture, this assumes the test system uses a
+        # standard-ish Unix implementation where `/etc/localtime` can be used
+        # to set the time zone.
+        # <https://www.unix.com/man-page/linux/4/zoneinfo>
+        key, name = request.param
+        os.remove("/etc/localtime")
+        os.symlink(f"{zoneinfo}/{key}", "/etc/localtime")
+        return name
+
+    def test_get_localzone(self, zoneinfo, timezone):
+        """ Test the get_localtime() function.
+
+        """
+        dst = datetime.datetime(2023, 7, 1)  # testing DST time zone names
+        assert get_localzone().tzname(dst) == timezone
+
+    def test_localtz(self, zoneinfo):
+        """ Test the LOCALTZ module attribute.
+
+        """
+        assert LOCALTZ == get_localzone()
+
+
+@pytest.mark.skipif(sys.platform != "win32", reason="Win32 tests")
+class TestWin32Localtime:
+    """ Tests for the `localtime` module in a Windows environment.
 
     """
-    # fs.add_real_directory(zoneinfo)
-    # fs.makedir("/etc")
-    # fs.link(zoneinfo, "/etc/localtime")
-    # localtime = tmp_path / "etc/localtime"
-    # localtime.parent.mkdir()
-    # localtime.symlink_to("../zoneinfo/Etc//UTC")
-    os.remove("/etc/localtime")
-    os.symlink(f"{zoneinfo}/America//Chicago", "/etc/localtime")
-    assert zoneinfo.exists()
-    assert zoneinfo.joinpath("America/Chicago").exists()
-    assert _unix._get_localzone() == ZoneInfo("America/Chicago")
+    # This is just a placeholder and basic smoke test for now.
+    # TODO: Add relevant tests.
+    def test_localtz(self):
+        """ Test the LOCALTZ module attribute.
+
+        """
+        assert LOCALTZ == get_localzone()