Skip to contentSkip to conversation

systemd.bbclass: Clean up empty parent directories

PATCH Superseded Peter Kjellerstedt 2 participants 4 messages Aug 20, 2024 – Aug 22, 2024 1 message not in the archive

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/2 systemd.bbclass: Clean up empty parent directories

Previously, rm_systemd_unitdir() would remove one parent directory of ${systemd_unitdir} if it was empty after removing ${systemd_unitdir}. rm_sysvinit_initddir() would not remove any parent directory. Thus, if the only directory created in /etc was /etc/init.d, an empty /etc would remain after the cleanup and would be packaged.

Simplify rm_systemd_unitdir() and rm_sysvinit_initddir() by rewriting them in shell, and use rmdir -p to remove all empty parent directories.

---

PATCHv2: No changes.

 meta/classes-recipe/systemd.bbclass | 46 +++++++++++++----------------
 1 file changed, 21 insertions(+), 25 deletions(-)
meta/classes-recipe/systemd.bbclass +21 -25
index 0f7e3b5a08..987b3fc0c7 100644
@@ -208,33 +208,29 @@ python systemd_populate_packages() {
 
 PACKAGESPLITFUNCS =+ "systemd_populate_packages"
 
-python rm_systemd_unitdir (){
-    import shutil
-    if not bb.utils.contains('DISTRO_FEATURES', 'systemd', True, False, d):
-        systemd_unitdir = oe.path.join(d.getVar("D"), d.getVar('systemd_unitdir'))
-        if os.path.exists(systemd_unitdir):
-            shutil.rmtree(systemd_unitdir)
-        systemd_libdir = os.path.dirname(systemd_unitdir)
-        if (os.path.exists(systemd_libdir) and not os.listdir(systemd_libdir)):
-            os.rmdir(systemd_libdir)
+rm_systemd_unitdir() {
+	rm -rf ${D}${systemd_unitdir}
+	rmdir -p $(dirname ${D}${systemd_unitdir}) 2>/dev/null || :
+	# Make sure ${D} still exists since rmdir -p may have removed it in
+	# case ${systemd_unitdir} was the only directory present.
+	[ -d ${D} ] || mkdir -p ${D}
 }
 
-python rm_sysvinit_initddir (){
-    import shutil
-    sysv_initddir = oe.path.join(d.getVar("D"), (d.getVar('INIT_D_DIR') or "/etc/init.d"))
-
-    if bb.utils.contains('DISTRO_FEATURES', 'systemd', True, False, d) and \
-        not bb.utils.contains('DISTRO_FEATURES', 'sysvinit', True, False, d) and \
-        os.path.exists(sysv_initddir):
-        systemd_system_unitdir = oe.path.join(d.getVar("D"), d.getVar('systemd_system_unitdir'))
+rm_sysvinit_initddir() {
+	local sysv_initddir=${INIT_D_DIR}
+	: ${sysv_initddir:=${sysconfdir}/init.d}
 
-        # If systemd_system_unitdir contains anything, delete sysv_initddir
-        if (os.path.exists(systemd_system_unitdir) and os.listdir(systemd_system_unitdir)):
-            shutil.rmtree(sysv_initddir)
+	# If systemd_system_unitdir contains anything, delete sysv_initddir
+        if find ${D}${systemd_system_unitdir} -mindepth 1 -maxdepth 1 2>/dev/null | read; then
+		rm -rf ${D}$sysv_initddir
+		rmdir -p $(dirname ${D}$sysv_initddir) 2>/dev/null || :
+	fi
 }
 
-do_install[postfuncs] += "${RMINITDIR} "
-RMINITDIR:class-target = " rm_sysvinit_initddir rm_systemd_unitdir "
-RMINITDIR:class-nativesdk = " rm_sysvinit_initddir rm_systemd_unitdir "
-RMINITDIR = ""
-
+do_install[postfuncs] += "${RMINITDIR}"
+RMINITDIR = " \
+    ${@bb.utils.contains('DISTRO_FEATURES', 'systemd', '', 'rm_systemd_unitdir', d)} \
+    ${@'rm_sysvinit_initddir' if bb.utils.contains('DISTRO_FEATURES', 'systemd', True, False, d) and \
+                                 not bb.utils.contains('DISTRO_FEATURES', 'sysvinit', True, False, d) else ''} \
+"
+RMINITDIR:class-native = ""
#1 lore raw

PATCH v2 2/2 oeqa/selftest/bbclasses: Add tests for systemd and update-rc.d interaction

These tests verify that the correct files are left behind when systemd is inherited and depending on whether the systemd and/or sysvinit distro features are enabled.

---

PATCHv2: Change LICENSE to MIT and add EXCLUDE_FROM_WORLD to the test
recipes

 .../bbclasses/systemd-and-sysvinit.bb         |  17 +++
 .../recipes-test/bbclasses/systemd-only.bb    |  12 ++
 meta/lib/oeqa/selftest/cases/bbclasses.py     | 106 ++++++++++++++++++
 3 files changed, 135 insertions(+)
 create mode 100644 meta-selftest/recipes-test/bbclasses/systemd-and-sysvinit.bb
 create mode 100644 meta-selftest/recipes-test/bbclasses/systemd-only.bb
 create mode 100644 meta/lib/oeqa/selftest/cases/bbclasses.py
meta-selftest/recipes-test/bbclasses/systemd-and-sysvinit.bb new file +17 -0
new file mode 100644
index 0000000000..f9fc59a494
@@ -0,0 +1,17 @@
+LICENSE = "MIT"
+
+inherit allarch systemd update-rc.d
+
+do_install() {
+	install -d ${D}${systemd_system_unitdir}
+	touch ${D}${systemd_system_unitdir}/${BPN}.service
+
+	install -d ${D}${INIT_D_DIR}
+	touch ${D}${INIT_D_DIR}/${BPN}
+}
+
+INITSCRIPT_NAME = "${BPN}"
+
+SYSTEMD_SERVICE:${PN} = "${BPN}.service"
+
+EXCLUDE_FROM_WORLD = "1"
meta-selftest/recipes-test/bbclasses/systemd-only.bb new file +12 -0
new file mode 100644
index 0000000000..590a27b9cb
@@ -0,0 +1,12 @@
+LICENSE = "MIT"
+
+inherit allarch systemd
+
+do_install() {
+	install -d ${D}${systemd_system_unitdir}
+	touch ${D}${systemd_system_unitdir}/${BPN}.service
+}
+
+SYSTEMD_SERVICE:${PN} = "${BPN}.service"
+
+EXCLUDE_FROM_WORLD = "1"
meta/lib/oeqa/selftest/cases/bbclasses.py new file +106 -0

106 lines not on this page · raw message

#2 lore raw

Re: [OE-core] [PATCHv2 2/2] oeqa/selftest/bbclasses: Add tests for systemd and update-rc.d interaction

Quoted 162 lines · Peter Kjellerstedt via lists.openembedded.org

These tests verify that the correct files are left behind when systemd is inherited and depending on whether the systemd and/or sysvinit distro features are enabled.

---

PATCHv2: Change LICENSE to MIT and add EXCLUDE_FROM_WORLD to the test recipes

 .../bbclasses/systemd-and-sysvinit.bb         |  17 +++ .../recipes-test/bbclasses/systemd-only.bb    |  12 ++ meta/lib/oeqa/selftest/cases/bbclasses.py     | 106 ++++++++++++++++++

 3 files changed, 135 insertions(+)

 create mode 100644 meta-selftest/recipes-test/bbclasses/systemd-and-sysvinit.bb create mode 100644 meta-selftest/recipes-test/bbclasses/systemd-only.bb create mode 100644 meta/lib/oeqa/selftest/cases/bbclasses.py

meta-selftest/recipes-test/bbclasses/systemd-and-sysvinit.bb new file +17 -0
new file mode 100644
index 0000000000..f9fc59a494
@@ -0,0 +1,17 @@
+LICENSE = "MIT"
+
+inherit allarch systemd update-rc.d
+
+do_install() {
+	install -d ${D}${systemd_system_unitdir}
+	touch ${D}${systemd_system_unitdir}/${BPN}.service
+
+	install -d ${D}${INIT_D_DIR}
+	touch ${D}${INIT_D_DIR}/${BPN}
+}
+
+INITSCRIPT_NAME = "${BPN}"
+
+SYSTEMD_SERVICE:${PN} = "${BPN}.service"
+
+EXCLUDE_FROM_WORLD = "1"
meta-selftest/recipes-test/bbclasses/systemd-only.bb new file +12 -0
new file mode 100644
index 0000000000..590a27b9cb
@@ -0,0 +1,12 @@
+LICENSE = "MIT"
+
+inherit allarch systemd
+
+do_install() {
+	install -d ${D}${systemd_system_unitdir}
+	touch ${D}${systemd_system_unitdir}/${BPN}.service
+}
+
+SYSTEMD_SERVICE:${PN} = "${BPN}.service"
+
+EXCLUDE_FROM_WORLD = "1"
meta/lib/oeqa/selftest/cases/bbclasses.py new file +96 -0
new file mode 100644
index 0000000000..10545ebe65
@@ -0,0 +1,106 @@
+#
+# Copyright OpenEmbedded Contributors
+#
+# SPDX-License-Identifier: MIT
+#
+
+from oeqa.selftest.case import OESelftestTestCase
+from oeqa.utils.commands import get_bb_vars, bitbake
+
+class Systemd(OESelftestTestCase):
+    """
+    Tests related to the systemd bbclass.
+    """
+
+    def getVars(self, recipe):
+        self.bb_vars = get_bb_vars(
+            [
+                'BPN',
+                'D',
+                'INIT_D_DIR',
+                'prefix',
+                'systemd_system_unitdir',
+                'sysconfdir',
+            ],
+            recipe,
+        )
+
+    def fileExists(self, filename):
+        self.assertExists(filename.format(**self.bb_vars))
+
+    def fileNotExists(self, filename):
+        self.assertNotExists(filename.format(**self.bb_vars))
+
+    def test_systemd_in_distro(self):
+        """
+        Summary:    Verify that no sysvinit files are installed when the
+                    systemd distro feature is enabled, but sysvinit is not.
+        Expected:   Systemd service file exists, but /etc does not.
+        Product:    OE-Core
+        Author:     Peter Kjellerstedt <[email protected]>
+        """
+
+        self.write_config("""
+DISTRO_FEATURES:append = " systemd usrmerge"
+DISTRO_FEATURES:remove = "sysvinit"
+VIRTUAL-RUNTIME_init_manager = "systemd"
+""")
+        bitbake("systemd-only systemd-and-sysvinit -c install")
+
+        self.getVars("systemd-only")
+        self.fileExists("{D}{systemd_system_unitdir}/{BPN}.service")
+
+        self.getVars("systemd-and-sysvinit")
+        self.fileExists("{D}{systemd_system_unitdir}/{BPN}.service")
+        self.fileNotExists("{D}{sysconfdir}")
+
+    def test_systemd_and_sysvinit_in_distro(self):
+        """
+        Summary:    Verify that both systemd and sysvinit files are installed
+                    when both the systemd and sysvinit distro features are
+                    enabled.
+        Expected:   Systemd service file and sysvinit initscript exist.
+        Product:    OE-Core
+        Author:     Peter Kjellerstedt <[email protected]>
+        """
+
+        self.write_config("""
+DISTRO_FEATURES:append = " systemd sysvinit usrmerge"
+VIRTUAL-RUNTIME_init_manager = "systemd"
+""")
+        bitbake("systemd-only systemd-and-sysvinit -c install")
+
+        self.getVars("systemd-only")
+        self.fileExists("{D}{systemd_system_unitdir}/{BPN}.service")
+
+        self.getVars("systemd-and-sysvinit")
+        self.fileExists("{D}{systemd_system_unitdir}/{BPN}.service")
+        self.fileExists("{D}{INIT_D_DIR}/{BPN}")
+
+    def test_sysvinit_in_distro(self):
+        """
+        Summary:    Verify that no systemd service files are installed when the
+                    sysvinit distro feature is enabled, but systemd is not.
+        Expected:   The systemd  service file does not exist, nor does /usr.
+                    The sysvinit initscript exists.
+        Product:    OE-Core
+        Author:     Peter Kjellerstedt <[email protected]>
+        """
+
+        self.write_config("""
+DISTRO_FEATURES:remove = "systemd"
+DISTRO_FEATURES:append = " sysvinit usrmerge"
+VIRTUAL-RUNTIME_init_manager = "sysvinit"
+""")
+        bitbake("systemd-only systemd-and-sysvinit -c install")
+

meta/lib/oeqa/selftest/cases/bbclasses.py line 106

Quoted 10 lines
meta/lib/oeqa/selftest/cases/bbclasses.py new file +10 -0
+        self.getVars("systemd-only")
+        self.fileNotExists("{D}{systemd_system_unitdir}/{BPN}.service")
+        self.fileNotExists("{D}{prefix}")
+        self.fileNotExists("{D}{sysconfdir}")
+        self.fileExists("{D}")
+
+        self.getVars("systemd-and-sysvinit")
+        self.fileNotExists("{D}{systemd_system_unitdir}/{BPN}.service")
+        self.fileNotExists("{D}{prefix}")
+        self.fileExists("{D}{INIT_D_DIR}/{BPN}")

I'm really happy to see tests so thanks for that! Unfortunately something isn't quite right, some builds passed and some failed. The failures:

https://autobuilder.yoctoproject.org/typhoon/#/builders/127/builds/3754/steps/15/logs/stdio
https://autobuilder.yoctoproject.org/typhoon/#/builders/127/builds/3754/steps/15/logs/stdio
https://autobuilder.yoctoproject.org/typhoon/#/builders/87/builds/7088/steps/14/logs/stdio

and the passes:

https://autobuilder.yoctoproject.org/typhoon/#/builders/79/builds/7074
https://autobuilder.yoctoproject.org/typhoon/#/builders/86/builds/7096

At this point I've not looked into what happened, I'm just reporting the results.

Cheers,

Richard

A message that is not in the archive (sent off-list or not yet received): [email protected]

#4 lore raw

Re: [OE-core] [PATCHv2 2/2] oeqa/selftest/bbclasses: Add tests for systemd and update-rc.d interaction