Merge branch 'dev/aviatcohen/supportPrintKeyValue' of https://github.com/aviatco/fabric-cli into dev/aviatcohen/supportPrintKeyValue

Author: aviat cohen

.changes/unreleased/added-20251111-144602.yaml

@@ -0,0 +1,3 @@
+kind: added
+body: support mv/cp/export/import for SqlDatabase
+time: 2025-11-11T14:46:02.635689113Z

.changes/unreleased/fixed-20251111-134254.yaml

@@ -0,0 +1,3 @@
+kind: fixed
+body: Fix create connection with onPremGateway and encryptedCredentials
+time: 2025-11-11T13:42:54.695045434Z

docs/examples/connection_examples.md

@@ -46,6 +46,13 @@ Create a connection that uses a specific gateway for secure access.
 ```
 fab create .connections/conn.Connection -P gateway=MyVnetGateway.Gateway,connectionDetails.type=SQL,connectionDetails.parameters.server=<server>,connectionDetails.parameters.database=sales,credentialDetails.type=Basic,credentialDetails.username=<username>,credentialDetails.password=<password>
 ```
+#### Create Connection with On-premises Gateway
+
+Create a connection that uses a specific on-premises gateway with encrypted credentials for secure access
+
+```
+fab create .connections/conn.Connection -P gateway=MyVnetGateway.Gateway,connectionDetails.type=SQL,connectionDetails.parameters.server=<server>,connectionDetails.parameters.database=sales,credentialDetails.type=Basic,credentialDetails.values=[{"gatewayId":"<gatewayId>", "encryptedCredentials": "<encryptedCredentials>"}]
+```
 
 #### Create Connection with All Parameters
 

src/fabric_cli/core/fab_config/command_support.yaml

@@ -167,6 +167,7 @@ commands:
           - graph_ql_api
           #- lakehouse # this is included just to support underlying /Files
           - dataflow
+          - sql_database
       cp:
         supported_elements:
           - workspace
@@ -192,6 +193,7 @@ commands:
           - graph_ql_api
           #- lakehouse # this is included just to support underlying /Files
           - dataflow
+          - sql_database
       ln:
         supported_elements:
           - onelake
@@ -242,6 +244,7 @@ commands:
           - variable_library
           - graph_ql_api
           - dataflow
+          - sql_database
       import:
         supported_items:
           - report
@@ -262,6 +265,7 @@ commands:
           - variable_library
           - graph_ql_api
           - dataflow
+          - sql_database
       get:
         supported_elements:
           - workspace

src/fabric_cli/errors/common.py

@@ -195,3 +195,13 @@ def missing_connection_creation_method_or_parameters(
         supported_creation_methods: list,
     ) -> str:
         return f"Missing connection creation method and parameters. Please indicate either one of the following creation methods: {supported_creation_methods}, or provide parameters for automatic selection"
+    
+    @staticmethod
+    def missing_onpremises_gateway_parameters(
+        missing_params: list,
+    ) -> str:
+        return  f"Missing parameters for credential values in OnPremisesGateway connectivity type: {missing_params}"
+
+    @staticmethod
+    def invalid_onpremises_gateway_values() -> str:
+        return "Values must be a list of JSON objects, each containing 'gatewayId' and 'encryptedCredentials' keys"

src/fabric_cli/utils/fab_cmd_mkdir_utils.py

@@ -359,33 +359,41 @@ def check_required_params(params, required_params):
             )
 
 
-def _validate_credential_params(cred_type, provided_cred_params):
-    ignored_params = []
-    params = {}
+def _get_params_per_cred_type(cred_type, is_on_premises_gateway):
     match cred_type:
         case "Anonymous" | "WindowsWithoutImpersonation" | "WorkspaceIdentity":
-            param_keys = []
+            return []
         case "Basic" | "Windows":
-            param_keys = ["username", "password"]
+            if is_on_premises_gateway:
+                return ["values"]
+            else:
+                return ["username", "password"]
         case "Key":
-            param_keys = ["key"]
+            return ["key"]
         case "OAuth2":
             raise FabricCLIError(
                 "OAuth2 credential type is not supported",
                 fab_constant.ERROR_NOT_SUPPORTED,
             )
         case "ServicePrincipal":
-            param_keys = [
+            return [
                 "servicePrincipalClientId",
                 "servicePrincipalSecret",
                 "tenantId",
             ]
         case "SharedAccessSignature":
-            param_keys = ["token"]
+            return ["token"]
         case _:
             utils_ui.print_warning(
                 f"Unsupported credential type {cred_type}. Skipping validation"
             )
+            return []
+    
+
+def _validate_credential_params(cred_type, provided_cred_params, is_on_premises_gateway):
+    ignored_params = []
+    params = {}
+    param_keys = _get_params_per_cred_type(cred_type, is_on_premises_gateway)
 
     missing_params = [
         key for key in param_keys if key.lower() not in provided_cred_params
@@ -405,12 +413,46 @@ def _validate_credential_params(cred_type, provided_cred_params):
         utils_ui.print_warning(
             f"Ignoring unsupported parameters for credential type {cred_type}: {ignored_params}"
         )
+    if is_on_premises_gateway:
+        provided_cred_params["values"] = _validate_and_get_on_premises_gateway_credential_values(provided_cred_params.get("values"))
 
     for key in param_keys:
         params[key] = provided_cred_params[key.lower()]
 
     return params
 
+def _validate_and_get_on_premises_gateway_credential_values(cred_values):
+    for item in cred_values:
+        if not isinstance(item, dict):
+            raise FabricCLIError(
+                ErrorMessages.Common.invalid_onpremises_gateway_values(),
+                fab_constant.ERROR_INVALID_INPUT,
+            )
+        
+    param_values_keys = ["gatewayId", "encryptedCredentials"]
+    missing_params = [
+        key for key in param_values_keys 
+        if not all(key.lower() in {k.lower() for k in item.keys()} for item in cred_values)
+    ]
+    if len(missing_params) > 0:
+        raise FabricCLIError(
+            ErrorMessages.Common.missing_onpremises_gateway_parameters(missing_params),
+            fab_constant.ERROR_INVALID_INPUT,
+    )
+
+    ignored_params = [
+        key
+        for item in cred_values
+        for key in item.keys()
+        if key not in [k.lower() for k in param_values_keys]
+    ]
+    if len(ignored_params) > 0:
+        utils_ui.print_warning(
+            f"Ignoring unsupported parameters for on-premises gateway: {ignored_params}"
+    )
+
+    return [{key: item[key.lower()] for key in param_values_keys if key.lower() in item} for item in cred_values]
+
 
 def get_connection_config_from_params(payload, con_type, con_type_def, params):
     connection_request = payload
@@ -537,13 +579,6 @@ def get_connection_config_from_params(payload, con_type, con_type_def, params):
             fab_constant.ERROR_INVALID_INPUT,
         )
 
-    if missing_params:
-        missing_params_str = ", ".join(missing_params)
-        raise FabricCLIError(
-            f"Missing parameter(s) {missing_params_str} for creation method {c_method}",
-            fab_constant.ERROR_INVALID_INPUT,
-        )
-
     connection_request["connectionDetails"] = {
         "type": con_type,
         "creationMethod": creation_method["name"],
@@ -563,6 +598,14 @@ def get_connection_config_from_params(payload, con_type, con_type_def, params):
          "password": "********"
        }
     }
+    or in case of OnPremisesGateway:
+    "credentialDetails": {
+        .....,
+        "credentials": {
+        "credentialType": "Basic",
+        "values": [{gatewayId: "gatewayId", encryptedCredentials: "**********"}] 
+        }
+        }
     """
     sup_cred_types = ", ".join(con_type_def["supportedCredentialTypes"])
     if not params.get("credentialdetails"):
@@ -603,7 +646,8 @@ def get_connection_config_from_params(payload, con_type, con_type_def, params):
     if "skiptestconnection" in provided_cred_params:
         provided_cred_params.pop("skiptestconnection")
 
-    connection_params = _validate_credential_params(cred_type, provided_cred_params)
+    is_on_premises_gateway = connection_request.get("connectivityType").lower() == "onpremisesgateway"
+    connection_params = _validate_credential_params(cred_type, provided_cred_params, is_on_premises_gateway)
 
     connection_request["credentialDetails"] = {
         "singleSignOnType": singleSignOnType,
@@ -613,6 +657,9 @@ def get_connection_config_from_params(payload, con_type, con_type_def, params):
     }
     connection_request["credentialDetails"]["credentials"]["credentialType"] = cred_type
 
+    if is_on_premises_gateway:
+        connection_request["credentialDetails"]["credentials"]["values"] = connection_params.get("values")
+
     return connection_request
 
 

src/fabric_cli/utils/fab_util.py

@@ -121,9 +121,25 @@ def get_dict_from_parameter(
         key, rest = param.split(".", 1)
         return {key: get_dict_from_parameter(rest, value, max_depth, current_depth + 1)}
     else:
-        clean_value = value.replace("'", "").replace('"', "")
+        clean_value = try_get_json_value_from_string(value)
         return {param: clean_value}
 
+def try_get_json_value_from_string(value: str) -> Any:
+    """
+    Try to parse a string as JSON, with special handling for array parameters.
+    
+    Args:
+        value: String that may contain JSON data
+        
+    Returns:
+        Parsed JSON if valid, otherwise original string
+    """
+    if value.strip().startswith('[{') and value.strip().endswith('}]'):
+        try:
+            return json.loads(value)
+        except json.JSONDecodeError:
+            pass        
+    return value.replace("'", "").replace('"', "")
 
 def merge_dicts(dict1: dict, dict2: dict) -> dict:
     """

tests/authoring_tests.md

@@ -93,6 +93,14 @@ For most testing scenarios, the mock values provided in [`static_test_data.py`](
 | `FABRIC_CLI_TEST_CREDENTIAL_DETAILS_USERNAME` | Username for Connection credential details | Username for Connection creation tests |
 | `FABRIC_CLI_TEST_CREDENTIAL_DETAILS_PASSWORD` | Password for Connection  credentialdetails | Password for Connection creation tests|
 
+### On-premesis gateway Details
+
+| Variable | Description | Purpose |
+|----------|-------------|---------|
+| `FABRIC_CLI_TEST_ONPREMISES_GATEWAY_ID` | On-premesis gateway Id for Connection credential details | Gateway Id for Connection creation tests |
+| `FABRIC_CLI_TEST_ONPREMISES_GATEWAY_ENCRYPTED_CREDENTIALS` | On-premesis gateway encrypted credential for Connection encrypted credential details | Encrypted credential for Connection creation tests|
+
+
 ### Mock vs. Actual Values - Best Practices
 
 | Resource Type | Recommended Approach | Example Mock Value | When to Use Actual |

tests/test_commands/api_processors/connection_api_processor.py

@@ -3,7 +3,11 @@
 
 import json
 from tests.test_commands.api_processors.base_api_processor import BaseAPIProcessor
-from tests.test_commands.api_processors.utils import load_response_json_body
+from tests.test_commands.api_processors.utils import (
+    load_request_json_body,
+    load_response_json_body,
+)
+from tests.test_commands.data.static_test_data import get_mock_data, get_static_data
 
 
 class ConnectionAPIProcessor(BaseAPIProcessor):
@@ -13,6 +17,21 @@ def __init__(self, generated_name_mapping):
         self.generated_name_mapping = generated_name_mapping
 
     def try_process_request(self, request) -> bool:
+        uri = request.uri
+        self._mock_gateway_id_in_uri(request)
+        
+        # Handle connection creation and listing
+        if uri.lower() == self.CONNECTIONS_URI.lower():
+            method = request.method
+            if method == "POST":
+                """https://learn.microsoft.com/en-us/rest/api/fabric/core/connections/create-connection?tabs=HTTP"""
+                self._handle_post_request(request)
+            return True
+        
+        # Handle supported connection types with gateway ID query parameter
+        if uri.lower().startswith(f"{self.CONNECTIONS_URI.lower()}/supportedconnectiontypes"):
+            return True
+        
         return False
 
     def try_process_response(self, request, response) -> bool:
@@ -23,6 +42,9 @@ def try_process_response(self, request, response) -> bool:
             if method == "GET":
                 """https://learn.microsoft.com/en-us/rest/api/fabric/core/connections/list-connections?tabs=HTTP"""
                 self._handle_get_response(response)
+            if method == "POST":
+                """https://learn.microsoft.com/en-us/rest/api/fabric/core/connections/create-connection?tabs=HTTP"""
+                self._handle_post_response(response)
             return True
         return False
 
@@ -34,9 +56,56 @@ def _handle_get_response(self, response):
         new_value = []
         for item in data["value"]:
             if item.get("displayName") in self.generated_name_mapping:
+                self._mock_gateway_references(item)
                 new_value.append(item)
 
         data["value"] = new_value
 
         new_body_str = json.dumps(data)
         response["body"]["string"] = new_body_str.encode("utf-8")
+
+    def _handle_post_request(self, request):
+        """Handle POST request for connection creation"""
+        data = load_request_json_body(request)
+        if not data:
+            return
+
+        self._mock_gateway_references(data)
+
+        new_body_str = json.dumps(data)
+        request.body = new_body_str
+
+    def _handle_post_response(self, response):
+        """Handle POST response for connection creation"""
+        data = load_response_json_body(response)
+        if not data:
+            return
+
+        self._mock_gateway_references(data)
+
+        new_body_str = json.dumps(data)
+        response["body"]["string"] = new_body_str.encode("utf-8")
+
+    def _mock_gateway_references(self, obj):
+        """Mock gateway ID references in connection objects"""
+        static_gateway_id = get_static_data().onpremises_gateway_details.id
+        mock_gateway_id = get_mock_data().onpremises_gateway_details.id
+        
+        # Mock direct gatewayId field
+        if "gatewayId" in obj and obj["gatewayId"] == static_gateway_id:
+            obj["gatewayId"] = f"{mock_gateway_id}"
+        
+        # Mock gatewayId in credentialDetails.values arrays
+        if "credentialDetails" in obj and "values" in obj["credentialDetails"]:
+            for cred_value in obj["credentialDetails"]["values"]:
+                if isinstance(cred_value, dict) and "gatewayId" in cred_value:
+                    if cred_value["gatewayId"] == static_gateway_id:
+                        cred_value["gatewayId"] = mock_gateway_id
+
+    def _mock_gateway_id_in_uri(self, request):
+        """Mock gateway IDs in request URIs and query parameters"""
+        static_gateway_id = get_static_data().onpremises_gateway_details.id
+        mock_gateway_id = get_mock_data().onpremises_gateway_details.id
+        
+        # Replace gateway ID in URI path and query parameters
+        request.uri = request.uri.replace(static_gateway_id, mock_gateway_id)