Source code for ramble.test.end_to_end.shell_wrappers

# Copyright 2022-2026 The Ramble Authors
#
# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
# https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
# <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
# option. This file may not be copied, modified, or distributed
# except according to those terms.

import os
import shutil
import subprocess

import pytest

from ramble import paths

pytestmark = pytest.mark.maybeslow

# TODO: add tests for other supported shells
_SHELLS_TO_TEST = ["bash", "fish", "tcsh"]

_SETUP_ENV_FILE = {
    "bash": "setup-env.sh",
    "fish": "setup-env.fish",
    "tcsh": "setup-env.csh",
}




@pytest.mark.parametrize("shell", _SHELLS_TO_TEST)
def test_shell_wrapper_workspace_activate_missing(shell, tmpdir):
    """Test activation of missing workspace fails with proper exit code."""
    if not shutil.which(shell):
        pytest.skip(f"{shell} not found")

    setup_env = os.path.join(paths.ramble_root, "share", "ramble", _SETUP_ENV_FILE[shell])
    test_script_path = str(tmpdir.join("test_missing.sh"))

    with open(test_script_path, "w") as f:
        f.write(
            f"""
source "{setup_env}"
ramble workspace activate non_existent_workspace
"""
        )

    cmd = [shell, test_script_path]
    process = subprocess.run(
        cmd, capture_output=True, text=True, cwd=str(tmpdir), env=os.environ.copy()
    )

    assert process.returncode == 1





@pytest.mark.parametrize("shell", _SHELLS_TO_TEST)
def test_shell_wrapper_workspace_lifecycle(shell, tmpdir):
    """Test workspace creation, activation and deactivation."""
    if not shutil.which(shell):
        pytest.skip(f"{shell} not found")

    setup_env = os.path.join(paths.ramble_root, "share", "ramble", _SETUP_ENV_FILE[shell])
    test_script_path = str(tmpdir.join(f"test_lifecycle.{shell}"))
    ws_name = f"test_ws_lifecycle_{shell}"

    script_templates = {
        "bash": f"""
source "{setup_env}"
ramble workspace create {ws_name} || exit 1
ramble workspace activate {ws_name} || exit 2
ramble workspace deactivate || exit 3
ramble workspace create -a {ws_name} && exit 4
exit 0
""",
        "tcsh": f"""
# The set prompt is needed as tcsh doesn't tolerate undefined variables.
set prompt=""
source "{setup_env}"
ramble workspace create {ws_name}
if ( $status != 0 ) exit 1
ramble workspace activate {ws_name}
if ( $status != 0 ) exit 2
ramble workspace deactivate
if ( $status != 0 ) exit 3
ramble workspace create -a {ws_name}
if ( $status == 0 ) exit 4
exit 0
""",
        "fish": f"""
source "{setup_env}"
ramble workspace create {ws_name}; or exit 1
ramble workspace activate {ws_name}; or exit 2
ramble workspace deactivate; or exit 3
ramble workspace create -a {ws_name}; and exit 4
exit 0
""",
    }
    script_content = script_templates[shell]

    with open(test_script_path, "w") as f:
        f.write(script_content)

    try:
        cmd = [shell, test_script_path]
        process = subprocess.run(
            cmd, capture_output=True, text=True, cwd=str(tmpdir), env=os.environ.copy()
        )
        if process.returncode != 0:
            print(process.stdout)
            print(process.stderr)
        assert process.returncode == 0
    finally:
        ramble_exe = os.path.join(paths.ramble_root, "bin", "ramble")
        subprocess.run(
            [ramble_exe, "workspace", "rm", "-y", ws_name],
            capture_output=True,
            text=True,
        )