Merge pull request #7 from forcedotcom/sdkVersion-config

Add sdkVersion to config.json as part of deploy

Author: markdlv-sf

src/datacustomcode/deploy.py

@@ -36,6 +36,7 @@
 
 from datacustomcode.cmd import cmd_output
 from datacustomcode.scan import scan_file
+from datacustomcode.version import get_version
 
 if TYPE_CHECKING:
     from datacustomcode.credentials import Credentials
@@ -284,6 +285,7 @@ class DataTransformConfig(BaseModel):
     "entryPoint": "entrypoint.py",
     "dataspace": "default",
     "permissions": {"read": {"dlo": ""}, "write": {"dlo": ""}},
+    "sdkVersion": get_version(),
 }
 
 

src/datacustomcode/version.py

@@ -0,0 +1,27 @@
+# Copyright (c) 2025, Salesforce, Inc.
+# SPDX-License-Identifier: Apache-2
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Version information for the Data Cloud Custom Code SDK."""
+
+import importlib.metadata
+
+
+def get_version() -> str:
+    """Get the current version of the SDK.
+
+    Returns:
+        str: The version string from package metadata.
+    """
+    # First try to get version from installed package metadata
+    return importlib.metadata.version("salesforce-data-customcode")

tests/test_deploy.py

@@ -10,24 +10,27 @@
 import requests
 
 from datacustomcode.credentials import Credentials
-from datacustomcode.deploy import (
-    AccessTokenResponse,
-    CreateDeploymentResponse,
-    DataTransformConfig,
-    DeploymentsResponse,
-    TransformationJobMetadata,
-    _make_api_call,
-    _retrieve_access_token,
-    create_data_transform,
-    create_data_transform_config,
-    create_deployment,
-    deploy_full,
-    get_data_transform_config,
-    get_deployments,
-    run_data_transform,
-    wait_for_deployment,
-    zip_and_upload_directory,
-)
+
+# Patch get_version before importing deploy module
+with patch("datacustomcode.version.get_version", return_value="1.2.3"):
+    from datacustomcode.deploy import (
+        AccessTokenResponse,
+        CreateDeploymentResponse,
+        DataTransformConfig,
+        DeploymentsResponse,
+        TransformationJobMetadata,
+        _make_api_call,
+        _retrieve_access_token,
+        create_data_transform,
+        create_data_transform_config,
+        create_deployment,
+        deploy_full,
+        get_data_transform_config,
+        get_deployments,
+        run_data_transform,
+        wait_for_deployment,
+        zip_and_upload_directory,
+    )
 
 
 class TestMakeApiCall:
@@ -248,10 +251,14 @@ def test_create_data_transform_config(
         mock_get_config.assert_called_once_with("/test/dir")
         mock_file.assert_called_once_with("/test/dir/config.json", "w")
         mock_json_dump.assert_called_once()
-        # Check permissions in config
-        config = mock_json_dump.call_args[0][0]
-        assert config["permissions"]["read"]["dlo"] == "input_dlo"
-        assert config["permissions"]["write"]["dlo"] == "output_dlo"
+
+        # Verify the config contains all required fields including sdkVersion
+        config_data = mock_json_dump.call_args[0][0]
+        assert config_data["entryPoint"] == "entrypoint.py"
+        assert config_data["dataspace"] == "default"
+        assert config_data["permissions"]["read"]["dlo"] == "input_dlo"
+        assert config_data["permissions"]["write"]["dlo"] == "output_dlo"
+        assert config_data["sdkVersion"] == "1.2.3"
 
 
 class TestCreateDataTransform: