tequilaOS/platform_build
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix a bug in run_tool_with_logging script

Browse source 
Fix the case when call a tool with run_tool_with_logging with a single
arg start with -- (e.g. adb --help), make sure when we pass that arg
to the logger, it treat it as the value for the --tool_args option
instead of a separate option

Test: atest run_tool_with_logging_test
Test: manually run source build/envsetup.sh and run adb --help and check
the event log is sent to clearcut. Tested with both bash and zsh
Bug: 341382247

Change-Id: I1e09907f267b453cb62876e171064daa021e3d91
This commit is contained in:
Zhuoyao Zhang 2024-05-20 18:31:12 +00:00
parent d429640373
commit dfdf19f225
2 changed files with 22 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
envsetup.sh
View file

@ -847,11 +847,11 @@ function run_tool_with_logging() {
# Remove the trap to prevent duplicate log.
trap - EXIT;
"${logger}" \
--tool_tag "${tool_tag}" \
--start_timestamp "${start_time}" \
--end_timestamp "$(date +%s.%N)" \
--tool_args "$*" \
--exit_code "${exit_code}" \
--tool_tag="${tool_tag}" \
--start_timestamp="${start_time}" \
--end_timestamp="$(date +%s.%N)" \
--tool_args="$*" \
--exit_code="${exit_code}" \
${ANDROID_TOOL_LOGGER_EXTRA_ARGS} \
> /dev/null 2>&1 &
exit ${exit_code}

21
tests/run_tool_with_logging_test.py
View file

@ -90,8 +90,8 @@ class RunToolWithLoggingTest(unittest.TestCase):
test_tool.assert_called_once_with_args("arg1 arg2")
expected_logger_args = (
"--tool_tag FAKE_TOOL --start_timestamp \d+\.\d+ --end_timestamp"
" \d+\.\d+ --tool_args arg1 arg2 --exit_code 0"
"--tool_tag=FAKE_TOOL --start_timestamp=\d+\.\d+ --end_timestamp="
"\d+\.\d+ --tool_args=arg1 arg2 --exit_code=0"
)
test_logger.assert_called_once_with_args(expected_logger_args)
@ -163,8 +163,8 @@ class RunToolWithLoggingTest(unittest.TestCase):
self.assertEqual(returncode, INTERRUPTED_RETURN_CODE)
expected_logger_args = (
"--tool_tag FAKE_TOOL --start_timestamp \d+\.\d+ --end_timestamp"
" \d+\.\d+ --tool_args arg1 arg2 --exit_code 130"
"--tool_tag=FAKE_TOOL --start_timestamp=\d+\.\d+ --end_timestamp="
"\d+\.\d+ --tool_args=arg1 arg2 --exit_code=130"
)
test_logger.assert_called_once_with_args(expected_logger_args)
@ -205,6 +205,19 @@ class RunToolWithLoggingTest(unittest.TestCase):
self._assert_logger_dry_run()
def test_tool_args_do_not_fail_logger(self):
test_tool = TestScript.create(self.working_dir)
logger_path = self._import_logger()
self._run_script_and_wait(f"""
TMPDIR="{self.working_dir.name}"
ANDROID_TOOL_LOGGER="{logger_path}"
ANDROID_TOOL_LOGGER_EXTRA_ARGS="--dry_run"
run_tool_with_logging "FAKE_TOOL" {test_tool.executable} --tool-arg1
""")
self._assert_logger_dry_run()
def _import_logger(self) -> Path:
logger = "tool_event_logger"
logger_path = Path(self.working_dir.name).joinpath(logger)