✨ [+feature] Added InitializeStreamCapabilities for testing (#40)

davidbrownell · May 30, 2024 · ced9263 · ced9263
2 parents 955d2f0 + 7f2d71e
commit ced9263
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 7 deletions.
diff --git a/Build.py b/Build.py
@@ -45,17 +45,21 @@ def list_commands(self, *args, **kwargs):  # pylint: disable=unused-argument
 # ----------------------------------------------------------------------
 this_dir = PathEx.EnsureDir(Path(__file__).parent)
 src_dir = PathEx.EnsureDir(this_dir / "src" / "dbrownell_Common")
-tests_dir = PathEx.EnsureDir(this_dir / "tests")
 
 
 # ----------------------------------------------------------------------
 Black = RepoBuildTools.BlackFuncFactory(this_dir, app)
 Pylint = RepoBuildTools.PylintFuncFactory(src_dir, app)
 Pytest = RepoBuildTools.PytestFuncFactory(
-    tests_dir, "dbrownell_Common", app, default_min_coverage=80.0
+    this_dir,
+    "dbrownell_Common",
+    app,
+    default_min_coverage=80.0,
 )
 UpdateVersion = RepoBuildTools.UpdateVersionFuncFactory(
-    src_dir.parent, src_dir / "__init__.py", app
+    src_dir.parent,
+    src_dir / "__init__.py",
+    app,
 )
 Package = RepoBuildTools.PackageFuncFactory(this_dir, app)
 Publish = RepoBuildTools.PublishFuncFactory(this_dir, app)

diff --git a/src/dbrownell_Common/TestHelpers/StreamTestHelpers.py b/src/dbrownell_Common/TestHelpers/StreamTestHelpers.py
@@ -14,6 +14,7 @@
 """Test helpers for content found in ../Streams"""
 
 import re
+import sys
 
 from io import StringIO
 from typing import Generator, Match, Optional
@@ -47,7 +48,7 @@ def Replace(
     else:
         replace_func = lambda _: "<scrubbed duration>"
 
-    return re.sub(
+    content = re.sub(
         r"""(?#
             Hours                           )(?P<hours>\d+)(?#
             sep                             )\:(?#
@@ -59,6 +60,11 @@ def Replace(
         content,
     )
 
+    # Remove any trailing whitespace
+    content = "\n".join(line.rstrip() for line in content.split("\n"))
+
+    return content
+
 
 # ----------------------------------------------------------------------
 def GenerateDoneManagerAndContent(
@@ -118,12 +124,27 @@ def GenerateDoneManagerAndContent(
         keep_seconds=keep_duration_seconds,
     )
 
-    # Remove any trailing whitespace
-    content = "\n".join(line.rstrip() for line in content.split("\n"))
-
     assert expected_result is None or final_result == expected_result, (
         expected_result,
         final_result,
         content,
     )
     yield content
+
+
+# ----------------------------------------------------------------------
+def InitializeStreamCapabilities(
+    stream=sys.stdout,
+) -> None:
+    """Ensure that the provided stream outputs consistently within a variety of different environments."""
+
+    if not hasattr(
+        stream,
+        Capabilities._EMBEDDED_CAPABILITIES_ATTRIBUTE_NAME,  # pylint: disable=protected-access
+    ):
+        Capabilities(
+            columns=120,
+            supports_colors=True,
+            stream=stream,
+            no_column_warning=True,
+        )
diff --git a/tests/TestHelpers/StreamTestHelpers_UnitTest.py b/tests/TestHelpers/StreamTestHelpers_UnitTest.py
@@ -258,3 +258,12 @@ def Impl(
             DONE! (0, <scrubbed duration>)
             """,
         )
+
+
+# ----------------------------------------------------------------------
+def test_InitializeStreamCapabilites():
+    # It should be safe to call this multiple times
+    InitializeStreamCapabilities()
+    InitializeStreamCapabilities()
+
+    assert True