Use locale pragma instead of POSIX::setlocale()

The Pragma is more likely to do the right thing, as confirmed by new tests, which fail when using `setlocale` and now succeed with `use locale`. The tests, in `xt/locale`, include compiled locale dictionaries (`*.mo` files) with a single message for the tested languages. This is in contrast to the released locale dictionaries, which are generated at release time but not stored in the repository. Update the `Language-Team` header in the project localization packages in `po` directory to `Sqitch Hackers <sqitch-hackers@googlegroups.com>`. Update the `os.yml` and `perl.yml` workflows, which run all tests including the new locale tests, to install the required locales on Linux and to set the full `runs-on:` image name in the matrix (in response to shogo82148/actions-setup-perl#1699). Also remove the installation of an older version of Locale::TextDomain from those workflows, since gflohr/libintl-perl#7 has been fixed and released. While at it, upgrade to `actions/checkout@v4` in all workflows and use `runner.os` instead of `matrix.os` in conditionals.
sqitchers · Jan 8, 2024 · 501759c · 501759c
1 parent 7edc536
commit 501759c
Show file tree

Hide file tree

Showing 30 changed files with 176 additions and 48 deletions.
diff --git a/.github/workflows/cockroach.yml b/.github/workflows/cockroach.yml
@@ -18,7 +18,7 @@ jobs:
     steps:
       - name: Start CockroachDB
         run: docker run -d -p 26257:26257 cockroachdb/cockroach:latest-v${{ matrix.version }} start-single-node --insecure
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Perl
         id: perl
         uses: shogo82148/actions-setup-perl@v1

diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -49,7 +49,7 @@ jobs:
         run: rm -rf /opt/hostedtoolcache
       - name: Start CockroachDB
         run: docker run -d -p 26257:26257 cockroachdb/cockroach:latest start-single-node --insecure
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Perl
         id: perl
         uses: shogo82148/actions-setup-perl@v1

diff --git a/.github/workflows/exasol.yml b/.github/workflows/exasol.yml
@@ -20,7 +20,7 @@ jobs:
         ports: [ 8563 ]
         options: --privileged
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Clients
         run: .github/ubuntu/exasol.sh
       - name: Setup Perl

diff --git a/.github/workflows/firebird.yml b/.github/workflows/firebird.yml
@@ -29,7 +29,7 @@ jobs:
           ISC_PASSWORD: nix
           FIREBIRD_DATABASE: sqitchtest.db
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Clients
         run: .github/ubuntu/firebird.sh
       - name: Setup Perl

diff --git a/.github/workflows/mysql.yml b/.github/workflows/mysql.yml
@@ -39,7 +39,7 @@ jobs:
         ports: [ 3306 ]
         options: --health-cmd="healthcheck.sh --innodb_initialized || mysqladmin ping --protocol=tcp" --health-interval=5s --health-timeout=2s --health-retries=3
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Clients
         run: .github/ubuntu/mysql.sh
       - name: Setup Perl

diff --git a/.github/workflows/oracle.yml b/.github/workflows/oracle.yml
@@ -40,7 +40,7 @@ jobs:
           --health-timeout 10s
           --health-retries 10
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Clients
         run: .github/ubuntu/oracle.sh
       - name: Setup Perl

diff --git a/.github/workflows/os.yml b/.github/workflows/os.yml
@@ -12,27 +12,29 @@ jobs:
     strategy:
       matrix:
         include:
-          - { icon: 🐧, os: ubuntu,  name: Linux }
-          - { icon: 🍎, os: macos,   name: macOS }
-          - { icon: 🪟, os: windows, name: Windows }
+          - { icon: 🐧, on: ubuntu,  name: Linux }
+          - { icon: 🍎, on: macos,   name: macOS }
+          - { icon: 🪟, on: windows, name: Windows }
     name: ${{ matrix.icon }} ${{ matrix.name }}
-    runs-on: ${{ matrix.os }}-latest
+    runs-on: ${{ matrix.on }}-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Perl
         id: perl
         uses: shogo82148/actions-setup-perl@v1
         with: { perl-version: latest }
       - run: perl -V
+      - if: runner.os == 'Linux'
+        name: Install Apt Packages
+        run: sudo apt-get install -qq aspell-en language-pack-fr language-pack-en language-pack-de language-pack-it
       - name: Cache CPAN Modules
         uses: actions/cache@v3
         with:
           path: local
           key: perl-${{ steps.perl.outputs.perl-hash }}
       - run: cpm install --verbose --show-build-log-on-failure --no-test --with-recommends ExtUtils::MakeMaker List::MoreUtils::XS
-      # Remove Locale::TextDomain if https://github.com/gflohr/libintl-perl/issues/7 fixed and released.
-      - if: ${{ matrix.os == 'windows' }}
-        run: cpm install --verbose --show-build-log-on-failure --no-test --with-recommends Encode Win32::Console::ANSI Win32API::Net Win32::Locale Win32::ShellQuote DateTime::TimeZone::Local::Win32 Locale::TextDomain@1.31
+      - if: runner.os == 'Windows'
+        run: cpm install --verbose --show-build-log-on-failure --no-test --with-recommends Encode Win32::Console::ANSI Win32API::Net Win32::Locale Win32::ShellQuote DateTime::TimeZone::Local::Win32
       - run: cpm install --verbose --show-build-log-on-failure --no-test --with-recommends --cpanfile dist/cpanfile
       - run: cpm install --verbose --show-build-log-on-failure --no-test --with-recommends Test::Spelling Test::Pod Test::Pod::Coverage
       - name: prove

diff --git a/.github/workflows/perl.yml b/.github/workflows/perl.yml
@@ -19,20 +19,22 @@ jobs:
     name: 🧅 Perl ${{ matrix.perl }} on ${{ matrix.os[0] }} ${{ matrix.os[1] }}
     runs-on: ${{ matrix.os[1] }}-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Perl
         id: perl
         uses: shogo82148/actions-setup-perl@v1
         with: { perl-version: "${{ matrix.perl }}" }
       - run: perl -V
+      - if: runner.os == 'Linux'
+        name: Install Apt Packages
+        run: sudo apt-get install -qq language-pack-fr language-pack-en language-pack-de language-pack-it
       - name: Cache CPAN Modules
         uses: actions/cache@v3
         with:
           path: local
           key: perl-${{ steps.perl.outputs.perl-hash }}
-      # Remove Locale::TextDomain if https://github.com/gflohr/libintl-perl/issues/7 fixed and released.
-      - if: ${{ matrix.os[1] == 'windows' }}
-        run: cpm install --verbose --show-build-log-on-failure --no-test --with-recommends Encode Win32::Console::ANSI Win32API::Net Win32::Locale Win32::ShellQuote DateTime::TimeZone::Local::Win32 Locale::TextDomain@1.31
+      - if: runner.os == 'Windows'
+        run: cpm install --verbose --show-build-log-on-failure --no-test --with-recommends Encode Win32::Console::ANSI Win32API::Net Win32::Locale Win32::ShellQuote DateTime::TimeZone::Local::Win32
       - run: cpm install --verbose --show-build-log-on-failure --no-test --with-recommends --cpanfile dist/cpanfile
       - run: cpm install --verbose --show-build-log-on-failure --no-test --with-recommends Test::Spelling Test::Pod Test::Pod::Coverage
       - name: prove

diff --git a/.github/workflows/pg.yml b/.github/workflows/pg.yml
@@ -15,7 +15,7 @@ jobs:
     name: 🐘 Postgres ${{ matrix.pg }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Perl
         id: perl
         uses: shogo82148/actions-setup-perl@v1

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -10,7 +10,7 @@ jobs:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
     - name: Check out the repo
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Setup Perl
       id: perl
       uses: shogo82148/actions-setup-perl@v1

diff --git a/.github/workflows/snowflake.yml b/.github/workflows/snowflake.yml
@@ -11,7 +11,7 @@ jobs:
     name: ❄️ Snowflake
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Clients
         run: .github/ubuntu/snowflake.sh
       - name: Setup Perl

diff --git a/.github/workflows/sqlite.yml b/.github/workflows/sqlite.yml
@@ -16,7 +16,7 @@ jobs:
     name: 💡 SQLite ${{ matrix.sqlite }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Perl
         id: perl
         uses: shogo82148/actions-setup-perl@v1

diff --git a/.github/workflows/vertica.yml b/.github/workflows/vertica.yml
@@ -27,7 +27,7 @@ jobs:
         image: ${{ matrix.image }}:${{ matrix.version }}
         ports: [ 5433 ]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Clients
         run: .github/ubuntu/vertica.sh
       - name: Setup Perl

diff --git a/.github/workflows/yugabyte.yml b/.github/workflows/yugabyte.yml
@@ -34,7 +34,7 @@ jobs:
         uses: jameshartig/yugabyte-db-action@master
         with:
           yb_image_tag: "${{ matrix.tag }}"
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Perl
         id: perl
         uses: shogo82148/actions-setup-perl@v1

diff --git a/.gitignore b/.gitignore
@@ -13,7 +13,8 @@
 /_rpmbuild
 /target
 .build/
-*.mo
 .al
 /latest_changes.md
 /local/
+/LocaleData/
+/lib/LocaleData/
diff --git a/Changes b/Changes
@@ -22,6 +22,10 @@ Revision history for Perl extension App::Sqitch
        (#795)!
      - Fixed Oracle and Firebird test failures due to incorrect use of `chmod`.
        Thanks to Slaven Rezić for the report and the fix (#807)!
+     - Updated the locale configuration to fix issues in more recent versions
+       of Perl, and added tests to ensure that the sqitch CLI executes and
+       properly emits localized messages (except on Windows, where the language
+       codes are incompatible).
 
 1.4.0 2023-08-01T23:37:30Z
      - Fixed Snowflake warehouse and role setup to properly quote identifiers

diff --git a/bin/sqitch b/bin/sqitch
@@ -1,15 +1,6 @@
 #!perl -w -CAS
 
 # VERSION
-use POSIX qw(setlocale);
-BEGIN {
-    if ($^O eq 'MSWin32') {
-        require Win32::Locale;
-        setlocale POSIX::LC_ALL, Win32::Locale::get_locale();
-    } else {
-        setlocale POSIX::LC_ALL, '';
-    }
-}
+use locale;
 use App::Sqitch;
-
 exit App::Sqitch->go;
diff --git a/dist.ini b/dist.ini
@@ -2,7 +2,7 @@ name = App-Sqitch
 license = MIT
 copyright_holder = "iovation Inc., David E. Wheeler"
 copyright_year = 2012-2023
-version = v1.4.1-dev
+version = v1.4.1
 
 [GatherDir]
 exclude_filename = dist/cpanfile

diff --git a/po/de_DE.po b/po/de_DE.po
@@ -10,7 +10,7 @@ msgstr ""
 "POT-Creation-Date: 2023-07-30 20:02-0400\n"
 "PO-Revision-Date: 2012-08-31 17:15-0700\n"
 "Last-Translator: Thomas Iguchi <ti@nobu-games.com>\n"
-"Language-Team: German <david@justatheory.com>\n"
+"Language-Team: Sqitch Hackers <sqitch-hackers@googlegroups.com>\n"
 "Language: de\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"

diff --git a/po/fr_FR.po b/po/fr_FR.po
@@ -10,7 +10,7 @@ msgstr ""
 "POT-Creation-Date: 2023-07-30 20:02-0400\n"
 "PO-Revision-Date: 2012-10-12 11:28-0700\n"
 "Last-Translator: Arnaud Assad <arhuman@gmail.com>\n"
-"Language-Team: French <arhuman@gmail.com>\n"
+"Language-Team: Sqitch Hackers <sqitch-hackers@googlegroups.com>\n"
 "Language: fr\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"

diff --git a/po/it_IT.po b/po/it_IT.po
@@ -10,7 +10,7 @@ msgstr ""
 "POT-Creation-Date: 2023-07-30 20:02-0400\n"
 "PO-Revision-Date: 2017-10-12 10:30+0200\n"
 "Last-Translator: Luca Ferrari <fluca1978@gmail.com>\n"
-"Language-Team: Italian <fluca1978@gmail.com>\n"
+"Language-Team: Sqitch Hackers <sqitch-hackers@googlegroups.com>\n"
 "Language: it_IT\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"

diff --git a/t/sqitch b/t/sqitch
@@ -1,14 +1,6 @@
 #!/usr/bin/env perl -CAS
 
-use POSIX qw(setlocale);
-BEGIN {
-    if ($^O eq 'MSWin32') {
-        require Win32::Locale;
-        setlocale POSIX::LC_ALL, Win32::Locale::get_locale();
-    } else {
-        setlocale POSIX::LC_ALL, '';
-    }
-}
+use locale;
 use FindBin;
 use lib "$FindBin::Bin/../lib";
 use App::Sqitch;

diff --git a/xt/locale/LocaleData/de_DE/LC_MESSAGES/App-Sqitch.mo b/xt/locale/LocaleData/de_DE/LC_MESSAGES/App-Sqitch.mo
diff --git a/xt/locale/LocaleData/fr_FR/LC_MESSAGES/App-Sqitch.mo b/xt/locale/LocaleData/fr_FR/LC_MESSAGES/App-Sqitch.mo
diff --git a/xt/locale/LocaleData/it_IT/LC_MESSAGES/App-Sqitch.mo b/xt/locale/LocaleData/it_IT/LC_MESSAGES/App-Sqitch.mo
diff --git a/xt/locale/README.md b/xt/locale/README.md
@@ -0,0 +1,43 @@
+Sqitch Locale Test
+==================
+
+This directory contains the files necessary to test the Sqitch CLI to ensure it
+properly detects locale settings and emits translated messages. The
+[`po` directory here](./po/), unlike the canonical translations in the root `po`
+directory, contains only a few languages translating a single message:
+
+```
+"{command}" is not a valid command
+```
+
+The `LocaleData` directory contains the compiled forms of these dictionaries,
+and unlike the main dictionaries, these are committed to the repository. This
+allows the [OS](.github/workflows/os.yml) and [Perl](.github/workflows/os.yml)
+workflows to run without the overhead of compiling them (a PITA since `gettext`
+is hard to get on Windows and Dist::Zilla supports only more recent versions of
+Perl). If the messages need to change, recompile the dictionaries with these
+commands:
+
+```sh
+cpanm Dist::Zilla --notest
+dzil authordeps --missing | cpanm --notest
+dzil msg-compile -d xt/locale xt/locale/po/*.po
+```
+
+For errors where it can't find `msgformat` or `gettext`, be sure that [gettext]
+is installed (readily available via `apt-get`, `yum`, or `brew`).
+
+Now run the test, which validates the output from [`bin/sqitch`](bin/sqitch):
+
+```sh
+prove -lv xt/locale/test-cli.t
+```
+
+If tests fail, be sure each of the locales is installed on your system.
+Apt-based systems, for example, require the relevant language packs:
+
+```sh
+sudo apt-get install -qq language-pack-fr language-pack-en language-pack-de language-pack-it
+```
+
+  [gettext]: https://www.gnu.org/software/gettext/
diff --git a/xt/locale/po/de_DE.po b/xt/locale/po/de_DE.po
@@ -0,0 +1,12 @@
+msgid ""
+msgstr ""
+"Language: de\n"
+"Project-Id-Version: Sqitch 1.4.1\n"
+"PO-Revision-Date: 22024-01-06T21:10:06Z\n"
+"Last-Translator: Sqitch Hackers <sqitch-hackers@googlegroups.com>\n"
+"Language-Team: Sqitch Hackers <sqitch-hackers@googlegroups.com>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+msgid "\"{command}\" is not a valid command"
+msgstr "\"{command}\" ist ein ungültiger Befehl"
diff --git a/xt/locale/po/fr_FR.po b/xt/locale/po/fr_FR.po
@@ -0,0 +1,12 @@
+msgid ""
+msgstr ""
+"Language: fr\n"
+"Project-Id-Version: Sqitch 1.4.1\n"
+"PO-Revision-Date: 22024-01-06T21:10:06Z\n"
+"Last-Translator: Sqitch Hackers <sqitch-hackers@googlegroups.com>\n"
+"Language-Team: Sqitch Hackers <sqitch-hackers@googlegroups.com>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+msgid "\"{command}\" is not a valid command"
+msgstr "\"{command}\" n'est pas une commande valide"
diff --git a/xt/locale/po/it_IT.po b/xt/locale/po/it_IT.po
@@ -0,0 +1,12 @@
+msgid ""
+msgstr ""
+"Language: it\n"
+"Project-Id-Version: Sqitch 1.4.1\n"
+"PO-Revision-Date: 22024-01-06T21:10:06Z\n"
+"Last-Translator: Sqitch Hackers <sqitch-hackers@googlegroups.com>\n"
+"Language-Team: Sqitch Hackers <sqitch-hackers@googlegroups.com>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+msgid "\"{command}\" is not a valid command"
+msgstr "\"{command}\" non è un comando valido"