feat(stack-state/config&deploy-summary/diagnostic): Added unit testcases

Author: isivaselvan

CHANGELOG.md

@@ -7,6 +7,10 @@
 * Added `client.stack_deployment_groups` — list, read, approve, and rerun deployment groups within a stack configuration. `list(stack_configuration_id)` (`GET /stack-configurations/{id}/stack-deployment-groups`), `read(group_id)` (`GET /stack-deployment-groups/{id}`), `read_by_name(stack_configuration_id, name)`, `approve_all_plans(group_id)` (`POST .../approve-all-plans`), `rerun(group_id, options)` (`POST .../rerun?deployments=...`). New models: `StackDeploymentGroup`, `DeploymentGroupStatus`, `StackDeploymentGroupListOptions`, `StackDeploymentGroupRerunOptions`.
 * Added `client.stack_deployment_runs` — list, read, approve, and cancel individual deployment runs within a deployment group. `list(group_id)` (`GET /stack-deployment-groups/{id}/stack-deployment-runs`), `read(run_id)` (`GET /stack-deployment-runs/{id}`), `approve_all_plans(run_id)` (`POST .../approve-all-plans`), `cancel(run_id)` (`POST .../cancel`). New models: `StackDeploymentRun`, `DeploymentRunStatus`, `StackDeploymentRunListOptions`, `StackDeploymentRunReadOptions`, `StackDeploymentRunIncludeOpt`.
 * Added `client.stack_deployment_steps` — list, read, advance, list diagnostics, and download artifacts for individual deployment steps within a deployment run. `list(run_id)` (`GET /stack-deployment-runs/{id}/stack-deployment-steps`), `read(step_id)` (`GET /stack-deployment-steps/{id}`), `advance(step_id)` (`POST .../advance`), `list_diagnostics(step_id)` (`GET .../stack-diagnostics`), `download_artifact(step_id, artifact_type)` (`GET .../artifacts?name=<type>`) returns raw `bytes`. New models: `StackDeploymentStep`, `DeploymentStepStatus`, `StackDeploymentStepArtifactType`, `StackDeploymentStepIncludeOpt`, `StackDeploymentStepListOptions`, `StackDeploymentStepReadOptions`, `StackDiagnostic`, `StackDiagnosticListOptions`.
+* Added `client.stack_states` — list, read, and download descriptions for stack states. `list(stack_id)` (`GET /stacks/{id}/stack-states`), `read(state_id)` (`GET /stack-states/{id}`), `download_description(state_id)` (`GET /stack-states/{id}/description`) returns raw `bytes`. New models: `StackState`, `StackStateListOptions`. New error: `InvalidStackStateIDError`.
+* Added `client.stack_configuration_summaries` — list lightweight stack configuration summaries for a stack. `list(stack_id)` (`GET /stacks/{id}/stack-configuration-summaries`). New models: `StackConfigurationSummary`, `StackConfigurationSummaryListOptions`.
+* Added `client.stack_deployment_group_summaries` — list rolled-up deployment group summaries for a stack configuration. `list(stack_configuration_id)` (`GET /stack-configurations/{id}/stack-deployment-group-summaries`). New models: `StackDeploymentGroupSummary`, `StackDeploymentGroupSummaryListOptions`, `StackDeploymentGroupStatusCounts`.
+* Added `client.stack_diagnostics` — read and acknowledge stack diagnostics. `read(diagnostic_id)` (`GET /stack-diagnostics/{id}`), `acknowledge(diagnostic_id)` (`POST /stack-diagnostics/{id}/acknowledge`). New error: `InvalidStackDiagnosticIDError`.
 
 # Released
 # v1.2.0

tests/units/test_stack_configuration_summary.py

