Merge ~lvoytek/ubuntu/+source/mysql-8.0:mysql-fix-my-cnf-symlink-apport into ubuntu/+source/mysql-8.0:ubuntu/devel

[Lena Voytek]

When apport bugs are submitted for mysql with the default config, it will display my.cnf with

Error: [Errno 40] Too many levels of symbolic links: '/etc/mysql/my.cnf'

which can be an issue when trying to diagnose the actual problem.
This update shows what my.cnf links to if it is linked otherwise it will show the file customized by the user.

To test:

# lxc launch images:ubuntu/kinetic test-kinetic
# lxc exec test-kinetic bash

# apt update && apt dist-upgrade -y

# apt install apport mysql-server software-properties-common

# ubuntu-bug mysql-server
V
- Under the my.cnf section the too many symbolic links error will be shown
C

# add-apt-repository ppa:lvoytek/mysql-8.0-fix-apport-my-cnf-kinetic

- If 8.0.29-0ubuntu1 hasn't been released then enable proposed before updating

# apt update && apt upgrade -y

# export APPORT_DISABLE_DISTRO_CHECK=1

- Check default config
# ubuntu-bug mysql-server
V
- The my.cnf section will now show "MySQLConf.etc.mysql.my.cnf: my.cnf links to /etc/mysql/mysql.cnf"
C

- Check custom config
# rm /etc/mysql/my.cnf
# cp /etc/mysql/mysql.cnf /etc/mysql/my.cnf

# ubuntu-bug mysql-server
V
- The my.cnf section will now show the contents of the file
C

[Robie Basak (racb)]

Looks good, with an inline suggestion.

FTR, I looked up why there was a problem in the first place. Looks like apport.hookutils.read_file() uses os.open(..., os_O_NOFOLLOW) so it's intentional that it doesn't follow symlinks. I found that surprising, but I guess it does make sense to report the symlink target in this case instead, so doing it in the mysql-server apport hook works.

review: Approve

[Lena Voytek (lvoytek)]

> Looks good, with an inline suggestion.

That's a much better way of going about it, thanks! I updated the code and tested the apport file in an LXD container. The ppa version for it is currently building.

[Lena Voytek (lvoytek)]

The ppa finally finished building. I ran the autopkgtests against it locally in a vm and all tests passed

[Robie Basak (racb)]

Uploaded. Thanks!

diff --git a/debian/additions/source_mysql-8.0.py b/debian/additions/source_mysql-8.0.py
index ea3fb84..63754e3 100644
--- a/debian/additions/source_mysql-8.0.py
+++ b/debian/additions/source_mysql-8.0.py
@@ -78,7 +78,13 @@ def add_info(report, ui=None):
             report['UnreportableReason'] = "Missing /etc/mysql directory"
             return False
     else:
-        _add_my_conf_files(report, '/etc/mysql/my.cnf')
+        # By default my.cnf is a symlink, and _add_my_conf_files calls apport.hookutils.read_file()
+        # doesn't support them, so send the link target separately instead. LP: #1969369
+        if os.path.islink('/etc/mysql/my.cnf'):
+            my_cnf_link = os.path.realpath('/etc/mysql/my.cnf')
+            report['MySQLConf.etc.mysql.my.cnf'] = f'my.cnf links to {my_cnf_link}'
+        else:
+            _add_my_conf_files(report, '/etc/mysql/my.cnf')
         _add_my_conf_files(report, '/etc/mysql/mysql.cnf')
         for d in ['/etc/mysql/conf.d', '/etc/mysql/mysql.conf.d']:
             if os.path.isdir(d):
diff --git a/debian/changelog b/debian/changelog
index fd67d95..9258571 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+mysql-8.0 (8.0.29-0ubuntu3) kinetic; urgency=medium
+
+  * d/a/source_mysql-8.0.py: Fix apport too many symbolic
+    links report for my.cnf (LP: #1969369)
+
+ -- Lena Voytek <[e-mail]>  Thu, 12 May 2022 09:00:19 -0700
+
 mysql-8.0 (8.0.29-0ubuntu2) kinetic; urgency=medium
 
   * Add libexpect-perl module to fix mysqlpump_bugs test (LP: #1972737)