Fix Docker output by moving colorama init for ECS expressgateway commands (aws#9878)

ashovlin · web-flow · commit a57d9ca656cc · 2025-11-26T07:48:31.000-05:00
diff --git a/awscli/customizations/ecs/expressgateway/color_utils.py b/awscli/customizations/ecs/expressgateway/color_utils.py
@@ -15,70 +15,64 @@
 
 from colorama import Fore, Style, init
 
-# Initialize colorama for cross-platform support
-init()
-
 # Status symbols
 CHECK_MARK = '✓'
 
 
 class ColorUtils:
     """Utility class for applying colors to text using colorama."""
 
-    @staticmethod
-    def make_green(text, use_color=True):
+    def __init__(self):
+        # Initialize colorama
+        init(autoreset=True, strip=False)
+
+    def make_green(self, text, use_color=True):
         if not use_color:
             return text
         return f"{Fore.GREEN}{text}{Style.RESET_ALL}"
 
-    @staticmethod
-    def make_red(text, use_color=True):
+    def make_red(self, text, use_color=True):
         if not use_color:
             return text
         return f"{Fore.RED}{text}{Style.RESET_ALL}"
 
-    @staticmethod
-    def make_purple(text, use_color=True):
+    def make_purple(self, text, use_color=True):
         if not use_color:
             return text
         return f"{Fore.MAGENTA}{text}{Style.RESET_ALL}"
 
-    @staticmethod
-    def make_yellow(text, use_color=True):
+    def make_yellow(self, text, use_color=True):
         if not use_color:
             return text
         return f"{Fore.YELLOW}{text}{Style.RESET_ALL}"
 
-    @staticmethod
-    def make_cyan(text, use_color=True):
+    def make_cyan(self, text, use_color=True):
         if not use_color:
             return text
         return f"{Fore.CYAN}{text}{Style.RESET_ALL}"
 
-    @staticmethod
-    def color_by_status(text, status, use_color=True):
+    def color_by_status(self, text, status, use_color=True):
         """Color text based on resource status."""
         if not status or status == "ACTIVE" or status == "SUCCESSFUL":
-            return ColorUtils.make_green(text, use_color)
+            return self.make_green(text, use_color)
         elif status == "FAILED":
-            return ColorUtils.make_red(text, use_color)
+            return self.make_red(text, use_color)
         elif status == "DELETED":
-            return ColorUtils.make_yellow(text, use_color)
+            return self.make_yellow(text, use_color)
         else:
-            return ColorUtils.make_purple(text, use_color)
+            return self.make_purple(text, use_color)
 
-    @staticmethod
-    def make_status_symbol(status, spinner_char, use_color=True):
+    def make_status_symbol(self, status, spinner_char, use_color=True):
         """Create status symbol with appropriate color."""
         if not status or status == "ACTIVE" or status == "SUCCESSFUL":
-            return ColorUtils.make_green(f"{CHECK_MARK} ", use_color)
+            return self.make_green(f"{CHECK_MARK} ", use_color)
         elif status == "FAILED" or status == "ROLLBACK_FAILED":
-            return ColorUtils.make_red("X ", use_color)
+            return self.make_red("X ", use_color)
         elif (
             status == "DELETED"
             or status == "STOPPED"
             or status == "ROLLBACK_SUCCESSFUL"
         ):
-            return ColorUtils.make_yellow("— ", use_color)
+            return self.make_yellow("— ", use_color)
         else:
-            return ColorUtils.make_purple(f"{spinner_char} ", use_color)
+            return self.make_purple(f"{spinner_char} ", use_color)
diff --git a/awscli/customizations/ecs/expressgateway/managedresource.py b/awscli/customizations/ecs/expressgateway/managedresource.py
@@ -51,6 +51,7 @@ def __init__(
             self.updated_at = updated_at
         self.reason = reason
         self.additional_info = additional_info
+        self.color_utils = ColorUtils()
 
     def is_terminal(self):
         return self.status in TERMINAL_RESOURCE_STATUSES
@@ -67,23 +68,23 @@ def get_status_string(self, spinner_char, depth=0, use_color=True):
             str: Formatted status string with resource information
         """
         lines = []
-        resource_header = " " * depth + ColorUtils.make_cyan(
+        resource_header = " " * depth + self.color_utils.make_cyan(
             self.resource_type, use_color
         )
 
         resource_header += ": " if self.identifier else " "
-        resource_header += ColorUtils.make_status_symbol(
+        resource_header += self.color_utils.make_status_symbol(
             self.status, spinner_char, use_color
         )
         if self.identifier:
             resource_header += (
-                ColorUtils.color_by_status(
+                self.color_utils.color_by_status(
                     self.identifier, self.status, use_color
                 )
                 + " "
             )
         if self.status:
-            resource_header += "- " + ColorUtils.color_by_status(
+            resource_header += "- " + self.color_utils.color_by_status(
                 self.status, self.status, use_color
             )
         lines.append(resource_header)
diff --git a/awscli/customizations/ecs/expressgateway/managedresourcegroup.py b/awscli/customizations/ecs/expressgateway/managedresourcegroup.py
@@ -48,6 +48,7 @@ def __init__(
         }
         self.status = status
         self.reason = reason
+        self.color_utils = ColorUtils()
 
     def _create_key(self, resource):
         resource_type = (
@@ -78,29 +79,29 @@ def get_status_string(self, spinner_char, depth=0, use_color=True):
         lines = []
 
         if self.resource_type:
-            header = " " * depth + ColorUtils.make_cyan(
+            header = " " * depth + self.color_utils.make_cyan(
                 str(self.resource_type), use_color
             )
 
             if self.identifier:
                 header += ": "
                 if self.status:
-                    header += ColorUtils.make_status_symbol(
+                    header += self.color_utils.make_status_symbol(
                         self.status, spinner_char, use_color
                     )
-                    header += ColorUtils.color_by_status(
+                    header += self.color_utils.color_by_status(
                         self.identifier, self.status, use_color
                     )
-                    header += " - " + ColorUtils.color_by_status(
+                    header += " - " + self.color_utils.color_by_status(
                         self.status, self.status, use_color
                     )
                 else:
                     header += self.identifier
             elif self.status:
-                header += " " + ColorUtils.make_status_symbol(
+                header += " " + self.color_utils.make_status_symbol(
                     self.status, spinner_char, use_color
                 )
-                header += "- " + ColorUtils.color_by_status(
+                header += "- " + self.color_utils.color_by_status(
                     self.status, self.status, use_color
                 )
 
diff --git a/tests/functional/test_output.py b/tests/functional/test_output.py
@@ -27,7 +27,11 @@
 
 class TestOutput(BaseAWSCommandParamsTest):
     def setUp(self):
-        super(TestOutput, self).setUp()
+        # Patch this before super, in case called on import
+        self.patch_colorama_init = mock.patch('colorama.init')
+        self.mock_colorama_init = self.patch_colorama_init.start()
+
+        super().setUp()
         self.files = FileCreator()
 
         self.patch_popen = mock.patch('awscli.utils.Popen')
@@ -49,7 +53,7 @@ def setUp(self):
         self.expected_content = self.get_expected_content(self.parsed_response)
 
     def tearDown(self):
-        super(TestOutput, self).tearDown()
+        super().tearDown()
         self.files.remove_all()
         self.patch_popen.stop()
         self.patch_tty.stop()
@@ -61,7 +65,7 @@ def get_expected_content(self, response):
 
     def write_cli_pager_config(self, pager):
         config_file = self.files.create_file(
-            'config', '[default]\n' 'cli_pager = %s\n' % pager
+            'config', '[default]\n' f'cli_pager = {pager}\n'
         )
         self.environ['AWS_CONFIG_FILE'] = config_file
         self.driver = create_clidriver()
@@ -194,6 +198,15 @@ def test_raises_exception_when_pager_cannot_be_opened(self):
         self.assertIn('Unable to redirect output to pager', stderr)
         self.assertIn(pager_error_message, stderr)
 
+    def test_colorama_init_not_called(self):
+        """
+        For https://github.com/aws/aws-cli/issues/9864,
+        we had an issue where colorama was always being initialized, instead of
+        just during the custom commands or modes that use it
+        """
+        self.run_cmd(self.cmdline)
+        self.mock_colorama_init.assert_not_called()
+
 
 class TestYAMLStream(BaseAWSCommandParamsTest):
     def assert_yaml_response_equal(self, response, expected):
diff --git a/tests/unit/customizations/ecs/expressgateway/test_color_utils.py b/tests/unit/customizations/ecs/expressgateway/test_color_utils.py

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,7 @@ def __init__(`
`48`	`48`	`}`
`49`	`49`	`self.status = status`
`50`	`50`	`self.reason = reason`
	`51`	`+ self.color_utils = ColorUtils()`
`51`	`52`
`52`	`53`	`def _create_key(self, resource):`
`53`	`54`	`resource_type = (`
`@@ -78,29 +79,29 @@ def get_status_string(self, spinner_char, depth=0, use_color=True):`
`78`	`79`	`lines = []`
`79`	`80`
`80`	`81`	`if self.resource_type:`
`81`		`- header = " " * depth + ColorUtils.make_cyan(`
	`82`	`+ header = " " * depth + self.color_utils.make_cyan(`
`82`	`83`	`str(self.resource_type), use_color`
`83`	`84`	`)`
`84`	`85`
`85`	`86`	`if self.identifier:`
`86`	`87`	`header += ": "`
`87`	`88`	`if self.status:`
`88`		`- header += ColorUtils.make_status_symbol(`
	`89`	`+ header += self.color_utils.make_status_symbol(`
`89`	`90`	`self.status, spinner_char, use_color`
`90`	`91`	`)`
`91`		`- header += ColorUtils.color_by_status(`
	`92`	`+ header += self.color_utils.color_by_status(`
`92`	`93`	`self.identifier, self.status, use_color`
`93`	`94`	`)`
`94`		`- header += " - " + ColorUtils.color_by_status(`
	`95`	`+ header += " - " + self.color_utils.color_by_status(`
`95`	`96`	`self.status, self.status, use_color`
`96`	`97`	`)`
`97`	`98`	`else:`
`98`	`99`	`header += self.identifier`
`99`	`100`	`elif self.status:`
`100`		`- header += " " + ColorUtils.make_status_symbol(`
	`101`	`+ header += " " + self.color_utils.make_status_symbol(`
`101`	`102`	`self.status, spinner_char, use_color`
`102`	`103`	`)`
`103`		`- header += "- " + ColorUtils.color_by_status(`
	`104`	`+ header += "- " + self.color_utils.color_by_status(`
`104`	`105`	`self.status, self.status, use_color`
`105`	`106`	`)`
`106`	`107`