bmsdna-devtools 0.44.0__tar.gz → 0.45.0__tar.gz

{bmsdna_devtools-0.44.0 → bmsdna_devtools-0.45.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: bmsdna-devtools
-Version: 0.44.0
+Version: 0.45.0
 Summary: Shared Azure DevOps / GitHub / git / Azure Monitor developer tooling for BMS projects
 Requires-Python: >=3.14
 Requires-Dist: azure-identity>=1.19.0
@@ -283,6 +283,16 @@ create prints a reminder to run `bdt pr status` afterward to check whether
 the CI build passes. This is a best-effort check — failures reading policy
 config (auth, permissions) fail open and simply skip the reminder.
 
+## `bdt pr comment`
+
+```bash
+bdt pr comment --message "Looks good" [--screenshot shot.png] [--file report.pdf] [--pr-id 123]
+bdt pr comment --message-file plan.md          # post a file's text as the comment (`-` = stdin)
+```
+
+`--file` links the file as an *attachment* (a download link in the comment); it does not post the file's
+content. To post a markdown document (an implementation plan, review findings) use `--message-file`.
+
 ## `bdt issue create` / `show` / `update` / `delete`, `bdt issue comment add` / `update` / `delete`
 
 ```bash
@@ -559,7 +569,9 @@ scan_jinja = ["backend/print"]         # "KEY" | tr in .jinja2/.j2/.html
 bdt worktree my-feature [--base dev] [--env-file .local_env] [--no-submodules] [--install "just install"]
 ```
 
-Creates `.worktrees/<name>` branched from `--base`, initializes submodules
+Creates `.worktrees/<name>` branched from `--base`. It first fetches `origin/<base>` and, if the local
+`<base>` is strictly behind it, branches from `origin/<base>` instead (so the PR starts on current code);
+a local base that is ahead of or has diverged from the remote is kept as is. Then it initializes submodules
 (unless `--no-submodules`), and copies an env file into the new worktree as
 `.env` (auto-detects `.local_env` then `.env` if `--env-file` isn't given).
 

{bmsdna_devtools-0.44.0 → bmsdna_devtools-0.45.0}/README.md

@@ -265,6 +265,16 @@ create prints a reminder to run `bdt pr status` afterward to check whether
 the CI build passes. This is a best-effort check — failures reading policy
 config (auth, permissions) fail open and simply skip the reminder.
 
+## `bdt pr comment`
+
+```bash
+bdt pr comment --message "Looks good" [--screenshot shot.png] [--file report.pdf] [--pr-id 123]
+bdt pr comment --message-file plan.md          # post a file's text as the comment (`-` = stdin)
+```
+
+`--file` links the file as an *attachment* (a download link in the comment); it does not post the file's
+content. To post a markdown document (an implementation plan, review findings) use `--message-file`.
+
 ## `bdt issue create` / `show` / `update` / `delete`, `bdt issue comment add` / `update` / `delete`
 
 ```bash
@@ -541,7 +551,9 @@ scan_jinja = ["backend/print"]         # "KEY" | tr in .jinja2/.j2/.html
 bdt worktree my-feature [--base dev] [--env-file .local_env] [--no-submodules] [--install "just install"]
 ```
 
-Creates `.worktrees/<name>` branched from `--base`, initializes submodules
+Creates `.worktrees/<name>` branched from `--base`. It first fetches `origin/<base>` and, if the local
+`<base>` is strictly behind it, branches from `origin/<base>` instead (so the PR starts on current code);
+a local base that is ahead of or has diverged from the remote is kept as is. Then it initializes submodules
 (unless `--no-submodules`), and copies an env file into the new worktree as
 `.env` (auto-detects `.local_env` then `.env` if `--env-file` isn't given).
 

{bmsdna_devtools-0.44.0 → bmsdna_devtools-0.45.0}/bmsdna/devtools/bdt_config.py

@@ -1,6 +1,8 @@
 """Shared lookup for `[tool.bdt.*]` configuration tables in the consuming
 repo's pyproject.toml (walks up from a start directory the same way `git`
-looks for `.git`, so it works from any subdirectory of the repo).
+looks for `.git`, so it works from any subdirectory of the repo). The walk stops at the
+repository root (the first directory holding a `.git` dir or file), so a submodule or nested
+repo never picks up the config of the repo that contains it.
 """
 
 from __future__ import annotations
@@ -15,6 +17,8 @@ def find_pyproject(start: Path | None = None) -> Path | None:
         candidate = directory / "pyproject.toml"
         if candidate.is_file():
             return candidate
+        if (directory / ".git").exists():
+            return None
     return None
 
 

{bmsdna_devtools-0.44.0 → bmsdna_devtools-0.45.0}/bmsdna/devtools/cli.py

@@ -629,11 +629,14 @@ def pr_update(
 @pr_app.command("comment")
 def pr_comment(
     message: str | None = typer.Option(None, "--message", help="Comment text"),
+    message_file: str | None = typer.Option(
+        None, "--message-file", help="Read the comment text from this file (`-` = stdin); unlike --file, the content is posted as the comment"
+    ),
     screenshot: list[str] = typer.Option(
         [], "--screenshot", help="Path to an image to embed in the comment (repeatable)"
     ),
     file: list[str] = typer.Option(
-        [], "--file", help="Path to an arbitrary file to link in the comment as an attachment (repeatable)"
+        [], "--file", help="Path to a file to link in the comment as an attachment (repeatable); to post a file's text as the comment use --message-file"
     ),
     target: str | None = typer.Option(None, "--target", help=_LOOKUP_TARGET_HELP),
     pr_id: int | None = typer.Option(None, "--pr-id", help=_PR_ID_HELP),
@@ -647,6 +650,13 @@ def pr_comment(
     """Post a comment on the PR opened from the current branch, or --pr-id directly
     (Azure DevOps or GitHub, auto-detected).
     """
+    if message_file is not None:
+        if message is not None:
+            raise typer.BadParameter("pass either --message or --message-file, not both", param_hint="--message-file")
+        try:
+            message = sys.stdin.read() if message_file == "-" else Path(message_file).read_text(encoding="utf-8")
+        except OSError as e:
+            raise typer.BadParameter(f"cannot read {message_file!r}: {e}", param_hint="--message-file") from e
     for path in screenshot:
         if not Path(path).is_file():
             raise typer.BadParameter(f"Screenshot not found: {path}", param_hint="--screenshot")
@@ -654,7 +664,7 @@ def pr_comment(
         if not Path(path).is_file():
             raise typer.BadParameter(f"File not found: {path}", param_hint="--file")
     if not message and not screenshot and not file:
-        raise typer.BadParameter("Provide at least one of --message, --screenshot, --file")
+        raise typer.BadParameter("Provide at least one of --message, --message-file, --screenshot, --file")
 
     remote = current_remote()
     if isinstance(remote, GitHubRemote):

{bmsdna_devtools-0.44.0 → bmsdna_devtools-0.45.0}/bmsdna/devtools/pr_build.py

@@ -561,13 +561,40 @@ def update(
 def link_work_item(session: requests.Session, remote: AdoRemote, pr_id: int, work_item_id: int) -> None:
     """Link work item `work_item_id` to PR `pr_id`, so it shows up in the PR's "Work Items" tab
     (and the work item's own "Development" links) -- the Azure DevOps equivalent of GitHub's
-    closing-keyword PR<->issue link, via the dedicated Pull Request Work Items REST resource
-    (POST .../pullRequests/{pr_id}/workitems/{work_item_id}, the same one `az repos pr work-item
-    add` itself calls). Idempotent -- linking an already-linked work item just re-confirms it.
+    closing-keyword PR<->issue link.
+
+    There is no REST resource that links "PR -> work item" directly; what `az repos pr work-item add`
+    does (and so do we) is add an `ArtifactLink` relation to the *work item*, pointing at the PR's
+    `vstfs:///Git/PullRequestId/{projectId}%2F{repoId}%2F{prId}` artifact URI. Idempotent -- an
+    already-linked work item is left alone (adding the relation twice would be rejected).
     """
-    r = session.post(
-        f"{_base_url(remote)}/_apis/git/repositories/{quote(remote.repo, safe='')}/pullRequests/{pr_id}/workitems/{work_item_id}",
+    r = session.get(
+        f"{_base_url(remote)}/_apis/git/repositories/{quote(remote.repo, safe='')}/pullrequests/{pr_id}",
+        params={"api-version": "7.1"},
+        timeout=HTTP_TIMEOUT_SECS,
+    )
+    r.raise_for_status()
+    repository = r.json()["repository"]
+    artifact_url = f"vstfs:///Git/PullRequestId/{repository['project']['id']}%2F{repository['id']}%2F{pr_id}"
+
+    work_item_url = f"{_base_url(remote)}/_apis/wit/workitems/{work_item_id}"
+    r = session.get(work_item_url, params={"$expand": "relations", "api-version": "7.1"}, timeout=HTTP_TIMEOUT_SECS)
+    r.raise_for_status()
+    existing = r.json().get("relations") or []
+    if any(rel.get("rel") == "ArtifactLink" and str(rel.get("url", "")).lower() == artifact_url.lower() for rel in existing):
+        return
+
+    r = session.patch(
+        work_item_url,
         params={"api-version": "7.1"},
+        json=[
+            {
+                "op": "add",
+                "path": "/relations/-",
+                "value": {"rel": "ArtifactLink", "url": artifact_url, "attributes": {"name": "Pull Request"}},
+            }
+        ],
+        headers={"Content-Type": "application/json-patch+json"},
         timeout=HTTP_TIMEOUT_SECS,
     )
     r.raise_for_status()

{bmsdna_devtools-0.44.0 → bmsdna_devtools-0.45.0}/bmsdna/devtools/worktree.py

@@ -59,6 +59,43 @@ def _run_capture(cmd: list[str], cwd: Path | None = None) -> subprocess.Complete
     return subprocess.run(cmd, cwd=cwd, capture_output=True, text=True, check=False)
 
 
+def _git_ok(args: list[str], cwd: Path, timeout: float = 5.0) -> bool:
+    try:
+        return subprocess.run(["git", *args], cwd=cwd, capture_output=True, check=False, timeout=timeout).returncode == 0
+    except (FileNotFoundError, subprocess.TimeoutExpired):
+        return False
+
+
+def _start_point(root: Path, base: str) -> tuple[str, bool]:
+    """Where a new worktree branch should start, and whether that is a remote-tracking ref.
+
+    `base` is usually a long-lived local branch (`dev`) that nobody keeps up to date, so a worktree
+    branched from it starts behind -- the PR then shows merge conflicts and the plan gets written
+    against stale code. Fetch `origin/<base>` first and start from it when the local branch is
+    strictly behind. A local branch that is ahead of / diverged from the remote is left alone (its
+    unpushed work is on purpose), as is everything when there is no `origin` or it can't be reached.
+    """
+    local = f"refs/heads/{base}"
+    remote = f"refs/remotes/origin/{base}"
+    has_local = _git_ok(["rev-parse", "--verify", "--quiet", local], root)
+    if not _git_ok(["remote", "get-url", "origin"], root):
+        return base, False
+    if not _git_ok(["fetch", "--quiet", "origin", f"+refs/heads/{base}:{remote}"], root, timeout=pull_mod.CLI_TIMEOUT_SECS):
+        if has_local:
+            print(f"warning: could not fetch origin/{base}; branching from the local {base}, which may be behind", file=sys.stderr)
+        return base, False
+    if not has_local:
+        return f"origin/{base}", True
+    if _git_ok(["merge-base", "--is-ancestor", remote, local], root):
+        return base, False  # up to date or ahead of the remote
+    if _git_ok(["merge-base", "--is-ancestor", local, remote], root):
+        behind = _run_capture(["git", "rev-list", "--count", f"{local}..{remote}"], cwd=root).stdout.strip()
+        print(f"{base} is {behind} commit(s) behind origin/{base}; branching from origin/{base}")
+        return f"origin/{base}", True
+    print(f"warning: local {base} and origin/{base} have diverged; branching from the local {base}", file=sys.stderr)
+    return base, False
+
+
 def create(
     name: str,
     base: str = "dev",
@@ -72,7 +109,9 @@ def create(
     if path.exists():
         sys.exit(f"error: {path} already exists")
 
-    _run(["git", "worktree", "add", str(path), "-b", name, base], cwd=root)
+    start, remote_start = _start_point(root, base)
+    # --no-track: the new branch must not push to / compare against origin/<base>
+    _run(["git", "worktree", "add", *(["--no-track"] if remote_start else []), str(path), "-b", name, start], cwd=root)
 
     if submodules and (root / ".gitmodules").exists():
         _run(["git", "submodule", "update", "--init"], cwd=path)

{bmsdna_devtools-0.44.0 → bmsdna_devtools-0.45.0}/pyproject.toml

@@ -10,7 +10,7 @@ packages = ["bmsdna"]
 
 [project]
 name = "bmsdna-devtools"
-version = "0.44.0"
+version = "0.45.0"
 description = "Shared Azure DevOps / GitHub / git / Azure Monitor developer tooling for BMS projects"
 readme = "README.md"
 requires-python = ">=3.14"  # pgdevkit>=0.7.1 requires 3.14; was >=3.11 before adding it as a dependency

{bmsdna_devtools-0.44.0 → bmsdna_devtools-0.45.0}/tests/test_bdt_config.py

@@ -29,3 +29,24 @@ def test_load_bdt_table_returns_empty_when_key_absent(tmp_path) -> None:
 def test_load_bdt_table_reads_configured_table(tmp_path) -> None:
     write_pyproject(tmp_path, "[tool.bdt.ado]\nboard = 'My Team'\n")
     assert load_bdt_table("ado", tmp_path) == {"board": "My Team"}
+
+
+def test_find_pyproject_stops_at_the_repo_root(tmp_path) -> None:
+    """A submodule (its `.git` is a file) is another repository: the parent repo's config must not apply."""
+    write_pyproject(tmp_path, "[tool.bdt.pr.required_labels]\ne2e_area = ['e2e-full']\n")
+    (tmp_path / ".git").mkdir()
+    sub = tmp_path / "database"
+    (sub / "src").mkdir(parents=True)
+    (sub / ".git").write_text("gitdir: ../.git/modules/database\n")
+
+    assert find_pyproject(sub / "src") is None
+    assert load_bdt_table("pr", sub / "src") == {}
+
+
+def test_find_pyproject_prefers_the_repo_roots_own_pyproject(tmp_path) -> None:
+    write_pyproject(tmp_path, "[project]\nname = 'x'\n")
+    (tmp_path / ".git").mkdir()
+    nested = tmp_path / "a" / "b"
+    nested.mkdir(parents=True)
+
+    assert find_pyproject(nested) == tmp_path / "pyproject.toml"

{bmsdna_devtools-0.44.0 → bmsdna_devtools-0.45.0}/tests/test_cli_pr_id.py

@@ -232,3 +232,52 @@ def test_pr_comment_with_pr_id_resolves_by_id_and_skips_branch_for_ado(monkeypat
 
     assert result.exit_code == 0, result.output
     assert captured == {"pr_id": 99, "message": "hi"}
+
+
+def test_pr_comment_message_file_posts_the_file_content(monkeypatch, tmp_path) -> None:
+    monkeypatch.setattr("bmsdna.devtools.cli.current_remote", lambda: GITHUB_REMOTE)
+    monkeypatch.setattr("bmsdna.devtools.cli.require_gh", lambda: "gh")
+    captured = {}
+    monkeypatch.setattr(
+        "bmsdna.devtools.cli.gh_pr.comment_with_screenshots",
+        lambda gh, owner, repo, branch, message, screenshot, file, pr_id=None: captured.update(message=message, file=file),
+    )
+    plan = tmp_path / "plan.md"
+    plan.write_text("# Plan\n\n- step 1\n", encoding="utf-8")
+
+    result = runner.invoke(app, ["pr", "comment", "--pr-id", "99", "--message-file", str(plan)])
+
+    assert result.exit_code == 0, result.output
+    assert captured == {"message": "# Plan\n\n- step 1\n", "file": []}
+
+
+def test_pr_comment_message_file_reads_stdin_for_dash(monkeypatch) -> None:
+    monkeypatch.setattr("bmsdna.devtools.cli.current_remote", lambda: GITHUB_REMOTE)
+    monkeypatch.setattr("bmsdna.devtools.cli.require_gh", lambda: "gh")
+    captured = {}
+    monkeypatch.setattr(
+        "bmsdna.devtools.cli.gh_pr.comment_with_screenshots",
+        lambda gh, owner, repo, branch, message, screenshot, file, pr_id=None: captured.update(message=message),
+    )
+
+    result = runner.invoke(app, ["pr", "comment", "--pr-id", "99", "--message-file", "-"], input="from stdin")
+
+    assert result.exit_code == 0, result.output
+    assert captured == {"message": "from stdin"}
+
+
+def test_pr_comment_message_and_message_file_are_exclusive(tmp_path) -> None:
+    plan = tmp_path / "plan.md"
+    plan.write_text("x", encoding="utf-8")
+
+    result = runner.invoke(app, ["pr", "comment", "--message", "hi", "--message-file", str(plan)])
+
+    assert result.exit_code != 0
+    assert "not both" in result.output
+
+
+def test_pr_comment_message_file_missing_is_a_usage_error(tmp_path) -> None:
+    result = runner.invoke(app, ["pr", "comment", "--message-file", str(tmp_path / "nope.md")])
+
+    assert result.exit_code == 2
+    assert "cannot read" in result.output

{bmsdna_devtools-0.44.0 → bmsdna_devtools-0.45.0}/tests/test_pr_build.py

@@ -418,24 +418,15 @@ def test_get_pr_by_id_exits_on_merge_conflict() -> None:
 # -- link_work_item -----------------------------------------------------------
 
 
-def test_link_work_item_posts_to_the_pr_work_items_endpoint() -> None:
-    remote = AdoRemote("myorg", "MyProj", "myrepo")
-    session = MagicMock()
-    session.post.return_value = MagicMock(status_code=200)
-
-    link_work_item(session, remote, pr_id=456, work_item_id=99)
-
-    url = session.post.call_args.args[0]
-    assert url == "https://dev.azure.com/myorg/MyProj/_apis/git/repositories/myrepo/pullRequests/456/workitems/99"
-    session.post.return_value.raise_for_status.assert_called_once()
-
-
 def test_link_work_item_raises_on_http_error() -> None:
     remote = AdoRemote("myorg", "MyProj", "myrepo")
     session = MagicMock()
+    session.get.return_value = MagicMock(
+        status_code=200, json=lambda: {"repository": {"id": "r", "project": {"id": "p"}}, "relations": []}
+    )
     response = MagicMock(status_code=404)
     response.raise_for_status.side_effect = requests.HTTPError("not found")
-    session.post.return_value = response
+    session.patch.return_value = response
 
     with pytest.raises(requests.HTTPError):
         link_work_item(session, remote, pr_id=456, work_item_id=99)

{bmsdna_devtools-0.44.0 → bmsdna_devtools-0.45.0}/tests/test_pr_build_flow.py

@@ -651,3 +651,49 @@ def test_run_wait_checks_build_policy_only_once(monkeypatch) -> None:
         run(REMOTE, "fake-pat", "main", wait=True, source_branch="feature-x")
 
     assert calls == ["main"]
+
+
+# --- link_work_item -------------------------------------------------------
+
+_PR_BODY = {"pullRequestId": 42, "repository": {"id": "repo-guid", "project": {"id": "proj-guid"}}}
+_ARTIFACT = "vstfs:///Git/PullRequestId/proj-guid%2Frepo-guid%2F42"
+
+
+def _link_session(relations: list[dict]) -> MagicMock:
+    session = MagicMock()
+
+    def fake_get(url, params=None, **kwargs):
+        if "/pullrequests/42" in url:
+            return FakeResponse(_PR_BODY)
+        if "/_apis/wit/workitems/7" in url:
+            return FakeResponse({"id": 7, "relations": relations})
+        raise AssertionError(f"unexpected GET {url}")
+
+    session.get.side_effect = fake_get
+    session.patch.return_value = FakeResponse({})
+    return session
+
+
+def test_link_work_item_adds_an_artifact_link_relation_on_the_work_item() -> None:
+    from bmsdna.devtools.pr_build import link_work_item
+
+    session = _link_session([{"rel": "AttachedFile", "url": "https://x/attachment"}])
+
+    link_work_item(session, AdoRemote(org="myorg", project="BMS - CCMT2", repo="BMS - CCMT2"), 42, 7)
+
+    (url,), kwargs = session.patch.call_args
+    assert url == "https://dev.azure.com/myorg/BMS%20-%20CCMT2/_apis/wit/workitems/7"
+    assert kwargs["headers"] == {"Content-Type": "application/json-patch+json"}
+    assert kwargs["json"] == [
+        {"op": "add", "path": "/relations/-", "value": {"rel": "ArtifactLink", "url": _ARTIFACT, "attributes": {"name": "Pull Request"}}}
+    ]
+
+
+def test_link_work_item_is_idempotent() -> None:
+    from bmsdna.devtools.pr_build import link_work_item
+
+    session = _link_session([{"rel": "ArtifactLink", "url": _ARTIFACT.upper().replace("VSTFS", "vstfs")}])
+
+    link_work_item(session, REMOTE, 42, 7)
+
+    session.patch.assert_not_called()

{bmsdna_devtools-0.44.0 → bmsdna_devtools-0.45.0}/tests/test_worktree_clean.py

@@ -108,6 +108,72 @@ def test_create_does_not_hint_no_default_when_base_is_main_but_remotes_real_defa
     assert "--no-default" not in out
 
 
+# --- create: starts from a fetched origin/<base> -------------------------
+
+
+def _clone_with_dev(tmp_path):
+    """A clone whose `origin` has a `dev` branch; returns (origin, clone)."""
+    origin = init_repo(tmp_path / "origin")
+    _git(["branch", "dev"], cwd=origin)
+    clone = tmp_path / "clone"
+    _git(["clone", "-q", str(origin), str(clone)], cwd=tmp_path)
+    _git(["config", "user.email", "test@example.com"], cwd=clone)
+    _git(["config", "user.name", "Test"], cwd=clone)
+    _git(["branch", "dev", "origin/dev"], cwd=clone)
+    return origin, clone
+
+
+def _commit(repo, branch, filename):
+    _git(["checkout", "-q", branch], cwd=repo)
+    (repo / filename).write_text(filename)
+    _git(["add", "."], cwd=repo)
+    _git(["commit", "-q", "-m", filename], cwd=repo)
+    _git(["checkout", "-q", "main"], cwd=repo)
+
+
+def test_create_branches_from_fetched_origin_when_local_base_is_behind(tmp_path, capsys) -> None:
+    origin, clone = _clone_with_dev(tmp_path)
+    _commit(origin, "dev", "new-on-origin.txt")
+
+    path = create("my-feature", base="dev", submodules=False, root=clone)
+
+    assert (path / "new-on-origin.txt").exists()
+    assert "1 commit(s) behind origin/dev" in capsys.readouterr().out
+    # not tracking origin/dev: a plain `git push` must not target the base branch
+    assert _git(["config", "--get", "branch.my-feature.remote"], cwd=clone, check=False).stdout.strip() == ""
+
+
+def test_create_keeps_local_base_when_it_is_ahead_of_origin(tmp_path) -> None:
+    _, clone = _clone_with_dev(tmp_path)
+    _commit(clone, "dev", "local-only.txt")
+
+    path = create("my-feature", base="dev", submodules=False, root=clone)
+
+    assert (path / "local-only.txt").exists()
+
+
+def test_create_warns_and_keeps_local_base_when_diverged(tmp_path, capsys) -> None:
+    origin, clone = _clone_with_dev(tmp_path)
+    _commit(origin, "dev", "on-origin.txt")
+    _commit(clone, "dev", "local-only.txt")
+
+    path = create("my-feature", base="dev", submodules=False, root=clone)
+
+    assert (path / "local-only.txt").exists()
+    assert not (path / "on-origin.txt").exists()
+    assert "diverged" in capsys.readouterr().err
+
+
+def test_create_uses_local_base_without_an_origin_remote(tmp_path, capsys) -> None:
+    repo = init_repo(tmp_path / "repo")
+    _git(["branch", "dev"], cwd=repo)
+
+    path = create("my-feature", base="dev", submodules=False, root=repo)
+
+    assert path.exists()
+    assert "warning" not in capsys.readouterr().err
+
+
 # --- find_repos -----------------------------------------------------------
 
 

{bmsdna_devtools-0.44.0 → bmsdna_devtools-0.45.0}/uv.lock

@@ -51,7 +51,7 @@ wheels = [
 
 [[package]]
 name = "bmsdna-devtools"
-version = "0.44.0"
+version = "0.45.0"
 source = { editable = "." }
 dependencies = [
     { name = "azure-identity" },