opsscript-gate 0.2.0__tar.gz → 0.2.1__tar.gz

{opsscript_gate-0.2.0 → opsscript_gate-0.2.1}/CHANGELOG.md

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.1] - 2026-09-19
+
+### Fixed
+- Strip complete ANSI CSI and OSC escape sequences from diagnostic text instead of leaving escape-sequence residue.
+- Ensure diagnostic `max_length` includes the trailing ellipsis when truncation occurs.
+- Add regression coverage for ANSI sanitization and truncation edge cases.
+
+---
+
 ## [0.2.0] - 2026-09-18
 
 ### Added

{opsscript_gate-0.2.0 → opsscript_gate-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: opsscript-gate
-Version: 0.2.0
+Version: 0.2.1
 Summary: Run Linux shell scripts across Debian, Ubuntu and Alpine before release to catch runtime compatibility failures
 Project-URL: Homepage, https://github.com/Mresyzz/opsscript-gate
 Project-URL: Repository, https://github.com/Mresyzz/opsscript-gate
@@ -55,7 +55,7 @@ Add one step to your pull request workflow (`.github/workflows/gate.yml`):
 
 ```yaml
 - name: Verify Shell Script Portability
-  uses: Mresyzz/opsscript-gate@v0.2.0
+  uses: Mresyzz/opsscript-gate@v0.2.1
   with:
     script-path: scripts/setup.sh
     # shell: posix  # optional: 'posix' (default), 'shebang', or 'auto'
@@ -217,6 +217,14 @@ Check out the [examples/](examples/) directory for self-contained, runnable scen
 
 ---
 
+## Dogfooding
+
+OpsScript Gate is used in [`Mresyzz/linux-dev-bootstrap`](https://github.com/Mresyzz/linux-dev-bootstrap) to validate its `install.sh` script across the default Debian, Ubuntu, and Alpine matrix in GitHub Actions. That workflow pins `Mresyzz/opsscript-gate@v0.2.0` with `shell: auto`.
+
+See the downstream workflow: [`.github/workflows/test.yml`](https://github.com/Mresyzz/linux-dev-bootstrap/blob/main/.github/workflows/test.yml).
+
+---
+
 ## Development & Testing
 
 The test suite uses Docker SDK mocking to ensure fast unit tests without needing a local daemon:

{opsscript_gate-0.2.0 → opsscript_gate-0.2.1}/README.md

@@ -27,7 +27,7 @@ Add one step to your pull request workflow (`.github/workflows/gate.yml`):
 
 ```yaml
 - name: Verify Shell Script Portability
-  uses: Mresyzz/opsscript-gate@v0.2.0
+  uses: Mresyzz/opsscript-gate@v0.2.1
   with:
     script-path: scripts/setup.sh
     # shell: posix  # optional: 'posix' (default), 'shebang', or 'auto'
@@ -189,6 +189,14 @@ Check out the [examples/](examples/) directory for self-contained, runnable scen
 
 ---
 
+## Dogfooding
+
+OpsScript Gate is used in [`Mresyzz/linux-dev-bootstrap`](https://github.com/Mresyzz/linux-dev-bootstrap) to validate its `install.sh` script across the default Debian, Ubuntu, and Alpine matrix in GitHub Actions. That workflow pins `Mresyzz/opsscript-gate@v0.2.0` with `shell: auto`.
+
+See the downstream workflow: [`.github/workflows/test.yml`](https://github.com/Mresyzz/linux-dev-bootstrap/blob/main/.github/workflows/test.yml).
+
+---
+
 ## Development & Testing
 
 The test suite uses Docker SDK mocking to ensure fast unit tests without needing a local daemon:

{opsscript_gate-0.2.0 → opsscript_gate-0.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "opsscript-gate"
-version = "0.2.0"
+version = "0.2.1"
 description = "Run Linux shell scripts across Debian, Ubuntu and Alpine before release to catch runtime compatibility failures"
 readme = "README.md"
 license = { text = "MIT" }

{opsscript_gate-0.2.0 → opsscript_gate-0.2.1}/src/opsscript_gate/__init__.py

@@ -1,4 +1,4 @@
 """OpsScript Gate: Lightweight cross-distro compatibility pre-check for Linux ops scripts."""
 
-__version__ = "0.2.0"
+__version__ = "0.2.1"
 __all__ = ["__version__"]

{opsscript_gate-0.2.0 → opsscript_gate-0.2.1}/src/opsscript_gate/runner.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import os
+import re
 import tempfile
 import time
 from typing import Sequence
@@ -35,21 +36,34 @@ SUPPORTED_SHEBANG_COMMANDS: dict[str, list[str]] = {
 
 DEFAULT_POSIX_COMMAND: list[str] = ["/bin/sh", "-c", "/bin/sh /tmp/target_script.sh </dev/null"]
 
+# Regular expression matching common ANSI escape sequences:
+# 1. CSI (Control Sequence Introducer): ESC [ ... [@-~]
+# 2. OSC (Operating System Command): ESC ] ... (BEL | ST)
+_ANSI_ESCAPE_RE = re.compile(
+    r"\x1b(?:\[[0-?]*[ -/]*[@-~]|\][^\x07\x1b]*(?:\x07|\x1b\\))"
+)
+
 
 def sanitize_diagnostic_text(text: str, max_length: int = 200) -> str:
     """
     Sanitize raw shebang text for safe display in diagnostics and error messages:
+    - Strips complete ANSI escape sequences (CSI, OSC)
     - Removes control characters and embedded CR/LF
-    - Truncates to max_length characters with an ellipsis if exceeded
+    - Collapses multiple consecutive whitespace
+    - Ensures maximum final length <= max_length (including ellipsis if truncated)
     """
-    if not text:
+    if not text or max_length <= 0:
         return ""
+    # Strip complete ANSI escape sequences first
+    text = _ANSI_ESCAPE_RE.sub("", text)
     # Filter out control characters (ASCII < 32 and 127)
     sanitized = "".join(ch if (32 <= ord(ch) < 127 or ord(ch) >= 160) else " " for ch in text)
     # Collapse multiple consecutive whitespace
     sanitized = " ".join(sanitized.split())
     if len(sanitized) > max_length:
-        return sanitized[:max_length] + "..."
+        if max_length < 3:
+            return sanitized[:max_length]
+        return sanitized[: max_length - 3] + "..."
     return sanitized
 
 

{opsscript_gate-0.2.0 → opsscript_gate-0.2.1}/tests/test_runner.py

@@ -368,7 +368,7 @@ def test_cli_version(capsys):
         main(["--version"])
     assert excinfo.value.code == 0
     captured = capsys.readouterr()
-    assert "0.2.0" in captured.out
+    assert "0.2.1" in captured.out
 
 
 def test_cli_format_markdown_and_table(tmp_path, capsys):
@@ -681,21 +681,71 @@ def test_run_matrix_parses_shebang_once(tmp_path):
 def test_sanitize_diagnostic_text():
     # Empty string
     assert sanitize_diagnostic_text("") == ""
-    # Control characters, embedded CR/LF, ANSI escapes
+
+    # Control characters, embedded CR/LF, ANSI escape, BEL
     raw = "#!/bin/sh\r\n\x00\x1b[31mecho evil\x07"
     cleaned = sanitize_diagnostic_text(raw)
+    # ESC byte is absent
+    assert "\x1b" not in cleaned
+    # ANSI parameter residue such as "[31m" is also absent
+    assert "[31m" not in cleaned
     assert "\r" not in cleaned
     assert "\n" not in cleaned
     assert "\x00" not in cleaned
-    assert "\x1b" not in cleaned
     assert "\x07" not in cleaned
-    # Multiple whitespace collapsed
-    assert "  " not in cleaned
-    # Truncation to max_length
+    assert cleaned == "#!/bin/sh echo evil"
+
+    # Extended CSI sequence (e.g. 256-color) is removed as a complete sequence
+    extended_csi = "prefix \x1b[38;5;196mcolor\x1b[0m suffix"
+    cleaned_csi = sanitize_diagnostic_text(extended_csi)
+    assert "\x1b" not in cleaned_csi
+    assert "[38;5;196m" not in cleaned_csi
+    assert "[0m" not in cleaned_csi
+    assert cleaned_csi == "prefix color suffix"
+
+    # Additional CSI sequences (\x1b[1;31m, \x1b[?25h, etc.)
+    csi_variations = "\x1b[1;31mboldred\x1b[0m \x1b[?25hcursor"
+    cleaned_variations = sanitize_diagnostic_text(csi_variations)
+    assert "[1;31m" not in cleaned_variations
+    assert "[?25h" not in cleaned_variations
+    assert cleaned_variations == "boldred cursor"
+
+    # OSC title sequences are removed cleanly
+    osc_bel = "\x1b]0;terminal title\x07echo hello"
+    cleaned_osc_bel = sanitize_diagnostic_text(osc_bel)
+    assert "terminal title" not in cleaned_osc_bel
+    assert cleaned_osc_bel == "echo hello"
+
+    osc_st = "\x1b]0;terminal title\x1b\\echo world"
+    cleaned_osc_st = sanitize_diagnostic_text(osc_st)
+    assert "terminal title" not in cleaned_osc_st
+    assert cleaned_osc_st == "echo world"
+
+    # Ordinary printable text and Unicode are preserved
+    normal_text = "echo 'Hello world! 12345 äöü'"
+    cleaned_normal = sanitize_diagnostic_text(normal_text)
+    assert cleaned_normal == normal_text
+
+    # Repeated whitespace is collapsed
+    whitespace_text = "  a    b \t  c   \n\r  d  "
+    assert sanitize_diagnostic_text(whitespace_text) == "a b c d"
+
+    # max_length=200 returns len(result) <= 200, ends in "..."
     long_text = "#!" + "a" * 250
     truncated = sanitize_diagnostic_text(long_text, max_length=200)
-    assert len(truncated) == 203  # 200 chars + "..."
+    assert len(truncated) <= 200
+    assert len(truncated) == 200
     assert truncated.endswith("...")
+    assert truncated == "#!" + "a" * 195 + "..."
+
+    # Small/zero max_length values do not crash and remain defensively sized
+    assert sanitize_diagnostic_text("hello world", max_length=0) == ""
+    assert sanitize_diagnostic_text("hello world", max_length=-5) == ""
+    assert sanitize_diagnostic_text("hello world", max_length=1) == "h"
+    assert sanitize_diagnostic_text("hello world", max_length=2) == "he"
+    assert sanitize_diagnostic_text("hello world", max_length=3) == "..."
+    assert sanitize_diagnostic_text("hello world", max_length=4) == "h..."
+    assert len(sanitize_diagnostic_text("hello world", max_length=5)) <= 5
 
 
 def test_missing_interpreter_compatibility_failure(tmp_path):