bmsdna-devtools 0.8.0__tar.gz → 0.9.0__tar.gz

{bmsdna_devtools-0.8.0 → bmsdna_devtools-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: bmsdna-devtools
-Version: 0.8.0
+Version: 0.9.0
 Summary: Shared Azure DevOps / GitHub / git / Azure Monitor developer tooling for BMS projects
 Requires-Python: >=3.11
 Requires-Dist: requests>=2.32.0

{bmsdna_devtools-0.8.0 → bmsdna_devtools-0.9.0}/bmsdna/devtools/ado_issue.py

@@ -157,6 +157,29 @@ def update_work_item(
     return r.json()
 
 
+def get_work_item_type(session: requests.Session, remote: AdoRemote, work_item_id: int) -> str:
+    r = session.get(
+        f"{_base_url(remote)}/_apis/wit/workitems/{work_item_id}",
+        params={"fields": "System.WorkItemType", "api-version": "7.1"},
+    )
+    if r.status_code == 404:
+        sys.exit(f"Work item #{work_item_id} not found in project '{remote.project}'.")
+    r.raise_for_status()
+    return r.json()["fields"]["System.WorkItemType"]
+
+
+def get_valid_states(session: requests.Session, remote: AdoRemote, work_item_type: str) -> list[str]:
+    """The state names defined for `work_item_type` by this project's process template —
+    state names (and which ones are terminal) are per-type, per-template, not a fixed set.
+    """
+    r = session.get(
+        f"{_base_url(remote)}/_apis/wit/workitemtypes/{quote(work_item_type, safe='')}/states",
+        params={"api-version": "7.1"},
+    )
+    r.raise_for_status()
+    return [s["name"] for s in r.json()["value"]]
+
+
 def delete_work_item(session: requests.Session, remote: AdoRemote, work_item_id: int) -> None:
     """Soft-delete: moves the work item to the project's Recycle Bin, where it can be restored.
 
@@ -327,7 +350,10 @@ def run_wiql(session: requests.Session, remote: AdoRemote, wiql: str, top: int)
 
 
 def get_work_items(session: requests.Session, remote: AdoRemote, ids: list[int]) -> list[dict]:
-    """Batch-fetch Title/State for a set of work item ids. WIQL only returns ids, not field values."""
+    """Batch-fetch Title/State for a set of work item ids, in the given `ids` order — WIQL only
+    returns ids (not field values), and this batch endpoint doesn't guarantee it echoes them back
+    in the order they were requested, so the caller's WIQL `ORDER BY` isn't preserved otherwise.
+    """
     if not ids:
         return []
     r = session.get(
@@ -335,7 +361,8 @@ def get_work_items(session: requests.Session, remote: AdoRemote, ids: list[int])
         params={"ids": ",".join(map(str, ids)), "fields": "System.Title,System.State", "api-version": "7.1"},
     )
     r.raise_for_status()
-    return r.json()["value"]
+    by_id = {item["id"]: item for item in r.json()["value"]}
+    return [by_id[i] for i in ids if i in by_id]
 
 
 def search(
@@ -398,13 +425,45 @@ def update(
     board: str | None = None,
     tags: list[str] | None = None,
     state: str | None = None,
-) -> dict:
+) -> dict | None:
     """Update a work item's fields. Unlike `create`, `board` is only resolved (and the Area Path only
     touched) when explicitly given — it never falls back to `[tool.bdt.ado].board`, so an unrelated
     field update (e.g. just `--title`) can't silently move the item to a different team's board.
+
+    If `state` isn't one of this work item's type's valid states (state names, and which ones are
+    terminal, are defined per work item type per process template — e.g. a Basic-process Issue has
+    'Done' but no 'Closed'), the state is left unchanged and a comment records the exact state that
+    was requested instead of the update failing or silently doing nothing.
     """
     area_path = get_team_area_path(session, remote, board) if board else None
-    work_item = update_work_item(session, remote, work_item_id, title, description, area_path, tags, state)
+    applied_state = state
+    if state is not None:
+        work_item_type = get_work_item_type(session, remote, work_item_id)
+        valid_states = get_valid_states(session, remote, work_item_type)
+        # Azure DevOps state values are case-sensitive, so a case-insensitive match ('closed' for
+        # a project whose actual state is 'Closed') must still PATCH the canonical casing, not the
+        # caller's — otherwise the update fails (or silently sets a technically-invalid value)
+        # despite the validation above having found a match.
+        canonical_state = next((s for s in valid_states if state.lower() == s.lower()), None)
+        if canonical_state is not None:
+            applied_state = canonical_state
+        else:
+            add_comment(
+                session,
+                remote,
+                work_item_id,
+                f"Requested state change to '{state}', which isn't a valid state for a "
+                f"'{work_item_type}' here (valid states: {', '.join(valid_states)}) — left unchanged.",
+            )
+            applied_state = None
+
+    if title is None and description is None and area_path is None and tags is None and applied_state is None:
+        if state is not None:
+            print(f"Work item #{work_item_id}: '{state}' isn't a valid state here — noted in a comment.")
+            return None
+        sys.exit("Nothing to update — provide at least one of --title, --description, --board, --tag, --state.")
+
+    work_item = update_work_item(session, remote, work_item_id, title, description, area_path, tags, applied_state)
     print(f"Updated work item #{work_item_id}")
     return work_item
 

{bmsdna_devtools-0.8.0 → bmsdna_devtools-0.9.0}/bmsdna/devtools/cli.py

@@ -378,7 +378,14 @@ def issue_update(
         r"this is only applied when explicitly given here — it does not fall back to \[tool.bdt.ado].board, "
         "so an unrelated field update can't silently move the item onto a different board.",
     ),
-    state: str | None = typer.Option(None, "--state", help="New work item state, e.g. Active, Resolved, Closed (Azure DevOps only)"),
+    state: str | None = typer.Option(
+        None,
+        "--state",
+        help="New state. Both backends understand 'Open', 'Closed'/'Done' (closes as completed), and "
+        "'Removed'/'Not Planned' (closes as not planned); other values (e.g. Active, Resolved) only "
+        "apply where that exact state name exists for the work item's type — elsewhere the state is "
+        "left unchanged and a comment records what was requested.",
+    ),
     tag: list[str] | None = typer.Option(None, "--tag", help="Replaces all tags (Azure DevOps only, repeatable); omit to leave unchanged"),
     label: list[str] | None = typer.Option(None, "--label", help="Label to add (GitHub only, repeatable)"),
     remove_label: list[str] | None = typer.Option(None, "--remove-label", help="Label to remove (GitHub only, repeatable)"),
@@ -392,7 +399,7 @@ def issue_update(
     """Update an issue / work item's fields (Azure DevOps or GitHub, auto-detected)."""
     remote = current_remote()
     if isinstance(remote, GitHubRemote):
