test_conversion.py

from __future__ import annotations

import itertools
import subprocess
from pathlib import Path
import os
import sys

import pytest

from muutils.nbutils.convert_ipynb_to_script import process_dir, process_file
from muutils.nbutils.run_notebook_tests import run_notebook_tests

notebooks_input_dir: Path = Path("tests/input_data/notebooks")
notebooks_converted_input_dir: Path = Path("tests/input_data/notebooks_converted/")
nb_test_dir: Path = Path("tests/_temp/run_notebook_tests")
nb_conversion_dir: Path = Path("tests/_temp/test_file_conversion")


def test_run_notebook_tests():
    os.makedirs(nb_test_dir, exist_ok=True)
    print(os.listdir(notebooks_input_dir))
    print(os.listdir(notebooks_converted_input_dir))

    # convert the notebooks
    process_dir(
        input_dir=notebooks_input_dir,
        output_dir=nb_test_dir,
        disable_plots=True,
    )

    # run the notebooks
    run_notebook_tests(
        notebooks_dir=notebooks_input_dir,
        converted_notebooks_temp_dir=nb_test_dir,
        run_python_cmd_fmt="python",
    )

    # assert output directory contents are identical
    output_files: list = sorted(os.listdir(notebooks_converted_input_dir))
    assert sorted(os.listdir(nb_test_dir)) == output_files

    for fname in output_files:
        with open(os.path.join(notebooks_converted_input_dir, fname), "r") as f:
            expected = f.read()
        with open(os.path.join(nb_test_dir, fname), "r") as f:
            actual = f.read()
        assert expected == actual


@pytest.mark.parametrize(
    "idx, args",
    enumerate(
        itertools.product(
            [True, False],
            [r"#%%", "#" + "=" * 50],
            [True, False],
            ["%", ("!", "#"), ("import", "return")],
        )
    ),
)
def test_file_conversion(idx, args):
    os.makedirs(nb_conversion_dir, exist_ok=True)
    process_file(
        in_file=os.path.join(notebooks_input_dir, "dummy_notebook.ipynb"),
        out_file=os.path.join(nb_conversion_dir, f"dn-test-{idx}.py"),
        strip_md_cells=args[0],
        header_comment=args[1],
        disable_plots=args[2],
        filter_out_lines=args[3],
    )


def test_cli():
    """Test the CLI interface for run_notebook_tests"""
    # Setup
    nb_test_cli_dir: Path = Path("tests/_temp/run_notebook_tests_cli")
    os.makedirs(nb_test_cli_dir, exist_ok=True)

    # First convert notebooks to test with
    process_dir(
        input_dir=notebooks_input_dir,
        output_dir=nb_test_cli_dir,
        disable_plots=True,
    )

    # Test successful case using sys.executable to ensure we use the right Python
    process = subprocess.run(
        [
            sys.executable,
            "-m",
            "muutils.nbutils.run_notebook_tests",
            "--notebooks-dir",
            notebooks_input_dir,
            "--converted-notebooks-temp-dir",
            nb_test_cli_dir,
            "--run-python-cmd-fmt",
            "python",  # Override to just use python directly
        ],
        capture_output=True,
        text=True,
    )

    if process.returncode != 0:
        print("STDOUT:", process.stdout)
        print("STDERR:", process.stderr)
    assert process.returncode == 0

    # Test missing directory error
    process = subprocess.run(
        [
            sys.executable,
            "-m",
            "muutils.nbutils.run_notebook_tests",
            "--notebooks-dir",
            "nonexistent_dir",
            "--converted-notebooks-temp-dir",
            nb_test_cli_dir,
        ],
        capture_output=True,
        text=True,
    )
    assert process.returncode != 0
    assert "does not exist" in process.stderr

    # Test missing converted notebooks error
    os.makedirs("tests/_temp/empty_dir", exist_ok=True)
    process = subprocess.run(
        [
            sys.executable,
            "-m",
            "muutils.nbutils.run_notebook_tests",
            "--notebooks-dir",
            notebooks_input_dir,
            "--converted-notebooks-temp-dir",
            "tests/_temp/empty_dir",
        ],
        capture_output=True,
        text=True,
    )
    assert process.returncode != 0
    assert "Did not find converted notebook" in process.stderr