Skip to contentSkip to conversation

bitbake.conf: add an addfragments directive for oe-core and dependent layers

PATCH Superseded Alexander Kanavin 3 participants 7 messages Nov 14, 2024 – Nov 15, 2024

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 bitbake.conf: add an addfragments directive for oe-core and dependent layers

From: Alexander Kanavin <[email protected]>

Please see the patch to bitbake for syntax and implementation details.

The path prefix to fragments is in its own variable so it doesn't have to be hardcoded into tools.

---
 meta/conf/bitbake.conf | 2 ++
 1 file changed, 2 insertions(+)
meta/conf/bitbake.conf +2 -0
index 02bbf0e7a52..b6013f66e26 100644
@@ -836,6 +836,8 @@ include conf/documentation.conf
 include conf/licenses.conf
 require conf/sanity.conf
 include conf/bblock.conf
+OE_FRAGMENTS_PREFIX ?= "conf/fragments"
+addfragments ${OE_FRAGMENTS_PREFIX} OE_FRAGMENTS
 
 ##################################################################
 # Weak variables (usually to retain backwards compatibility)
Signature · 1 line
2.39.5
#1 lore raw

PATCH 2/2 bitbake-config-build: add a plugin for config fragments

From: Alexander Kanavin <[email protected]>

This allows fine-tuning local configurations with pre-frabricated configuration snippets in a structured, controlled way. It's also an important building block for bitbake-setup.

There are three (and a half) operations (list/enable/disable/disable all), and here's the 'list' output:

alex@Zen2:/srv/storage/alex/yocto/build-64$ bitbake-config-build list-fragments
NOTE: Starting bitbake server...
Available fragments in selftest layer located in /srv/work/alex/poky/meta-selftest:

selftest/test-another-fragment This is a second configuration fragment intended for testing in oe-selftest context
selftest/test-fragment This is a configuration fragment intended for testing in oe-selftest context

The tool requires that each fragment contains a one-line summary, and one or more lines of description, as BB_CONF_FRAGMENT_SUMMARY[fragmentname] style metadata.

---
 .../selftest/test-another-fragment.conf       |   3 +
 .../fragments/selftest/test-fragment.conf     |   3 +
 meta/lib/bbconfigbuild/configfragments.py     | 138 ++++++++++++++++++
 meta/lib/oeqa/selftest/cases/bblayers.py      |  31 ++++
 4 files changed, 175 insertions(+)
 create mode 100644 meta-selftest/conf/fragments/selftest/test-another-fragment.conf
 create mode 100644 meta-selftest/conf/fragments/selftest/test-fragment.conf
 create mode 100644 meta/lib/bbconfigbuild/configfragments.py
meta-selftest/conf/fragments/selftest/test-another-fragment.conf new file +3 -0
new file mode 100644
index 00000000000..4b4bf537964
@@ -0,0 +1,3 @@
+BB_CONF_FRAGMENT_SUMMARY[selftest/test-another-fragment] = "This is a second configuration fragment intended for testing in oe-selftest context"
+BB_CONF_FRAGMENT_DESCRIPTION[selftest/test-another-fragment] = "It defines another variable that can be checked inside the test."
+SELFTEST_FRAGMENT_ANOTHER_VARIABLE = "someothervalue"
meta-selftest/conf/fragments/selftest/test-fragment.conf new file +3 -0
new file mode 100644
index 00000000000..63ebc1fca68
@@ -0,0 +1,3 @@
+BB_CONF_FRAGMENT_SUMMARY[selftest/test-fragment] = "This is a configuration fragment intended for testing in oe-selftest context"
+BB_CONF_FRAGMENT_DESCRIPTION[selftest/test-fragment] = "It defines a variable that can be checked inside the test."
+SELFTEST_FRAGMENT_VARIABLE = "somevalue"
meta/lib/bbconfigbuild/configfragments.py new file +138 -0

138 lines not on this page · raw message

meta/lib/oeqa/selftest/cases/bblayers.py +31 -0
index 8b2bc319d50..945d9a511f7 100644
@@ -253,3 +253,34 @@ class BitbakeLayers(OESelftestTestCase):
                 meta_selftest_found = True
         self.assertTrue(oe_core_found, "meta/conf/layer.conf not found in {}".format(testcopydir))
         self.assertTrue(meta_selftest_found, "meta-selftest/conf/layer.conf not found in {}".format(testcopydir))
