From eb769ac03df2e5e5b257762a0f49bfc5e656d35f Mon Sep 17 00:00:00 2001
From: Zanie <contact@zanie.dev>
Date: Fri, 27 Oct 2023 12:40:42 -0500
Subject: [PATCH] Improve handling of ruff executable lookup

---
 python/ruff-ecosystem/README.md             | 11 +++--
 python/ruff-ecosystem/ruff_ecosystem/cli.py | 54 ++++++++++++++++++++-
 2 files changed, 58 insertions(+), 7 deletions(-)

diff --git a/python/ruff-ecosystem/README.md b/python/ruff-ecosystem/README.md
index fb3e10c089..abc6be7e57 100644
--- a/python/ruff-ecosystem/README.md
+++ b/python/ruff-ecosystem/README.md
@@ -16,18 +16,19 @@ pip install -e ./python/ruff-ecosystem
 ruff-ecosystem <check | format> <baseline executable> <comparison executable>
 ```
 
-Note executable paths must be absolute or relative to the current working directory.
+Note executable paths may be absolute, relative to the current working directory, or will be looked up in the
+current Python environment and PATH.
 
 Run `ruff check` ecosystem checks comparing your debug build to your system Ruff:
 
 ```shell
-ruff-ecosystem check "$(which ruff)" "./target/debug/ruff"
+ruff-ecosystem check ruff "./target/debug/ruff"
 ```
 
 Run `ruff format` ecosystem checks comparing your debug build to your system Ruff:
 
 ```shell
-ruff-ecosystem format "$(which ruff)" "./target/debug/ruff"
+ruff-ecosystem format ruff "./target/debug/ruff"
 ```
 
 ## Development
@@ -35,11 +36,11 @@ ruff-ecosystem format "$(which ruff)" "./target/debug/ruff"
 When developing, it can be useful to set the `--pdb` flag to drop into a debugger on failure:
 
 ```shell
-ruff-ecosystem check "$(which ruff)" "./target/debug/ruff" --pdb
+ruff-ecosystem check ruff "./target/debug/ruff" --pdb
 ```
 
 You can also provide a path to cache checkouts to speed up repeated runs:
 
 ```shell
-ruff-ecosystem check "$(which ruff)" "./target/debug/ruff" --cache ./repos
+ruff-ecosystem check ruff "./target/debug/ruff" --cache ./repos
 ```
diff --git a/python/ruff-ecosystem/ruff_ecosystem/cli.py b/python/ruff-ecosystem/ruff_ecosystem/cli.py
index a9dc20b008..911047f885 100644
--- a/python/ruff-ecosystem/ruff_ecosystem/cli.py
+++ b/python/ruff-ecosystem/ruff_ecosystem/cli.py
@@ -1,7 +1,10 @@
 import argparse
 import asyncio
 import logging
+import os
+import shutil
 import sys
+import sysconfig
 import tempfile
 from contextlib import nullcontext
 from pathlib import Path
@@ -10,6 +13,7 @@ from signal import SIGINT, SIGTERM
 from ruff_ecosystem.defaults import DEFAULT_TARGETS
 from ruff_ecosystem.main import OutputFormat, main
 from ruff_ecosystem.projects import RuffCommand
+from ruff_ecosystem import logger
 
 
 def excepthook(type, value, tb):
@@ -41,13 +45,41 @@ def entrypoint():
         tempfile.TemporaryDirectory() if not args.cache else nullcontext(args.cache)
     )
 
+    ruff_baseline = args.ruff_baseline
+    if not args.ruff_baseline.exists():
+        ruff_baseline = get_executable_path(str(args.ruff_baseline))
+        if not ruff_baseline:
+            print(
+                f"Could not find ruff baseline executable: {args.ruff_baseline}",
+                sys.stderr,
+            )
+            exit(1)
+        logger.info(
+            "Resolved baseline executable %s to %s", args.ruff_baseline, ruff_baseline
+        )
+
+    ruff_comparison = args.ruff_comparison
+    if not args.ruff_comparison.exists():
+        ruff_comparison = get_executable_path(str(args.ruff_comparison))
+        if not ruff_comparison:
+            print(
+                f"Could not find ruff comparison executable: {args.ruff_comparison}",
+                sys.stderr,
+            )
+            exit(1)
+        logger.info(
+            "Resolved comparison executable %s to %s",
+            args.ruff_comparison,
+            ruff_comparison,
+        )
+
     with cache_context as cache:
         loop = asyncio.get_event_loop()
         main_task = asyncio.ensure_future(
             main(
                 command=RuffCommand(args.ruff_command),
-                ruff_baseline_executable=args.ruff_baseline,
-                ruff_comparison_executable=args.ruff_comparison,
+                ruff_baseline_executable=ruff_baseline,
+                ruff_comparison_executable=ruff_comparison,
                 targets=DEFAULT_TARGETS,
                 format=OutputFormat(args.output_format),
                 project_dir=Path(cache),
@@ -114,3 +146,21 @@ def parse_args() -> argparse.Namespace:
     )
 
     return parser.parse_args()
+
+
+def get_executable_path(name: str) -> Path | None:
+    # Add suffix for Windows executables
+    name += ".exe" if sys.platform == "win32" and not name.endswith(".exe") else ""
+
+    path = os.path.join(sysconfig.get_path("scripts"), name)
+
+    # The executable in the current interpreter's scripts directory.
+    if os.path.exists(path):
+        return Path(path)
+
+    # The executable in the global environment.
+    environment_path = shutil.which(name)
+    if environment_path:
+        return Path(environment_path)
+
+    return None