Merge pull request #1099 from jlarkin09/feat/add-output-dir-cli-option

feat(cli): add option for a single output-dir and hide options

Author: mergify[bot]

src/fromager/__main__.py

@@ -67,19 +67,28 @@
     type=clickext.ClickPath(),
     help="save error messages to a file",
 )
+@click.option(
+    "-O",
+    "--output-dir",
+    default=pathlib.Path("."),
+    type=clickext.ClickPath(),
+    help="base directory for sdists-repo, wheels-repo, and work-dir (default: current directory)",
+)
 @click.option(
     "-o",
     "--sdists-repo",
-    default=pathlib.Path("sdists-repo"),
+    default=None,
     type=clickext.ClickPath(),
-    help="location to manage source distributions",
+    hidden=True,
+    help="location to manage source distributions (overrides --output-dir)",
 )
 @click.option(
     "-w",
     "--wheels-repo",
-    default=pathlib.Path("wheels-repo"),
+    default=None,
     type=clickext.ClickPath(),
-    help="location to manage wheel repository",
+    hidden=True,
+    help="location to manage wheel repository (overrides --output-dir)",
 )
 @click.option(
     "--build-wheel-server-url",
@@ -88,9 +97,10 @@
 @click.option(
     "-t",
     "--work-dir",
-    default=pathlib.Path("work-dir"),
+    default=None,
     type=clickext.ClickPath(),
-    help="location to manage working files, including builds and logs",
+    hidden=True,
+    help="location to manage working files, including builds and logs (overrides --output-dir)",
 )
 @click.option(
     "-p",
@@ -159,10 +169,11 @@ def main(
     log_file: pathlib.Path,
     log_format: str,
     error_log_file: pathlib.Path,
-    sdists_repo: pathlib.Path,
-    wheels_repo: pathlib.Path,
+    output_dir: pathlib.Path,
+    sdists_repo: pathlib.Path | None,
+    wheels_repo: pathlib.Path | None,
     build_wheel_server_url: str,
-    work_dir: pathlib.Path,
+    work_dir: pathlib.Path | None,
     patches_dir: pathlib.Path,
     settings_file: pathlib.Path,
     settings_dir: pathlib.Path,
@@ -177,6 +188,15 @@ def main(
     global _DEBUG
     _DEBUG = debug
 
+    # Resolve output directories: explicit per-directory flags take
+    # precedence, otherwise derive from --output-dir.
+    if not sdists_repo:
+        sdists_repo = output_dir / "sdists-repo"
+    if not wheels_repo:
+        wheels_repo = output_dir / "wheels-repo"
+    if not work_dir:
+        work_dir = output_dir / "work-dir"
+
     # Set custom log factory to prepend requirement name.
     logging.setLogRecordFactory(log.FromagerLogRecord)
     # Set the overall logger level to debug and allow the handlers to filter

tests/test_cli.py

@@ -42,6 +42,60 @@ def test_fromager_version(cli_runner: CliRunner) -> None:
     assert result.stdout.startswith("fromager, version")
 
 
+def test_output_dir_hidden_options(cli_runner: CliRunner) -> None:
+    """--output-dir is visible in help; old per-directory flags are hidden."""
+    result = cli_runner.invoke(fromager, ["--help"])
+    assert "-O, --output-dir" in result.output
+    lines = result.output.splitlines()
+    option_lines = [line.strip() for line in lines if line.strip().startswith("-")]
+    option_names = " ".join(option_lines)
+    assert "--sdists-repo" not in option_names
+    assert "--wheels-repo" not in option_names
+    assert "--work-dir" not in option_names
+
+
+def test_output_dir_sets_subdirectories(
+    tmp_path: pathlib.Path, cli_runner: CliRunner
+) -> None:
+    """Passing -O <dir> creates sdists-repo, wheels-repo, work-dir under it."""
+    out = tmp_path / "my-output"
+    out.mkdir()
+
+    result = cli_runner.invoke(
+        fromager,
+        ["-O", str(out), "canonicalize", "some-package"],
+    )
+    assert result.exit_code == 0, result.output
+    assert (out / "sdists-repo").is_dir()
+    assert (out / "wheels-repo").is_dir()
+    assert (out / "work-dir").is_dir()
+
+
+def test_output_dir_overridden_by_explicit_flags(
+    tmp_path: pathlib.Path, cli_runner: CliRunner
+) -> None:
+    """Explicit --sdists-repo takes precedence over --output-dir."""
+    out = tmp_path / "base"
+    out.mkdir()
+
+    result = cli_runner.invoke(
+        fromager,
+        [
+            "-O",
+            str(out),
+            "--sdists-repo",
+            str(tmp_path / "custom-sdists"),
+            "canonicalize",
+            "some-package",
+        ],
+    )
+    assert result.exit_code == 0, result.output
+    assert (tmp_path / "custom-sdists").is_dir()
+    assert (out / "wheels-repo").is_dir()
+    assert (out / "work-dir").is_dir()
+    assert not (out / "sdists-repo").exists()
+
+
 KNOWN_COMMANDS: set[str] = {
     "bootstrap",
     "bootstrap-parallel",