streamsets 6.6.2rc1__tar.gz → 6.7.0.dev0__tar.gz

{streamsets-6.6.2rc1 → streamsets-6.7.0.dev0}/HISTORY.rst

@@ -3,6 +3,12 @@
 
 History
 =======
+6.6.2 (August 2025)
+----------------------
+* Fixed race conditions when retrieving objects
+
+* Bug fixes and improvements
+
 6.6.1 (June 2025)
 ----------------------
 * Fixed an issue that caused an error to be raised when calling the method :py:meth:`streamsets.sdk.ControlHub.delete_deployment`.

{streamsets-6.6.2rc1/streamsets.egg-info → streamsets-6.7.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: streamsets
-Version: 6.6.2rc1
+Version: 6.7.0.dev0
 Summary: A Python SDK for StreamSets
 Author: StreamSets Inc
 Classifier: Development Status :: 5 - Production/Stable

{streamsets-6.6.2rc1 → streamsets-6.7.0.dev0}/streamsets/sdk/__version__.py

@@ -2,4 +2,4 @@
 #  PID 5900-BAF
 #  Copyright StreamSets Inc., an IBM Company 2025
 
-__version__ = "6.6.2rc1"
+__version__ = "6.7.0dev0"

{streamsets-6.6.2rc1 → streamsets-6.7.0.dev0}/streamsets/sdk/sch.py

@@ -3962,19 +3962,49 @@ class ControlHub:
             raise start_deployment_exception
         return enable_deployments_command
 
-    def stop_deployment(self, *deployments):
+    def stop_deployment(self, *deployments, force: bool = False):
         """Stop Deployments.
 
         Args:
             *deployments: One or more instances of :py:class:`streamsets.sdk.sch_models.Deployment`.
+            force (:obj:`bool`, optional): Force deployment to stop. Default: ``False``.
         """
         deployments = [deployment for deployment in deployments if not isinstance(deployment, NotImplementedDeployment)]
         if not deployments:
             logger.info('No deployments to stop. Returning')
             return
-        deployment_ids = [deployment.deployment_id for deployment in deployments]
-        logger.info('Stopping deployments %s ...', deployment_ids)
-        stop_deployments_command = self.api_client.disable_deployments(deployment_ids)
+
+        force_stop_deployment_ids = []
+
+        if force:
+            # only force stop k8s deployments
+            force_stop_deployment_ids = [
+                deployment.deployment_id for deployment in deployments if isinstance(deployment, KubernetesDeployment)
+            ]
+
+        disable_deployment_ids = [
+            deployment.deployment_id
+            for deployment in deployments
+            if deployment.deployment_id not in force_stop_deployment_ids
+        ]
+
+        if force and not force_stop_deployment_ids:
+            raise ValueError(
+                "Invalid operation: force=True was specified, but no Kubernetes deployments were provided."
+            )
+        if force and force_stop_deployment_ids and disable_deployment_ids:
+            raise ValueError(
+                "Invalid operation: when force=True, only Kubernetes deployments may be stopped. "
+                "Non-Kubernetes deployments were also included."
+            )
+
+        stop_deployments_command = None
+
+        if force_stop_deployment_ids:
+            for deployment_id in force_stop_deployment_ids:
+                stop_deployments_command = self.api_client.force_stop_deployment(deployment_id, confirm=True)
+        if disable_deployment_ids:
+            stop_deployments_command = self.api_client.disable_deployments(disable_deployment_ids)
 
         stop_deployment_exception = None
         for deployment in deployments:

{streamsets-6.6.2rc1 → streamsets-6.7.0.dev0}/streamsets/sdk/sch_api.py

@@ -8100,6 +8100,24 @@ class ApiClient(object):
         initial_state_display_label = self.get_deployment(deployment_id).response.json()['stateDisplayLabel']
         wait_for_condition(condition=condition, timeout=timeout_sec, failure=failure, success=success)
 
+    def force_stop_deployment(self, deployment_id: str, confirm: bool = False):
+        """Force stop a deployment.
+
+        Args:
+            deployment_id (:obj:`str`): Id of the deployment.
+            confirm (:obj:`bool`, optional): Must be True to actually perform the
+            force stop. Defaults to False.
+
+        Returns:
+            An instance of :py:class:`streamsets.sdk.sch_api.Command`.
+        """
+        response = self._post(
+            app='provisioning',
+            endpoint='/v{}/csp/deployment/{}/forceStop'.format(self.api_version, deployment_id),
+            params={'confirm': 'true' if confirm else 'false'},
+        )
+        return Command(self, response)
+
     def get_deployment_engine_token(self, deployment_id):
         """Fetches a Engine Token for the Deployment.
 

{streamsets-6.6.2rc1 → streamsets-6.7.0.dev0/streamsets.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: streamsets
-Version: 6.6.2rc1
+Version: 6.7.0.dev0
 Summary: A Python SDK for StreamSets
 Author: StreamSets Inc
 Classifier: Development Status :: 5 - Production/Stable

{streamsets-6.6.2rc1 → streamsets-6.7.0.dev0}/tests/unit/test_sch.py

@@ -9,7 +9,7 @@ import pytest
 
 from streamsets.sdk import ControlHub
 from streamsets.sdk.sch_api import ApiClient
-from streamsets.sdk.sch_models import SelfManagedDeployment
+from streamsets.sdk.sch_models import KubernetesDeployment, SelfManagedDeployment
 
 from .resources.sch_data import DUMMY_DEPLOYMENT_JSON, DUMMY_DEPLOYMENT_JSON_2
 
@@ -62,6 +62,10 @@ class MockCommand:
 
 class MockApiClient(ApiClient):
     def __init__(self, *args, **kwargs):
+        self._disabled_ids = []
+        self._wait_calls = []
+        self._force_calls = []
+        self.fail_disable = False
         pass  # do not call super()
 
     def enable_deployments(self, deployment_ids):
@@ -138,6 +142,19 @@ class MockApiClient(ApiClient):
     ):
         return MockCommand(VALID_INSTALL_SCRIPT)
 
+    def disable_deployments(self, deployment_ids):
+        if self.fail_disable:
+            raise Exception("disable failed (mock)")
+        self._disabled_ids = list(deployment_ids)
+        return True
+
+    def wait_for_deployment_state_display_label(self, deployment_id, state_display_label, **kwargs):
+        self._wait_calls.append((deployment_id, state_display_label))
+
+    def force_stop_deployment(self, deployment_id, confirm=False):
+        self._force_calls.append((deployment_id, bool(confirm)))
+        return MockCommand({"ok": True})
+
 
 @pytest.fixture(scope="function")
 def dummy_deployment_data():
@@ -196,3 +213,66 @@ def test_add_deployment_adds_disabled_engine(dummy_deployment_data_2):
     deployment = SelfManagedDeployment(dummy_deployment_data_2)
     deployment._control_hub = sch
     sch.add_deployment(deployment)
+
+
+def test_stop_deployment_no_force(dummy_deployment_data):
+    sch = MockControlHub()
+    payload = deepcopy(dummy_deployment_data)
+    deployment = SelfManagedDeployment(payload)
+    deployment._control_hub = sch
+
+    dep_id = payload["id"]
+    deployment._data_internal["id"] = dep_id
+    deployment._data_internal["type"] = "SELF"
+
+    result = sch.stop_deployment(deployment, force=False)
+
+    assert result is True
+
+    assert sch.api_client._disabled_ids == [dep_id]
+
+    assert any(state == "DEACTIVATED" for (_id, state) in sch.api_client._wait_calls)
+    assert any(call[0] == dep_id for call in sch.api_client._wait_calls)
+
+
+def test_stop_deployment_with_force_non_k8s_skips_force(caplog, dummy_deployment_data):
+    sch = MockControlHub()
+    sch.api_client.fail_disable = True
+
+    payload = deepcopy(dummy_deployment_data)
+    deployment = SelfManagedDeployment(payload)
+    deployment._control_hub = sch
+
+    dep_id = payload["id"]
+    deployment._data_internal["id"] = dep_id
+    deployment._data_internal["type"] = "SELF"
+
+    with pytest.raises(ValueError, match=r"force=True was specified, but no Kubernetes deployments were provided"):
+        sch.stop_deployment(deployment, force=True)
+
+    assert sch.api_client._force_calls == []
+    assert sch.api_client._disabled_ids == []
+    assert sch.api_client._wait_calls == []
+
+
+def test_stop_deployment_with_force_k8s_calls_force(dummy_deployment_data, caplog):
+    sch = MockControlHub()
+    sch.api_client.fail_disable = True
+
+    payload = deepcopy(dummy_deployment_data)
+    payload['type'] = 'KUBERNETES'
+    deployment = KubernetesDeployment(payload)
+    deployment._control_hub = sch
+
+    dep_id = payload["id"]
+    deployment._data_internal["id"] = dep_id
+    deployment._data_internal["type"] = "KUBERNETES"
+
+    result = sch.stop_deployment(deployment, force=True)
+
+    assert sch.api_client._force_calls == [(dep_id, True)]
+    assert sch.api_client._disabled_ids == []
+
+    assert any((_id == dep_id and state == "DEACTIVATED") for (_id, state) in sch.api_client._wait_calls)
+
+    assert isinstance(result, MockCommand)