fix: add ordering constraints for the markdown files

Author: Leon-hk

src/gardenlinux/features/difference_formatter.py

@@ -325,7 +325,11 @@ def __str__(self) -> str:
             row += "|No analysis available|\n"
             rows += row
 
-        for files in trees:
+        # Sort the problems by affected flavors in descending order and by files names for problems with the same number of affected flavors
+        # to get a derterministic ordering for testing
+        sorting_function = lambda files: (-len(trees[files][0]), ",".join(files))
+
+        for files in sorted(trees, key=sorting_function):
             flavors, tree = trees[files]
             row = "|"
             row += self._dropdown(files)

test-data/diff_files/different_commit.md

@@ -11,8 +11,8 @@
 |----------------|---------|------------------------------|
 |`/etc/os-release`|**97.3%** affected<br><details><summary>ali-gardener_prod-amd64...</summary>`ali-gardener_prod-amd64`<br>`aws-gardener_prod-amd64`<br>`aws-gardener_prod-arm64`<br>`aws-gardener_prod_tpm2_trustedboot-amd64`<br>`aws-gardener_prod_tpm2_trustedboot-arm64`<br>`aws-gardener_prod_trustedboot-amd64`<br>`aws-gardener_prod_trustedboot-arm64`<br>`aws-gardener_prod_usi-amd64`<br>`aws-gardener_prod_usi-arm64`<br>`azure-gardener_prod-amd64`<br>`azure-gardener_prod-arm64`<br>`azure-gardener_prod_tpm2_trustedboot-amd64`<br>`azure-gardener_prod_tpm2_trustedboot-arm64`<br>`azure-gardener_prod_trustedboot-amd64`<br>`azure-gardener_prod_trustedboot-arm64`<br>`azure-gardener_prod_usi-amd64`<br>`azure-gardener_prod_usi-arm64`<br>`bare-nodejs-amd64`<br>`bare-nodejs-arm64`<br>`bare-python-amd64`<br>`bare-python-arm64`<br>`bare-sapmachine-amd64`<br>`bare-sapmachine-arm64`<br>`container-amd64`<br>`container-arm64`<br>`gcp-gardener_prod-amd64`<br>`gcp-gardener_prod-arm64`<br>`gcp-gardener_prod_tpm2_trustedboot-amd64`<br>`gcp-gardener_prod_tpm2_trustedboot-arm64`<br>`gcp-gardener_prod_trustedboot-amd64`<br>`gcp-gardener_prod_trustedboot-arm64`<br>`gcp-gardener_prod_usi-amd64`<br>`gcp-gardener_prod_usi-arm64`<br>`gdch-gardener_prod-amd64`<br>`gdch-gardener_prod-arm64`<br>`kvm-gardener_prod-amd64`<br>`kvm-gardener_prod-arm64`<br>`kvm-gardener_prod_tpm2_trustedboot-amd64`<br>`kvm-gardener_prod_tpm2_trustedboot-arm64`<br>`kvm-gardener_prod_trustedboot-amd64`<br>`kvm-gardener_prod_trustedboot-arm64`<br>`kvm-gardener_prod_usi-amd64`<br>`kvm-gardener_prod_usi-arm64`<br>`metal-capi-amd64`<br>`metal-capi-arm64`<br>`metal-gardener_prod-amd64`<br>`metal-gardener_prod-arm64`<br>`metal-gardener_prod_tpm2_trustedboot-amd64`<br>`metal-gardener_prod_tpm2_trustedboot-arm64`<br>`metal-gardener_prod_trustedboot-amd64`<br>`metal-gardener_prod_trustedboot-arm64`<br>`metal-gardener_prod_usi-amd64`<br>`metal-gardener_prod_usi-arm64`<br>`metal-gardener_pxe-amd64`<br>`metal-gardener_pxe-arm64`<br>`metal-vhost-amd64`<br>`metal-vhost-arm64`<br>`metal_pxe-amd64`<br>`metal_pxe-arm64`<br>`openstack-gardener_prod-amd64`<br>`openstack-gardener_prod-arm64`<br>`openstack-gardener_prod_tpm2_trustedboot-amd64`<br>`openstack-gardener_prod_tpm2_trustedboot-arm64`<br>`openstack-gardener_prod_trustedboot-amd64`<br>`openstack-gardener_prod_trustedboot-arm64`<br>`openstack-gardener_prod_usi-amd64`<br>`openstack-gardener_prod_usi-arm64`<br>`openstackbaremetal-gardener_prod-amd64`<br>`openstackbaremetal-gardener_prod-arm64`<br>`vmware-gardener_prod-amd64`<br>`vmware-gardener_prod-arm64`</details>|<pre>base:<br>  _slim</pre>|
 |`/boot/initrd.img-6.12.57-cloud-amd64`<br>`/efi/Default/6.12.57-cloud-amd64/initrd`|**11.0%** affected<br>`ali-gardener_prod-amd64`<br>`aws-gardener_prod-amd64`<br>`azure-gardener_prod-amd64`<br>`gcp-gardener_prod-amd64`<br>`gdch-gardener_prod-amd64`<br>`kvm-gardener_prod-amd64`<br>`openstack-gardener_prod-amd64`<br>`vmware-gardener_prod-amd64`|No analysis available|
