refactored model class names

Author: katzy687

assets/polling-orchestrations/teardown_with_sleep/__main__.py

@@ -1,8 +1,8 @@
 from cloudshell.workflow.orchestration.sandbox import Sandbox
 from cloudshell.workflow.orchestration.teardown.default_teardown_orchestrator import DefaultTeardownWorkflow
+import time
 
 SLEEP_SECONDS = 30
-import time
 
 
 def fake_config(sandbox, components=None):

requirements-dev.txt

@@ -2,4 +2,5 @@ pytest
 python-dotenv
 flake8
 pylint
-pre-commit
+pre-commit
+cloudshell-orch-core

src/cloudshell/sandbox_rest/api.py

@@ -283,7 +283,7 @@ def run_component_command(
             max_polling_minutes: int = 20,
             polling_frequency_seconds: int = 10,
             polling_log_level: int = logging.DEBUG
-    ) -> model.ResourceCommandExecutionDetails:
+    ) -> model.ComponentCommandExecutionDetails:
         """Start a command on sandbox component"""
         self._validate_auth_header()
         uri = f"{self._v2_base_uri}/sandboxes/{sandbox_id}/components/{component_id}/commands/{command_name}/start"
@@ -294,11 +294,11 @@ def run_component_command(
         start_response = model.CommandStartResponse.dict_to_model(response_dict)
         component_details = self.get_sandbox_component_details(sandbox_id, component_id)
         model_wrapped_command_params = [model.CommandParameterNameValue(x.name, x.value) for x in params] if params else []
-        command_context = model.ResourceCommandContextDetails(sandbox_id=sandbox_id,
-                                                              command_name=command_name,
-                                                              command_params=model_wrapped_command_params,
-                                                              component_name=component_details.name,
-                                                              component_id=component_details.id)
+        command_context = model.ComponentCommandContextDetails(sandbox_id=sandbox_id,
+                                                               command_name=command_name,
+                                                               command_params=model_wrapped_command_params,
+                                                               component_name=component_details.name,
+                                                               component_id=component_details.id)
         if polling_execution:
             execution_details = self.poll_command_execution(execution_id=start_response.executionId,
                                                             max_polling_minutes=max_polling_minutes,
@@ -307,13 +307,13 @@ def run_component_command(
         else:
             execution_details = self.get_execution_details(start_response.executionId)
 
-        return model.ResourceCommandExecutionDetails(id=start_response.executionId,
-                                                     status=execution_details.status,
-                                                     supports_cancellation=execution_details.supports_cancellation,
-                                                     started=execution_details.started,
-                                                     ended=execution_details.ended,
-                                                     output=execution_details.output,
-                                                     command_context=command_context)
+        return model.ComponentCommandExecutionDetails(id=start_response.executionId,
+                                                      status=execution_details.status,
+                                                      supports_cancellation=execution_details.supports_cancellation,
+                                                      started=execution_details.started,
+                                                      ended=execution_details.ended,
+                                                      output=execution_details.output,
+                                                      command_context=command_context)
 
     def extend_sandbox(self, sandbox_id: str, duration: str) -> model.ExtendResponse:
         """Extend the sandbox

src/cloudshell/sandbox_rest/model.py

@@ -7,7 +7,7 @@
 from enum import Enum
 from typing import TYPE_CHECKING, List, Optional
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel
 
 RESPONSE_DICT_KEY = "response_dict"
 
@@ -249,29 +249,6 @@ class CommandExecutionDetails(SandboxApiBaseModel):
     output: Optional[str]
 
 
-@_basemodel_decorator
-class CommandContextDetails(SandboxApiBaseModel):
-    sandbox_id: Optional[str]
-    command_name: Optional[str]
-    command_params: Optional[List[CommandParameterNameValue]]
-
-
-@_basemodel_decorator
-class ResourceCommandContextDetails(CommandContextDetails):
-    component_name: Optional[str]
-    component_id: Optional[str]
-
-
-@_basemodel_decorator
-class EnvironmentCommandExecutionDetails(CommandExecutionDetails):
-    command_context: Optional[CommandContextDetails]
-
-
-@_basemodel_decorator
-class ResourceCommandExecutionDetails(CommandExecutionDetails):
-    command_context: Optional[ResourceCommandContextDetails]
-
-
 @_basemodel_decorator
 class ComponentAttribute(SandboxApiBaseModel):
     type: Optional[str]
@@ -330,7 +307,30 @@ class SandboxOutput(SandboxApiBaseModel):
     entries: Optional[List[SandboxOutputEntry]]
 
 
-# Missing from Swagger Schema Docs
+# ===== Custom Data Models NOT returned from endpoint responses
 @_basemodel_decorator
 class StopSandboxResponse(SandboxApiBaseModel):
     result: Optional[str] = "success"
+
+
+@_basemodel_decorator
+class CommandContextDetails(SandboxApiBaseModel):
+    sandbox_id: Optional[str]
+    command_name: Optional[str]
+    command_params: Optional[List[CommandParameterNameValue]]
+
+
+@_basemodel_decorator
+class ComponentCommandContextDetails(CommandContextDetails):
+    component_name: Optional[str]
+    component_id: Optional[str]
+
+
+@_basemodel_decorator
+class EnvironmentCommandExecutionDetails(CommandExecutionDetails):
+    command_context: Optional[CommandContextDetails]
+
+
+@_basemodel_decorator
+class ComponentCommandExecutionDetails(CommandExecutionDetails):
+    command_context: Optional[ComponentCommandContextDetails]

tests/test_api_polling.py

@@ -65,6 +65,6 @@ def test_component_command_blocking(admin_session: SandboxRestApiSession, sandbo
                                                    polling_execution=True,
                                                    polling_log_level=logging.INFO)
     common.fixed_sleep()
-    assert isinstance(response, model.ResourceCommandExecutionDetails)
+    assert isinstance(response, model.ComponentCommandExecutionDetails)
     print(f"Resource command finished after {default_timer() - start:.2f} seconds.\n"
           f"Execution response: {response.pretty_json()}")