[PATCH] lib/bbconfigbuild/configfragments: disable the previous builtin fragment when enabling a new one

[PATCH] lib/bbconfigbuild/configfragments: disable the previous builtin fragment when enabling a new one

[Alexander Kanavin]

From: Alexander Kanavin <alex@linutronix.de>

There was a flaw in the logic that allowed multiple builtin fragments with
the same prefix to be enabled at the same time. The correct behaviour
is that only one of them should be enabled, and when enabling it
all previously enabled fragments should be removed.

The issues that this caused are further explained in
https://bugzilla.yoctoproject.org/show_bug.cgi?id=15987

[YOCTO #15987]

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
---
 meta/lib/bbconfigbuild/configfragments.py |  7 ++++++-
 meta/lib/oeqa/selftest/cases/bblayers.py  | 15 +++++++++------
 2 files changed, 15 insertions(+), 7 deletions(-)

diff --git a/meta/lib/bbconfigbuild/configfragments.py b/meta/lib/bbconfigbuild/configfragments.py
index fce3301bac9..34c6a3b4bcc 100644
--- a/meta/lib/bbconfigbuild/configfragments.py
+++ b/meta/lib/bbconfigbuild/configfragments.py
@@ -104,8 +104,11 @@ class ConfigFragmentsPlugin(LayerPlugin):
                   return True
         return False
 
+    def fragment_prefix(self, fragmentname):
+        return fragmentname.split("/",1)[0]
+
     def builtin_fragment_exists(self, fragmentname):
-        fragment_prefix = fragmentname.split("/",1)[0]
+        fragment_prefix = self.fragment_prefix(fragmentname)
         fragment_prefix_defs = set([f.split(':')[0] for f in self.tinfoil.config_data.getVar('OE_FRAGMENTS_BUILTIN').split()])
         return fragment_prefix in fragment_prefix_defs
 
@@ -128,6 +131,8 @@ class ConfigFragmentsPlugin(LayerPlugin):
                 if f in enabled_fragments:
                     print("Fragment {} already included in {}".format(f, args.confpath))
                 else:
+                    # first filter out all built-in fragments with the same prefix as the one that is being enabled
+                    enabled_fragments = [fragment for fragment in enabled_fragments if not(self.builtin_fragment_exists(fragment) and self.fragment_prefix(fragment) == self.fragment_prefix(f))]
                     enabled_fragments.append(f)
             return " ".join(enabled_fragments), None, 0, True
 
diff --git a/meta/lib/oeqa/selftest/cases/bblayers.py b/meta/lib/oeqa/selftest/cases/bblayers.py
index d82c5aaf376..7eb176aa04b 100644
--- a/meta/lib/oeqa/selftest/cases/bblayers.py
+++ b/meta/lib/oeqa/selftest/cases/bblayers.py
@@ -281,11 +281,11 @@ class BitbakeConfigBuild(OESelftestTestCase):
         2. Verify that SELFTEST_BUILTIN_FRAGMENT_VARIABLE is set after setting
            the fragment.
         3. Verify that SELFTEST_BUILTIN_FRAGMENT_VARIABLE is set after setting
-           the fragment with another value that overrides the first one.
-        4. Verify that SELFTEST_BUILTIN_FRAGMENT_VARIABLE is set to the previous
-           value after removing the second assignment (from step 3).
+           the fragment with another value that replaces the first one.
+        4. Repeat steps 2 and 3 to verify that going back and forth between values
+           works.
         5. Verify that SELFTEST_BUILTIN_FRAGMENT_VARIABLE is not set after
-           removing the original assignment.
+           removing the final assignment.
         """
         self.assertEqual(get_bb_var('SELFTEST_BUILTIN_FRAGMENT_VARIABLE'), None)
 
@@ -295,10 +295,13 @@ class BitbakeConfigBuild(OESelftestTestCase):
         runCmd('bitbake-config-build enable-fragment selftest-fragment/someothervalue')
         self.assertEqual(get_bb_var('SELFTEST_BUILTIN_FRAGMENT_VARIABLE'), 'someothervalue')
 
-        runCmd('bitbake-config-build disable-fragment selftest-fragment/someothervalue')
+        runCmd('bitbake-config-build enable-fragment selftest-fragment/somevalue')
         self.assertEqual(get_bb_var('SELFTEST_BUILTIN_FRAGMENT_VARIABLE'), 'somevalue')
 
-        runCmd('bitbake-config-build disable-fragment selftest-fragment/somevalue')
+        runCmd('bitbake-config-build enable-fragment selftest-fragment/someothervalue')
+        self.assertEqual(get_bb_var('SELFTEST_BUILTIN_FRAGMENT_VARIABLE'), 'someothervalue')
+
+        runCmd('bitbake-config-build disable-fragment selftest-fragment/someothervalue')
         self.assertEqual(get_bb_var('SELFTEST_BUILTIN_FRAGMENT_VARIABLE'), None)
 
     def test_show_fragment(self):
-- 
2.39.5

Patchtest results for [PATCH] lib/bbconfigbuild/configfragments: disable the previous builtin fragment when enabling a new one

[patchtest]

[-- Attachment #1: Type: text/plain, Size: 3134 bytes --]

Thank you for your submission. Patchtest identified one
or more issues with the patch. Please see the log below for
more information:

---
Testing patch /home/patchtest/share/mboxes/lib-bbconfigbuild-configfragments-disable-the-previous-builtin-fragment-when-enabling-a-new-one.patch

FAIL: test shortlog length: Edit shortlog so that it is 90 characters or less (currently 96 characters) (test_mbox.TestMbox.test_shortlog_length)

PASS: pretest pylint (test_python_pylint.PyLint.pretest_pylint)
PASS: test Signed-off-by presence (test_mbox.TestMbox.test_signed_off_by_presence)
PASS: test author valid (test_mbox.TestMbox.test_author_valid)
PASS: test bugzilla entry format (test_mbox.TestMbox.test_bugzilla_entry_format)
PASS: test commit message presence (test_mbox.TestMbox.test_commit_message_presence)
PASS: test commit message user tags (test_mbox.TestMbox.test_commit_message_user_tags)
PASS: test max line length (test_metadata.TestMetadata.test_max_line_length)
PASS: test mbox format (test_mbox.TestMbox.test_mbox_format)
PASS: test non-AUH upgrade (test_mbox.TestMbox.test_non_auh_upgrade)
PASS: test pylint (test_python_pylint.PyLint.test_pylint)
PASS: test shortlog format (test_mbox.TestMbox.test_shortlog_format)
PASS: test target mailing list (test_mbox.TestMbox.test_target_mailing_list)

SKIP: pretest src uri left files: No modified recipes, skipping pretest (test_metadata.TestMetadata.pretest_src_uri_left_files)
SKIP: test CVE check ignore: No modified recipes or older target branch, skipping test (test_metadata.TestMetadata.test_cve_check_ignore)
SKIP: test CVE tag format: No new CVE patches introduced (test_patch.TestPatch.test_cve_tag_format)
SKIP: test Signed-off-by presence: No new CVE patches introduced (test_patch.TestPatch.test_signed_off_by_presence)
SKIP: test Upstream-Status presence: No new CVE patches introduced (test_patch.TestPatch.test_upstream_status_presence_format)
SKIP: test lic files chksum modified not mentioned: No modified recipes, skipping test (test_metadata.TestMetadata.test_lic_files_chksum_modified_not_mentioned)
SKIP: test lic files chksum presence: No added recipes, skipping test (test_metadata.TestMetadata.test_lic_files_chksum_presence)
SKIP: test license presence: No added recipes, skipping test (test_metadata.TestMetadata.test_license_presence)
SKIP: test series merge on head: Merge test is disabled for now (test_mbox.TestMbox.test_series_merge_on_head)
SKIP: test src uri left files: No modified recipes, skipping pretest (test_metadata.TestMetadata.test_src_uri_left_files)
SKIP: test summary presence: No added recipes, skipping test (test_metadata.TestMetadata.test_summary_presence)

---

Please address the issues identified and
submit a new revision of the patch, or alternatively, reply to this
email with an explanation of why the patch should be accepted. If you
believe these results are due to an error in patchtest, please submit a
bug at https://bugzilla.yoctoproject.org/ (use the 'Patchtest' category
under 'Yocto Project Subprojects'). For more information on specific
failures, see: https://wiki.yoctoproject.org/wiki/Patchtest. Thank
you!