Initial commit

tests/test_colors.py

@@ -0,0 +1,7 @@
+import shlax
+
+
+def test_colors():
+    assert shlax.colors.cyan == '\u001b[38;5;51m'
+    assert shlax.colors.bcyan == '\u001b[1;38;5;51m'
+    assert shlax.colors.reset == '\u001b[0m'

tests/test_proc.py

@@ -0,0 +1,158 @@
+import pytest
+from unittest.mock import Mock, call
+
+from shlax import Proc
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    'args',
+    (
+        ['sh', '-c', 'echo hi'],
+        ['echo hi'],
+        ['sh -c "echo hi"'],
+    )
+)
+async def test_proc(args):
+    proc = Proc(*args, quiet=True)
+    assert not proc.waited
+    assert not proc.started
+    await proc.wait()
+    assert proc.waited
+    assert proc.started
+    assert proc.out == 'hi'
+    assert proc.err == ''
+    assert proc.out_raw == b'hi\n'
+    assert proc.err_raw == b''
+    assert proc.rc == 0
+
+
+@pytest.mark.asyncio
+async def test_wait_unbound():
+    proc = await Proc('echo hi', quiet=True).wait()
+    assert proc.out == 'hi'
+
+
+@pytest.mark.asyncio
+async def test_rc_1():
+    proc = await Proc(
+        'NON EXISTING COMMAND',
+        write=Mock(),
+    ).wait()
+    assert proc.rc != 0
+    proc.write.assert_called_once_with(
+        b'sh: line 1: NON: command not found\x1b[0m\n'
+    )
+
+
+@pytest.mark.asyncio
+async def test_prefix():
+    """
+    Test output prefixes for when executing multiple commands in parallel.
+    """
+    Proc.prefix_length = 0  # reset
+
+    write = Mock()
+    await Proc(
+        'echo hi',
+        write=write,
+        prefix='test_prefix',
+    ).wait()
+    await Proc(
+        'echo hi',
+        write=write,
+        prefix='test_prefix_1'
+    ).wait()
+    await Proc(
+        'echo hi',
+        write=write,
+        prefix='test_prefix',
+    ).wait()
+
+    assert write.mock_calls == [
+        call(
+            Proc.prefix_colors[0].encode()
+            + b'test_prefix '
+            + Proc.colors.reset.encode()
+            + b'| hi'
+            + Proc.colors.reset.encode()
+            + b'\n'
+        ),
+        call(
+            Proc.prefix_colors[1].encode()
+            # padding has been added because of output1
+            + b'test_prefix_1 '
+            + Proc.colors.reset.encode()
+            + b'| hi'
+            + Proc.colors.reset.encode()
+            + b'\n'
+        ),
+        call(
+            Proc.prefix_colors[0].encode()
+            # padding has been added because of output1
+            + b'  test_prefix '
+            + Proc.colors.reset.encode()
+            + b'| hi'
+            + Proc.colors.reset.encode()
+            + b'\n'
+        )
+    ]
+
+
+@pytest.mark.asyncio
+async def test_prefix_multiline():
+    Proc.prefix_length = 0  # reset
+    proc = await Proc(
+        'echo -e "a\nb"',
+        write=Mock(),
+        prefix='test_prefix',
+    ).wait()
+    assert proc.write.mock_calls == [
+        call(
+            Proc.prefix_colors[0].encode()
+            + b'test_prefix '
+            + Proc.colors.reset.encode()
+            + b'| a'
+            + Proc.colors.reset.encode()
+            + b'\n'
+        ),
+        call(
+            Proc.prefix_colors[0].encode()
+            # padding has been added because of output1
+            + b'test_prefix '
+            + Proc.colors.reset.encode()
+            + b'| b'
+            + Proc.colors.reset.encode()
+            + b'\n'
+        ),
+    ]
+
+
+@pytest.mark.asyncio
+async def test_highlight():
+    """
+    Test that we can color output with regexps.
+    """
+    proc = await Proc(
+        'echo hi',
+        write=Mock(),
+        regexps={
+            r'h([\w\d-]+)': 'h{cyan}\\1',
+        }
+    ).wait()
+    proc.write.assert_called_once_with(b'h\x1b[38;5;51mi\x1b[0m\n')
+
+
+@pytest.mark.asyncio
+async def test_highlight_if_not_colored():
+    """
+    Test that coloration does not apply on output that is already colored.
+    """
+    proc = await Proc(
+        'echo -e h"\\e[31m"i',
+        write=Mock(),
+        regexps={
+            r'h([\w\d-]+)': 'h{cyan}\\1',
+        }
+    ).wait()
+    proc.write.assert_called_once_with(b'h\x1b[31mi\n')