added cancel command

Author: sanderegg

packages/aws-library/src/aws_library/ssm/_client.py

@@ -107,7 +107,6 @@ async def send_command(
     @log_decorator(_logger, logging.DEBUG)
     @ssm_exception_handler(_logger)
     async def get_command(self, instance_id: str, *, command_id: str) -> SSMCommand:
-
         response = await self._client.get_command_invocation(
             CommandId=command_id, InstanceId=instance_id
         )
@@ -130,6 +129,13 @@ async def get_command(self, instance_id: str, *, command_id: str) -> SSMCommand:
             ),
         )
 
+    @log_decorator(_logger, logging.DEBUG)
+    @ssm_exception_handler(_logger)
+    async def cancel_command(self, instance_id: str, *, command_id: str) -> None:
+        await self._client.cancel_command(
+            CommandId=command_id, InstanceIds=[instance_id]
+        )
+
     @log_decorator(_logger, logging.DEBUG)
     @ssm_exception_handler(_logger)
     async def is_instance_connected_to_ssm_server(self, instance_id: str) -> bool:

packages/aws-library/tests/test_ssm_client.py

@@ -37,8 +37,7 @@ async def simcore_ssm_api(
     await ec2.close()
 
 
-async def test_ssm_client_lifespan(simcore_ssm_api: SimcoreSSMAPI):
-    ...
+async def test_ssm_client_lifespan(simcore_ssm_api: SimcoreSSMAPI): ...
 
 
 async def test_aiobotocore_ssm_client_when_ssm_server_goes_up_and_down(
@@ -125,6 +124,30 @@ async def test_send_command(
         )
 
 
+async def test_cancel_command(
+    mocked_aws_server: ThreadedMotoServer,
+    simcore_ssm_api: SimcoreSSMAPI,
+    faker: Faker,
+):
+    command_name = faker.word()
+    target_instance_id = faker.pystr()
+    sent_command = await simcore_ssm_api.send_command(
+        instance_ids=[target_instance_id],
+        command=faker.text(),
+        command_name=command_name,
+    )
+    assert sent_command
+    assert sent_command.command_id
+    assert sent_command.name == command_name
+    assert sent_command.instance_ids == [target_instance_id]
+    assert sent_command.status == "Success"
+
+    # cancelling a finished command is a no-op but is a bit of a joke as moto does not implement cancel command yet
+    await simcore_ssm_api.cancel_command(
+        instance_id=target_instance_id, command_id=sent_command.command_id
+    )
+
+
 async def test_is_instance_connected_to_ssm_server(
     mocked_aws_server: ThreadedMotoServer,
     simcore_ssm_api: SimcoreSSMAPI,

packages/pytest-simcore/src/pytest_simcore/helpers/moto.py

@@ -55,6 +55,16 @@ def _patch_describe_instance_information(
     return {"InstanceInformationList": [{"PingStatus": "Online"}]}
 
 
+def _patch_cancel_command(self, operation_name, api_params) -> dict[str, Any]:
+    warnings.warn(
+        "moto is missing the cancel_command function, therefore it is manually mocked."
+        "TIP: periodically check if it gets updated https://docs.getmoto.org/en/latest/docs/services/ssm.html#ssm",
+        UserWarning,
+        stacklevel=1,
+    )
+    return {}
+
+
 # Mocked aiobotocore _make_api_call function
 async def patched_aiobotocore_make_api_call(self, operation_name, api_params):
     # For example for the Access Analyzer service
@@ -63,6 +73,8 @@ async def patched_aiobotocore_make_api_call(self, operation_name, api_params):
     # Rationale -> https://github.com/boto/botocore/blob/develop/botocore/client.py#L810:L816
     if operation_name == "SendCommand":
         return await _patch_send_command(self, operation_name, api_params)
+    if operation_name == "CancelCommand":
+        return _patch_cancel_command(self, operation_name, api_params)
     if operation_name == "DescribeInstanceInformation":
         return _patch_describe_instance_information(self, operation_name, api_params)