diff options
author | Zhuoyao Zhang <zhuoyao@google.com> | 2024-05-07 22:18:37 +0000 |
---|---|---|
committer | Zhuoyao Zhang <zhuoyao@google.com> | 2024-05-07 22:51:51 +0000 |
commit | ef1c03f9977e883cc3cbacd1837e1174b2ea4165 (patch) | |
tree | d2476ba1e899a7053be6906ea575456d5ffee1ed | |
parent | 5a99056218e4baa26de4d7ee1f0f53b2bd7a3b8d (diff) | |
download | build-ef1c03f9977e883cc3cbacd1837e1174b2ea4165.tar.gz |
Remove the ANDROID_ENABLE_TOOL_LOGGING environment variable
Reduce the number of variables required to toggle logging. This simplifies configuration and usage.
Test: atest run_tool_with_logging_test
Bug: 331638854
Change-Id: I6f2a820b59a0d1f45aba9ffb3e33e7ace601e9c6
-rw-r--r-- | envsetup.sh | 4 | ||||
-rw-r--r-- | tests/run_tool_with_logging_test.py | 41 |
2 files changed, 4 insertions, 41 deletions
diff --git a/envsetup.sh b/envsetup.sh index 1ef9a54803..50fec5146a 100644 --- a/envsetup.sh +++ b/envsetup.sh @@ -1112,8 +1112,8 @@ function run_tool_with_logging() { local tool_binary="$1" shift - # If logging is not enabled or the logger is not configured, run the original command and return. - if [[ "${ANDROID_ENABLE_TOOL_LOGGING}" != "true" ]] || [[ -z "${ANDROID_TOOL_LOGGER}" ]]; then + # If the logger is not configured, run the original command and return. + if [[ -z "${ANDROID_TOOL_LOGGER}" ]]; then "${tool_binary}" "${@}" return $? fi diff --git a/tests/run_tool_with_logging_test.py b/tests/run_tool_with_logging_test.py index 215d992cf0..18abd8e54f 100644 --- a/tests/run_tool_with_logging_test.py +++ b/tests/run_tool_with_logging_test.py @@ -59,37 +59,10 @@ class RunToolWithLoggingTest(unittest.TestCase): self.working_dir.cleanup() super().tearDown() - def test_does_not_log_when_logging_disabled(self): - test_tool = TestScript.create(self.working_dir) - test_logger = TestScript.create(self.working_dir) - - self._run_script_and_wait(f""" - ANDROID_ENABLE_TOOL_LOGGING=false - ANDROID_TOOL_LOGGER="{test_logger.executable}" - run_tool_with_logging "FAKE_TOOL" {test_tool.executable} arg1 arg2 - """) - - test_tool.assert_called_once_with_args("arg1 arg2") - test_logger.assert_not_called() - - def test_does_not_log_when_logger_var_unset(self): - test_tool = TestScript.create(self.working_dir) - test_logger = TestScript.create(self.working_dir) - - self._run_script_and_wait(f""" - unset ANDROID_ENABLE_TOOL_LOGGING - ANDROID_TOOL_LOGGER="{test_logger.executable}" - run_tool_with_logging "FAKE_TOOL" {test_tool.executable} arg1 arg2 - """) - - test_tool.assert_called_once_with_args("arg1 arg2") - test_logger.assert_not_called() - def test_does_not_log_when_logger_var_empty(self): test_tool = TestScript.create(self.working_dir) self._run_script_and_wait(f""" - ANDROID_ENABLE_TOOL_LOGGING=true ANDROID_TOOL_LOGGER="" run_tool_with_logging "FAKE_TOOL" {test_tool.executable} arg1 arg2 """) @@ -100,7 +73,6 @@ class RunToolWithLoggingTest(unittest.TestCase): test_tool = TestScript.create(self.working_dir) self._run_script_and_wait(f""" - ANDROID_ENABLE_TOOL_LOGGING=true unset ANDROID_TOOL_LOGGER run_tool_with_logging "FAKE_TOOL" {test_tool.executable} arg1 arg2 """) @@ -112,7 +84,6 @@ class RunToolWithLoggingTest(unittest.TestCase): test_logger = TestScript.create(self.working_dir) self._run_script_and_wait(f""" - ANDROID_ENABLE_TOOL_LOGGING=true ANDROID_TOOL_LOGGER="{test_logger.executable}" run_tool_with_logging "FAKE_TOOL" {test_tool.executable} arg1 arg2 """) @@ -130,7 +101,6 @@ class RunToolWithLoggingTest(unittest.TestCase): run_tool_with_logging_stdout, run_tool_with_logging_stderr = ( self._run_script_and_wait(f""" - ANDROID_ENABLE_TOOL_LOGGING=true ANDROID_TOOL_LOGGER="{test_logger.executable}" run_tool_with_logging "FAKE_TOOL" {test_tool.executable} arg1 arg2 """) @@ -138,7 +108,6 @@ class RunToolWithLoggingTest(unittest.TestCase): run_tool_without_logging_stdout, run_tool_without_logging_stderr = ( self._run_script_and_wait(f""" - ANDROID_ENABLE_TOOL_LOGGING=true ANDROID_TOOL_LOGGER="{test_logger.executable}" {test_tool.executable} arg1 arg2 """) @@ -156,7 +125,6 @@ class RunToolWithLoggingTest(unittest.TestCase): test_logger = TestScript.create(self.working_dir, "echo 'logger called'") run_tool_with_logging_output, _ = self._run_script_and_wait(f""" - ANDROID_ENABLE_TOOL_LOGGING=true ANDROID_TOOL_LOGGER="{test_logger.executable}" run_tool_with_logging "FAKE_TOOL" {test_tool.executable} arg1 arg2 """) @@ -170,7 +138,6 @@ class RunToolWithLoggingTest(unittest.TestCase): ) _, err = self._run_script_and_wait(f""" - ANDROID_ENABLE_TOOL_LOGGING=true ANDROID_TOOL_LOGGER="{test_logger.executable}" run_tool_with_logging "FAKE_TOOL" {test_tool.executable} arg1 arg2 """) @@ -182,7 +149,6 @@ class RunToolWithLoggingTest(unittest.TestCase): test_logger = TestScript.create(self.working_dir) process = self._run_script_in_build_env(f""" - ANDROID_ENABLE_TOOL_LOGGING=true ANDROID_TOOL_LOGGER="{test_logger.executable}" run_tool_with_logging "FAKE_TOOL" {test_tool.executable} arg1 arg2 """) @@ -207,9 +173,8 @@ class RunToolWithLoggingTest(unittest.TestCase): test_logger = TestScript.create(self.working_dir) self._run_script_and_wait(f""" - ANDROID_ENABLE_TOOL_LOGGING=false + ANDROID_TOOL_LOGGER="" ANDROID_TOOL_LOGGER="{test_logger.executable}" - ANDROID_ENABLE_TOOL_LOGGING=true run_tool_with_logging "FAKE_TOOL" {test_tool.executable} arg1 arg2 """) @@ -220,9 +185,8 @@ class RunToolWithLoggingTest(unittest.TestCase): test_logger = TestScript.create(self.working_dir) self._run_script_and_wait(f""" - ANDROID_ENABLE_TOOL_LOGGING=true ANDROID_TOOL_LOGGER="{test_logger.executable}" - ANDROID_ENABLE_TOOL_LOGGING=false + ANDROID_TOOL_LOGGER="" run_tool_with_logging "FAKE_TOOL" {test_tool.executable} arg1 arg2 """) @@ -234,7 +198,6 @@ class RunToolWithLoggingTest(unittest.TestCase): self._run_script_and_wait(f""" TMPDIR="{self.working_dir.name}" - ANDROID_ENABLE_TOOL_LOGGING=true ANDROID_TOOL_LOGGER="{logger_path}" ANDROID_TOOL_LOGGER_EXTRA_ARGS="--dry_run" run_tool_with_logging "FAKE_TOOL" {test_tool.executable} arg1 arg2 |