marsh-lib 0.3.1__tar.gz → 0.3.2__tar.gz

{marsh_lib-0.3.1 → marsh_lib-0.3.2}/.github/workflows/test.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches: ["*"]
   pull_request:
-    branches: ["main"]
+    branches: ["develop", "main"]
   workflow_dispatch:
 
 permissions:
@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Install uv
         uses: astral-sh/setup-uv@v10.2.0
@@ -27,7 +27,6 @@ jobs:
         run: |
           uv sync --all-groups
 
-      # TODO: Setup Docker for testing docker components (and possible ssh components).
       - name: Run pytest
         run: |
           cd src
@@ -45,3 +44,26 @@ jobs:
         with:
             coverageFile: coverage.xml
             token: ${{ secrets.GITHUB_TOKEN }}
+
+  windows_portability:
+    name: Windows portability (Python 3.12)
+    runs-on: windows-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.2.0
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: uv sync --all-groups
+
+      - name: Run portable pytest suite
+        run: >
+          uv run pytest -vv --disable-warnings --tb=short
+          --ignore=tests/bash
+          --ignore=tests/docker
+          --ignore=tests/ssh
+          tests/

{marsh_lib-0.3.1 → marsh_lib-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: marsh-lib
-Version: 0.3.1
+Version: 0.3.2
 Summary: Lightweight, extensible Python library for building, managing, and executing command workflows.
 Project-URL: Repository, https://github.com/CedricAnover/marsh
 Author-email: Cedric Anover <cedric.anover@hotmail.com>

marsh_lib-0.3.2/docs/v0.3.2-test-portability.md

@@ -0,0 +1,73 @@
+# v0.3.2 Test Portability Audit
+
+Date: 2026-10-04
+Release: v0.3.2
+Base branch: develop
+
+## Scope
+
+Make the test suite platform-independent without changing Marsh execution semantics.
+
+## Portability boundary
+
+### Portable unit tests
+
+These tests must not depend on a host shell executable when shell/process behavior is not the subject:
+
+- `tests/core/test_executor.py`
+  - callback behavior
+  - timeout behavior
+  - invalid callback return behavior
+  - mocked subprocess lifecycle
+- Core/runtime tests that use `sys.executable` for genuine Python subprocess behavior.
+
+### Genuine subprocess tests
+
+A real subprocess is appropriate when process lifecycle/exit/timeout behavior is the behavior under test.
+
+Current examples:
+
+- `tests/core/test_runtime.py` uses `sys.executable` for deterministic Python subprocesses and timeout/cancellation coverage.
+
+Rule: use `sys.executable` rather than a shell convenience command.
+
+### Provider/OS integration tests
+
+These intentionally retain provider-specific or OS-specific behavior and must stay outside the portable Windows unit gate:
+
+- `tests/bash/` — Bash provider/grammar/script behavior.
+- `tests/docker/` — Docker provider/integration behavior; commands such as `bash`, `echo`, and `sleep` are exercised inside containers.
+- `tests/ssh/` — SSH/provider acceptance and remote shell behavior.
+- `tests/core/test_py_command_grammar.py` — explicit command-grammar construction for configured shell commands; this tests command construction, not local Windows execution.
+
+## Issue #90 and sibling findings
+
+`tests/core/test_executor.py` contained unit tests that selected Unix shell commands (`bash`, `echo`, `sleep`) even though the tests were validating executor callback/timeout/result semantics. Those dependencies make the tests host-shell dependent.
+
+The v0.3.2 fix is to mock `subprocess.Popen` for those semantics tests. Production `LocalCommandExecutor` remains unchanged and continues to use `shell=False`.
+
+## Policy
+
+1. Mock process creation when subprocess behavior itself is not the subject.
+2. Use `sys.executable` for genuine Python subprocess tests.
+3. Do not use `echo`, `bash`, `sh`, `sleep`, or similar commands merely as convenient test fixtures.
+4. Keep provider/OS integration tests explicitly separated from portable unit tests.
+5. Do not add a subprocess-testing dependency without evidence that the existing stdlib/pytest tooling is insufficient.
+
+## CI boundary
+
+- CircleCI Linux Python 3.10/3.11/3.12: broad compatibility.
+- GitHub Actions Windows Python 3.12: native portability gate.
+- GitHub Actions Ubuntu + Docker: Docker integration.
+- Existing SSH integration: SSH/provider acceptance.
+
+Native Windows is the portability gate. Linux Docker is not a substitute for native Windows.
+
+## Exit evidence
+
+The audit is complete when:
+- OS-dependent tests have an explicit classification;
+- executor unit tests contain no accidental host-shell dependency;
+- genuine subprocess tests use a portable executable;
+- CI explicitly separates portable tests from provider/OS integration;
+- no production execution semantics were changed for portability.

{marsh_lib-0.3.1 → marsh_lib-0.3.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "marsh-lib"
-version = "0.3.1"
+version = "0.3.2"
 description = "Lightweight, extensible Python library for building, managing, and executing command workflows."
 authors = [{ name = "Cedric Anover", email = "cedric.anover@hotmail.com" }]
 license = { text = "MIT" }

{marsh_lib-0.3.1 → marsh_lib-0.3.2}/src/marsh/modifier_functions/readers.py

@@ -1,8 +1,8 @@
 def read_file(inp_stdout: bytes, inp_stderr: bytes, file_path: str, encoding='utf-8') -> tuple[bytes, bytes]:
     try:
-        with open(file_path, 'r') as file:
+        with open(file_path, 'r', encoding=encoding) as file:
             return file.read().encode(encoding), b""
-    except (FileNotFoundError, PermissionError, IsADirectoryError, OSError, UnicodeEncodeError, IOError) as e:
+    except (FileNotFoundError, PermissionError, IsADirectoryError, OSError, UnicodeEncodeError, UnicodeDecodeError, IOError) as e:
         return b"", str(e).encode(encoding)
 
 

{marsh_lib-0.3.1 → marsh_lib-0.3.2}/src/marsh/processor_functions/printers.py

@@ -1,5 +1,6 @@
 import pprint
 import logging
+import sys
 
 from ..utils.output_streams import mask_sensitive_data
 from ..logger import create_console_logger
@@ -17,10 +18,10 @@ def print_output_stream(inp_stdout: bytes,
 
     if output_stream == "stdout":
         if inp_stdout.strip():
-            print(inp_stdout.decode(encoding).strip(), *args, **kwargs)
+            print(inp_stdout.decode(encoding).strip(), *args, file=sys.stdout, **kwargs)
     else:
         if inp_stderr.strip():
-            print(inp_stderr.decode(encoding).strip(), *args, **kwargs)
+            print(inp_stderr.decode(encoding).strip(), *args, file=sys.stderr, **kwargs)
 
 
 def print_stdout(inp_stdout: bytes, inp_stderr: bytes, *args, encoding='utf-8', **kwargs) -> None:

{marsh_lib-0.3.1 → marsh_lib-0.3.2}/src/marsh/processor_functions/redirections.py

@@ -14,7 +14,7 @@ def redirect_output_stream(inp_stdout: bytes,
     if output_stream not in ["stdout", "stderr"]:
         raise ValueError("Output stream must be 'stdout' or 'stderr'.")
 
-    with open(file_path, mode) as file:
+    with open(file_path, mode, encoding=encoding) as file:
         if output_stream == "stdout":
             file.write(inp_stdout.decode(encoding).strip())
         else: