Expose the overwrite parameter in the profile-save functions of the C/C++ APIs (#5695)

This PR exposes the `overwrite` parameter in the profile save functions
of the C and C++ APIs. This is good-to-have for high level APIs.

Closes CORE-433

---
TYPE: C_API
DESC: Expose the `overwrite` parameter in `tiledb_profile_save`.

---
TYPE: CPP_API
DESC: Expose the `overwrite` parameter in `Profile::save`.

Author: kounelisagis

test/src/unit-cppapi-profile.cc

@@ -374,3 +374,31 @@ TEST_CASE(
       loaded_explicit_profile.get_param("rest.server_address") ==
       "https://explicit.server");
 }
+
+TEST_CASE_METHOD(
+    ProfileCPPFx,
+    "C++ API: Profile::save with overwrite",
+    "[cppapi][profile][save][overwrite]") {
+  Profile p1(name_, tempdir_.path());
+  p1.set_param("rest.token", "token1");
+  p1.save();
+
+  // Attempt to save again without overwrite should fail
+  Profile p2(name_, tempdir_.path());
+  p2.set_param("rest.token", "token2");
+  REQUIRE_THROWS_WITH(
+      p2.save(false),
+      Catch::Matchers::ContainsSubstring(
+          "This profile already exists. Use the overwrite parameter"));
+
+  // Verify that the original profile is unchanged
+  Profile loaded1 = Profile::load(name_, tempdir_.path());
+  REQUIRE(loaded1.get_param("rest.token") == "token1");
+
+  // Save with overwrite=true should succeed
+  REQUIRE_NOTHROW(p2.save(true));
+
+  // Verify that the profile was updated
+  Profile loaded2 = Profile::load(name_, tempdir_.path());
+  REQUIRE(loaded2.get_param("rest.token") == "token2");
+}

tiledb/api/c_api/profile/profile_api.cc

@@ -102,9 +102,10 @@ capi_return_t tiledb_profile_get_param(
   return TILEDB_OK;
 }
 
