sql-sp-harness 1.0.0__tar.gz

sql_sp_harness-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2026 Deepraj Adhikary
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sql_sp_harness-1.0.0/MANIFEST.in

@@ -0,0 +1,11 @@
+include LICENSE
+include README.md
+graft src
+prune tests
+prune dist
+prune build
+prune .github
+prune .venv
+global-exclude __pycache__
+global-exclude *.py[cod]
+global-exclude .DS_Store

sql_sp_harness-1.0.0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: sql-sp-harness
+Version: 1.0.0
+Summary: Generate safe T-SQL stored-procedure debug harness scripts (analyze + DML previews)
+Author: Deepraj Adhikary
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/DeeprajDeveloper/sql-sp-harness
+Project-URL: Documentation, https://github.com/DeeprajDeveloper/sql-sp-harness#readme
+Project-URL: Repository, https://github.com/DeeprajDeveloper/sql-sp-harness
+Project-URL: Issues, https://github.com/DeeprajDeveloper/sql-sp-harness/issues
+Project-URL: Changelog, https://github.com/DeeprajDeveloper/sql-sp-harness/releases
+Project-URL: Extension, https://github.com/DeeprajDeveloper/mssql-sp-debug-scripter
+Keywords: sql,sql-server,t-sql,stored-procedure,debug-harness,test-harness
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sqlglot>=25.0.0
+Requires-Dist: typer>=0.12.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: twine>=5.0.0; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <img
+    src="https://raw.githubusercontent.com/DeeprajDeveloper/sql-sp-harness/master/docs/BANNER.png"
+    alt="sql-sp-harness"
+  >
+</p>
+
+[![PyPI](https://badge.fury.io/py/sql-sp-harness.svg)](https://pypi.python.org/pypi/sql-sp-harness) 
+[![Python 3.10|3.12|3.13](https://img.shields.io/badge/python-3.10&nbsp;|&nbsp;3.12&nbsp;|&nbsp;3.13-blue.svg)](https://github.com/DeeprajDeveloper/sql-sp-harness)
+
+# sql-sp-harness
+
+**T-SQL Stored Procedure Debug Harness** — turn SQL Server stored procedures into **safe, runnable debug scripts** you can execute on a pre-production database without writing to real tables.
+
+> Not a live debugger. This tool generates a **static test harness** (DML previews + variable traces), not breakpoints or step-into debugging.
+>
+> Not affiliated with Microsoft. "SQL Server" and T-SQL are used descriptively only.
+
+## What it does
+
+| Command | Purpose |
+|---------|---------|
+| `analyze` | See what keyword elements that procedure contains along with counts — DML, TRY/CATCH, loops, SET, line-level detail |
+| `generate` | Create a debug harness: real-table DML → `SELECT` previews, `PRINT` traces on variables |
+
+Output includes a banner on the top of the procedure stating: **DEBUG HARNESS — DO NOT RUN ON PRODUCTION**.
+
+## Install
+
+```bash
+pip install sql-sp-harness
+```
+
+Requires **Python 3.10+**.
+
+Verify:
+
+```bash
+sql-sp-harness version
+python -m sql_sp_harness version
+```
+
+## Quick start
+
+```bash
+sql-sp-harness analyze -i MyProc.sql
+sql-sp-harness generate -i MyProc.sql -o MyProc_debug.sql
+```
+
+With traces in the Messages tab (default):
+
+```bash
+sql-sp-harness generate -i MyProc.sql -o MyProc_debug.sql --trace-style print
+```
+
+## Development
+
+```bash
+git clone https://github.com/DeeprajDeveloper/sql-sp-harness.git
+cd sql-sp-harness
+pip install -e ".[dev]"
+pytest
+```
+
+Build for PyPI:
+
+```bash
+./scripts/publish-pypi.sh
+./scripts/publish-pypi.sh upload
+```
+
+## Limitations
+
+| Pattern | Behavior |
+|---------|----------|
+| Dynamic SQL | Not analyzed |
+| Encrypted procedures | No source |
+| Cursors | Not rewritten |
+| DDL inside proc | Not stubbed |
+
+Always review generated scripts before running on a shared server.
+
+## License
+
+MIT

sql_sp_harness-1.0.0/README.md

@@ -0,0 +1,85 @@
+<p align="center">
+  <img
+    src="https://raw.githubusercontent.com/DeeprajDeveloper/sql-sp-harness/master/docs/BANNER.png"
+    alt="sql-sp-harness"
+  >
+</p>
+
+[![PyPI](https://badge.fury.io/py/sql-sp-harness.svg)](https://pypi.python.org/pypi/sql-sp-harness) 
+[![Python 3.10|3.12|3.13](https://img.shields.io/badge/python-3.10&nbsp;|&nbsp;3.12&nbsp;|&nbsp;3.13-blue.svg)](https://github.com/DeeprajDeveloper/sql-sp-harness)
+
+# sql-sp-harness
+
+**T-SQL Stored Procedure Debug Harness** — turn SQL Server stored procedures into **safe, runnable debug scripts** you can execute on a pre-production database without writing to real tables.
+
+> Not a live debugger. This tool generates a **static test harness** (DML previews + variable traces), not breakpoints or step-into debugging.
+>
+> Not affiliated with Microsoft. "SQL Server" and T-SQL are used descriptively only.
+
+## What it does
+
+| Command | Purpose |
+|---------|---------|
+| `analyze` | See what keyword elements that procedure contains along with counts — DML, TRY/CATCH, loops, SET, line-level detail |
+| `generate` | Create a debug harness: real-table DML → `SELECT` previews, `PRINT` traces on variables |
+
+Output includes a banner on the top of the procedure stating: **DEBUG HARNESS — DO NOT RUN ON PRODUCTION**.
+
+## Install
+
+```bash
+pip install sql-sp-harness
+```
+
+Requires **Python 3.10+**.
+
+Verify:
+
+```bash
+sql-sp-harness version
+python -m sql_sp_harness version
+```
+
+## Quick start
+
+```bash
+sql-sp-harness analyze -i MyProc.sql
+sql-sp-harness generate -i MyProc.sql -o MyProc_debug.sql
+```
+
+With traces in the Messages tab (default):
+
+```bash
+sql-sp-harness generate -i MyProc.sql -o MyProc_debug.sql --trace-style print
+```
+
+## Development
+
+```bash
+git clone https://github.com/DeeprajDeveloper/sql-sp-harness.git
+cd sql-sp-harness
+pip install -e ".[dev]"
+pytest
+```
+
+Build for PyPI:
+
+```bash
+./scripts/publish-pypi.sh
+./scripts/publish-pypi.sh upload
+```
+
+## Limitations
+
+| Pattern | Behavior |
+|---------|----------|
+| Dynamic SQL | Not analyzed |
+| Encrypted procedures | No source |
+| Cursors | Not rewritten |
+| DDL inside proc | Not stubbed |
+
+Always review generated scripts before running on a shared server.
+
+## License
+
+MIT

sql_sp_harness-1.0.0/pyproject.toml

@@ -0,0 +1,66 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sql-sp-harness"
+dynamic = ["version"]
+description = "Generate safe T-SQL stored-procedure debug harness scripts (analyze + DML previews)"
+readme = { file = "README.md", content-type = "text/markdown" }
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+authors = [{ name = "Deepraj Adhikary" }]
+keywords = [
+  "sql",
+  "sql-server",
+  "t-sql",
+  "stored-procedure",
+  "debug-harness",
+  "test-harness",
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Database",
+  "Topic :: Software Development :: Code Generators",
+]
+dependencies = [
+  "sqlglot>=25.0.0",
+  "typer>=0.12.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/DeeprajDeveloper/sql-sp-harness"
+Documentation = "https://github.com/DeeprajDeveloper/sql-sp-harness#readme"
+Repository = "https://github.com/DeeprajDeveloper/sql-sp-harness"
+Issues = "https://github.com/DeeprajDeveloper/sql-sp-harness/issues"
+Changelog = "https://github.com/DeeprajDeveloper/sql-sp-harness/releases"
+Extension = "https://github.com/DeeprajDeveloper/mssql-sp-debug-scripter"
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0.0", "build>=1.0.0", "twine>=5.0.0"]
+
+[project.scripts]
+sql-sp-harness = "sql_sp_harness.cli:app"
+sp-harness = "sql_sp_harness.cli:app"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.dynamic]
+version = { attr = "sql_sp_harness.__version__" }
+
+[tool.setuptools]
+include-package-data = false
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

sql_sp_harness-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sql_sp_harness-1.0.0/src/sql_sp_harness/__init__.py

@@ -0,0 +1,4 @@
+"""T-SQL stored procedure debug harness — safe SQL test-harness generator."""
+
+__version__ = "1.0.0"
+__pypi_name__ = "sql-sp-harness"

sql_sp_harness-1.0.0/src/sql_sp_harness/__main__.py

@@ -0,0 +1,4 @@
+from sql_sp_harness.cli import main
+
+if __name__ == "__main__":
+    main()

sql_sp_harness-1.0.0/src/sql_sp_harness/cli.py

@@ -0,0 +1,297 @@
+"""CLI for sql-sp-harness."""
+
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+from typing import Optional
+
+import typer
+
+from sql_sp_harness import __version__
+from sql_sp_harness.console import supports_color
+from sql_sp_harness.inventory import inventory_from_sql
+from sql_sp_harness.transform import transform_sql
+
+APP_HELP = """
+Turn T-SQL stored procedures into safe, runnable debug scripts.
+
+\b
+Commands:
+  analyze    See what a procedure does (DML, TRY/CATCH, loops, variables)
+  generate   Create a debug harness script safe to run on a dev database
+
+\b
+Quick start:
+  sql-sp-harness analyze -i MyProc.sql
+  sql-sp-harness generate -i MyProc.sql -o MyProc_debug.sql
+
+\b
+More help:
+  sql-sp-harness analyze --help
+  sql-sp-harness generate --help
+"""
+
+app = typer.Typer(
+    name="sql-sp-harness",
+    help=APP_HELP,
+    no_args_is_help=True,
+    add_completion=False,
+)
+
+
+@app.command("version")
+def cmd_version() -> None:
+    """Print package version."""
+    typer.echo(__version__)
+
+
+def _version() -> str:
+    try:
+        from importlib.metadata import version
+
+        return version("sql-sp-harness")
+    except Exception:
+        return __version__
+
+
+@app.callback()
+def _root_callback(
+    ctx: typer.Context,
+    version: Optional[bool] = typer.Option(
+        None,
+        "--version",
+        "-V",
+        help="Show version and exit.",
+        is_eager=True,
+    ),
+) -> None:
+    """T-SQL stored procedure debug harness generator."""
+    if version:
+        typer.echo(f"sql-sp-harness {_version()}")
+        raise typer.Exit()
+
+
+def _read_input(path: Optional[Path]) -> str:
+    if path is None or str(path) == "-":
+        return sys.stdin.read()
+    return path.read_text(encoding="utf-8")
+
+
+def _write_output(path: Optional[Path], content: str) -> None:
+    if path is None or str(path) == "-":
+        sys.stdout.write(content)
+        return
+    path.write_text(content, encoding="utf-8")
+
+
+def _run_analyze(
+    input: Path,
+    report: Optional[Path],
+    plain: bool,
+    full: bool,
+) -> None:
+    sql = _read_input(input)
+    inv = inventory_from_sql(sql)
+    colorize = supports_color() and not plain and report is None
+    text = inv.to_text(colorize=colorize, non_zero_only=not full)
+    if report:
+        report.write_text(text + "\n", encoding="utf-8")
+        typer.echo(f"Report written to {report}")
+    else:
+        typer.echo(text)
+
+
+@app.command("analyze")
+def analyze_cmd(
+    input: Path = typer.Option(
+        ...,
+        "--input",
+        "-i",
+        help="Input .sql file (use - for stdin).",
+    ),
+    report: Optional[Path] = typer.Option(
+        None,
+        "--report",
+        "-r",
+        help="Write plain-text report to file (no ANSI colors).",
+    ),
+    plain: bool = typer.Option(
+        False,
+        "--plain",
+        help="Disable ANSI colors on terminal output.",
+    ),
+    full: bool = typer.Option(
+        False,
+        "--full",
+        help="Show all sections, including zero counts.",
+    ),
+) -> None:
+    """
+    Analyze a stored procedure and show what it does.
+
+    Summarizes DML against real tables, TRY/CATCH blocks, loops, SET statements,
+    and other structural detail — useful before generating a debug harness.
+    """
+    _run_analyze(input, report, plain, full)
+
+
+@app.command("inventory", hidden=True)
+def inventory_cmd(
+    input: Path = typer.Option(
+        ...,
+        "--input",
+        "-i",
+        help="Input .sql file (use - for stdin).",
+    ),
+    report: Optional[Path] = typer.Option(
+        None,
+        "--report",
+        "-r",
+        help="Write plain-text report to file (no ANSI colors).",
+    ),
+    plain: bool = typer.Option(
+        False,
+        "--plain",
+        help="Disable ANSI colors on terminal output.",
+    ),
+    full: bool = typer.Option(
+        False,
+        "--full",
+        help="Show all sections, including zero counts.",
+    ),
+) -> None:
+    """Deprecated alias for analyze."""
+    _run_analyze(input, report, plain, full)
+
+
+def _run_generate(
+    input: Path,
+    output: Optional[Path],
+    trace_style: str,
+    no_stub_dml: bool,
+    block_markers: bool,
+    quiet: bool,
+) -> None:
+    if trace_style not in ("raiserror", "print"):
+        typer.echo("trace-style must be 'raiserror' or 'print'", err=True)
+        raise typer.Exit(1)
+
+    sql = _read_input(input)
+    progress = None if quiet else lambda msg: typer.echo(msg, err=True)
+
+    result = transform_sql(
+        sql,
+        trace_style=trace_style,
+        stub_dml=not no_stub_dml,
+        add_block_markers=block_markers,
+        on_progress=progress,
+    )
+
+    out_path = output
+    if out_path is None and str(input) != "-":
+        out_path = input.with_name(f"{input.stem}_debug{input.suffix}")
+
+    _write_output(out_path, result.sql)
+
+    summary = (
+        f"Done: {result.stats.dml_stubbed} DML stubbed, "
+        f"{result.stats.traces_added} traces added."
+    )
+    if out_path and str(out_path) != "-":
+        typer.echo(f"{summary} Written to {out_path}")
+    else:
+        typer.echo(summary)
+
+    if result.parse_errors:
+        typer.echo("Parse warnings present — review banner in output.", err=True)
+        raise typer.Exit(2)
+
+
+@app.command("generate")
+def generate_cmd(
+    input: Path = typer.Option(
+        ...,
+        "--input",
+        "-i",
+        help="Input .sql file (use - for stdin).",
+    ),
+    output: Optional[Path] = typer.Option(
+        None,
+        "--output",
+        "-o",
+        help="Output path (default: <input>_debug.sql).",
+    ),
+    trace_style: str = typer.Option(
+        "print",
+        "--trace-style",
+        help="Trace style: print (default) or raiserror (NOWAIT).",
+    ),
+    no_stub_dml: bool = typer.Option(
+        False, "--no-stub-dml", help="Skip DML stubbing; only add traces."
+    ),
+    block_markers: bool = typer.Option(
+        False,
+        "--block-markers",
+        help="Insert -- [DBG] Step N markers before IF/WHILE.",
+    ),
+    quiet: bool = typer.Option(
+        False,
+        "--quiet",
+        "-q",
+        help="Suppress progress messages on stderr.",
+    ),
+) -> None:
+    """
+    Generate a debug harness script from a stored procedure.
+
+    Replaces writes to real tables with SELECT previews and adds PRINT traces on
+    variables so you can run the script on a dev database without side effects.
+    """
+    _run_generate(input, output, trace_style, no_stub_dml, block_markers, quiet)
+
+
+@app.command("transform", hidden=True)
+def transform_cmd(
+    input: Path = typer.Option(
+        ...,
+        "--input",
+        "-i",
+        help="Input .sql file (use - for stdin).",
+    ),
+    output: Optional[Path] = typer.Option(
+        None,
+        "--output",
+        "-o",
+        help="Output path (default: <input>_debug.sql).",
+    ),
+    trace_style: str = typer.Option(
+        "print",
+        "--trace-style",
+        help="Trace style: print (default) or raiserror (NOWAIT).",
+    ),
+    no_stub_dml: bool = typer.Option(
+        False, "--no-stub-dml", help="Skip DML stubbing; only add traces."
+    ),
+    block_markers: bool = typer.Option(
+        False,
+        "--block-markers",
+        help="Insert -- [DBG] Step N markers before IF/WHILE.",
+    ),
+    quiet: bool = typer.Option(
+        False,
+        "--quiet",
+        "-q",
+        help="Suppress progress messages on stderr.",
+    ),
+) -> None:
+    """Deprecated alias for generate."""
+    _run_generate(input, output, trace_style, no_stub_dml, block_markers, quiet)
+
+
+def main() -> None:
+    app()
+
+
+if __name__ == "__main__":
+    main()

sql_sp_harness-1.0.0/src/sql_sp_harness/console.py

@@ -0,0 +1,45 @@
+"""Terminal styling helpers for CLI output."""
+
+from __future__ import annotations
+
+import os
+import sys
+
+RESET = "\033[0m"
+GREEN = "\033[32m"
+RED = "\033[31m"
+YELLOW = "\033[33m"
+CYAN = "\033[36m"
+BOLD = "\033[1m"
+ITALIC = "\033[3m"
+DIM = "\033[2m"
+
+
+def supports_color() -> bool:
+    return sys.stdout.isatty() and os.environ.get("NO_COLOR") is None
+
+
+def style(text: str, color: str, *, enabled: bool = True) -> str:
+    if not enabled:
+        return text
+    return f"{color}{text}{RESET}"
+
+
+def success(text: str, *, enabled: bool = True) -> str:
+    return style(text, GREEN, enabled=enabled)
+
+
+def failure(text: str, *, enabled: bool = True) -> str:
+    return style(text, RED, enabled=enabled)
+
+
+def warning(text: str, *, enabled: bool = True) -> str:
+    return style(text, YELLOW, enabled=enabled)
+
+
+def heading(text: str, *, enabled: bool = True) -> str:
+    return style(text, CYAN + BOLD, enabled=enabled)
+
+
+def dim(text: str, *, enabled: bool = True) -> str:
+    return style(text, DIM, enabled=enabled)