+
+class BitbakeConfigBuild(OESelftestTestCase):
+    def test_add_remove_fragments(self):
+        self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_VARIABLE'), None)
+        self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_ANOTHER_VARIABLE'), None)
+
+        runCmd('bitbake-config-build enable-fragment selftest/test-fragment')
+        self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_VARIABLE'), 'somevalue')
+        self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_ANOTHER_VARIABLE'), None)
+
+        runCmd('bitbake-config-build enable-fragment selftest/test-another-fragment')
+        self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_VARIABLE'), 'somevalue')
+        self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_ANOTHER_VARIABLE'), 'someothervalue')
+
+        fragment_metadata_command = "bitbake-getvar -f {} --value {}"
+        result = runCmd(fragment_metadata_command.format("selftest/test-fragment", "BB_CONF_FRAGMENT_SUMMARY"))
+        self.assertIn("This is a configuration fragment intended for testing in oe-selftest context", result.output)
+        result = runCmd(fragment_metadata_command.format("selftest/test-fragment", "BB_CONF_FRAGMENT_DESCRIPTION"))
+        self.assertIn("It defines a variable that can be checked inside the test.", result.output)
+        result = runCmd(fragment_metadata_command.format("selftest/test-another-fragment", "BB_CONF_FRAGMENT_SUMMARY"))
+        self.assertIn("This is a second configuration fragment intended for testing in oe-selftest context", result.output)
+        result = runCmd(fragment_metadata_command.format("selftest/test-another-fragment", "BB_CONF_FRAGMENT_DESCRIPTION"))
+        self.assertIn("It defines another variable that can be checked inside the test.", result.output)
+
+        runCmd('bitbake-config-build disable-fragment selftest/test-fragment')
+        self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_VARIABLE'), None)
+        self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_ANOTHER_VARIABLE'), 'someothervalue')
+
+        runCmd('bitbake-config-build disable-fragment selftest/test-another-fragment')
+        self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_VARIABLE'), None)
+        self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_ANOTHER_VARIABLE'), None)
Signature · 1 line
2.39.5
#2 lore raw

Patchtest results for [PATCH 2/2] bitbake-config-build: add a plugin for config fragments

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/2-2-bitbake-config-build-add-a-plugin-for-config-fragments.patch

FAIL: test max line length: Patch line too long (current length 213, maximum is 200) (test_metadata.TestMetadata.test_max_line_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 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 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 shortlog length (test_mbox.TestMbox.test_shortlog_length)
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 bugzilla entry format: No bug ID found (test_mbox.TestMbox.test_bugzilla_entry_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!

#3 lore raw

Re: [OE-core] [PATCH 2/2] bitbake-config-build: add a plugin for config fragments

In reply to Alexander Kanavin
Quoted 12 lines · Alexander Kanavin via lists.openembedded.org

From: Alexander Kanavin <[email protected]>

This allows fine-tuning local configurations with pre-frabricated configuration snippets in a structured, controlled way. It's also an important building block for bitbake-setup.

There are three (and a half) operations (list/enable/disable/disable all), and here's the 'list' output:

alex@Zen2:/srv/storage/alex/yocto/build-64$ bitbake-config-build list-fragments
NOTE: Starting bitbake server...
Available fragments in selftest layer located in /srv/work/alex/poky/meta-selftest:
Quoted 7 lines

selftest/test-another-fragment This is a second configuration fragment intended for testing in oe-selftest context
selftest/test-fragment This is a configuration fragment intended for testing in oe-selftest context

The tool requires that each fragment contains a one-line summary, and one or more lines of description, as BB_CONF_FRAGMENT_SUMMARY[fragmentname] style metadata.

Hi,

I did not manage to apply this patch on master as I get conflicts on meta/lib/oeqa/selftest/cases/bblayers.py.

I might be missing something, but can do you confirm this patch is to be applied on master without any dependency on another patch ?

Signature · 3 lines
Mathieu Dubois-Briand, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#4 lore raw

Re: [OE-core] [PATCH 2/2] bitbake-config-build: add a plugin for config fragments

Quoted 5 lines · Mathieu Dubois-Briand

I did not manage to apply this patch on master as I get conflicts on meta/lib/oeqa/selftest/cases/bblayers.py.

I might be missing something, but can do you confirm this patch is to be applied on master without any dependency on another patch ?

A mistake on my side: I sent it from a branch that had additional unrelated commits before these. I removed that, and just sent a v2.

Alex

#5 lore raw
In reply to Alexander Kanavin
Quoted 9 lines · Alexander Kanavin via lists.openembedded.org

From: Alexander Kanavin <[email protected]>

Please see the patch to bitbake for syntax and implementation details.

The path prefix to fragments is in its own variable so it doesn't have to be hardcoded into tools.

---

Hi Alexander,

I'm not sure what is the issue, but it looks like this patch is breaking the patchtest-selftest on the autobuilder: the remove layers step is timing out.

https://valkyrie.yoctoproject.org/#/builders/71/builds/431

Can you have a look at this issue ?

Signature · 3 lines
Mathieu Dubois-Briand, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#6 lore raw
Quoted 7 lines · Mathieu Dubois-Briand

I'm not sure what is the issue, but it looks like this patch is breaking the patchtest-selftest on the autobuilder: the remove layers step is timing out.

https://valkyrie.yoctoproject.org/#/builders/71/builds/431

Can you have a look at this issue ?

I'll do that; I've also realized the v2 patchset is missing a couple things I was going to implement (prefixing fragment names with layer names; using standard library functions for manipulating configs), so I'll send a v3 and check it with patchtest-selftest first.

Alex