[SNOW-2039995] Implement application path override in CLIENT_ENVIRONMENT (#983)

Author: sfc-gh-makowalski

include/snowflake/client.h

@@ -348,7 +348,8 @@ typedef enum SF_ATTRIBUTE {
     SF_CON_WIF_PROVIDER,
     SF_CON_WIF_TOKEN,
     SF_CON_WIF_AZURE_RESOURCE,
-    SF_CON_WORKLOAD_IDENTITY_IMPERSONATION_PATH
+    SF_CON_WORKLOAD_IDENTITY_IMPERSONATION_PATH,
+    SF_CON_APPLICATION_PATH
 } SF_ATTRIBUTE;
 
 /**
@@ -462,6 +463,9 @@ typedef struct SF_CONNECT {
     // Partner application name
     char * application;
 
+    // Override for APPLICATION_PATH in CLIENT_ENVIRONMENT
+    char * application_path;
+
     // Proxy
     char * proxy;
     char * no_proxy;

lib/client.c

@@ -1236,6 +1236,7 @@ SF_STATUS STDCALL snowflake_term(SF_CONNECT *sf) {
     SF_FREE(sf->application_name);
     SF_FREE(sf->application_version);
     SF_FREE(sf->application);
+    SF_FREE(sf->application_path);
     SF_FREE(sf->timezone);
     SF_FREE(sf->service_name);
     SF_FREE(sf->query_result_format);
@@ -1640,6 +1641,9 @@ SF_STATUS STDCALL snowflake_set_attribute(
         case SF_CON_APPLICATION:
           alloc_buffer_and_copy(&sf->application, value);
           break;
+        case SF_CON_APPLICATION_PATH:
+            alloc_buffer_and_copy(&sf->application_path, value);
+            break;
         case SF_CON_AUTHENTICATOR:
             alloc_buffer_and_copy(&sf->authenticator, value);
             break;
@@ -1908,6 +1912,9 @@ SF_STATUS STDCALL snowflake_get_attribute(
         case SF_CON_APPLICATION:
           *value = sf->application;
           break;
+        case SF_CON_APPLICATION_PATH:
+            *value = sf->application_path;
+            break;
         case SF_CON_AUTHENTICATOR:
             *value = sf->authenticator;
             break;

lib/connection.c

@@ -43,7 +43,13 @@ cJSON *STDCALL create_auth_json_body(SF_CONNECT *sf,
     strcpy(app_path, "/app/path");
 #else
     sf_os_version(os_version, sizeof(os_version));
-    sf_get_callers_executable_path(app_path, sizeof(app_path));
+    // Use application_path override if provided, otherwise detect automatically
+    if (sf->application_path && sf->application_path[0] != '\0') {
+        sf_strncpy(app_path, sizeof(app_path), sf->application_path, sizeof(app_path) - 1);
+        app_path[sizeof(app_path) - 1] = '\0';
+    } else {
+        sf_get_callers_executable_path(app_path, sizeof(app_path));
+    }
 #endif
     snowflake_cJSON_AddStringToObject(client_env, "OS_VERSION", os_version);
     snowflake_cJSON_AddStringToObject(client_env, "APPLICATION_PATH", app_path);

tests/test_multiple_statements.c

@@ -177,7 +177,7 @@ void test_multi_stmt_with_large_result(void **unused)
     status = snowflake_query(sfstmt,
                              "create or replace temporary table test_multi_large(c1 number, c2 number);\n"
                              "insert into test_multi_large select seq4(), TO_VARCHAR(seq4()) from table(generator(rowcount => 100000));\n"
-                             "select * from test_multi_large",
+                             "select * from test_multi_large order by c1",
                              0);
     if (status != SF_STATUS_SUCCESS) {
         dump_error(&(sfstmt->error));
@@ -335,7 +335,7 @@ void test_multi_stmt_arrow_format(void **unused)
     status = snowflake_query(sfstmt,
                              "create or replace temporary table test_multi_large(c1 number, c2 number);\n"
                              "insert into test_multi_large select seq4(), TO_VARCHAR(seq4()) from table(generator(rowcount => 100000));\n"
-                             "select * from test_multi_large",
+                             "select * from test_multi_large order by c1",
                              0);
     if (status != SF_STATUS_SUCCESS) {
         dump_error(&(sfstmt->error));

tests/test_unit_mfa_auth.c

@@ -8,6 +8,7 @@
  */
 void test_json_data_in_MFA_Auth(void **unused)
 {
+    SF_UNUSED(unused);
     SF_CONNECT* sf = (SF_CONNECT*)SF_CALLOC(1, sizeof(SF_CONNECT));
     sf->account = "testaccount";
     sf->host = "testaccount.snowflakecomputing.com";
@@ -62,11 +63,66 @@ void test_json_data_in_MFA_Auth(void **unused)
     SF_FREE(sf);
 }
 
+/**
+ * Test that application_path override is used in CLIENT_ENVIRONMENT.
+ */
+void test_application_path_override(void **unused)
+{
+    SF_UNUSED(unused);
+    SF_CONNECT* sf = (SF_CONNECT*)SF_CALLOC(1, sizeof(SF_CONNECT));
+    sf->account = "testaccount";
+    sf->host = "testaccount.snowflakecomputing.com";
+    sf->user = "testuser";
+    sf->password = "testpassword";
+    sf->authenticator = SF_AUTHENTICATOR_DEFAULT;
+    sf->application_name = SF_API_NAME;
+    sf->application_version = SF_API_VERSION;
+
+    // Test 1: Without override, APPLICATION_PATH should be auto-detected
+    // (In mock mode it will be "/app/path")
+    cJSON *body = create_auth_json_body(
+        sf,
+        sf->application,
+        sf->application_name,
+        sf->application_version,
+        sf->timezone,
+        sf->autocommit);
+    cJSON* data = snowflake_cJSON_GetObjectItem(body, "data");
+    cJSON* client_env = snowflake_cJSON_GetObjectItem(data, "CLIENT_ENVIRONMENT");
+    cJSON* app_path = snowflake_cJSON_GetObjectItem(client_env, "APPLICATION_PATH");
+
+    assert_non_null(app_path);
+    // In non-mock mode this would be the executable path, in mock mode it's "/app/path"
+    assert_non_null(snowflake_cJSON_GetStringValue(app_path));
+    snowflake_cJSON_Delete(body);
+
+    // Test 2: With override, APPLICATION_PATH should use the custom value
+    sf->application_path = "/custom/path/to/my_script.php";
+
+    body = create_auth_json_body(
+        sf,
+        sf->application,
+        sf->application_name,
+        sf->application_version,
+        sf->timezone,
+        sf->autocommit);
+    data = snowflake_cJSON_GetObjectItem(body, "data");
+    client_env = snowflake_cJSON_GetObjectItem(data, "CLIENT_ENVIRONMENT");
+    app_path = snowflake_cJSON_GetObjectItem(client_env, "APPLICATION_PATH");
+
+    assert_non_null(app_path);
+    assert_string_equal(snowflake_cJSON_GetStringValue(app_path), "/custom/path/to/my_script.php");
+    snowflake_cJSON_Delete(body);
+
+    SF_FREE(sf);
+}
+
 int main(void)
 {
     initialize_test(SF_BOOLEAN_FALSE);
     const struct CMUnitTest tests[] = {
         cmocka_unit_test(test_json_data_in_MFA_Auth),
+        cmocka_unit_test(test_application_path_override),
     };
     int ret = cmocka_run_group_tests(tests, NULL, NULL);
     snowflake_global_term();

tests/test_unit_set_get_attributes.cpp

@@ -30,6 +30,7 @@ std::vector<sf_string_attributes> strAttributes = {
     { SF_CON_TIMEZONE, "test_timezone" },
     { SF_CON_SERVICE_NAME, "test_service_name" },
     { SF_CON_APPLICATION, "test_application" },
+    { SF_CON_APPLICATION_PATH, "/path/to/my/script.php" },
     { SF_CON_PRIV_KEY_FILE, "test_priv_key_file" },
     { SF_CON_PRIV_KEY_FILE_PWD, "test_priv_key_file_pwd" },
     { SF_CON_PROXY, "test_proxy" },