Fix test_slash_l* to support non-en_US locales (#141)

* Fix test_slash_l* to support non-en_US locales

Update the tests to expect the current locale rather than `en_US`.
While technically this isn't 100% guaranteed to be the same locale
as the database is running on, I think we can reasonably assume that
for the purpose of testing they are the same.  Non-UTF-8 locales
still are not supported but the other tests seem to be unable to handle
them well anyway.

Fixes #140

* GHA: set locale matching the postgres locale

Author: mgorny

.github/workflows/ci.yml

@@ -54,6 +54,8 @@ jobs:
           pip install -r requirements-dev.txt
 
       - name: Run unit tests
+        env:
+          LANG: en_US.UTF-8
         run: coverage run --source pgspecial -m pytest
 
       - name: Run Black

changelog.rst

@@ -2,6 +2,7 @@ Upcoming
 ========
 
 * Added `build-system` section to `pyproject.toml` to use the modern setuptools backend.
+* Fixed test failures when locale other than `en_US` is used.
 
 2.1.0 (2023-03-31)
 =========

tests/conftest.py

@@ -1,8 +1,12 @@
 import pytest
 from dbutils import create_db, db_connection, setup_db, teardown_db, TEST_DB_NAME
+import locale
 from pgspecial.main import PGSpecial
 
 
+locale.setlocale(locale.LC_ALL, "")
+
+
 @pytest.fixture(scope="module")
 def connection():
     create_db(TEST_DB_NAME)

tests/test_specials.py

@@ -4,14 +4,24 @@
 import pytest
 from dbutils import dbtest, POSTGRES_USER, SERVER_VERSION, foreign_db_environ, fdw_test
 import itertools
+import locale
 
 objects_listing_headers = ["Schema", "Name", "Type", "Owner", "Size", "Description"]
 
+# note: technically, this is the database encoding, not the client
+# locale but for the purpose of testing we can assume the server
+# and the client are using the same locale
+# note 2: locale.getlocale() does not return the raw values,
+# in particular it transforms C into en_US, so we use .setlocale()
+# instead as that matches the C library function
+LC_COLLATE = locale.setlocale(locale.LC_COLLATE, None)
+LC_CTYPE = locale.setlocale(locale.LC_CTYPE, None)
+
 
 @dbtest
 def test_slash_l(executor):
     results = executor(r"\l")
-    row = ("_test_db", "postgres", "UTF8", "en_US.UTF-8", "en_US.UTF-8", None)
+    row = ("_test_db", "postgres", "UTF8", LC_COLLATE, LC_CTYPE, None)
     headers = ["Name", "Owner", "Encoding", "Collate", "Ctype", "Access privileges"]
     assert row in results[1]
     assert headers == results[2]
@@ -20,7 +30,7 @@ def test_slash_l(executor):
 @dbtest
 def test_slash_l_pattern(executor):
     results = executor(r"\l _test*")
-    row = [("_test_db", "postgres", "UTF8", "en_US.UTF-8", "en_US.UTF-8", None)]
+    row = [("_test_db", "postgres", "UTF8", LC_COLLATE, LC_CTYPE, None)]
     headers = ["Name", "Owner", "Encoding", "Collate", "Ctype", "Access privileges"]
     assert row == results[1]
     assert headers == results[2]