pyserial driver: add pipe command on cli

(cherry picked from commit a659e96)

Author: mangelajo

packages/jumpstarter-driver-pyserial/README.md

@@ -33,6 +33,58 @@ export:
 | check_present | Check if the serial port exists during exporter initialization, disable if you are connecting to a dynamically created port (i.e. USB from your DUT) | bool  | no       | True    |
 | cps            | Characters per second throttling limit. When set, data transmission will be throttled to simulate slow typing. Useful for devices that can't handle fast input | float | no       | None    |
 
+## CLI Commands
+
+The pyserial driver provides two CLI commands for interacting with serial ports:
+
+### start_console
+
+Start an interactive serial console with direct terminal access.
+
+```bash
+j serial start-console
+```
+
+Exit the console by pressing CTRL+B three times.
+
+### pipe
+
+Pipe serial port data to stdout or a file. Automatically detects if stdin is piped and enables bidirectional mode.
+
+When stdin is used, commands are sent until EOF, then continues monitoring serial output until Ctrl+C.
+
+```bash
+# Log serial output to stdout
+j serial pipe
+
+# Log serial output to a file
+j serial pipe -o serial.log
+
+# Send command to serial, then continue monitoring output
+echo "hello" | j serial pipe
+
+# Send commands from file, then continue monitoring output
+cat commands.txt | j serial pipe -o serial.log
+
+# Force bidirectional mode (interactive)
+j serial pipe -i
+
+# Append to log file instead of overwriting
+j serial pipe -o serial.log -a
+
+# Disable stdin input even when piped
+cat data.txt | j serial pipe --no-input
+```
+
+#### Options
+
+- `-o, --output FILE`: Write serial output to a file instead of stdout
+- `-i, --input`: Force enable stdin to serial port (auto-detected if piped)
+- `--no-input`: Disable stdin to serial port, even if stdin is piped
+- `-a, --append`: Append to output file instead of overwriting
+
+Exit with Ctrl+C.
+
 ## API Reference
 
 ```{eval-rst}

packages/jumpstarter-driver-pyserial/jumpstarter_driver_pyserial/cli_test.py

@@ -0,0 +1,243 @@
+"""
+CLI tests for PySerial driver.
+
+Tests the Click CLI interface including the pipe command.
+"""
+
+from unittest.mock import patch
+
+import pytest
+from click.testing import CliRunner
+
+from .driver import PySerial
+from jumpstarter.common.utils import serve
+
+
+@pytest.fixture
+def pyserial_client():
+    """Fixture to create a PySerial client with loop:// URL for testing."""
+    instance = PySerial(url="loop://")
+    with serve(instance) as client:
+        yield client
+
+
+def test_pipe_command_append_requires_output(pyserial_client):
+    """Test that --append requires --output."""
+    runner = CliRunner()
+    cli = pyserial_client.cli()
+
+    # Mock the portal to prevent actual execution
+    with patch.object(pyserial_client, "portal"):
+        result = runner.invoke(cli, ["pipe", "--append"])
+        assert result.exit_code != 0
+        assert "--append requires --output" in result.output
+
+
+def test_pipe_command_input_and_no_input_conflict(pyserial_client):
+    """Test that --input and --no-input cannot be used together."""
+    runner = CliRunner()
+    cli = pyserial_client.cli()
+
+    # Mock the portal to prevent actual execution
+    with patch.object(pyserial_client, "portal"):
+        result = runner.invoke(cli, ["pipe", "--input", "--no-input"])
+        assert result.exit_code != 0
+        assert "Cannot use both --input and --no-input" in result.output
+
+
+def test_pipe_command_with_output_file(pyserial_client):
+    """Test pipe command with output file option."""
+    runner = CliRunner()
+    cli = pyserial_client.cli()
+
+    with runner.isolated_filesystem():
+        # Mock the portal.call to prevent actual execution
+        with patch.object(pyserial_client.portal, "call") as mock_call:
+            mock_call.side_effect = KeyboardInterrupt  # Simulate Ctrl+C to exit
+
+            # Use --no-input to explicitly disable input detection
+            runner.invoke(cli, ["pipe", "-o", "test.log", "--no-input"])
+
+            # Should have attempted to call _pipe_serial
+            assert mock_call.called
+            # Check the arguments passed
+            args = mock_call.call_args[0]
+            assert args[1] == "test.log"  # output file
+            assert args[2] is False  # input_enabled
+            assert args[3] is False  # append
+
+
+def test_pipe_command_with_append(pyserial_client):
+    """Test pipe command with append option."""
+    runner = CliRunner()
+    cli = pyserial_client.cli()
+
+    with runner.isolated_filesystem():
+        with patch.object(pyserial_client.portal, "call") as mock_call:
+            mock_call.side_effect = KeyboardInterrupt
+
+            runner.invoke(cli, ["pipe", "-o", "test.log", "-a"])
+
+            assert mock_call.called
+            args = mock_call.call_args[0]
+            assert args[1] == "test.log"  # output file
+            assert args[3] is True  # append
+
+
+def test_pipe_command_with_input_flag(pyserial_client):
+    """Test pipe command with --input flag."""
+    runner = CliRunner()
+    cli = pyserial_client.cli()
+
+    with patch.object(pyserial_client.portal, "call") as mock_call:
+        mock_call.side_effect = KeyboardInterrupt
+
+        runner.invoke(cli, ["pipe", "-i"])
+
+        assert mock_call.called
+        args = mock_call.call_args[0]
+        assert args[2] is True  # input_enabled
+
+
+def test_pipe_command_with_no_input_flag(pyserial_client):
+    """Test pipe command with --no-input flag."""
+    runner = CliRunner()
+    cli = pyserial_client.cli()
+
+    with patch.object(pyserial_client.portal, "call") as mock_call:
+        mock_call.side_effect = KeyboardInterrupt
+
+        runner.invoke(cli, ["pipe", "--no-input"])
+
+        assert mock_call.called
+        args = mock_call.call_args[0]
+        assert args[2] is False  # input_enabled
+
+
+def test_pipe_command_stdin_auto_detection(pyserial_client):
+    """Test that pipe command auto-detects piped stdin with CliRunner."""
+    runner = CliRunner()
+    cli = pyserial_client.cli()
+
+    # CliRunner doesn't provide a TTY by default, so stdin.isatty() returns False
+    # This simulates the behavior when stdin is piped
+    with patch.object(pyserial_client.portal, "call") as mock_call:
+        mock_call.side_effect = KeyboardInterrupt
+
+        runner.invoke(cli, ["pipe"])
+
+        assert mock_call.called
+        args = mock_call.call_args[0]
+        # Should auto-enable input when stdin is not a TTY (CliRunner default behavior)
+        assert args[2] is True  # input_enabled
+
+
+def test_pipe_command_no_auto_detection_with_no_input_flag(pyserial_client):
+    """Test that pipe command doesn't enable input with --no-input flag."""
+    runner = CliRunner()
+    cli = pyserial_client.cli()
+
+    with patch.object(pyserial_client.portal, "call") as mock_call:
+        mock_call.side_effect = KeyboardInterrupt
+
+        runner.invoke(cli, ["pipe", "--no-input"])
+
+        assert mock_call.called
+        args = mock_call.call_args[0]
+        # Should NOT enable input when --no-input is specified
+        assert args[2] is False  # input_enabled
+
+
+def test_pipe_command_status_messages(pyserial_client):
+    """Test that pipe command prints appropriate status messages."""
+    runner = CliRunner()
+    cli = pyserial_client.cli()
+
+    with patch.object(pyserial_client.portal, "call") as mock_call:
+        mock_call.side_effect = KeyboardInterrupt
+
+        # Test read-only mode (with --no-input flag)
+        result = runner.invoke(cli, ["pipe", "--no-input"])
+        assert "Reading from serial port" in result.output
+        assert "Ctrl+C to exit" in result.output
+
+        # Test bidirectional mode (CliRunner stdin is not a TTY, so it auto-detects)
+        result = runner.invoke(cli, ["pipe"])
+        assert "Bidirectional mode" in result.output or "auto-detected" in result.output
+
+
+def test_pipe_command_with_file_and_input(pyserial_client):
+    """Test pipe command with both file output and input."""
+    runner = CliRunner()
+    cli = pyserial_client.cli()
+
+    with runner.isolated_filesystem():
+        with patch.object(pyserial_client.portal, "call") as mock_call:
+            mock_call.side_effect = KeyboardInterrupt
+
+            with patch("sys.stdin.isatty", return_value=False):
+                runner.invoke(cli, ["pipe", "-o", "test.log"])
+
+                assert mock_call.called
+                args = mock_call.call_args[0]
+                assert args[1] == "test.log"  # output file
+                assert args[2] is True  # input_enabled (auto-detected)
+                assert args[3] is False  # append
+
+
+def test_pipe_command_keyboard_interrupt_handling(pyserial_client):
+    """Test that pipe command handles KeyboardInterrupt gracefully."""
+    runner = CliRunner()
+    cli = pyserial_client.cli()
+
+    with patch.object(pyserial_client.portal, "call") as mock_call:
+        mock_call.side_effect = KeyboardInterrupt
+
+        result = runner.invoke(cli, ["pipe"])
+
+        # Should exit cleanly after KeyboardInterrupt
+        assert "Stopped" in result.output or result.exit_code == 0
+
+
+def test_pipe_command_mode_descriptions(pyserial_client):
+    """Test that pipe command shows correct mode descriptions."""
+    runner = CliRunner()
+    cli = pyserial_client.cli()
+
+    with patch.object(pyserial_client.portal, "call") as mock_call:
+        mock_call.side_effect = KeyboardInterrupt
+
+        # Test auto-detected mode (CliRunner stdin is not a TTY)
+        result = runner.invoke(cli, ["pipe"])
+        assert "auto-detected" in result.output.lower()
+
+        # Test forced input mode
+        result = runner.invoke(cli, ["pipe", "-i"])
+        assert "forced input" in result.output.lower() or "bidirectional" in result.output.lower()
+
+        # Test read-only mode (with --no-input flag)
+        result = runner.invoke(cli, ["pipe", "--no-input"])
+        assert "read-only" in result.output.lower()
+
+
+def test_start_console_command_structure(pyserial_client):
+    """Test that start-console command has the correct structure."""
+    cli = pyserial_client.cli()
+
+    # Click converts underscores to hyphens in command names
+    cmd_name = "start-console" if "start-console" in cli.commands else "start_console"
+    console_cmd = cli.commands[cmd_name]
+
+    assert console_cmd is not None
+    assert hasattr(console_cmd, "callback")
+
+
+def test_cli_base_command(pyserial_client):
+    """Test that base CLI command works."""
+    runner = CliRunner()
+    cli = pyserial_client.cli()
+
+    result = runner.invoke(cli, ["--help"])
+    assert result.exit_code == 0
+    assert "Serial port client" in result.output or "Commands:" in result.output
+