-|`/boot/initrd.img-6.12.57-amd64`<br>`/efi/Default/6.12.57-amd64/initrd`|**8.2%** affected<br>`metal-capi-amd64`<br>`metal-gardener_prod-amd64`<br>`metal-gardener_pxe-amd64`<br>`metal-vhost-amd64`<br>`metal_pxe-amd64`<br>`openstackbaremetal-gardener_prod-amd64`|No analysis available|
 |`/boot/initrd.img-6.12.57-cloud-arm64`<br>`/efi/Default/6.12.57-cloud-arm64/initrd`|**9.6%** affected<br>`aws-gardener_prod-arm64`<br>`azure-gardener_prod-arm64`<br>`gcp-gardener_prod-arm64`<br>`gdch-gardener_prod-arm64`<br>`kvm-gardener_prod-arm64`<br>`openstack-gardener_prod-arm64`<br>`vmware-gardener_prod-arm64`|No analysis available|
+|`/boot/initrd.img-6.12.57-amd64`<br>`/efi/Default/6.12.57-amd64/initrd`|**8.2%** affected<br>`metal-capi-amd64`<br>`metal-gardener_prod-amd64`<br>`metal-gardener_pxe-amd64`<br>`metal-vhost-amd64`<br>`metal_pxe-amd64`<br>`openstackbaremetal-gardener_prod-amd64`|No analysis available|
 |`/boot/initrd.img-6.12.57-arm64`<br>`/efi/Default/6.12.57-arm64/initrd`|**8.2%** affected<br>`metal-capi-arm64`<br>`metal-gardener_prod-arm64`<br>`metal-gardener_pxe-arm64`<br>`metal-vhost-arm64`<br>`metal_pxe-arm64`<br>`openstackbaremetal-gardener_prod-arm64`|No analysis available|
 |`/etc/hostname`|**2.7%** affected<br>`container-amd64`<br>`container-arm64`|<pre>container</pre>|
 |✅ No problems found|**2.7%**<br>`bare-libc-amd64`<br>`bare-libc-arm64`|-|

test-data/diff_files/many_issues.md

@@ -10,9 +10,9 @@
 | Affected Files | Flavors | Features Causing the Problem |
 |----------------|---------|------------------------------|
 |`/etc/os-release`|**100.0%** affected<br><details><summary>ali-gardener_prod-amd64...</summary>`ali-gardener_prod-amd64`<br>`aws-gardener_prod-amd64`<br>`aws-gardener_prod-arm64`<br>`aws-gardener_prod_tpm2_trustedboot-amd64`<br>`aws-gardener_prod_tpm2_trustedboot-arm64`<br>`aws-gardener_prod_trustedboot-amd64`<br>`aws-gardener_prod_trustedboot-arm64`<br>`aws-gardener_prod_usi-amd64`<br>`aws-gardener_prod_usi-arm64`<br>`azure-gardener_prod-amd64`<br>`azure-gardener_prod-arm64`<br>`azure-gardener_prod_tpm2_trustedboot-amd64`<br>`azure-gardener_prod_tpm2_trustedboot-arm64`<br>`azure-gardener_prod_trustedboot-amd64`<br>`azure-gardener_prod_trustedboot-arm64`<br>`azure-gardener_prod_usi-amd64`<br>`azure-gardener_prod_usi-arm64`<br>`bare-libc-amd64`<br>`bare-libc-arm64`<br>`bare-nodejs-amd64`<br>`bare-nodejs-arm64`<br>`bare-python-amd64`<br>`bare-python-arm64`<br>`bare-sapmachine-amd64`<br>`bare-sapmachine-arm64`<br>`container-amd64`<br>`container-arm64`<br>`gcp-gardener_prod-amd64`<br>`gcp-gardener_prod-arm64`<br>`gcp-gardener_prod_tpm2_trustedboot-amd64`<br>`gcp-gardener_prod_tpm2_trustedboot-arm64`<br>`gcp-gardener_prod_trustedboot-amd64`<br>`gcp-gardener_prod_trustedboot-arm64`<br>`gcp-gardener_prod_usi-amd64`<br>`gcp-gardener_prod_usi-arm64`<br>`gdch-gardener_prod-amd64`<br>`gdch-gardener_prod-arm64`<br>`kvm-gardener_prod-amd64`<br>`kvm-gardener_prod-arm64`<br>`kvm-gardener_prod_tpm2_trustedboot-amd64`<br>`kvm-gardener_prod_tpm2_trustedboot-arm64`<br>`kvm-gardener_prod_trustedboot-amd64`<br>`kvm-gardener_prod_trustedboot-arm64`<br>`kvm-gardener_prod_usi-amd64`<br>`kvm-gardener_prod_usi-arm64`<br>`metal-capi-amd64`<br>`metal-capi-arm64`<br>`metal-gardener_prod-amd64`<br>`metal-gardener_prod-arm64`<br>`metal-gardener_prod_tpm2_trustedboot-amd64`<br>`metal-gardener_prod_tpm2_trustedboot-arm64`<br>`metal-gardener_prod_trustedboot-amd64`<br>`metal-gardener_prod_trustedboot-arm64`<br>`metal-gardener_prod_usi-amd64`<br>`metal-gardener_prod_usi-arm64`<br>`metal-gardener_pxe-amd64`<br>`metal-gardener_pxe-arm64`<br>`metal-vhost-amd64`<br>`metal-vhost-arm64`<br>`metal_pxe-amd64`<br>`metal_pxe-arm64`<br>`openstack-gardener_prod-amd64`<br>`openstack-gardener_prod-arm64`<br>`openstack-gardener_prod_tpm2_trustedboot-amd64`<br>`openstack-gardener_prod_tpm2_trustedboot-arm64`<br>`openstack-gardener_prod_trustedboot-amd64`<br>`openstack-gardener_prod_trustedboot-arm64`<br>`openstack-gardener_prod_usi-amd64`<br>`openstack-gardener_prod_usi-arm64`<br>`openstackbaremetal-gardener_prod-amd64`<br>`openstackbaremetal-gardener_prod-arm64`<br>`vmware-gardener_prod-amd64`<br>`vmware-gardener_prod-arm64`</details>|<pre>base:<br>  _slim</pre>|