@@ -0,0 +1,95 @@
+# Copyright IBM Corp. 2025, 2026
+# SPDX-License-Identifier: MPL-2.0
+
+"""Unit tests for the stack_configuration_summaries module."""
+
+from unittest.mock import Mock
+
+import pytest
+
+from pytfe._http import HTTPTransport
+from pytfe.errors import InvalidStackIDError
+from pytfe.models.stack_configuration import (
+    StackConfigurationSummary,
+    StackConfigurationSummaryListOptions,
+)
+from pytfe.resources.stack_configuration_summaries import StackConfigurationSummaries
+
+
+class TestStackConfigurationSummaries:
+    """Test the StackConfigurationSummaries service class."""
+
+    @pytest.fixture
+    def mock_transport(self):
+        """Create a mock HTTPTransport."""
+        return Mock(spec=HTTPTransport)
+
+    @pytest.fixture
+    def service(self, mock_transport):
+        """Create a StackConfigurationSummaries service with mocked transport."""
+        return StackConfigurationSummaries(mock_transport)
+
+    @pytest.fixture
+    def summary_api_data(self):
+        """Typical API response item for a single stack configuration summary."""
+        return {
+            "id": "stcs-abc123",
+            "type": "stack-configuration-summaries",
+            "attributes": {
+                "status": "converged",
+                "sequence-number": 5,
+            },
+        }
+
+    # ── Model tests ──────────────────────────────────────────────────────────
+
+    def test_stack_configuration_summary_parse(self, summary_api_data):
+        """StackConfigurationSummary parses all attributes correctly."""
+        attrs = dict(summary_api_data["attributes"])
+        attrs["id"] = summary_api_data["id"]
+        summary = StackConfigurationSummary.model_validate(attrs)
+        assert summary.id == "stcs-abc123"
+        assert summary.status == "converged"
+        assert summary.sequence_number == 5
+
+    def test_stack_configuration_summary_list_options_serialization(self):
+        """StackConfigurationSummaryListOptions serializes page[size] correctly."""
+        opts = StackConfigurationSummaryListOptions(page_size=15)
+        dumped = opts.model_dump(by_alias=True, exclude_none=True)
+        assert dumped["page[size]"] == 15
+
+    # ── list() tests ─────────────────────────────────────────────────────────
+
+    def test_list_invalid_stack_id_raises(self, service):
+        """list() with an empty stack ID raises InvalidStackIDError."""
+        with pytest.raises(InvalidStackIDError):
+            list(service.list(""))
+
+    def test_list_success(self, service, summary_api_data):
+        """list() yields StackConfigurationSummary objects from paginated results."""
+        service._list = Mock(return_value=[summary_api_data])
+
+        results = list(service.list("st-xyz789"))
+
+        service._list.assert_called_once_with(
+            path="/api/v2/stacks/st-xyz789/stack-configuration-summaries",
+            params={},
+        )
+        assert len(results) == 1
+        assert isinstance(results[0], StackConfigurationSummary)
+        assert results[0].id == "stcs-abc123"
+
+    def test_list_with_page_size(self, service, summary_api_data):
+        """list() passes page[size] param correctly."""
+        service._list = Mock(return_value=[summary_api_data])
+        opts = StackConfigurationSummaryListOptions(page_size=5)
+        list(service.list("st-xyz789", options=opts))
+        service._list.assert_called_once_with(
+            path="/api/v2/stacks/st-xyz789/stack-configuration-summaries",
+            params={"page[size]": 5},
+        )
+
+    def test_list_empty(self, service):
+        """list() returns an empty iterator when the API returns no items."""
+        service._list = Mock(return_value=[])
+        assert list(service.list("st-xyz789")) == []

tests/units/test_stack_deployment_group_summary.py

