Skip to content

fix(incident): read/write lifecycle via SDK 'state', not nonexistent 'status' #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
srgfrancisco merged 1 commit into from
May 12, 2026
Merged

fix(incident): read/write lifecycle via SDK 'state', not nonexistent 'status' #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions ddogctl/commands/incident.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ def list_incidents(format):
"id": inc.id,
"title": getattr(attrs, "title", ""),
"severity": getattr(attrs, "severity", ""),
"status": getattr(attrs, "status", ""),
"status": getattr(attrs, "state", ""),
"created": str(getattr(attrs, "created", "")),
"modified": str(getattr(attrs, "modified", "")),
}
Expand All @@ -59,7 +59,7 @@ def list_incidents(format):

for inc in incidents:
attrs = inc.attributes
status_str = str(getattr(attrs, "status", ""))
status_str = str(getattr(attrs, "state", ""))
severity_str = str(getattr(attrs, "severity", ""))
status_color = {
"active": "red",
Expand Down Expand Up @@ -100,7 +100,7 @@ def get_incident(incident_id, format):
"id": inc.id,
"title": getattr(attrs, "title", ""),
"severity": getattr(attrs, "severity", ""),
"status": getattr(attrs, "status", ""),
"status": getattr(attrs, "state", ""),
"created": str(getattr(attrs, "created", "")),
"modified": str(getattr(attrs, "modified", "")),
}
Expand All @@ -112,7 +112,7 @@ def get_incident(incident_id, format):
severity_str = str(getattr(attrs, "severity", ""))
console.print(f"[bold]Severity:[/bold] [yellow]{severity_str}[/yellow]")

status_str = str(getattr(attrs, "status", ""))
status_str = str(getattr(attrs, "state", ""))
status_color = {
"active": "red",
"stable": "yellow",
Expand Down Expand Up @@ -166,7 +166,7 @@ def create_incident(title, severity, format):
"id": inc.id,
"title": getattr(attrs, "title", ""),
"severity": severity,
"status": getattr(attrs, "status", ""),
"status": getattr(attrs, "state", ""),
}
print(json.dumps(output, indent=2))
else:
Expand Down Expand Up @@ -200,12 +200,12 @@ def update_incident(incident_id, title, status, severity, format):
attrs_kwargs = {}
if title is not None:
attrs_kwargs["title"] = title
if status is not None:
attrs_kwargs["status"] = status

fields = {}
if severity is not None:
fields["severity"] = {"type": "dropdown", "value": severity}
if status is not None:
fields["state"] = {"type": "dropdown", "value": status}
if fields:
attrs_kwargs["fields"] = fields

Expand All @@ -227,7 +227,7 @@ def update_incident(incident_id, title, status, severity, format):
output = {
"id": inc.id,
"title": getattr(attrs, "title", ""),
"status": getattr(attrs, "status", ""),
"status": getattr(attrs, "state", ""),
}
print(json.dumps(output, indent=2))
else:
Expand Down
51 changes: 49 additions & 2 deletions tests/commands/test_incident.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,20 @@
def _make_incident(
id, title, severity, status, created="2026-01-15T10:00:00Z", modified="2026-01-15T12:00:00Z"
):
"""Create a mock incident object."""
"""Create a mock incident object.

The Datadog v2 SDK exposes the incident lifecycle as ``state`` on
``IncidentResponseAttributes`` — not ``status`` — so the mock uses
``spec_set`` to reject the old attribute name and keep tests honest.
"""
inc = Mock()
inc.id = id
inc.type = "incidents"
inc.attributes = Mock(
spec_set=["title", "severity", "state", "created", "modified", "fields"],
title=title,
severity=severity,
status=status,
state=status,
created=created,
modified=modified,
fields={},
Expand Down Expand Up @@ -194,6 +200,47 @@ def test_update_incident_no_fields(self, runner):
assert result.exit_code != 0
assert "No update fields" in result.output

def test_update_incident_status_sent_as_fields_state(self, mock_client, runner):
"""--status must be sent via fields["state"], not as a top-level attribute.

Regression test: the Datadog v2 SDK's ``IncidentUpdateAttributes`` has
no ``status`` (or ``state``) attribute — state changes flow through
the ``fields`` dict. Putting ``status`` on the attributes object
silently no-ops the lifecycle update.
"""
inc = _make_incident("inc-1", "Service outage", "SEV-1", "resolved")
response = Mock(data=inc)
mock_client.incidents.update_incident.return_value = response

with patch("ddogctl.commands.incident.get_datadog_client", return_value=mock_client):
result = runner.invoke(incident, ["update", "inc-1", "--status", "resolved"])

assert result.exit_code == 0, f"Command failed: {result.output}"
mock_client.incidents.update_incident.assert_called_once()
body = mock_client.incidents.update_incident.call_args.kwargs["body"]
attrs = body.data.attributes
state_field = attrs.fields["state"]
assert str(state_field["type"]) == "dropdown"
assert str(state_field["value"]) == "resolved"
assert not hasattr(attrs, "status")
assert not hasattr(attrs, "state")

def test_update_incident_json_reads_state(self, mock_client, runner):
"""JSON output's ``status`` key must reflect the SDK's ``state`` attribute."""
inc = _make_incident("inc-1", "Service outage", "SEV-1", "resolved")
response = Mock(data=inc)
mock_client.incidents.update_incident.return_value = response

with patch("ddogctl.commands.incident.get_datadog_client", return_value=mock_client):
result = runner.invoke(
incident,
["update", "inc-1", "--status", "resolved", "--format", "json"],
)

assert result.exit_code == 0, f"Command failed: {result.output}"
output = json.loads(result.output)
assert output["status"] == "resolved"


class TestDeleteIncident:
def test_delete_incident_with_confirm(self, mock_client, runner):
Expand Down
Loading