rrun-cli 0.2.3__tar.gz → 0.2.4__tar.gz

{rrun_cli-0.2.3/src/rrun_cli.egg-info → rrun_cli-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rrun-cli
-Version: 0.2.3
+Version: 0.2.4
 Summary: Run local scripts on remote machines over SSH via stdin pipes — no escaping/encoding hell. Supports python/powershell/bash, with a unified remote Python 3.12 venv provisioner.
 Author: waqiju
 License-Expression: MIT
@@ -134,7 +134,7 @@ Sources are merged by machine name, highest priority first (all optional, failur
 2. `$REMOTE_MACHINE_CONFIG` (legacy name, still honored)
 3. `./machines.json` (current working directory)
 4. `~/.rrun/machines.json`
-5. `~/.rrun/machines.d/*.json` (sorted by filename — point each inventory at its own file/symlink)
+5. `~/.rrun/machines.d/*.json` (sorted by filename — point each inventory at its own file/symlink; `rrun config init` creates this directory with a README inside)
 6. Legacy: `~/.remote-machine/machines.json` (POSIX) / `C:\tools\remote-machine\machines.json` (Windows)
 
 Per-file `defaults` sections (keyed by `os`, lowercased) are applied before merging. Inspect the chain with `rrun config`; list machines (redacted) with `rrun machines`.

{rrun_cli-0.2.3 → rrun_cli-0.2.4}/README.md

@@ -106,7 +106,7 @@ Sources are merged by machine name, highest priority first (all optional, failur
 2. `$REMOTE_MACHINE_CONFIG` (legacy name, still honored)
 3. `./machines.json` (current working directory)
 4. `~/.rrun/machines.json`
-5. `~/.rrun/machines.d/*.json` (sorted by filename — point each inventory at its own file/symlink)
+5. `~/.rrun/machines.d/*.json` (sorted by filename — point each inventory at its own file/symlink; `rrun config init` creates this directory with a README inside)
 6. Legacy: `~/.remote-machine/machines.json` (POSIX) / `C:\tools\remote-machine\machines.json` (Windows)
 
 Per-file `defaults` sections (keyed by `os`, lowercased) are applied before merging. Inspect the chain with `rrun config`; list machines (redacted) with `rrun machines`.

{rrun_cli-0.2.3 → rrun_cli-0.2.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rrun-cli"
-version = "0.2.3"
+version = "0.2.4"
 description = "Run local scripts on remote machines over SSH via stdin pipes — no escaping/encoding hell. Supports python/powershell/bash, with a unified remote Python 3.12 venv provisioner."
 readme = "README.md"
 license = "MIT"
@@ -45,7 +45,7 @@ package-dir = { "" = "src" }
 where = ["src"]
 
 [tool.setuptools.package-data]
-rrun = ["remote-requirements.txt", "machines.template.json"]
+rrun = ["remote-requirements.txt", "machines.template.json", "machines.d.README.md"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]

{rrun_cli-0.2.3 → rrun_cli-0.2.4}/src/rrun/__init__.py

@@ -11,7 +11,7 @@ try:
 
     __version__ = _pkg_version("rrun-cli")
 except Exception:  # noqa: BLE001 - 未安装（源码直跑）时回退
-    __version__ = "0.2.3"
+    __version__ = "0.2.4"
 
 from .doctor import DoctorResult, check_machine
 from .executor import (

{rrun_cli-0.2.3 → rrun_cli-0.2.4}/src/rrun/config_cmd.py

@@ -1,11 +1,12 @@
 """`rrun config` 子命令组：机器清单的初始化 / 追加 / 编辑 + 来源链诊断。
 
 设计要点：
-- init/add/edit 只操作「用户级主清单」（registry 来源链中的 user 位），路径从
-  candidate_sources() 派生而非写死 ~/.rrun，保证写入位置就是加载位置；
-  其他来源（env/cwd/machines.d/legacy）只读不动。
-- 模板内嵌为 package data（src/rrun/machines.template.json），离线可用、随发行版本
-  锁定；写盘即收紧权限（目录 700 / 文件 600，明文密码场景，Windows chmod 语义有限跳过）。
+- init/add/edit 只操作「用户级主清单」，路径取 registry.user_inventory_path()（单一
+  真相源）；不得在来源链上按 label 反查——cwd/env 来源与之同路径时去重会丢弃
+  user 条目。其他来源（env/cwd/machines.d/legacy）只读不动。
+- init 顺带创建 machines.d/ 并内置 README.md（.d 模式的可发现性传统：目录自带说明）。
+- 模板与 README 内嵌为 package data，离线可用、随发行版本锁定；写盘即收紧权限
+  （目录 700 / 文件 600，明文密码场景，Windows chmod 语义有限跳过）。
 - add 双模式：不给 --name/--ip → 交互向导（getpass 隐藏密码，旗帜值作预填默认）；
   给了 → 纯旗帜模式（可脚本化）；-i 强制向导。
 - edit 走 $VISUAL/$EDITOR（Windows 回退 notepad，POSIX 回退 vi），退出后校验 JSON；
@@ -24,13 +25,14 @@ from pathlib import Path
 from .registry import (
     EMPTY_INVENTORY_HINT,
     _load_file,
-    candidate_sources,
     load_machines,
     resolve_machine,
     scan_sources,
+    user_inventory_path,
 )
 
 TEMPLATE_FILE = Path(__file__).resolve().with_name("machines.template.json")
+MACHINES_D_README = Path(__file__).resolve().with_name("machines.d.README.md")
 
 _OS_ALIASES = {
     "w": "Windows", "windows": "Windows",
@@ -39,14 +41,6 @@ _OS_ALIASES = {
 }
 
 
-def user_inventory_path() -> Path:
-    """用户级主清单路径（从来源链派生，不写死 ~/.rrun）。"""
-    for label, p in candidate_sources():
-        if label == "user":
-            return p
-    raise RuntimeError("unreachable: candidate_sources() always includes the user source")  # pragma: no cover
-
-
 def _shorten(path: Path) -> str:
     """显示用：home 前缀折叠为 ~。"""
     s = str(path)
@@ -125,15 +119,30 @@ def _report_added(path: Path, name: str) -> None:
     print(f"[config] next: rrun doctor {name}   # connectivity + python check")
 
 
+def _ensure_machines_d() -> Path:
+    """创建 machines.d/ 并内置 README（幂等；README 已存在不覆盖——用户可能改过）。"""
+    d = user_inventory_path().parent / "machines.d"
+    d.mkdir(parents=True, exist_ok=True)
+    if os.name != "nt":
+        os.chmod(d, 0o700)
+    readme = d / "README.md"
+    if not readme.exists():
+        _write_secure(readme, MACHINES_D_README.read_text(encoding="utf-8"))
+    return d
+
+
 def cmd_config_init(ns) -> int:
-    """按内嵌模板创建用户级主清单；已存在时拒绝覆盖（--force 除外）。"""
+    """按内嵌模板创建用户级主清单 + machines.d/；已存在时拒绝覆盖（--force 除外）。"""
     path = user_inventory_path()
     if path.exists() and not ns.force:
         print(f"[config] {_shorten(path)} already exists (use --force to overwrite)", file=sys.stderr)
         return 1
     _write_secure(path, TEMPLATE_FILE.read_text(encoding="utf-8"))
+    d = _ensure_machines_d()
     perms = "" if os.name == "nt" else ", mode 600"
     print(f"[config] created {_shorten(path)} from the bundled template{perms}")
+    print(f"[config] machines.d ready at {_shorten(d)}/ — drop extra *.json inventories there"
+          " (see its README.md)")
     print("[config] next: replace the my-* example entries with your machines"
           " — 'rrun config edit' or 'rrun config add'")
     print("[config] then: rrun machines   # verify the inventory is picked up (redacted)")
@@ -257,7 +266,9 @@ def cmd_config_chain(ns) -> int:
     print("overridden by higher-priority sources):")
     raw_total = 0
     for i, info in enumerate(infos, 1):
-        if not info.exists:
+        if info.path.is_dir():
+            state = "dir exists, no *.json files"
+        elif not info.exists:
             state = "- missing"
         elif info.error:
             state = f"x read failed: {info.error}"

rrun_cli-0.2.4/src/rrun/machines.d.README.md

@@ -0,0 +1,16 @@
+# machines.d — additional machine inventories
+
+Drop extra inventories here as `*.json` files (same format as
+`~/.rrun/machines.json`). They are merged with the main inventory
+by machine name:
+
+- `~/.rrun/machines.json` wins on name conflicts (higher priority).
+- Among `machines.d` files, filename order decides
+  (`10-*.json` beats `90-*.json`).
+
+Symlinks are welcome — one inventory per file, e.g.:
+
+    ln -s ~/src/bot_home/config/machines.json ~/.rrun/machines.d/bot_home.json
+
+Only `*.json` files are read; this README is ignored.
+Full format: https://github.com/waqiju/rrun#configuration-machinesjson

{rrun_cli-0.2.3 → rrun_cli-0.2.4}/src/rrun/machines.template.json

@@ -4,6 +4,7 @@
     "mac": { "os": "Mac" },
     "linux": { "os": "Linux" }
   },
+  "_hint": "more inventories: drop *.json into ~/.rrun/machines.d/ (see its README.md); docs: https://github.com/waqiju/rrun",
   "machines": [
     {
       "name": "my-win-box",

{rrun_cli-0.2.3 → rrun_cli-0.2.4}/src/rrun/registry.py

@@ -76,6 +76,15 @@ class SourceInfo:
     error: str = ""
 
 
+def user_inventory_path() -> Path:
+    """用户级主清单路径（单一真相源：candidate_sources 的 user 条目、config init/add/edit 共用）。
+
+    注意：不要从 candidate_sources() 的结果里按 label 反查这个路径——当 cwd 恰好是
+    ~/.rrun 或 $RRUN_CONFIG 指向同一文件时，去重会丢弃 user 条目（v0.2.3 的教训）。
+    """
+    return Path.home() / ".rrun" / "machines.json"
+
+
 def candidate_sources() -> "list[tuple[str, Path]]":
     """返回 (标签, 路径) 有序来源链（高→低优先级），按 resolved path 去重。"""
     cands: list[tuple[str, Path]] = []
@@ -86,12 +95,14 @@ def candidate_sources() -> "list[tuple[str, Path]]":
             label = f"${env_name}" if i == 0 else f"${env_name}[{i}]"
             cands.append((label, Path(p).expanduser()))
     cands.append(("cwd", Path.cwd() / "machines.json"))
-    rrun_home = Path.home() / ".rrun"
-    cands.append(("user", rrun_home / "machines.json"))
-    machines_d = rrun_home / "machines.d"
+    cands.append(("user", user_inventory_path()))
+    machines_d = user_inventory_path().parent / "machines.d"
     if machines_d.is_dir():
-        for p in sorted(machines_d.glob("*.json")):
-            cands.append(("user.d", p))
+        files = sorted(machines_d.glob("*.json"))
+        if files:
+            cands.extend(("user.d", p) for p in files)
+        else:
+            cands.append(("user.d", machines_d))  # 空目录也入链：让诊断能看到它存在（merge 时 is_file 跳过）
     if os.name == "nt":
         cands.append(("legacy", Path(r"C:\tools\remote-machine\machines.json")))
     else:
@@ -150,7 +161,9 @@ def scan_sources() -> "list[SourceInfo]":
     infos = []
     for label, p in candidate_sources():
         info = SourceInfo(label=label, path=p)
-        if p.is_file():
+        if p.is_dir():
+            info.exists = True  # 目录型来源（空 machines.d）：无可读机器，仅示意存在
+        elif p.is_file():
             info.exists = True
             try:
                 info.machine_count = len(_load_file(p))

{rrun_cli-0.2.3 → rrun_cli-0.2.4/src/rrun_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rrun-cli
-Version: 0.2.3
+Version: 0.2.4
 Summary: Run local scripts on remote machines over SSH via stdin pipes — no escaping/encoding hell. Supports python/powershell/bash, with a unified remote Python 3.12 venv provisioner.
 Author: waqiju
 License-Expression: MIT
@@ -134,7 +134,7 @@ Sources are merged by machine name, highest priority first (all optional, failur
 2. `$REMOTE_MACHINE_CONFIG` (legacy name, still honored)
 3. `./machines.json` (current working directory)
 4. `~/.rrun/machines.json`
-5. `~/.rrun/machines.d/*.json` (sorted by filename — point each inventory at its own file/symlink)
+5. `~/.rrun/machines.d/*.json` (sorted by filename — point each inventory at its own file/symlink; `rrun config init` creates this directory with a README inside)
 6. Legacy: `~/.remote-machine/machines.json` (POSIX) / `C:\tools\remote-machine\machines.json` (Windows)
 
 Per-file `defaults` sections (keyed by `os`, lowercased) are applied before merging. Inspect the chain with `rrun config`; list machines (redacted) with `rrun machines`.

{rrun_cli-0.2.3 → rrun_cli-0.2.4}/src/rrun_cli.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ src/rrun/__main__.py
 src/rrun/config_cmd.py
 src/rrun/doctor.py
 src/rrun/executor.py
+src/rrun/machines.d.README.md
 src/rrun/machines.template.json
 src/rrun/registry.py
 src/rrun/remote-requirements.txt

{rrun_cli-0.2.3 → rrun_cli-0.2.4}/tests/test_config_cmd.py

@@ -245,3 +245,72 @@ class TestEmptyStateHints:
     def test_resolve_machine_hint(self, isolated):
         with pytest.raises(KeyError, match="rrun config init"):
             resolve_machine("nope")
+
+
+class TestInventoryPathCollision:
+    """v0.2.3 回归：cwd == ~/.rrun 或 $RRUN_CONFIG 指向用户清单时，来源链去重会丢弃
+    user 标签——user_inventory_path() 不得受此影响。"""
+
+    def test_cwd_inside_rrun_home(self, isolated, monkeypatch):
+        cmd_config_init(_ns(force=False))
+        monkeypatch.chdir(isolated / "home" / ".rrun")
+        assert cmd_config_add(_flag_ns(name="x", ip="1.1.1.1", user="u")) == 0
+        assert resolve_machine("x").ip == "1.1.1.1"
+        assert cmd_config_init(_ns(force=False)) == 1  # 仍能正确识别已存在
+
+    def test_env_points_at_user_file(self, isolated, monkeypatch):
+        cmd_config_init(_ns(force=False))
+        monkeypatch.setenv("RRUN_CONFIG", str(user_inventory_path()))
+        assert cmd_config_add(_flag_ns(name="x", ip="1.1.1.1", user="u")) == 0
+        assert resolve_machine("x").ip == "1.1.1.1"
+
+
+class TestMachinesD:
+    def test_init_creates_dir_and_readme(self, isolated):
+        cmd_config_init(_ns(force=False))
+        d = user_inventory_path().parent / "machines.d"
+        readme = d / "README.md"
+        assert readme.is_file() and "ln -s" in readme.read_text(encoding="utf-8")
+        if os.name != "nt":
+            assert stat.S_IMODE(d.stat().st_mode) == 0o700
+
+    def test_readme_not_treated_as_inventory(self, isolated):
+        cmd_config_init(_ns(force=False))
+        assert all("README" not in m.name for m in load_machines())
+
+    def test_ensure_machines_d_idempotent(self, isolated):
+        cmd_config_init(_ns(force=False))
+        readme = user_inventory_path().parent / "machines.d" / "README.md"
+        readme.write_text("user customized", encoding="utf-8")
+        cmd_config_init(_ns(force=True))
+        assert readme.read_text(encoding="utf-8") == "user customized"  # 不覆盖用户改动
+
+    def test_chain_shows_empty_dir(self, isolated, capsys):
+        cmd_config_init(_ns(force=False))
+        capsys.readouterr()
+        cmd_config_chain(_ns())
+        assert "no *.json files" in capsys.readouterr().out
+
+    def test_chain_lists_json_files_when_present(self, isolated, capsys):
+        cmd_config_init(_ns(force=False))
+        d = user_inventory_path().parent / "machines.d"
+        (d / "10-x.json").write_text(
+            json.dumps({"machines": [{"name": "deep", "ip": "1.1.1.1", "user": "u"}]}),
+            encoding="utf-8")
+        capsys.readouterr()
+        cmd_config_chain(_ns())
+        out = capsys.readouterr().out
+        assert "10-x.json" in out and "no *.json" not in out
+        assert "deep" in [m.name for m in load_machines()]
+
+
+class TestTemplateHint:
+    def test_hint_present_and_ignored_by_loader(self, isolated):
+        cmd_config_init(_ns(force=False))
+        assert "_hint" in _read_inventory()
+        assert load_machines()  # _hint 不影响加载
+
+    def test_hint_preserved_after_add(self, isolated):
+        cmd_config_init(_ns(force=False))
+        cmd_config_add(_flag_ns(name="z", ip="1.1.1.1", user="u"))
+        assert "_hint" in _read_inventory()