+|`/boot/initrd.img-6.12.57-cloud-arm64`<br>`/efi/Default/6.12.57-cloud-arm64/initrd`|**12.3%** affected<br>`aws-gardener_prod-arm64`<br>`azure-gardener_prod-arm64`<br>`bare-libc-amd64`<br>`bare-libc-arm64`<br>`gcp-gardener_prod-arm64`<br>`gdch-gardener_prod-arm64`<br>`kvm-gardener_prod-arm64`<br>`openstack-gardener_prod-arm64`<br>`vmware-gardener_prod-arm64`|No analysis available|
 |`/boot/initrd.img-6.12.57-cloud-amd64`<br>`/efi/Default/6.12.57-cloud-amd64/initrd`|**11.0%** affected<br>`ali-gardener_prod-amd64`<br>`aws-gardener_prod-amd64`<br>`azure-gardener_prod-amd64`<br>`gcp-gardener_prod-amd64`<br>`gdch-gardener_prod-amd64`<br>`kvm-gardener_prod-amd64`<br>`openstack-gardener_prod-amd64`<br>`vmware-gardener_prod-amd64`|No analysis available|
 |`/boot/initrd.img-6.12.57-amd64`<br>`/efi/Default/6.12.57-amd64/initrd`|**8.2%** affected<br>`metal-capi-amd64`<br>`metal-gardener_prod-amd64`<br>`metal-gardener_pxe-amd64`<br>`metal-vhost-amd64`<br>`metal_pxe-amd64`<br>`openstackbaremetal-gardener_prod-amd64`|No analysis available|
-|`/boot/initrd.img-6.12.57-cloud-arm64`<br>`/efi/Default/6.12.57-cloud-arm64/initrd`|**12.3%** affected<br>`aws-gardener_prod-arm64`<br>`azure-gardener_prod-arm64`<br>`bare-libc-amd64`<br>`bare-libc-arm64`<br>`gcp-gardener_prod-arm64`<br>`gdch-gardener_prod-arm64`<br>`kvm-gardener_prod-arm64`<br>`openstack-gardener_prod-arm64`<br>`vmware-gardener_prod-arm64`|No analysis available|
 |`/boot/initrd.img-6.12.57-arm64`<br>`/efi/Default/6.12.57-arm64/initrd`|**8.2%** affected<br>`metal-capi-arm64`<br>`metal-gardener_prod-arm64`<br>`metal-gardener_pxe-arm64`<br>`metal-vhost-arm64`<br>`metal_pxe-arm64`<br>`openstackbaremetal-gardener_prod-arm64`|No analysis available|
 |`/etc/hostname`|**2.7%** affected<br>`container-amd64`<br>`container-arm64`|<pre>container</pre>|