ADB log tailing color output

Author: rmartin16

src/briefcase/console.py

@@ -33,7 +33,8 @@
 SENSITIVE_SETTING_RE = re.compile(r"API|TOKEN|KEY|SECRET|PASS|SIGNATURE", flags=re.I)
 
 # 7-bit C1 ANSI escape sequences
-ANSI_ESCAPE_RE = re.compile(r"\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])")
+ANSI_ESC_SEQ_RE_DEF = r"\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])"
+ANSI_ESCAPE_RE = re.compile(ANSI_ESC_SEQ_RE_DEF)
 
 
 class InputDisabled(Exception):

src/briefcase/integrations/android_sdk.py

@@ -1599,6 +1599,8 @@ def logcat(self, pid: str) -> subprocess.Popen:
                 self.device,
                 "logcat",
                 "--format=tag",
+                "-v",
+                "color",
                 "--pid",  # This option is available since API level 24.
                 pid,
             ]
@@ -1627,6 +1629,8 @@ def logcat_tail(self, since: datetime):
                     self.device,
                     "logcat",
                     "--format=tag",
+                    "-v",
+                    "color",
                     "-t",
                     since.strftime("%m-%d %H:%M:%S.000000"),
                     "-s",

src/briefcase/platforms/android/gradle.py

@@ -16,6 +16,7 @@
     UpdateCommand,
 )
 from briefcase.config import AppConfig, parsed_version
+from briefcase.console import ANSI_ESC_SEQ_RE_DEF
 from briefcase.exceptions import BriefcaseCommandError
 from briefcase.integrations.android_sdk import AndroidSDK
 from briefcase.integrations.subprocess import SubprocessArgT
@@ -35,7 +36,11 @@ def safe_formal_name(name):
     return re.sub(r"\s+", " ", re.sub(r'[!/\\:<>"\?\*\|]', "", name)).strip()
 
 
-ANDROID_LOG_PREFIX_REGEX = re.compile(r"[A-Z]/(?P<tag>.*?): (?P<content>.*)")
+# Matches zero or more ANSI control chars wrapping the message for when
+# the Android emulator is printing in color.
+ANDROID_LOG_PREFIX_REGEX = re.compile(
+    rf"(?:{ANSI_ESC_SEQ_RE_DEF})*[A-Z]/(?P<tag>.*?): (?P<content>.*?(?=\x1B|$))(?:{ANSI_ESC_SEQ_RE_DEF})*"
+)
 
 
 def android_log_clean_filter(line):

tests/integrations/android_sdk/ADB/test_logcat.py

@@ -20,6 +20,8 @@ def test_logcat(mock_tools, adb):
             "exampleDevice",
             "logcat",
             "--format=tag",
+            "-v",
+            "color",
             "--pid",
             "1234",
             "EGL_emulation:S",

tests/integrations/android_sdk/ADB/test_logcat_tail.py

@@ -21,6 +21,8 @@ def test_logcat_tail(mock_tools, adb):
             "exampleDevice",
             "logcat",
             "--format=tag",
+            "-v",
+            "color",
             "-t",
             "11-10 09:08:07.000000",
             "-s",

tests/platforms/android/gradle/test_android_log_clean_filter.py

@@ -19,6 +19,13 @@
                 False,
             ),
         ),
+        (
+            "\x1b[32mD/libEGL  : loaded /vendor/lib64/egl/libEGL_emulation.so\x1b[0m",
+            (
+                "loaded /vendor/lib64/egl/libEGL_emulation.so",
+                False,
+            ),
+        ),
         (
             "D/stdio   : Could not find platform independent libraries <prefix>",
             ("Could not find platform independent libraries <prefix>", False),
@@ -27,28 +34,60 @@
             "D/MainActivity: onStart() start",
             ("onStart() start", False),
         ),
+        (
+            "\x1b[32mD/MainActivity: onStart() start\x1b[0m",
+            ("onStart() start", False),
+        ),
         # Python App messages
         (
             "I/python.stdout: Python app launched & stored in Android Activity class",
             ("Python app launched & stored in Android Activity class", True),
         ),
+        (
+            "\x1b[32mI/python.stdout: Python app launched & stored in Android Activity class\x1b[0m",
+            ("Python app launched & stored in Android Activity class", True),
+        ),
         (
             "I/python.stdout: ",
             ("", True),
         ),
+        (
+            "\x1b[32mI/python.stdout: \x1b[0m",
+            ("", True),
+        ),
+        (
+            "\x1b[32m\x1b[98mI/python.stdout: \x1b[32m\x1b[0m",
+            ("", True),
+        ),
+        (
+            "\x1b[32m\x1b[98mI/python.stdout: this is colored output\x1b[32m\x1b[0m",
+            ("this is colored output", True),
+        ),
         (
             "I/python.stderr: test_case (tests.foobar.test_other.TestOtherMethods)",
             ("test_case (tests.foobar.test_other.TestOtherMethods)", True),
         ),
+        (
+            "\x1b[32mI/python.stderr: test_case (tests.foobar.test_other.TestOtherMethods)\x1b[0m",
+            ("test_case (tests.foobar.test_other.TestOtherMethods)", True),
+        ),
         (
             "I/python.stderr: ",
             ("", True),
         ),
+        (
+            "\x1b[32mI/python.stderr: \x1b[0m",
+            ("", True),
+        ),
         # Unknown content
         (
             "This doesn't match the regex",
             ("This doesn't match the regex", False),
         ),
+        (
+            "\x1b[33mThis doesn't match the regex\x1b[33m",
+            ("\x1b[33mThis doesn't match the regex\x1b[33m", False),
+        ),
     ],
 )
 def test_filter(original, filtered):