archlinux: Fix broken locale logic

[klausenbusk]

Proposed Commit Message

archlinux: Fix broken locale logic

The locale wasn't persisted correct nor set.

LP: https://bugs.launchpad.net/cloud-init/+bug/1402406

Additional Context

See LP bug: https://bugs.launchpad.net/cloud-init/+bug/1402406

Test Steps

This has been tested manually and /etc/locale.gen is in the expected format now and the locale is written to /etc/locale.conf.

Checklist:

• My code follows the process laid out in the documentation
• I have updated or added any unit tests accordingly
• I have updated or added any documentation accordingly

[TheRealFalcon]

I've verified that the CLA has been signed. Thanks for this PR.

I left a couple comments inline. Additionally, can you provide a unit test for this behavior? There's a very small unit test file at unittests/test_distros/test_arch.py . Ensuring we write out the correct locale config would be a very useful unit test.

[klausenbusk]

There's a very small unit test file at unittests/test_distros/test_arch.py . Ensuring we write out the correct locale config would be a very useful unit test.

localectl requires systemd-localed to be running (communicating over D-Bus). Is that something which can be tested in the CI?

[TheRealFalcon]

localectl requires systemd-localed to be running (communicating over D-Bus). Is that something which can be tested in the CI?

We use mocks in our unit tests. For testing this particular functionality, it would make sense to have tests that show:

• /etc/locale.gen contains what we expect
• localectl set-locale is called with the right argument (showing that it worked correctly would be beyond the scope of the test)
• Invalid user input is handled appropriately (per our conversation above)

I earlier linked you to some Arch tests, but looking again, it'd probably make more sense for them to go into the test_handler_locale tests . There are also other examples in there showing how some of the mocking works.

I hope that all makes sense. Let me know if you have any questions or need some additional guidance. Further test guidelines can be found here:
https://cloudinit.readthedocs.io/en/latest/topics/testing.html

[github-actions]

Hello! Thank you for this proposed change to cloud-init. This pull request is now marked as stale as it has not seen any activity in 14 days. If no activity occurs within the next 7 days, this pull request will automatically close.

If you are waiting for code review and you are seeing this message, apologies! Please reply, tagging mitechie, and he will ensure that someone takes a look soon.

(If the pull request is closed and you would like to continue working on it, please do tag mitechie to reopen it.)

[klausenbusk]

Real life is getting in the way and writing tests is a bit more complicated than writing plain Python code. I hope to find some time in the near future.

[klausenbusk]

@mitechie can you reopen?

@TheRealFalcon I pushed the unit test code but the PR is apparently not updating when it is closed.

[TheRealFalcon]

@klausenbusk , unfortunately it appears that github doesn't allow reopening of PRs that have had their branch force-pushed to.

Feel free to open a new PR with your changes.

[klausenbusk]

@klausenbusk , unfortunately it appears that github doesn't allow reopening of PRs that have had their branch force-pushed to.

TIL. I opened a new PR: #841