@@ -0,0 +1,146 @@
+# Copyright IBM Corp. 2025, 2026
+# SPDX-License-Identifier: MPL-2.0
+
+"""Unit tests for the stack_deployment_group_summaries module."""
+
+from unittest.mock import Mock
+
+import pytest
+
+from pytfe._http import HTTPTransport
+from pytfe.errors import InvalidStackConfigurationIDError
+from pytfe.models.stack_deployment_group import (
+    StackDeploymentGroup,
+    StackDeploymentGroupStatusCounts,
+    StackDeploymentGroupSummary,
+    StackDeploymentGroupSummaryListOptions,
+)
+from pytfe.resources.stack_deployment_group_summaries import (
+    StackDeploymentGroupSummaries,
+)
+
+
+class TestStackDeploymentGroupSummaries:
+    """Test the StackDeploymentGroupSummaries service class."""
+
+    @pytest.fixture
+    def mock_transport(self):
+        """Create a mock HTTPTransport."""
+        return Mock(spec=HTTPTransport)
+
+    @pytest.fixture
+    def service(self, mock_transport):
+        """Create a StackDeploymentGroupSummaries service with mocked transport."""
+        return StackDeploymentGroupSummaries(mock_transport)
+
+    @pytest.fixture
+    def summary_api_data(self):
+        """Typical API response item for a single deployment group summary."""
+        return {
+            "id": "sdgs-abc123",
+            "type": "stack-deployment-group-summaries",
+            "attributes": {
+                "name": "dev",
+                "status": "succeeded",
+                "status-counts": {
+                    "pending": 0,
+                    "pre-deploying": 0,
+                    "pending-operator": 0,
+                    "acquiring-lock": 0,
+                    "deploying": 0,
+                    "succeeded": 3,
+                    "failed": 0,
+                    "abandoned": 0,
+                },
+            },
+            "relationships": {
+                "stack-deployment-group": {
+                    "data": {"id": "sdg-xyz789", "type": "stack-deployment-groups"}
+                }
+            },
+        }
+
+    # ── Model tests ──────────────────────────────────────────────────────────
+
+    def test_stack_deployment_group_status_counts_parse(self):
+        """StackDeploymentGroupStatusCounts parses all count fields."""
+        counts_data = {
+            "pending": 1,
+            "pre-deploying": 2,
+            "pending-operator": 3,
+            "acquiring-lock": 4,
+            "deploying": 5,
+            "succeeded": 6,
+            "failed": 7,
+            "abandoned": 8,
+        }
+        counts = StackDeploymentGroupStatusCounts.model_validate(counts_data)
+        assert counts.pending == 1
+        assert counts.pre_deploying == 2
+        assert counts.pre_deploying_pending_operator == 3
+        assert counts.acquiring_lock == 4
+        assert counts.deploying == 5
+        assert counts.succeeded == 6
+        assert counts.failed == 7
+        assert counts.abandoned == 8
+
+    def test_stack_deployment_group_summary_parse(self, summary_api_data):
+        """StackDeploymentGroupSummary parses name and status correctly."""
+        attrs = dict(summary_api_data["attributes"])
+        attrs["id"] = summary_api_data["id"]
+        summary = StackDeploymentGroupSummary.model_validate(attrs)
+        assert summary.id == "sdgs-abc123"
+        assert summary.name == "dev"
+        assert summary.status == "succeeded"
+        assert isinstance(summary.status_counts, StackDeploymentGroupStatusCounts)
+        assert summary.status_counts.succeeded == 3
+
+    def test_summary_list_options_serialization(self):
+        """StackDeploymentGroupSummaryListOptions serializes page[size] correctly."""
+        opts = StackDeploymentGroupSummaryListOptions(page_size=25)
+        dumped = opts.model_dump(by_alias=True, exclude_none=True)
+        assert dumped["page[size]"] == 25
+
+    # ── list() tests ─────────────────────────────────────────────────────────
+
+    def test_list_invalid_configuration_id_raises(self, service):
+        """list() with an empty config ID raises InvalidStackConfigurationIDError."""
+        with pytest.raises(InvalidStackConfigurationIDError):
+            list(service.list(""))
+
+    def test_list_success(self, service, summary_api_data):
+        """list() yields StackDeploymentGroupSummary objects from paginated results."""
+        service._list = Mock(return_value=[summary_api_data])
+
+        results = list(service.list("stc-abc123"))
+
+        service._list.assert_called_once_with(
+            path="/api/v2/stack-configurations/stc-abc123/stack-deployment-group-summaries",
+            params={},
+        )
+        assert len(results) == 1
+        assert isinstance(results[0], StackDeploymentGroupSummary)
+        assert results[0].id == "sdgs-abc123"
+        assert results[0].name == "dev"
+
+    def test_list_with_page_size(self, service, summary_api_data):
+        """list() passes page[size] param correctly."""
+        service._list = Mock(return_value=[summary_api_data])
+        opts = StackDeploymentGroupSummaryListOptions(page_size=10)
+        list(service.list("stc-abc123", options=opts))
+        service._list.assert_called_once_with(
+            path="/api/v2/stack-configurations/stc-abc123/stack-deployment-group-summaries",
+            params={"page[size]": 10},
+        )
+
+    def test_list_hydrates_group_relation(self, service, summary_api_data):
+        """list() hydrates the stack-deployment-group relation as a typed stub."""
+        service._list = Mock(return_value=[summary_api_data])
+        results = list(service.list("stc-abc123"))
+        assert isinstance(results[0].stack_deployment_group, StackDeploymentGroup)
+        assert results[0].stack_deployment_group.id == "sdg-xyz789"
+
+    def test_list_empty(self, service):
+        """list() returns an empty iterator when the API returns no items."""
+        service._list = Mock(return_value=[])
+        assert list(service.list("stc-abc123")) == []

tests/units/test_stack_deployment_step.py

