diff mbox series

[01/12] tinfoil: add wait_for decorator and build_file_sync() helper

Message ID 20250620151429.3210879-1-ross.burton@arm.com
State New
Headers show
Series [01/12] tinfoil: add wait_for decorator and build_file_sync() helper | expand

Commit Message

Ross Burton June 20, 2025, 3:14 p.m. UTC
The bitbake worker/server IPC is asynchronous, but tinfoil only has
functionality to wait for a response on the build_targets() call.

Extract the bulk of the "wait for events and handle errors" logic to a
standalone wait_for wrapper, which is the build_targets code without the
extra_events or event_callback arguments (for now).

Then use this to create a build_file_sync() helper that just wraps the
existing build_file() with @wait_for.

Signed-off-by: Ross Burton <ross.burton@arm.com>
---
 bitbake/lib/bb/tinfoil.py | 125 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 124 insertions(+), 1 deletion(-)

Comments

patchtest@automation.yoctoproject.org June 20, 2025, 3:36 p.m. UTC | #1
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/01-12-tinfoil-add-wait_for-decorator-and-build_file_sync-helper.patch

FAIL: test commit message user tags: Mbox includes one or more GitHub-style username tags. Ensure that any "@" symbols are stripped out of usernames (test_mbox.TestMbox.test_commit_message_user_tags)
FAIL: test target mailing list: Series sent to the wrong mailing list or some patches from the series correspond to different mailing lists (test_mbox.TestMbox.test_target_mailing_list)

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 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 shortlog length (test_mbox.TestMbox.test_shortlog_length)

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!
diff mbox series

Patch

diff --git a/bitbake/lib/bb/tinfoil.py b/bitbake/lib/bb/tinfoil.py
index f48baeb3342..71c299689cb 100644
--- a/bitbake/lib/bb/tinfoil.py
+++ b/bitbake/lib/bb/tinfoil.py
@@ -14,7 +14,7 @@  import time
 import atexit
 import re
 from collections import OrderedDict, defaultdict
-from functools import partial
+from functools import partial, wraps
 from contextlib import contextmanager
 
 import bb.cache
@@ -27,6 +27,125 @@  import bb.remotedata
 from bb.main import setup_bitbake, BitBakeConfigParameters
 import bb.fetch2
 
+def wait_for(f):
+    @wraps(f)
+    def wrapper(self, *args, **kwds):
+        # A reasonable set of default events matching up with those we handle below
+        eventmask = [
+                    'bb.event.BuildStarted',
+                    'bb.event.BuildCompleted',
+                    'logging.LogRecord',
+                    'bb.event.NoProvider',
+                    'bb.command.CommandCompleted',
+                    'bb.command.CommandFailed',
+                    'bb.build.TaskStarted',
+                    'bb.build.TaskFailed',
+                    'bb.build.TaskSucceeded',
+                    'bb.build.TaskFailedSilent',
+                    'bb.build.TaskProgress',
+                    'bb.runqueue.runQueueTaskStarted',
+                    'bb.runqueue.sceneQueueTaskStarted',
+                    'bb.event.ProcessStarted',
+                    'bb.event.ProcessProgress',
+                    'bb.event.ProcessFinished',
+                    ]
+        #if extra_events:
+        #    eventmask.extend(extra_events)
+        ret = self.set_event_mask(eventmask)
+
+        # Call actual function
+        ret = f(self, *args, **kwds)
+
+        includelogs = self.config_data.getVar('BBINCLUDELOGS')
+        loglines = self.config_data.getVar('BBINCLUDELOGS_LINES')
+        lastevent = time.time()
+        result = False
+        # Borrowed from knotty, instead somewhat hackily we use the helper
+        # as the object to store "shutdown" on
+        helper = bb.ui.uihelper.BBUIHelper()
+        helper.shutdown = 0
+        parseprogress = None
+        termfilter = bb.ui.knotty.TerminalFilter(helper, helper, self.logger.handlers, quiet=self.quiet)
+        try:
+            while True:
+                try:
+                    event = self.wait_event(0.25)
+                    if event:
+                        lastevent = time.time()
+                        #if event_callback and event_callback(event):
+                        #    continue
+                        if helper.eventHandler(event):
+                            if isinstance(event, bb.build.TaskFailedSilent):
+                                self.logger.warning("Logfile for failed setscene task is %s" % event.logfile)
+                            elif isinstance(event, bb.build.TaskFailed):
+                                bb.ui.knotty.print_event_log(event, includelogs, loglines, termfilter)
+                            continue
+                        if isinstance(event, bb.event.ProcessStarted):
+                            if self.quiet > 1:
+                                continue
+                            parseprogress = bb.ui.knotty.new_progress(event.processname, event.total)
+                            parseprogress.start(False)
+                            continue
+                        if isinstance(event, bb.event.ProcessProgress):
+                            if self.quiet > 1:
+                                continue
+                            if parseprogress:
+                                parseprogress.update(event.progress)
+                            else:
+                                bb.warn("Got ProcessProgress event for something that never started?")
+                            continue
+                        if isinstance(event, bb.event.ProcessFinished):
+                            if self.quiet > 1:
+                                continue
+                            if parseprogress:
+                                parseprogress.finish()
+                            parseprogress = None
+                            continue
+                        if isinstance(event, bb.command.CommandCompleted):
+                            result = True
+                            break
+                        if isinstance(event, (bb.command.CommandFailed, bb.command.CommandExit)):
+                            self.logger.error(str(event))
+                            result = False
+                            break
+                        if isinstance(event, logging.LogRecord):
+                            if event.taskpid == 0 or event.levelno > logging.INFO:
+                                self.logger.handle(event)
+                            continue
+                        if isinstance(event, bb.event.NoProvider):
+                            self.logger.error(str(event))
+                            result = False
+                            break
+                    elif helper.shutdown > 1:
+                        break
+                    termfilter.updateFooter()
+                    if time.time() > (lastevent + (3*60)):
+                        if not self.run_command('ping', handle_events=False):
+                            print("\nUnable to ping server and no events, closing down...\n")
+                            return False
+                except KeyboardInterrupt:
+                    termfilter.clearFooter()
+                    if helper.shutdown == 1:
+                        print("\nSecond Keyboard Interrupt, stopping...\n")
+                        ret = self.run_command("stateForceShutdown")
+                        if ret and ret[2]:
+                            self.logger.error("Unable to cleanly stop: %s" % ret[2])
+                    elif helper.shutdown == 0:
+                        print("\nKeyboard Interrupt, closing down...\n")
+                        interrupted = True
+                        ret = self.run_command("stateShutdown")
+                        if ret and ret[2]:
+                            self.logger.error("Unable to cleanly shutdown: %s" % ret[2])
+                    helper.shutdown = helper.shutdown + 1
+            termfilter.clearFooter()
+        finally:
+            termfilter.finish()
+        if helper.failed_tasks:
+            result = False
+        return result
+
+    return wrapper
+
 
 # We need this in order to shut down the connection to the bitbake server,
 # otherwise the process will never properly exit
@@ -700,6 +819,10 @@  class Tinfoil:
         """
         return self.run_command('buildFile', buildfile, task, internal)
 
+    @wait_for
+    def build_file_sync(self, *args):
+        self.build_file(*args)
+
     def build_targets(self, targets, task=None, handle_events=True, extra_events=None, event_callback=None):
         """
         Builds the specified targets. This is equivalent to a normal invocation