public inbox for gentoo-dev@lists.gentoo.org
 help / color / mirror / Atom feed
From: Sam James <sam@gentoo.org>
To: gentoo-dev@lists.gentoo.org
Cc: qa@gentoo.org, Georgy Yakovlev <gyakovlev@gentoo.org>,
	Sam James <sam@gentoo.org>
Subject: [gentoo-dev] [PATCH v2 4/4] metadata/install-qa-check.d: add check for missing tmpfiles_process call
Date: Fri, 13 Aug 2021 04:43:40 +0100	[thread overview]
Message-ID: <20210813034340.2835238-4-sam@gentoo.org> (raw)
In-Reply-To: <20210813034340.2835238-1-sam@gentoo.org>

From: Georgy Yakovlev <gyakovlev@gentoo.org>

See: https://archives.gentoo.org/gentoo-dev/message/7bdfdc9a7560fd07436defd0253af0b8
Signed-off-by: Georgy Yakovlev <gyakovlev@gentoo.org>
Signed-off-by: Sam James <sam@gentoo.org>
---
 metadata/install-qa-check.d/60tmpfiles-paths | 34 ++++++++++++++------
 1 file changed, 24 insertions(+), 10 deletions(-)

diff --git a/metadata/install-qa-check.d/60tmpfiles-paths b/metadata/install-qa-check.d/60tmpfiles-paths
index 81286de584a2..aa666dfb7ce5 100644
--- a/metadata/install-qa-check.d/60tmpfiles-paths
+++ b/metadata/install-qa-check.d/60tmpfiles-paths
@@ -3,11 +3,14 @@
 
 # QA check: ensure that packages installing tmpfiles configuration inherit the eclass
 # Maintainer: Sam James <sam@gentoo.org>
+# Maintainer: Georgy Yakovlev <gyakovlev@gentoo.org>
 
 # Implements two checks:
 # 1) Installation to /etc/tmpfiles.d (which is a user-customization location);
 # 2) Installation of any tmpfiles to /usr/lib/tmpfiles.d without inheriting the eclass
-#    (needed for tmpfiles_process in pkg_postinst)
+#    (needed for tmpfiles_process in pkg_postinst);
+# 3) Check for installation of tmpfiles without calling tmpfiles_process in
+#    pkg_postinst.
 tmpfiles_check() {
 	# Check 1
 	# Scan image for files in /etc/tmpfiles.d which is a forbidden location
@@ -17,30 +20,41 @@ tmpfiles_check() {
 	shopt -u nullglob
 
 	if [[ ${#files[@]} -gt 0 ]]; then
-		eqawarn "QA Notice: files installed to /etc/tmpfiles.d"
-		eqawarn "tmpfiles configuration files must be installed by ebuilds /usr/lib/tmpfiles.d!"
+		eqawarn "QA Notice: files installed to /etc/tmpfiles.d found"
+		eqawarn "tmpfiles configuration files supplied by ebuilds must be installed to /usr/lib/tmpfiles.d"
 	fi
 
 	# Check 2
 	# We're now going to check for whether we install files to /usr/lib/tmpfiles.d without
 	# inheriting the eclass (weak catch for ebuilds not calling tmpfiles_process in pkg_postinst)
 
-	# No need to carry on if we're inheriting the eclass
-	if has tmpfiles ${INHERITED} ; then
-		return
-	fi
-
 	# It's okay for some packages to do this because of circular dependencies and such
 	# See: https://archives.gentoo.org/gentoo-dev/message/0a96793036a4fdd9ac311a46950d7e7b
 	# TODO: Standardize some way of allowing ebuilds to opt-out of checks like this
 	local package=${CATEGORY}/${PN}
+
 	if [[ ${package} == "sys-apps/systemd" || ${package} == "sys-libs/pam" ]] ; then
 		return
 	fi
 
 	if [[ -d "${ED}"/usr/lib/tmpfiles.d/ ]] ; then
-		eqawarn "QA Notice: package is installing tmpfiles without inheriting tmpfiles.eclass!"
-		eqawarn "Packages must inherit tmpfiles.eclass then call tmpfiles_process in pkg_postinst."
+		if ! has tmpfiles ${INHERITED} ; then
+			eqawarn "QA Notice: package is installing tmpfiles without inheriting tmpfiles.eclass!"
+			eqawarn "Packages must inherit tmpfiles.eclass then call tmpfiles_process in pkg_postinst."
+			return
+		fi
+
+		# Check 3
+		# Check whether we're installing tmpfiles without explicitly
+		# calling tmpfiles_process in pkg_postinst, but we have inherited
+		# the eclass.
+		# Small risk of false positives if called indirectly.
+		# See: https://archives.gentoo.org/gentoo-dev/message/7bdfdc9a7560fd07436defd0253af0b8
+		local pkg_postinst_body="$(declare -fp pkg_postinst 2>&1)"
+		if [[ ! ${pkg_postinst_body} == *tmpfiles_process* ]] ; then
+			eqawarn "QA Notice: package is installing tmpfiles without calling"
+			eqawarn "tmpfiles_process in pkg_postinst phase"
+		fi
 	fi
 }
 
-- 
2.32.0



      parent reply	other threads:[~2021-08-13  3:45 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-13  3:43 [gentoo-dev] [PATCH v2 1/4] metadata/install-qa-check.d: add 60tmpfiles-path QA check Sam James
2021-08-13  3:43 ` [gentoo-dev] [PATCH v2 2/4] metadata/install-qa-check.d: only trigger on tmpfiles in forbidden location Sam James
2021-08-13  3:43 ` [gentoo-dev] [PATCH v2 3/4] metadata/install-qa-check.d: add exemptions for some packages wrt inherit Sam James
2021-08-13  3:43 ` Sam James [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210813034340.2835238-4-sam@gentoo.org \
    --to=sam@gentoo.org \
    --cc=gentoo-dev@lists.gentoo.org \
    --cc=gyakovlev@gentoo.org \
    --cc=qa@gentoo.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox