Improve code coverage for depployment entity (Azure#39403)

pdhotems · web-flow · commit d9bd1e1a93e3 · 2025-02-04T12:39:37.000Z
* add unit tests for OnlineDeployment rest to entity conversion * add unit tests for onlinedeployment entity _get_arm_resource_and_params * move unit tests online_deployment_from_rest_object to right class * add unit tests for get arm resource for kubenets deployment * add unit tests for onlinedeployment entity set scale settings * add unit tests for to_dict method * code formatting * change comment to run tests * Update assets.json * Revert "Update assets.json" This reverts commit 3aee0c6. * disable failing tests * disable failing tests * enable failing tests and update recordings * add unit tests for OnlineDeployment merge * fix unit test * add unit tests for to_rest_object * update unit tests for resource settings * update unit tests for resource settings * add unit tests for online deployment settings * add unit tests for batch deployment * code formatting * add unit tests batch endpoint deployment * add unit tests for batch deployment * add unit tests for batch job * add unit tests for batch job * add unit tests for model deployment class * code formatting * remove unwanted tests * add unit tests for pipeline_component_batch_deployment.py * clean json rest response file * clean json rest response file
diff --git a/sdk/ml/azure-ai-ml/azure/ai/ml/entities/_deployment/online_deployment.py b/sdk/ml/azure-ai-ml/azure/ai/ml/entities/_deployment/online_deployment.py
@@ -215,7 +215,7 @@ def _from_rest_object(cls, deployment: RestOnlineDeploymentData) -> RestOnlineDe
         if deployment.properties.endpoint_compute_type == EndpointComputeType.MANAGED:
             return ManagedOnlineDeployment._from_rest_object(deployment)
 
-        msg = f"Unsupported online endpoint type {deployment.properties.type}."
+        msg = f"Unsupported online endpoint type {deployment.properties.endpoint_compute_type}."
         raise DeploymentException(
             message=msg,
             target=ErrorTarget.ONLINE_DEPLOYMENT,
diff --git a/sdk/ml/azure-ai-ml/azure/ai/ml/entities/_deployment/scale_settings.py b/sdk/ml/azure-ai-ml/azure/ai/ml/entities/_deployment/scale_settings.py
@@ -54,7 +54,7 @@ def _from_rest_object(  # pylint: disable=arguments-renamed
         if settings.scale_type == "TargetUtilization":
             return TargetUtilizationScaleSettings._from_rest_object(settings)
 
-        msg = f"Unsupported online scale setting type {settings.type}."
+        msg = f"Unsupported online scale setting type {settings.scale_type}."
         raise DeploymentException(
             message=msg,
             target=ErrorTarget.ONLINE_DEPLOYMENT,
diff --git a/sdk/ml/azure-ai-ml/tests/batch_online_common/unittests/test_batch_job.py b/sdk/ml/azure-ai-ml/tests/batch_online_common/unittests/test_batch_job.py
@@ -0,0 +1,32 @@
+import pytest
+
+from azure.ai.ml.entities import BatchJob
+from azure.ai.ml._restclient.v2020_09_01_dataplanepreview.models import BatchJobResource, BatchJob as BatchJobRest
+
+
+@pytest.mark.unittest
+class TestBatchJob:
+    def test_batch_job_to_dict(self):
+        batch_job = BatchJob(
+            id="id",
+            name="name",
+            type="type",
+            status="status",
+        )
+        batch_job_dict = batch_job._to_dict()
+        assert batch_job_dict == {
+            "id": "id",
+            "name": "name",
+            "type": "type",
+            "status": "status",
+        }
+
+    def test_batch_job_to_rest(self):
+        batch_jon_rest = BatchJobResource.deserialize(
+            {"id": "id", "name": "name", "type": "type", "properties": {"status": "status"}}
+        )
+        batch_job = BatchJob._from_rest_object(batch_jon_rest)
+        assert batch_job.id == "id"
+        assert batch_job.name == "name"
+        assert batch_job.type == "type"
+        assert batch_job.status == "status"
diff --git a/sdk/ml/azure-ai-ml/tests/batch_online_common/unittests/test_deployment_entity.py b/sdk/ml/azure-ai-ml/tests/batch_online_common/unittests/test_deployment_entity.py
diff --git a/sdk/ml/azure-ai-ml/tests/batch_online_common/unittests/test_model_batch_deployment.py b/sdk/ml/azure-ai-ml/tests/batch_online_common/unittests/test_model_batch_deployment.py
@@ -0,0 +1,67 @@
+import pytest
+from azure.ai.ml.entities import ModelBatchDeployment
+from azure.ai.ml.entities._load_functions import load_model_batch_deployment
+from azure.ai.ml.constants._deployment import BatchDeploymentOutputAction
+from azure.ai.ml._restclient.v2022_05_01.models import BatchOutputAction
+from azure.ai.ml.exceptions import ValidationException
+
+
+@pytest.mark.unittest
+class TestModelBatchDeployment:
+    MODEL_BATCH_DEPLOYMNET = "./tests/test_configs/deployments/batch/model_batch_deployment.yaml"
+
+    def test_to_rest_object(self) -> None:
+        deployment = load_model_batch_deployment(
+            TestModelBatchDeployment.MODEL_BATCH_DEPLOYMNET, params_override=[{"endpoint_name": "some-en-name"}]
+        )
+        rest_deployment = deployment._to_rest_object(location="eastus")
+        assert rest_deployment.location == "eastus"
+        assert rest_deployment.properties.description == deployment.description
+        assert rest_deployment.properties.environment_id == deployment.environment
+        assert rest_deployment.properties.model.asset_id.name == "model-1"
+        assert rest_deployment.properties.code_configuration.code_id == deployment.code_configuration.code
+        assert (
+            rest_deployment.properties.code_configuration.scoring_script == deployment.code_configuration.scoring_script
+        )
+        assert rest_deployment.properties.output_file_name == deployment.settings.output_file_name
+        assert str(rest_deployment.properties.output_action) == "BatchOutputAction.APPEND_ROW"
+        assert rest_deployment.properties.resources.instance_count == deployment.resources.instance_count
+        assert rest_deployment.properties.retry_settings.max_retries == deployment.settings.retry_settings.max_retries
+        assert (
+            rest_deployment.properties.max_concurrency_per_instance == deployment.settings.max_concurrency_per_instance
+        )
+        assert rest_deployment.properties.environment_variables == deployment.settings.environment_variables
+        assert rest_deployment.properties.compute == deployment.compute
+        assert rest_deployment.properties.properties == deployment.properties
+        assert rest_deployment.tags == deployment.tags
+
+    def test_output_action_yaml_to_rest(self):
+        assert (
+            ModelBatchDeployment._yaml_output_action_to_rest_output_action(BatchDeploymentOutputAction.APPEND_ROW)
+            == BatchOutputAction.APPEND_ROW
+        )
+        assert (
+            ModelBatchDeployment._yaml_output_action_to_rest_output_action(BatchDeploymentOutputAction.SUMMARY_ONLY)
+            == BatchOutputAction.SUMMARY_ONLY
+        )
+
+    def test_validation_fails_if_output_file_name_and_summary_output_action(self) -> None:
+        deployment = load_model_batch_deployment(TestModelBatchDeployment.MODEL_BATCH_DEPLOYMNET)
+        deployment.settings.output_action = BatchDeploymentOutputAction.SUMMARY_ONLY
+        deployment.settings.output_file_name = "some_file_name"
+        with pytest.raises(ValidationException) as ex:
+            deployment._to_rest_object(location="westus")
+        assert "When output_action is set to summary_only, the output_file_name need not to be specified." == str(
+            ex.value
+        )
+
+    def test_to_dict(self) -> None:
+        deployment = load_model_batch_deployment(TestModelBatchDeployment.MODEL_BATCH_DEPLOYMNET)
+        deployment_dict = deployment._to_dict()
+        assert deployment_dict["name"] == deployment.name
+        assert deployment_dict["endpoint_name"] == deployment.endpoint_name
+        assert deployment_dict["model"]["name"] == deployment.model.name
+        assert deployment_dict["compute"] == "azureml:cpu-cluster"
+        assert deployment_dict["resources"]["instance_count"] == deployment.resources.instance_count
+        assert deployment_dict["settings"]["error_threshold"] == deployment.settings.error_threshold
+        assert deployment_dict["settings"]["output_action"] == "append_row"
diff --git a/sdk/ml/azure-ai-ml/tests/batch_online_common/unittests/test_pipeline_component_bach_deployment.py b/sdk/ml/azure-ai-ml/tests/batch_online_common/unittests/test_pipeline_component_bach_deployment.py
@@ -0,0 +1,103 @@
+import pytest
+import json
+from azure.ai.ml.entities._deployment.pipeline_component_batch_deployment import (
+    PipelineComponentBatchDeployment,
+)
+from azure.ai.ml.entities import PipelineComponent
+from azure.ai.ml.entities._load_functions import (
+    load_pipeline_component_batch_deployment,
+)
+from azure.ai.ml._restclient.v2024_01_01_preview.models import (
+    BatchDeployment as RestBatchDeployment,
+    IdAssetReference,
+    BatchPipelineComponentDeploymentConfiguration as RestBatchPipelineComponentDeploymentConfiguration,
+)
+from azure.ai.ml._restclient.v2024_01_01_preview.models import (
+    BatchDeploymentProperties as RestBatchDeploymentProperties,
+)
+
+
+@pytest.mark.unittest
+class TestPipelineComponentBatchDeployment:
+    HELLO_BATCH_DEPLOYMENT = "tests/test_configs/deployments/batch/pipeline_component_batch_deployment.yml"
+    HELLO_BATCH_DEPLOYMENT_REST = "tests/test_configs/deployments/batch/batch_pipeline_component_rest.json"
+
+    def test_to_rest_object(self) -> None:
+        pipeline_component = load_pipeline_component_batch_deployment(
+            TestPipelineComponentBatchDeployment.HELLO_BATCH_DEPLOYMENT
+        )
+        pipeline_component_rest = pipeline_component._to_rest_object(location="eastus")
+        assert pipeline_component_rest.properties.deployment_configuration.settings == pipeline_component.settings
+        assert (
+            pipeline_component_rest.properties.deployment_configuration.component_id.asset_id
+            == pipeline_component.component
+        )
+        assert pipeline_component_rest.properties.description == pipeline_component.description
+        assert pipeline_component_rest.tags == pipeline_component.tags
+        assert pipeline_component_rest.location == "eastus"
+
+    def test_to_rest_object_for_component_obj(self) -> None:
+        pipeline_component = load_pipeline_component_batch_deployment(
+            TestPipelineComponentBatchDeployment.HELLO_BATCH_DEPLOYMENT
+        )
+
+        pipeline_component.component = PipelineComponent(
+            id=pipeline_component.component,
+            name="test_component",
+            description="component description",
+            tags={"tag1": "tag_value"},
+        )
+        pipeline_component_rest = pipeline_component._to_rest_object(location="eastus")
+
+        assert pipeline_component_rest.properties.deployment_configuration.settings == pipeline_component.settings
+        assert (
+            pipeline_component_rest.properties.deployment_configuration.component_id.asset_id
+            == pipeline_component.component.id
+        )
+        assert pipeline_component_rest.properties.deployment_configuration.tags == pipeline_component.component.tags
+        assert (
+            pipeline_component_rest.properties.deployment_configuration.description
+            == pipeline_component.component.description
+        )
+        assert pipeline_component_rest.properties.description == pipeline_component.description
+        assert pipeline_component_rest.tags == pipeline_component.tags
+        assert pipeline_component_rest.location == "eastus"
+
+    def test_to_dict(self) -> None:
+        pipeline_component = load_pipeline_component_batch_deployment(
+            TestPipelineComponentBatchDeployment.HELLO_BATCH_DEPLOYMENT,
+            params_override=[{"endpoint_name": "azureml:hello_batch2@latest"}],
+        )
+        pipeline_component_dict = pipeline_component._to_dict()
+        assert pipeline_component_dict["name"] == pipeline_component.name
+        assert pipeline_component_dict["tags"] == pipeline_component.tags
+        assert pipeline_component_dict["description"] == pipeline_component.description
+        assert pipeline_component_dict["endpoint_name"] == "azureml:hello_batch2@latest"
+        assert pipeline_component_dict["component"] == "azureml:hello_batch@latest"
+        assert pipeline_component_dict["settings"] == pipeline_component.settings
+
+    def test_from_rest_object(self) -> None:
+
+        with open(TestPipelineComponentBatchDeployment.HELLO_BATCH_DEPLOYMENT_REST, "r") as file:
+            pipeline_component_rest = RestBatchDeployment.from_dict(json.load(file))
+            pipeline_component_rest.properties.additional_properties = {
+                "deploymentConfiguration": {
+                    "componentId": {"assetId": "azureml:hello_batch@latest"},
+                    "settings": {"componentId": "azureml:hello_batch@latest"},
+                }
+            }
+            pipeline_component_from_rest = PipelineComponentBatchDeployment._from_rest_object(pipeline_component_rest)
+            assert pipeline_component_from_rest.component == "azureml:hello_batch@latest"
+            assert (
+                pipeline_component_from_rest.settings["componentId"]
+                == pipeline_component_rest.properties.additional_properties["deploymentConfiguration"]["componentId"][
+                    "assetId"
+                ]
+            )
+            assert (
+                pipeline_component_from_rest.component
+                == pipeline_component_rest.properties.additional_properties["deploymentConfiguration"]["componentId"][
+                    "assetId"
+                ]
+            )
+            assert pipeline_component_from_rest.endpoint_name == "achauhan-endpoint-name"
diff --git a/sdk/ml/azure-ai-ml/tests/test_configs/deployments/batch/batch_deployment_full_rest.json b/sdk/ml/azure-ai-ml/tests/test_configs/deployments/batch/batch_deployment_full_rest.json
@@ -0,0 +1,56 @@
+{
+    "id": "/subscriptions/sub-id/resourceGroups/some-res-group/providers/Microsoft.MachineLearningServices/workspaces/some-ws/batchEndpoints/achauhan-endpoint-name/deployments/hello-world-1",
+    "name": "hello-world-1",
+    "type": "Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments",
+    "properties": {
+        "description": "some description",
+        "properties": {
+            "AzureAsyncOperationUri": "azure-operation"
+        },
+        "codeConfiguration": {
+            "codeId": "/subscriptions/sub-id/resourceGroups/some-rg/providers/Microsoft.MachineLearningServices/workspaces/some-ws/onlineEndpoints/some-endpoint/deployments/blue",
+            "scoringScript": "score.py"
+        },
+        "environmentId": "/subscriptions/sub-id/resourceGroups/some-rg/providers/Microsoft.MachineLearningServices/workspaces/some-ws/onlineEndpoints/some-endpoint/deployments/blue",
+        "environmentVariables": {},
+        "compute": "/subscriptions/sub-id/resourceGroups/some-rg/providers/Microsoft.MachineLearningServices/workspaces/some-ws/onlineEndpoints/some-endpoint/deployments/blue",
+        "errorThreshold": -1,
+        "retrySettings": {
+            "maxRetries": 3,
+            "timeout": "PT30S"
+        },
+        "miniBatchSize": 10,
+        "loggingLevel": "Info",
+        "model": {
+            "referenceType": "Id",
+            "assetId": "/subscriptions/sub-id/resourceGroups/some-rg/providers/Microsoft.MachineLearningServices/workspaces/some-ws/onlineEndpoints/some-endpoint/deployments/blue"
+        },
+        "maxConcurrencyPerInstance": 1,
+        "outputAction": "AppendRow",
+        "outputFileName": "predictions.csv",
+        "resources": {
+            "instanceCount": 1,
+            "instanceType": null,
+            "locations": null,
+            "properties": null
+        },
+        "provisioningState": "Succeeded"
+    },
+    "systemData": {
+        "createdAt": "2025-02-01T17:51:56.513702+00:00",
+        "createdBy": "some-one"
+    },
+    "tags": {
+        "tag1": "value1"
+    },
+    "location": "eastus",
+    "identity": {
+        "type": "SystemAssigned",
+        "userAssignedIdentities": {
+            "key": {
+                "principalId": "some-principalId",
+                "clientId": "some-clientId"
+            }
+        }
+    }
+}
diff --git a/sdk/ml/azure-ai-ml/tests/test_configs/deployments/batch/batch_deployment_mlflow.yaml b/sdk/ml/azure-ai-ml/tests/test_configs/deployments/batch/batch_deployment_mlflow.yaml
@@ -14,3 +14,6 @@ max_concurrency_per_instance: 5
 compute: "azureml:testCompute"
 resources:
   instance_count: 2
+tags:
+  tag1: value1
+  tag2: value2
diff --git a/sdk/ml/azure-ai-ml/tests/test_configs/deployments/batch/batch_pipeline_component_rest.json b/sdk/ml/azure-ai-ml/tests/test_configs/deployments/batch/batch_pipeline_component_rest.json
@@ -0,0 +1,17 @@
+{
+    "id": "/subscriptions/sub-id/resourceGroups/some-res-group/providers/Microsoft.MachineLearningServices/workspaces/some-ws/batchEndpoints/achauhan-endpoint-name/deployments/hello-world-1",
+    "name":"hello-batch",
+    "description":"A batch pipeline component",
+    "properties":{
+        "deploymentConfiguration":{
+            "settings": {
+                "default_compute": "batch-cluster"
+            },
+            "tags": {
+                "tag1": "value1"
+            },
+            "componentId": "azureml:hello_batch@latest"
+        }
+    }
+
+}
diff --git a/sdk/ml/azure-ai-ml/tests/test_configs/deployments/batch/pipeline_component_batch_deployment.yml b/sdk/ml/azure-ai-ml/tests/test_configs/deployments/batch/pipeline_component_batch_deployment.yml
@@ -0,0 +1,12 @@
+$schema: https://azuremlschemas.azureedge.net/latest/pipelineComponentBatchDeployment.schema.json
+name: hello-batch-dpl
+endpoint_name: hello-pipeline-batch
+description: "Batch deployment description"
+type: pipeline
+component: azureml:hello_batch@latest
+settings:
+    default_compute: batch-cluster
+tags:
+    tag1: value1
+    tag2: value2
+
diff --git a/sdk/ml/azure-ai-ml/tests/test_configs/deployments/online/online_deployment_blue_full.yaml b/sdk/ml/azure-ai-ml/tests/test_configs/deployments/online/online_deployment_blue_full.yaml
@@ -0,0 +1,50 @@
+$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineDeployment.schema.json
+name: blue
+type: kubernetes
+endpoint_name: mit-test-1
+description: description for online deployment
+model:
+    name: sklearn_regression_model
+    version: 10
+    path: ../model-1/model/sklearn_regression_model.pkl
+code_configuration:
+    code: ../model-1/onlinescoring/
+    scoring_script: score.py
+environment:
+    name: k8s-env
+    version: 3
+    image: mcr.microsoft.com/azureml/openmpi4.1.0-ubuntu22.04:20230227.v1
+    conda_file: ../model-1/environment/conda.yml
+instance_type: cpuinstance
+liveness_probe:
+  initial_delay: 10
+  period: 10
+  timeout: 10
+  success_threshold: 1
+  failure_threshold: 1
+readiness_probe:
+  initial_delay: 10
+  period: 10
+  timeout: 10
+  success_threshold: 1
+  failure_threshold: 1
+scale_settings:
+  type: default
+request_settings:
+  request_timeout_ms: 10000
+  max_concurrent_requests_per_instance: 2
+  max_queue_wait_ms: 1000
+instance_count: 2
+environment_variables:
+  env1: value1
+tags:
+  tag1: value1
+resources:
+  requests:
+    cpu: 1n
+    memory: 1Gi
+    gpu: 0n
+  limits:
+    cpu: 1n
+    memory: 1Gi
+    gpu: 0n
diff --git a/sdk/ml/azure-ai-ml/tests/test_configs/deployments/online/online_deployment_kubernetes_rest.json b/sdk/ml/azure-ai-ml/tests/test_configs/deployments/online/online_deployment_kubernetes_rest.json
diff --git a/sdk/ml/azure-ai-ml/tests/test_configs/deployments/online/online_deployment_managed_full.yml b/sdk/ml/azure-ai-ml/tests/test_configs/deployments/online/online_deployment_managed_full.yml
diff --git a/sdk/ml/azure-ai-ml/tests/test_configs/deployments/online/online_deployment_managed_rest.json b/sdk/ml/azure-ai-ml/tests/test_configs/deployments/online/online_deployment_managed_rest.json
