forked from gentoo/portage
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support PORTAGE_LOG_FILTER_FILE (bug 709746)
This variable specifies a command that filters build log output to a log file. The plan is to extend this to support a separate filter for tty output in the future. In order to enable the EbuildPhase class to write elog messages to the build log with PORTAGE_LOG_FILTER_FILE support, convert its _elog method to a coroutine, and add a SchedulerInterface async_output method for it to use. Bug: https://bugs.gentoo.org/709746 Signed-off-by: Zac Medico <zmedico@gentoo.org>
- Loading branch information
Showing
7 changed files
with
213 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| # Copyright 2020 Gentoo Authors | ||
| # Distributed under the terms of the GNU General Public License v2 | ||
|
|
||
| from portage import os | ||
| from portage.util import shlex_split | ||
| from _emerge.AsynchronousTask import AsynchronousTask | ||
| from portage.util._async.PipeLogger import PipeLogger | ||
| from portage.util.futures import asyncio | ||
| from portage.util.futures.compat_coroutine import coroutine | ||
|
|
||
|
|
||
| class BuildLogger(AsynchronousTask): | ||
| """ | ||
| Write to a log file, with compression support provided by PipeLogger. | ||
| If the log_filter_file parameter is specified, then it is interpreted | ||
| as a command to execute which filters log output (see the | ||
| PORTAGE_LOG_FILTER_FILE variable in make.conf(5)). The stdin property | ||
| provides access to a writable binary file stream (refers to a pipe) | ||
| that log content should be written to (usually redirected from | ||
| subprocess stdout and stderr streams). | ||
| """ | ||
|
|
||
| __slots__ = ('env', 'log_path', 'log_filter_file', '_main_task', '_stdin') | ||
|
|
||
| @property | ||
| def stdin(self): | ||
| return self._stdin | ||
|
|
||
| def _start(self): | ||
| self.scheduler.run_until_complete(self._async_start()) | ||
|
|
||
| @coroutine | ||
| def _async_start(self): | ||
| pipe_logger = None | ||
| filter_proc = None | ||
| try: | ||
| log_input = None | ||
| if self.log_path is not None: | ||
| log_filter_file = self.log_filter_file | ||
| if log_filter_file is not None: | ||
| split_value = shlex_split(log_filter_file) | ||
| log_filter_file = split_value if split_value else None | ||
| if log_filter_file: | ||
| filter_input, stdin = os.pipe() | ||
| log_input, filter_output = os.pipe() | ||
| try: | ||
| filter_proc = yield asyncio.create_subprocess_exec( | ||
| *log_filter_file, | ||
| env=self.env, | ||
| stdin=filter_input, | ||
| stdout=filter_output, | ||
| stderr=filter_output, | ||
| loop=self.scheduler) | ||
| except EnvironmentError: | ||
| # Maybe the command is missing or broken somehow... | ||
| os.close(filter_input) | ||
| os.close(stdin) | ||
| os.close(log_input) | ||
| os.close(filter_output) | ||
| else: | ||
| self._stdin = os.fdopen(stdin, 'wb', 0) | ||
| os.close(filter_input) | ||
| os.close(filter_output) | ||
|
|
||
| if self._stdin is None: | ||
| # Since log_filter_file is unspecified or refers to a file | ||
| # that is missing or broken somehow, create a pipe that | ||
| # logs directly to pipe_logger. | ||
| log_input, stdin = os.pipe() | ||
| self._stdin = os.fdopen(stdin, 'wb', 0) | ||
|
|
||
| # Set background=True so that pipe_logger does not log to stdout. | ||
| pipe_logger = PipeLogger(background=True, | ||
| scheduler=self.scheduler, input_fd=log_input, | ||
| log_file_path=self.log_path) | ||
|
|
||
| yield pipe_logger.async_start() | ||
| except asyncio.CancelledError: | ||
| if pipe_logger is not None and pipe_logger.poll() is None: | ||
| pipe_logger.cancel() | ||
| if filter_proc is not None and filter_proc.returncode is None: | ||
| filter_proc.terminate() | ||
| raise | ||
|
|
||
| self._main_task = asyncio.ensure_future( | ||
| self._main(pipe_logger, filter_proc=filter_proc), loop=self.scheduler) | ||
| self._main_task.add_done_callback(self._main_exit) | ||
|
|
||
| def _cancel(self): | ||
| if self._main_task is not None: | ||
| self._main_task.done() or self._main_task.cancel() | ||
| if self._stdin is not None and not self._stdin.closed: | ||
| self._stdin.close() | ||
|
|
||
| @coroutine | ||
| def _main(self, pipe_logger, filter_proc=None): | ||
| try: | ||
| if pipe_logger.poll() is None: | ||
| yield pipe_logger.async_wait() | ||
| if filter_proc is not None and filter_proc.returncode is None: | ||
| yield filter_proc.wait() | ||
| except asyncio.CancelledError: | ||
| if pipe_logger.poll() is None: | ||
| pipe_logger.cancel() | ||
| if filter_proc is not None and filter_proc.returncode is None: | ||
| filter_proc.terminate() | ||
| raise | ||
|
|
||
| def _main_exit(self, main_task): | ||
| try: | ||
| main_task.result() | ||
| except asyncio.CancelledError: | ||
| self.cancel() | ||
| self._was_cancelled() | ||
| self.returncode = self.returncode or 0 | ||
| self._async_wait() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters