Merge pull request #7 from dPys/cli-from-anywhere

Cli from anywhere

nxbench/cli.py

@@ -1,9 +1,12 @@
+import json
 import logging
 import os
 import shutil
 import subprocess
 import sys
+import tempfile
 from collections.abc import Sequence
+from importlib import resources
 from pathlib import Path
 
 import click
@@ -19,23 +22,7 @@
 
 
 def validate_executable(path: str | Path) -> Path:
-    """Validate an executable path.
-
-    Parameters
-    ----------
-    path : str or Path
-        Path to executable to validate
-
-    Returns
-    -------
-    Path
-        Validated executable path
-
-    Raises
-    ------
-    ValueError
-        If path is not a valid executable
-    """
+    """Validate an executable path."""
     executable = Path(path).resolve()
     if not executable.exists():
         raise ValueError(f"Executable not found: {executable}")
@@ -50,32 +37,31 @@ def safe_run(
     capture_output: bool = False,
     **kwargs,
 ) -> subprocess.CompletedProcess:
-    """Safely run a subprocess command with optional output capture.
+    """
+    Safely run a subprocess command with optional output capture.
 
     Parameters
     ----------
-    cmd : sequence of str or Path
-        Command and arguments to run. First item must be path to executable.
+    cmd : Sequence[str | Path]
+        The command and arguments to execute.
     check : bool, default=True
-        Whether to check return code
+        If True, raise an exception if the command fails.
     capture_output : bool, default=False
-        Whether to capture stdout and stderr
+        If True, capture stdout and stderr.
     **kwargs : dict
-        Additional arguments to subprocess.run
+        Additional keyword arguments to pass to subprocess.run.
 
     Returns
     -------
     subprocess.CompletedProcess
-        Completed process info
+        The completed process.
 
     Raises
     ------
-    ValueError
-        If command is empty
     TypeError
-        If command contains invalid argument types
-    subprocess.SubprocessError
-        If command fails and check=True
+        If a command argument is not of type str or Path.
+    ValueError
+        If a command argument contains potentially unsafe characters.
     """
     if not cmd:
         raise ValueError("Empty command")
@@ -86,6 +72,8 @@ def safe_run(
     for arg in cmd[1:]:
         if not isinstance(arg, (str, Path)):
             raise TypeError(f"Command argument must be str or Path, got {type(arg)}")
+        if ";" in str(arg) or "&&" in str(arg) or "|" in str(arg):
+            raise ValueError(f"Potentially unsafe argument: {arg}")
         safe_cmd.append(str(arg))
 
     return subprocess.run(  # noqa: S603
@@ -109,6 +97,25 @@ def get_git_executable() -> Path | None:
         return None
 
 
+def get_git_hash(repo_path: Path) -> str:
+    """Get current git commit hash within the specified repository path."""
+    git_path = get_git_executable()
+    if git_path is None:
+        return "unknown"
+
+    try:
+        proc = subprocess.run(  # noqa: S603
+            [str(git_path), "rev-parse", "HEAD"],
+            cwd=str(repo_path),
+            capture_output=True,
+            text=True,
+            check=True,
+        )
+        return proc.stdout.strip()
+    except (subprocess.SubprocessError, ValueError):
+        return "unknown"
+
+
 def get_asv_executable() -> Path | None:
     """Get full path to asv executable."""
     asv_path = shutil.which("asv")
@@ -125,56 +132,123 @@ def get_python_executable() -> Path:
     return validate_executable(sys.executable)
 
 
-def get_git_hash() -> str:
-    """Get current git commit hash."""
-    git_path = get_git_executable()
-    if git_path is None:
-        return "unknown"
+def find_project_root() -> Path:
+    """Find the project root directory (one containing .git)."""
+    current = Path(__file__).resolve()
+    for parent in current.parents:
+        if (parent / ".git").exists():
+            return parent
+    return current.parent
 
-    try:
-        proc = safe_run([git_path, "rev-parse", "HEAD"], capture_output=True)
-        return proc.stdout.strip()
-    except (subprocess.SubprocessError, ValueError):
-        return "unknown"
 
+def ensure_asv_config_in_root():
+    """Ensure asv.conf.json is present at the project root as a symlink."""
+    project_root = find_project_root()
+    target = project_root / "asv.conf.json"
+    if not target.exists():
+        with resources.path("nxbench.configs", "asv.conf.json") as config_path:
+            target.symlink_to(config_path)
+    return project_root
 
-def run_asv_command(
-    args: Sequence[str], check: bool = True
-) -> subprocess.CompletedProcess:
-    """Run ASV command with security checks.
 
-    Parameters
-    ----------
-    args : sequence of str
-        Command arguments
-    check : bool, default=True
-        Whether to check return code
+def has_git(project_root):
+    return (project_root / ".git").exists()
 
-    Returns
-    -------
-    subprocess.CompletedProcess
-        Completed process info
 
-    Raises
-    ------
-    click.ClickException
-        If command fails
-    """
+def run_asv_command(
+    args: Sequence[str], check: bool = True, use_commit_hash: bool = True
+) -> subprocess.CompletedProcess:
+    """Run ASV command with dynamic asv.conf.json based on DVCS presence."""
     asv_path = get_asv_executable()
     if asv_path is None:
         raise click.ClickException("ASV executable not found")
 
-    safe_args = []
-    for arg in args:
-        if not isinstance(arg, str):
-            raise click.ClickException(f"Invalid argument type: {type(arg)}")
-        safe_args.append(arg)
+    project_root = find_project_root()
+    _has_git = has_git(project_root)
+    logger.debug(f"Project root: {project_root}")
+    logger.debug(f"Has .git: {_has_git}")
 
     try:
-        return safe_run([asv_path, *safe_args], check=check)
-    except (subprocess.SubprocessError, ValueError) as e:
+        with resources.open_text("nxbench.configs", "asv.conf.json") as f:
+            config_data = json.load(f)
+    except FileNotFoundError:
+        raise click.ClickException("asv.conf.json not found in package resources.")
+
+    if not _has_git:
+        logger.debug(
+            "No .git directory found. Modifying asv.conf.json for remote repo and "
+            "virtualenv."
+        )
+        config_data["repo"] = str(project_root.resolve())
+        config_data["environment_type"] = "virtualenv"
+    else:
+        logger.debug("Found .git directory. Using existing repository settings.")
+
+    try:
+        import nxbench
+
+        nxbench_path = Path(nxbench.__file__).resolve().parent
+        benchmark_dir = nxbench_path / "benchmarks"
+        if not benchmark_dir.exists():
+            logger.error(f"Benchmark directory not found: {benchmark_dir}")
+        config_data["benchmark_dir"] = str(benchmark_dir)
+        logger.debug(f"Set benchmark_dir to: {benchmark_dir}")
+    except ImportError:
+        raise click.ClickException("Failed to import nxbench. Ensure it is installed.")
+    except FileNotFoundError as e:
         raise click.ClickException(str(e))
 
+    config_data["pythons"] = [str(get_python_executable())]
+
+    with tempfile.TemporaryDirectory() as tmpdir:
+        temp_config_path = Path(tmpdir) / "asv.conf.json"
+        with temp_config_path.open("w") as f:
+            json.dump(config_data, f, indent=4)
+        logger.debug(f"Temporary asv.conf.json created at: {temp_config_path}")
+
+        safe_args = []
+        for arg in args:
+            if not isinstance(arg, str):
+                raise click.ClickException(f"Invalid argument type: {type(arg)}")
+            if ";" in arg or "&&" in arg or "|" in arg:
+                raise click.ClickException(f"Potentially unsafe argument: {arg}")
+            safe_args.append(arg)
+
+        if "--config" not in safe_args:
+            safe_args = ["--config", str(temp_config_path), *safe_args]
+            logger.debug(f"Added --config {temp_config_path} to ASV arguments.")
+
+        if use_commit_hash and _has_git:
+            try:
+                git_hash = get_git_hash(project_root)
+                if git_hash != "unknown":
+                    safe_args.append(f"--set-commit-hash={git_hash}")
+                    logger.debug(f"Set commit hash to: {git_hash}")
+            except subprocess.CalledProcessError:
+                logger.warning(
+                    "Could not determine git commit hash. Proceeding without it."
+                )
+
+        old_cwd = Path.cwd()
+        if _has_git:
+            os.chdir(project_root)
+            logger.debug(f"Changed working directory to project root: {project_root}")
+
+        try:
+            asv_command = [str(asv_path), *safe_args]
+            logger.debug(f"Executing ASV command: {' '.join(map(str, asv_command))}")
+            return safe_run(asv_command)
+        except subprocess.CalledProcessError:
+            logger.exception("ASV command failed.")
+            raise click.ClickException("ASV command failed.")
+        except (subprocess.SubprocessError, ValueError):
+            logger.exception("ASV subprocess error occurred.")
+            raise click.ClickException("ASV subprocess error occurred.")
+        finally:
+            if _has_git:
+                os.chdir(old_cwd)
+                logger.debug(f"Restored working directory to: {old_cwd}")
+
 
 @click.group()
 @click.option("-v", "--verbose", count=True, help="Increase verbosity.")
@@ -281,20 +355,19 @@ def benchmark(ctx):
     help="Backends to benchmark. Specify multiple values to run for multiple backends.",
 )
 @click.option("--collection", type=str, default="all", help="Graph collection to use.")
+@click.option(
+    "--use-commit-hash/--no-commit-hash",
+    default=False,
+    help="Whether to use git commit hash for benchmarking.",
+)
 @click.pass_context
-def run_benchmark(ctx, backend: tuple[str], collection: str):
+def run_benchmark(ctx, backend: tuple[str], collection: str, use_commit_hash: bool):
     """Run benchmarks."""
     config = ctx.obj.get("CONFIG")
     if config:
         logger.debug(f"Config file used for benchmark run: {config}")
 
-    try:
-        git_hash = get_git_hash()
-    except subprocess.CalledProcessError:
-        logger.exception("Failed to get git hash")
-        raise click.ClickException("Could not determine git commit hash")
-
-    cmd_args = ["run", "--quick", f"--set-commit-hash={git_hash}"]
+    cmd_args = ["run", "--quick"]
 
     if package_config.verbosity_level >= 1:
         cmd_args.append("--verbose")
@@ -313,7 +386,7 @@ def run_benchmark(ctx, backend: tuple[str], collection: str):
     cmd_args.append("--python=same")
 
     try:
-        run_asv_command(cmd_args)
+        run_asv_command(cmd_args, use_commit_hash=use_commit_hash)
     except subprocess.CalledProcessError:
         logger.exception("Benchmark run failed")
         raise click.ClickException("Benchmark run failed")
@@ -329,15 +402,7 @@ def run_benchmark(ctx, backend: tuple[str], collection: str):
 )
 @click.pass_context
 def export(ctx, result_file: Path, output_format: str):
-    """Export benchmark results.
-
-    Parameters
-    ----------
-    result_file : Path
-        Output file path for results
-    output_format : str
-        Format to export results in (json, csv, or sql)
-    """
+    """Export benchmark results."""
     config = ctx.obj.get("CONFIG")
     if config:
         logger.debug(f"Using config file for export: {config}")

nxbench/configs/asv.conf.json

@@ -4,19 +4,8 @@
     "timeout": 3000,
     "project_url": "https://github.com/dpys/nxbench",
     "repo": ".",
-    "branches": [
-        "main"
-    ],
-    "environment_type": "existing",
+    "environment_type": "virtualenv",
     "show_commit_url": "https://github.com/dpys/nxbench/commit/",
-    "pythons": [
-        "3.11"
-    ],
-    "req": [
-        "networkx==3.4.2",
-        "nx_parallel==0.3",
-        "graphblas_algorithms==2023.10.0"
-    ],
     "matrix": {},
     "benchmark_dir": "nxbench/benchmarks",
     "env_dir": "env",

nxbench/configs/example.yaml

@@ -219,3 +219,12 @@ matrix:
     - "1"
     - "4"
     - "8"
+
+asv_config:
+  repo: "https://github.com/dpys/nxbench.git"
+  branches:
+    - "main"
+  req:
+    - "networkx==3.4.2"
+    - "nx_parallel==0.3"
+    - "graphblas_algorithms==2023.10.0"

pyproject.toml

@@ -90,6 +90,10 @@ packages = [
     'nxbench.configs',
 ]
 
+[tool.setuptools.package-data]
+"nxbench.configs" = ["asv.conf.json", "example.yaml"]
+"nxbench.data" = ["network_directory.csv"]
+
 platforms = [
     'Linux',
     'Mac OSX',
@@ -100,9 +104,6 @@ platforms = [
 [tool.setuptools.dynamic]
 version = { attr = "nxbench._version.__version__" }
 
-[tool.setuptools.package-data]
-"nxbench.data" = ["network_directory.csv"]
-
 [tool.black]
 line-length = 88
 target-version = ["py310", "py311", "py312"]