@@ -62,7 +62,7 @@ def step_api_data(self):
     def diag_api_data(self):
         """Typical API response item for a single stack diagnostic."""
         return {
-            "id": "stf-diag001",
+            "id": "std-diag001",
             "type": "stack-diagnostics",
             "attributes": {
                 "severity": "warning",
@@ -244,7 +244,7 @@ def test_list_diagnostics_success(self, service, diag_api_data):
         )
         assert len(results) == 1
         assert isinstance(results[0], StackDiagnostic)
-        assert results[0].id == "stf-diag001"
+        assert results[0].id == "std-diag001"
         assert results[0].severity == "warning"
 
     def test_list_diagnostics_with_page_size(self, service, diag_api_data):

tests/units/test_stack_diagnostic.py

@@ -0,0 +1,101 @@
+# Copyright IBM Corp. 2025, 2026
+# SPDX-License-Identifier: MPL-2.0
+
+"""Unit tests for the stack_diagnostics module."""
+
+from unittest.mock import Mock
+
+import pytest
+
+from pytfe._http import HTTPTransport
+from pytfe.errors import InvalidStackDiagnosticIDError
+from pytfe.models.stack_deployment_step import StackDiagnostic
+from pytfe.resources.stack_diagnostics import StackDiagnostics
+
+
+class TestStackDiagnostics:
+    """Test the StackDiagnostics service class."""
+
+    @pytest.fixture
+    def mock_transport(self):
+        """Create a mock HTTPTransport."""
+        return Mock(spec=HTTPTransport)
+
+    @pytest.fixture
+    def service(self, mock_transport):
+        """Create a StackDiagnostics service with mocked transport."""
+        return StackDiagnostics(mock_transport)
+
+    @pytest.fixture
+    def diagnostic_api_data(self):
+        """Typical API response data for a single stack diagnostic."""
+        return {
+            "id": "std-abc123",
+            "type": "stack-diagnostics",
+            "attributes": {
+                "severity": "error",
+                "summary": "Invalid configuration",
+                "detail": "The stack configuration failed validation.",
+                "diags": None,
+                "acknowledged": False,
+                "acknowledged-at": None,
+                "created-at": "2026-07-03T10:00:00.000Z",
+            },
+        }
+
+    # ── Model tests ──────────────────────────────────────────────────────────
+
+    def test_stack_diagnostic_parse(self, diagnostic_api_data):
+        """StackDiagnostic parses all attributes correctly."""
+        attrs = dict(diagnostic_api_data["attributes"])
+        attrs["id"] = diagnostic_api_data["id"]
+        diag = StackDiagnostic.model_validate(attrs)
+        assert diag.id == "std-abc123"
+        assert diag.severity == "error"
+        assert diag.summary == "Invalid configuration"
+        assert diag.acknowledged is False
+
+    # ── read() tests ─────────────────────────────────────────────────────────
+
+    def test_read_invalid_id_raises(self, service):
+        """read() with an empty ID raises InvalidStackDiagnosticIDError."""
+        with pytest.raises(InvalidStackDiagnosticIDError):
+            service.read("")
+
+    def test_read_success(self, service, mock_transport, diagnostic_api_data):
+        """read() fetches a single stack diagnostic by ID."""
+        mock_response = Mock()
+        mock_response.json.return_value = {"data": diagnostic_api_data}
+        mock_transport.request.return_value = mock_response
+
+        diag = service.read("std-abc123")
+
+        mock_transport.request.assert_called_once_with(
+            "GET", path="/api/v2/stack-diagnostics/std-abc123"
+        )
+        assert isinstance(diag, StackDiagnostic)
+        assert diag.id == "std-abc123"
+        assert diag.severity == "error"
+        assert diag.acknowledged is False
+
+    # ── acknowledge() tests ───────────────────────────────────────────────────
+
+    def test_acknowledge_invalid_id_raises(self, service):
+        """acknowledge() with an empty ID raises InvalidStackDiagnosticIDError."""
+        with pytest.raises(InvalidStackDiagnosticIDError):
+            service.acknowledge("")
+
+    def test_acknowledge_calls_correct_endpoint(self, service, mock_transport):
+        """acknowledge() POSTs to the acknowledge action endpoint."""
+        mock_transport.request.return_value = Mock()
+        service.acknowledge("std-abc123")
+        mock_transport.request.assert_called_once_with(
+            "POST",
+            path="/api/v2/stack-diagnostics/std-abc123/acknowledge",
+        )
+
+    def test_acknowledge_returns_none(self, service, mock_transport):
+        """acknowledge() returns None on success."""
+        mock_transport.request.return_value = Mock()
+        result = service.acknowledge("std-abc123")
+        assert result is None