]> git.ipfire.org Git - thirdparty/openembedded/openembedded-core.git/commitdiff
yocto-check-layer: Add messages in test_readme assertions
authorRicardo Ungerer <ungerer.ricardo@gmail.com>
Tue, 20 Jan 2026 19:47:20 +0000 (19:47 +0000)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Thu, 22 Jan 2026 14:21:21 +0000 (14:21 +0000)
Assertions in test_readme does not provide context message when they
fail. Which leads to errors like:

  File "/media/workspace/yocto_master/openembedded-core/scripts/lib/checklayer/cases/common.py", line 41, in test_readme
    self.assertTrue(email_regex.match(data))
    AssertionError: None is not true

This patch adds context messages to the assertions to help identify the
issue when they fail.

Signed-off-by: Ricardo Ungerer <ungerer.ricardo@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
scripts/lib/checklayer/cases/common.py

index ddead69a7be8529a72bf165a52623164422fea4e..011448143402ce25f5a61da52aa1094893aab8d3 100644 (file)
@@ -32,13 +32,14 @@ class CommonCheckLayer(OECheckLayerTestCase):
 
         # If a layer's README references another README, then the checks below are not valid
         if re.search('README', data, re.IGNORECASE):
+            print("Layer README references another README; skipping further README checks.")
             return
 
-        self.assertIn('maintainer', data.lower())
-        self.assertIn('patch', data.lower())
+        self.assertIn('maintainer', data.lower(), msg="No maintainer info found in README.")
+        self.assertIn('patch', data.lower(), msg="No patching information found in README.")
         # Check that there is an email address in the README
         email_regex = re.compile(r"[^@]+@[^@]+")
-        self.assertTrue(email_regex.match(data))
+        self.assertTrue(email_regex.match(data), msg="No email address found in README.")
 
     def find_file_by_name(self, globs):
         """