[ Impact ]
Accounts with unicode characters in their contract information are unable to run `pro status` if their terminal doesn't support unicode characters, which is also the last step of a `pro attach`. Attaches should still work, but it is impossible to confirm because `pro status` doesn't work.
The fix is to ignore unicode characters when printing the output of `pro status` if python.stdout.encoding is something other than "utf-8".
[ Test Plan ]
Recreate the bug:
Start a bionic container and perform the following to insert a unicode character into the account name and try to run status with a locale that causes python to try to print only ascii (note this only affects xenial and bionic - on focal and later python will still treat output as utf-8)
```
pro attach $TOKEN
sed -i 's/"name": "[a-zA-Z ]\+"/"name": "ü"/g' /var/lib/ubuntu-advantage/private/machine-token.json
LC_CTYPE=es_ES.UTF-8 pro status
# see crash
```
To see the fix, install the new version (currently in staging PPA, but for SRU verification it will be in -proposed) and try again
```
add-apt-repository ppa:ua-client/staging
apt install ubuntu-advantage-tools
LC_CTYPE=es_ES.UTF-8 pro status
# no crash - unicode character is not printed
```
[ Where problems could occur ]
This works by ignoring non-ascii characters when python thinks the stdout encoding is something other than utf-8. This could result in not printing unicode characters in some situations where it would actually be okay.
Since we're ignoring unicode characters in these situations, we could misrepresent certain strings, such as account names. This could be confusing.
[ Original Description ]
# lsb_release -rd
Description: Ubuntu 18.04.6 LTS
Release: 18.04
# pro --version
27.14.4~18.04
I wanted to attach the server to our new Ubuntu pro subscribtion. so I run:
# pro attach <MY_TOKEN>
that fails with:
["2023-05-15T15:49:04.130", "ERROR", "root", "wrapper", 1942, "Unhandled exception, please file a bug", {"exc_inf
o": "Traceback (most recent call last):\n File \"/usr/lib/python3/dist-packages/uaclient/cli.py\", line 1886, in
wrapper\n return func(*args, **kwargs)\n File \"/usr/lib/python3/dist-packages/uaclient/cli.py\", line 1994, in main\n return_value = args.action(args, cfg=cfg)\n File \"/usr/lib/python3/dist-packages/uaclient/cli.py\", line 1692, in action_status\n event.info(util.handle_unicode_characters(output))\n File \"/usr/lib/python3/dist-packages/uaclient/event_logger.py\", line 118, in info\n print(info_msg, file=file_type, end=end)\nUnicodeEncodeError: 'ascii' codec can't encode character '\\xfc' in position 1002: ordinal not in range(128)"}]
then as suggested I run
# pro status
Unexpected error(s) occurred.
For more details, see the log: /var/log/ubuntu-advantage.log
To file a bug run: ubuntu-bug ubuntu-advantage-tools
and created a bug using ubuntu-bug ubuntu-advantage-tools
let me know if you need more info
ProblemType: Bug
DistroRelease: Ubuntu 18.04
Package: ubuntu-advantage-tools 27.14.4~18.04
ProcVersionSignature: Ubuntu 4.15.0-210.221-generic 4.15.18
Uname: Linux 4.15.0-210-generic x86_64
NonfreeKernelModules: nvidia_modeset nvidia
ApportVersion: 2.20.9-0ubuntu7.29
Architecture: amd64
Date: Mon May 15 15:52:17 2023
ProcEnviron:
TERM=xterm-256color
PATH=(custom, no user)
XDG_RUNTIME_DIR=<set>
SHELL=/bin/bash
SourcePackage: ubuntu-advantage-tools
UpgradeStatus: Upgraded to bionic on 2023-03-30 (46 days ago)
cloud-id.txt-error: Error: path contained symlinks.
livepatch-status.txt-error: Error: path contained symlinks.
ua-status.json: Error: path contained symlinks.
uaclient.conf: Error: path contained symlinks.
ubuntu-advantage-timer.log: Error: path contained symlinks.
ubuntu-advantage.log: Error: path contained symlinks.
Hi vspano,
Thanks for reporting this bug. We will make the Pro client more robust to this type of errors. But just to see if we can create a better test case for this issue, which language pack are you using in the machine ? I just want to double if the problem might be related to this