-        gh_issue.update(require_gh(), number, title, description, label, remove_label)
+        gh_issue.update(require_gh(), number, title, description, label, remove_label, state)
     else:
         session = requests.Session()
         session.headers.update(auth_header(pat))

{bmsdna_devtools-0.8.0 → bmsdna_devtools-0.9.0}/bmsdna/devtools/gh_issue.py

@@ -111,6 +111,39 @@ def search(gh: str, keywords: list[str], since: str | None, limit: int, state: s
     return items
 
 
+_DONE_STATE_NAMES = ("closed", "done", "completed")
+_REMOVED_STATE_NAMES = ("removed", "not planned", "not_planned", "wontfix", "won't fix")
+_OPEN_STATE_NAMES = ("open", "reopened", "reopen")
+
+
+def _set_state(gh: str, number: int, state: str) -> None:
+    """GitHub issues only have two states (open/closed) plus, when closed, a `state_reason` of
+    'completed' or 'not planned' — no per-process-template state names like Azure DevOps. Map the
+    common terminal-state spellings onto that: 'Closed'/'Done'/'Completed' close as completed
+    (GitHub's "done" concept); 'Removed'/'Not Planned'/'Wontfix' close as not planned; 'Open'/
+    'Reopened' reopens. Anything else has no GitHub equivalent — leave the issue's state
+    unchanged and comment with the exact state that was requested, so it isn't silently dropped.
+    """
+    normalized = state.strip().lower()
+    if normalized in _DONE_STATE_NAMES:
+        _run_gh(gh, ["issue", "close", str(number), "--reason", "completed"])
+    elif normalized in _REMOVED_STATE_NAMES:
+        _run_gh(gh, ["issue", "close", str(number), "--reason", "not planned"])
+    elif normalized in _OPEN_STATE_NAMES:
+        _run_gh(gh, ["issue", "reopen", str(number)])
+    else:
+        _run_gh(
+            gh,
+            [
+                "issue",
+                "comment",
+                str(number),
+                "--body",
+                f"Requested state change to '{state}', which isn't a valid GitHub issue state — left unchanged.",
+            ],
+        )
+
+
 def update(
     gh: str,
     number: int,
@@ -118,6 +151,7 @@ def update(
     body: str | None = None,
     add_labels: list[str] | None = None,
     remove_labels: list[str] | None = None,
+    state: str | None = None,
 ) -> None:
     args = ["issue", "edit", str(number)]
     if title is not None:
@@ -128,10 +162,13 @@ def update(
         args += ["--add-label", label]
     for label in remove_labels or []:
         args += ["--remove-label", label]
-    if len(args) == 3:
-        sys.exit("Nothing to update — provide at least one of --title, --description, --label, --remove-label.")
+    if len(args) == 3 and state is None:
+        sys.exit("Nothing to update — provide at least one of --title, --description, --label, --remove-label, --state.")
 
-    _run_gh(gh, args)
+    if len(args) > 3:
+        _run_gh(gh, args)
+    if state is not None:
+        _set_state(gh, number, state)
     print(f"Updated issue #{number}")
 
 

{bmsdna_devtools-0.8.0 → bmsdna_devtools-0.9.0}/pyproject.toml

@@ -10,7 +10,7 @@ packages = ["bmsdna"]
 
 [project]
 name = "bmsdna-devtools"
-version = "0.8.0"
+version = "0.9.0"
 description = "Shared Azure DevOps / GitHub / git / Azure Monitor developer tooling for BMS projects"
 readme = "README.md"
 requires-python = ">=3.11"

{bmsdna_devtools-0.8.0 → bmsdna_devtools-0.9.0}/tests/test_ado_issue_flow.py

@@ -8,6 +8,8 @@ from __future__ import annotations
 
 from unittest.mock import MagicMock
 
+import pytest
+
 from bmsdna.devtools.ado_issue import (
     comment_with_screenshots,
     create,
@@ -212,6 +214,27 @@ def test_search_runs_wiql_then_batch_fetches_matched_fields() -> None:
     assert results == [{"id": 42, "fields": {"System.Title": "Auth timeout bug", "System.State": "Active"}}]
 
 
+def test_search_preserves_wiql_order_when_batch_fetch_returns_a_different_order() -> None:
+    # The batch "list work items by id" endpoint doesn't guarantee it echoes ids back in the
+    # order they were requested — WIQL's ORDER BY [System.ChangedDate] DESC must still win.
+    session = make_session(
+        get_map={
+            "/_apis/wit/workitems": {
+                "value": [
+                    {"id": 50, "fields": {"System.Title": "Oldest match", "System.State": "Active"}},
+                    {"id": 102, "fields": {"System.Title": "Newest match", "System.State": "Active"}},
+                    {"id": 99, "fields": {"System.Title": "Middle match", "System.State": "Active"}},
+                ]
+            }
+        },
+        wiql_ids=[102, 99, 50],
+    )
+
+    results = search(session, REMOTE, ["auth"])
+
+    assert [item["id"] for item in results] == [102, 99, 50]
+
+
 def test_search_skips_batch_fetch_when_no_matches() -> None:
     session = make_session(wiql_ids=[])
 
@@ -246,3 +269,70 @@ def test_search_without_board_does_not_look_up_area_path() -> None:
     search(session, REMOTE, ["auth"])
 
     session.get.assert_not_called()  # no --board given, so no team field values lookup at all
+
+
+def test_update_with_valid_state_includes_it_in_the_patch() -> None:
+    session = make_session(
+        get_map={
+            "/_apis/wit/workitems/42": {"fields": {"System.WorkItemType": "Bug"}},
+            "/_apis/wit/workitemtypes/Bug/states": {"value": [{"name": "New"}, {"name": "Active"}, {"name": "Closed"}]},
+        }
+    )
+
+    update(session, REMOTE, 42, state="Closed")
+
+    ops = session.patch.call_args.kwargs["json"]
+    assert {"op": "add", "path": "/fields/System.State", "value": "Closed"} in ops
+
+
+def test_update_state_uses_canonical_casing_from_valid_states() -> None:
+    session = make_session(
+        get_map={
+            "/_apis/wit/workitems/42": {"fields": {"System.WorkItemType": "Bug"}},
+            "/_apis/wit/workitemtypes/Bug/states": {"value": [{"name": "New"}, {"name": "Closed"}]},
+        }
+    )
+
+    update(session, REMOTE, 42, state="closed")  # lowercase — doesn't match ADO's 'Closed' exactly
+
+    ops = session.patch.call_args.kwargs["json"]
+    assert {"op": "add", "path": "/fields/System.State", "value": "Closed"} in ops
+
+
+def test_update_with_invalid_state_comments_instead_of_failing() -> None:
+    session = make_session(
+        get_map={
+            "/_apis/wit/workitems/42": {"fields": {"System.WorkItemType": "Bug"}},
+            "/_apis/wit/workitemtypes/Bug/states": {"value": [{"name": "New"}, {"name": "Active"}, {"name": "Closed"}]},
+        }
+    )
+
+    result = update(session, REMOTE, 42, state="Done")
+
+    assert result is None
+    session.patch.assert_not_called()
+    comment_url, comment_kwargs = session.post.call_args.args[0], session.post.call_args.kwargs
+    assert comment_url == "https://dev.azure.com/myorg/MyProj/_apis/wit/workItems/42/comments"
+    assert "'Done'" in comment_kwargs["json"]["text"]
+    assert "Bug" in comment_kwargs["json"]["text"]
+
+
+def test_update_with_invalid_state_still_patches_other_given_fields() -> None:
+    session = make_session(
+        get_map={
+            "/_apis/wit/workitems/42": {"fields": {"System.WorkItemType": "Bug"}},
+            "/_apis/wit/workitemtypes/Bug/states": {"value": [{"name": "New"}]},
+        }
+    )
+
+    update(session, REMOTE, 42, title="New title", state="Done")
+
+    ops = session.patch.call_args.kwargs["json"]
+    assert ops == [{"op": "add", "path": "/fields/System.Title", "value": "New title"}]
+
+
+def test_update_with_nothing_given_still_errors() -> None:
+    session = make_session()
+
+    with pytest.raises(SystemExit):
+        update(session, REMOTE, 42)

{bmsdna_devtools-0.8.0 → bmsdna_devtools-0.9.0}/tests/test_gh_issue.py

@@ -2,7 +2,7 @@ from unittest.mock import MagicMock
 
 import pytest
 
-from bmsdna.devtools.gh_issue import build_search_query, parse_comment_id, parse_issue_number, search
+from bmsdna.devtools.gh_issue import build_search_query, parse_comment_id, parse_issue_number, search, update
 
 
 @pytest.mark.parametrize(
@@ -70,3 +70,43 @@ def test_search_passes_through_requested_state(monkeypatch) -> None:
     search("gh", ["auth"], None, 10, state="all")
 
     assert captured_cmd[captured_cmd.index("--state") + 1] == "all"
+
+
+def _run_update_capturing_commands(monkeypatch, **update_kwargs) -> list[list[str]]:
+    captured_cmds: list[list[str]] = []
+
+    def fake_run(cmd, **kwargs):
+        captured_cmds.append(cmd)
+        return MagicMock(returncode=0, stdout="", stderr="")
+
+    monkeypatch.setattr("bmsdna.devtools.gh_issue.subprocess.run", fake_run)
+    update("gh", 42, **update_kwargs)
+    return captured_cmds
+
+
+@pytest.mark.parametrize("state", ["Closed", "Done", "completed"])
+def test_update_closes_as_completed_for_done_states(monkeypatch, state: str) -> None:
+    cmds = _run_update_capturing_commands(monkeypatch, state=state)
+    assert cmds == [["gh", "issue", "close", "42", "--reason", "completed"]]
+
+
+@pytest.mark.parametrize("state", ["Removed", "Not Planned", "wontfix"])
+def test_update_closes_as_not_planned_for_removed_states(monkeypatch, state: str) -> None:
+    cmds = _run_update_capturing_commands(monkeypatch, state=state)
+    assert cmds == [["gh", "issue", "close", "42", "--reason", "not planned"]]
+
+
+def test_update_reopens_for_open_state(monkeypatch) -> None:
+    cmds = _run_update_capturing_commands(monkeypatch, state="Open")
+    assert cmds == [["gh", "issue", "reopen", "42"]]
+
+
+def test_update_comments_exact_state_when_unsupported(monkeypatch) -> None:
+    cmds = _run_update_capturing_commands(monkeypatch, state="Active")
+    assert cmds == [["gh", "issue", "comment", "42", "--body", "Requested state change to 'Active', which isn't a valid GitHub issue state — left unchanged."]]
+
+
+def test_update_errors_with_nothing_to_do(monkeypatch) -> None:
+    monkeypatch.setattr("bmsdna.devtools.gh_issue.subprocess.run", MagicMock())
+    with pytest.raises(SystemExit):
+        update("gh", 42)

{bmsdna_devtools-0.8.0 → bmsdna_devtools-0.9.0}/uv.lock

@@ -13,7 +13,7 @@ wheels = [
 
 [[package]]
 name = "bmsdna-devtools"
-version = "0.8.0"
+version = "0.9.0"
 source = { editable = "." }
 dependencies = [
     { name = "requests" },