-capi_return_t tiledb_profile_save(tiledb_profile_t* profile) {
+capi_return_t tiledb_profile_save(
+    tiledb_profile_t* profile, uint8_t overwrite) {
   ensure_profile_is_valid(profile);
-  profile->profile()->save_to_file();
+  profile->profile()->save_to_file(overwrite != 0);
   return TILEDB_OK;
 }
 
@@ -189,8 +190,12 @@ CAPI_INTERFACE(
 }
 
 CAPI_INTERFACE(
-    profile_save, tiledb_profile_t* profile, tiledb_error_t** error) {
-  return api_entry_error<tiledb::api::tiledb_profile_save>(error, profile);
+    profile_save,
+    tiledb_profile_t* profile,
+    uint8_t overwrite,
+    tiledb_error_t** error) {
+  return api_entry_error<tiledb::api::tiledb_profile_save>(
+      error, profile, overwrite);
 }
 
 CAPI_INTERFACE(

tiledb/api/c_api/profile/profile_api_experimental.h

@@ -183,12 +183,15 @@ TILEDB_EXPORT capi_return_t tiledb_profile_get_param(
  * Saves the given profile to the local file.
  *
  * @param[in] profile The profile.
+ * @param[in] overwrite If non-zero, overwrite the existing profile.
  * @param[out] error Error object returned upon error (`NULL` if there is no
  * error).
  * @return TILEDB_EXPORT
  */
 TILEDB_EXPORT capi_return_t tiledb_profile_save(
-    tiledb_profile_t* profile, tiledb_error_t** error) TILEDB_NOEXCEPT;
+    tiledb_profile_t* profile,
+    uint8_t overwrite,
+    tiledb_error_t** error) TILEDB_NOEXCEPT;
 
 /**
  * Loads a profile from the local file.

tiledb/api/c_api/profile/test/unit_capi_profile.cc

@@ -229,11 +229,11 @@ TEST_CASE_METHOD(
   tiledb_profile_alloc(name_, dir_.c_str(), &profile, &err);
   REQUIRE(profile != nullptr);
   SECTION("success") {
-    rc = tiledb_profile_save(profile, &err);
+    rc = tiledb_profile_save(profile, 0, &err);
     REQUIRE(tiledb_status(rc) == TILEDB_OK);
   }
   SECTION("null profile") {
-    rc = tiledb_profile_save(nullptr, &err);
+    rc = tiledb_profile_save(nullptr, 0, &err);
     REQUIRE(tiledb_status(rc) == TILEDB_ERR);
   }
 
@@ -249,7 +249,7 @@ TEST_CASE_METHOD(
   tiledb_error_t* err = nullptr;
   tiledb_profile_alloc(name_, dir_.c_str(), &profile, &err);
   REQUIRE(profile != nullptr);
-  rc = tiledb_profile_save(profile, &err);
+  rc = tiledb_profile_save(profile, 0, &err);
   REQUIRE(tiledb_status(rc) == TILEDB_OK);
   tiledb_profile_t* loaded_profile;
   // Use the same name and directory
@@ -275,7 +275,7 @@ TEST_CASE_METHOD(
   tiledb_profile_alloc(name_, dir_.c_str(), &profile, &err);
   REQUIRE(profile != nullptr);
   SECTION("success") {
-    rc = tiledb_profile_save(profile, &err);
+    rc = tiledb_profile_save(profile, 0, &err);
     REQUIRE(tiledb_status(rc) == TILEDB_OK);
     rc = tiledb_profile_remove(name_, dir_.c_str(), &err);
     REQUIRE(tiledb_status(rc) == TILEDB_OK);
@@ -309,3 +309,55 @@ TEST_CASE_METHOD(
 
   tiledb_profile_free(&profile);
 }
+
+TEST_CASE_METHOD(
+    CAPINProfileFx,
+    "C API: tiledb_profile_save with overwrite",
+    "[capi][profile][save][overwrite]") {
+  capi_return_t rc;
+  tiledb_profile_t* p1;
+  tiledb_error_t* err = nullptr;
+  tiledb_profile_alloc(name_, dir_.c_str(), &p1, &err);
+  tiledb_profile_set_param(p1, "rest.token", "token1", &err);
+  rc = tiledb_profile_save(p1, 0, &err);
+  REQUIRE(tiledb_status(rc) == TILEDB_OK);
+
+  // Attempt to save again without overwrite should fail
+  tiledb_profile_t* p2;
+  tiledb_profile_alloc(name_, dir_.c_str(), &p2, &err);
+  tiledb_profile_set_param(p2, "rest.token", "token2", &err);
+  rc = tiledb_profile_save(p2, 0, &err);
+  REQUIRE(tiledb_status(rc) == TILEDB_ERR);
+  REQUIRE(err != nullptr);
+  tiledb_error_free(&err);
+
+  // Verify that the original profile is unchanged
+  tiledb_profile_t* loaded1;
+  tiledb_profile_alloc(name_, dir_.c_str(), &loaded1, &err);
+  tiledb_profile_load(loaded1, &err);
+
+  tiledb_string_t* value;
+  tiledb_profile_get_param(loaded1, "rest.token", &value, &err);
+  const char* value_ptr;
+  size_t value_len;
+  tiledb_string_view(value, &value_ptr, &value_len);
+  CHECK(std::string(value_ptr, value_len) == "token1");
+
+  // Save with overwrite=1 should succeed
+  rc = tiledb_profile_save(p2, 1, &err);
+  REQUIRE(tiledb_status(rc) == TILEDB_OK);
+
+  // Verify that the profile is updated
+  tiledb_profile_t* loaded2;
+  tiledb_profile_alloc(name_, dir_.c_str(), &loaded2, &err);
+  tiledb_profile_load(loaded2, &err);
+  tiledb_profile_get_param(loaded2, "rest.token", &value, &err);
+  tiledb_string_view(value, &value_ptr, &value_len);
+  CHECK(std::string(value_ptr, value_len) == "token2");
+
+  tiledb_string_free(&value);
+  tiledb_profile_free(&p1);
+  tiledb_profile_free(&p2);
+  tiledb_profile_free(&loaded1);
+  tiledb_profile_free(&loaded2);
+}

tiledb/sm/cpp_api/profile_experimental.h

@@ -229,10 +229,15 @@ class Profile {
     return ret;
   }
 
-  /** Saves the profile to the local file. */
-  void save() {
+  /**
+   * Saves the profile to the local file.
+   *
+   * @param overwrite If true, overwrite the existing profile.
+   */
+  void save(bool overwrite = false) {
     tiledb_error_t* capi_error = nullptr;
-    int rc = tiledb_profile_save(profile_.get(), &capi_error);
+    int rc =
+        tiledb_profile_save(profile_.get(), overwrite ? 1 : 0, &capi_error);
     if (rc != TILEDB_OK) {
       const char* msg_cstr;
       tiledb_error_message(capi_error, &msg_cstr);

tiledb/sm/rest/rest_profile.cc

@@ -219,8 +219,8 @@ void RestProfile::save_to_file(const bool overwrite) {
       if (data.contains(name_) && !overwrite) {
         throw RestProfileException(
             "Failed to save '" + name_ +
-            "'; This profile has already been saved "
-            "and must be explicitly removed in order to be replaced.");
+            "'; This profile already exists. "
+            "Use the overwrite parameter to replace it.");
       }
 
       if (overwrite) {

tiledb/sm/rest/test/unit_rest_profile.cc

@@ -196,8 +196,8 @@ TEST_CASE_METHOD(
   REQUIRE_THROWS_WITH(
       p2.save_to_file(),
       Catch::Matchers::Equals("RestProfile: Failed to save 'default'; This "
-                              "profile has already been saved and must be "
-                              "explicitly removed in order to be replaced."));
+                              "profile already exists. "
+                              "Use the overwrite parameter to replace it."));
   RestProfile::remove_profile(std::nullopt, dir_);
   p2.save_to_file();
 
@@ -271,3 +271,33 @@ TEST_CASE_METHOD(
         Catch::Matchers::ContainsSubstring("Error parsing file"));
   }
 }
+
+TEST_CASE_METHOD(
+    RestProfileFx,
+    "REST Profile: save_to_file with overwrite",
+    "[rest_profile][save][overwrite]") {
+  RestProfile p1(create_profile());
+  p1.set_param("rest.token", "token1");
+  p1.save_to_file();
+
+  // Attempt to save again without overwrite should fail
+  RestProfile p2(create_profile());
+  p2.set_param("rest.token", "token2");
+  REQUIRE_THROWS_WITH(
+      p2.save_to_file(false),
+      Catch::Matchers::ContainsSubstring(
+          "This profile already exists. Use the overwrite parameter"));
+
+  // Verify that the original profile is unchanged
+  RestProfile loaded1(create_profile());
+  loaded1.load_from_file();
+  CHECK(*loaded1.get_param("rest.token") == "token1");
+
+  // Save with overwrite=true should succeed
+  REQUIRE_NOTHROW(p2.save_to_file(true));
+
+  // Verify that the profile is updated
+  RestProfile loaded2(create_profile());
+  loaded2.load_from_file();
+  CHECK(*loaded2.get_param("rest.token") == "token2");
+}