Merge pull request #74 from forcedotcom/jo_deploy_sf-cli

deploy sf cli flag and sanitization

Author: joroscoSF

src/datacustomcode/cli.py

@@ -160,6 +160,11 @@ def zip(path: str, network: str):
     Choose based on your workload requirements.""",
 )
 @click.option("--function-invoke-opt")
+@click.option(
+    "--sf-cli-org",
+    default=None,
+    help="SF CLI org alias or username. Fetches credentials via `sf org display`.",
+)
 def deploy(
     path: str,
     name: str,
@@ -169,15 +174,19 @@ def deploy(
     profile: str,
     network: str,
     function_invoke_opt: str,
+    sf_cli_org: Optional[str],
 ):
     from datacustomcode.credentials import Credentials
-    from datacustomcode.deploy import CodeExtensionMetadata, deploy_full
+    from datacustomcode.deploy import (
+        COMPUTE_TYPES,
+        AccessTokenResponse,
+        CodeExtensionMetadata,
+        _retrieve_access_token_from_sf_cli,
+        deploy_full,
+    )
 
     logger.debug("Deploying project")
 
-    # Validate compute type
-    from datacustomcode.deploy import COMPUTE_TYPES
-
     if cpu_size not in COMPUTE_TYPES.keys():
         click.secho(
             f"Error: Invalid CPU size '{cpu_size}'. "
@@ -208,15 +217,23 @@ def deploy(
             function_invoke_options = function_invoke_opt.split(",")
             metadata.functionInvokeOptions = function_invoke_options
 
-    try:
-        credentials = Credentials.from_available(profile=profile)
-    except ValueError as e:
-        click.secho(
-            f"Error: {e}",
-            fg="red",
-        )
-        raise click.Abort() from None
-    deploy_full(path, metadata, credentials, network)
+    auth: Union[Credentials, AccessTokenResponse]
+    if sf_cli_org:
+        try:
+            auth = _retrieve_access_token_from_sf_cli(sf_cli_org)
+        except RuntimeError as e:
+            click.secho(f"Error: {e}", fg="red")
+            raise click.Abort() from None
+    else:
+        try:
+            auth = Credentials.from_available(profile=profile)
+        except ValueError as e:
+            click.secho(
+                f"Error: {e}",
+                fg="red",
+            )
+            raise click.Abort() from None
+    deploy_full(path, metadata, auth, network)
 
 
 @cli.command()

src/datacustomcode/deploy.py

@@ -17,7 +17,9 @@
 from html import unescape
 import json
 import os
+import re
 import shutil
+import subprocess
 import tempfile
 import time
 from typing import (
@@ -57,6 +59,19 @@
 }
 
 
+def _sanitize_api_name(name: str) -> str:
+    """Sanitize an API name to comply with Salesforce naming rules.
+
+    Replaces spaces and hyphens with underscores, removes invalid characters,
+    collapses consecutive underscores, and strips leading/trailing underscores.
+    """
+    sanitized = re.sub(r"[ \-]", "_", name)
+    sanitized = re.sub(r"[^\w]", "", sanitized)
+    sanitized = re.sub(r"_+", "_", sanitized)
+    sanitized = sanitized.strip("_")
+    return sanitized
+
+
 class CodeExtensionMetadata(BaseModel):
     name: str
     version: str
@@ -66,6 +81,24 @@ class CodeExtensionMetadata(BaseModel):
     functionInvokeOptions: Union[list[str], None] = None
 
     def __init__(self, **data):
+        name = data.get("name", "")
+        sanitized = _sanitize_api_name(name)
+        if sanitized != name:
+            logger.warning(f"API name '{name}' was sanitized to '{sanitized}'")
+            data["name"] = sanitized
+        if not sanitized:
+            raise ValueError(
+                f"API name '{name}' is invalid and could not be sanitized to a"
+                " valid name."
+            )
+        if not sanitized[0].isalpha():
+            raise ValueError(
+                f"API name '{sanitized}' must begin with a letter. "
+                "The name can only contain underscores and alphanumeric"
+                " characters, must begin with a letter, not include spaces,"
+                " not end with an underscore, and not contain two consecutive"
+                " underscores."
+            )
         super().__init__(**data)
 
 
@@ -156,6 +189,54 @@ def _retrieve_access_token(credentials: Credentials) -> AccessTokenResponse:
     return AccessTokenResponse(**response)
 
 
+def _retrieve_access_token_from_sf_cli(sf_cli_org: str) -> AccessTokenResponse:
+    """Get an access token from the Salesforce CLI."""
+    try:
+        result = subprocess.run(
+            ["sf", "org", "display", "--target-org", sf_cli_org, "--json"],
+            capture_output=True,
+            text=True,
+            check=True,
+            timeout=30,
+        )
+    except FileNotFoundError as exc:
+        raise RuntimeError(
+            "The 'sf' command was not found. "
+            "Please install Salesforce CLI: https://developer.salesforce.com/tools/salesforcecli"
+        ) from exc
+    except subprocess.TimeoutExpired as exc:
+        raise RuntimeError(
+            f"'sf org display' timed out for org '{sf_cli_org}'"
+        ) from exc
+    except subprocess.CalledProcessError as exc:
+        raise RuntimeError(
+            f"'sf org display' failed for org '{sf_cli_org}'.\n"
+            f"Ensure the org is authenticated via 'sf org login web'.\n"
+            f"stderr: {exc.stderr.strip()}"
+        ) from exc
+
+    try:
+        data = json.loads(result.stdout)
+    except json.JSONDecodeError as exc:
+        raise RuntimeError(f"Failed to parse 'sf org display' output: {exc}") from exc
+
+    if data.get("status") != 0:
+        raise RuntimeError(
+            f"SF CLI error for org '{sf_cli_org}': "
+            f"{data.get('message', 'unknown error')}"
+        )
+
+    org_result = data.get("result", {})
+    access_token = org_result.get("accessToken")
+    instance_url = org_result.get("instanceUrl")
+    if not access_token or not instance_url:
+        raise RuntimeError(
+            f"'sf org display' did not return an access token or instance URL "
+            f"for org '{sf_cli_org}'"
+        )
+    return AccessTokenResponse(access_token=access_token, instance_url=instance_url)
+
+
 class CreateDeploymentResponse(BaseModel):
     fileUploadUrl: str
 
@@ -463,12 +544,15 @@ def zip(
 def deploy_full(
     directory: str,
     metadata: CodeExtensionMetadata,
-    credentials: Credentials,
+    credentials: Union["Credentials", AccessTokenResponse],
     docker_network: str,
     callback=None,
 ) -> AccessTokenResponse:
     """Deploy a data transform in the DataCloud."""
-    access_token = _retrieve_access_token(credentials)
+    if isinstance(credentials, AccessTokenResponse):
+        access_token = credentials
+    else:
+        access_token = _retrieve_access_token(credentials)
 
     # prepare payload
     config = get_config(directory)

tests/test_cli.py

@@ -5,6 +5,7 @@
 from click.testing import CliRunner
 
 from datacustomcode.cli import deploy, init
+from datacustomcode.deploy import AccessTokenResponse
 from datacustomcode.scan import write_sdk_config
 
 
@@ -91,7 +92,9 @@ def test_deploy_command_success(self, mock_credentials, mock_deploy_full):
             # Check that deploy_full was called with correct arguments
             call_args = mock_deploy_full.call_args
             assert call_args[0][0] == "payload"  # path
-            assert call_args[0][1].name == "test-job"  # metadata
+            assert (
+                call_args[0][1].name == "test_job"
+            )  # metadata (hyphen sanitized to underscore)
             assert call_args[0][1].version == "1.0.0"
             assert call_args[0][1].description == "Custom Data Transform Code"
             assert call_args[0][2] == mock_creds  # credentials
@@ -180,3 +183,39 @@ def test_deploy_command_custom_description(
             # Check that deploy_full was called with custom description
             call_args = mock_deploy_full.call_args
             assert call_args[0][1].description == "Custom description"
+
+    @patch("datacustomcode.deploy.deploy_full")
+    @patch("datacustomcode.deploy._retrieve_access_token_from_sf_cli")
+    def test_deploy_command_sf_cli_org(self, mock_sf_cli_token, mock_deploy_full):
+        """Test deploy command with --sf-cli-org flag."""
+        mock_token = AccessTokenResponse(
+            access_token="test_token", instance_url="https://test.salesforce.com"
+        )
+        mock_sf_cli_token.return_value = mock_token
+
+        runner = CliRunner()
+        with runner.isolated_filesystem():
+            os.makedirs("payload", exist_ok=True)
+            result = runner.invoke(
+                deploy, ["--name", "test-job", "--sf-cli-org", "my-org"]
+            )
+
+            assert result.exit_code == 0
+            mock_sf_cli_token.assert_called_once_with("my-org")
+            mock_deploy_full.assert_called_once()
+            call_args = mock_deploy_full.call_args
+            assert call_args[0][2] == mock_token  # AccessTokenResponse passed directly
+
+    @patch("datacustomcode.deploy._retrieve_access_token_from_sf_cli")
+    def test_deploy_command_sf_cli_org_error(self, mock_sf_cli_token):
+        """Test deploy command when --sf-cli-org fails."""
+        mock_sf_cli_token.side_effect = RuntimeError("sf command not found")
+
+        runner = CliRunner()
+        with runner.isolated_filesystem():
+            os.makedirs("payload", exist_ok=True)
+            result = runner.invoke(
+                deploy, ["--name", "test-job", "--sf-cli-org", "bad-org"]
+            )
+            assert result.exit_code == 1
+            assert "sf command not found" in result.output