Feature: Allow for the group and user functions to not require a write value.

Several of these functions can be used to just check the validity of an ID or name.
Use the NULL pointer case to support this rather than writing a completely new functions for this logic.

For example, the `f_account_group_id_by_name()` function can have NULL for the `id` parameter.
In this case, nothing is written for the `id` and the function does not error out on invalid parameter (for when `id` is NULL).
The same logic is applied for the `f_account_group_name_by_id()` for the `name` parameter.

The same logic is applied for both user functions.

The account by functions are not updated as this is not needed.
Update the documentation for the account by functions, documenting that NULL is not allowed.

diff --git a/level_0/f_account/c/account.c b/level_0/f_account/c/account.c
index a7424ea676c26ab7198726dbb9aab0610c4b2dac..388b4cde6fdfa33689b96184b986812e46bb2f12 100644 (file)
--- a/level_0/f_account/c/account.c
+++ b/level_0/f_account/c/account.c
@@ -163,9 +163,6 @@ extern "C" {
 
 #ifndef _di_f_account_group_id_by_name_
   f_status_t f_account_group_id_by_name(const f_string_static_t name, f_gid_t * const id) {
-    #ifndef _di_level_0_parameter_checking_
-      if (!id) return F_status_set_error(F_parameter);
-    #endif // _di_level_0_parameter_checking_
 
     const size_t length_max = sysconf(_SC_GETPW_R_SIZE_MAX);
 
@@ -204,7 +201,9 @@ extern "C" {
       else {
         if (!pointer) return F_exist_not;
 
-        *id = (f_gid_t) group_data.gr_gid;
+        if (id) {
+          *id = (f_gid_t) group_data.gr_gid;
+        }
 
         return F_okay;
       }
@@ -229,7 +228,9 @@ extern "C" {
 
     if (!pointer) return F_exist_not;
 
-    *id = group_data.gr_gid;
+    if (id) {
+      *id = group_data.gr_gid;
+    }
 
     return F_okay;
   }
@@ -237,11 +238,10 @@ extern "C" {
 
 #ifndef _di_f_account_group_name_by_id_
   f_status_t f_account_group_name_by_id(const f_gid_t id, f_string_dynamic_t * const name) {
-    #ifndef _di_level_0_parameter_checking_
-      if (!name) return F_status_set_error(F_parameter);
-    #endif // _di_level_0_parameter_checking_
 
-    name->used = 0;
+    if (name) {
+      name->used = 0;
+    }
 
     f_status_t status = F_okay;
 
@@ -282,17 +282,19 @@ extern "C" {
       else {
         if (!pointer) return F_exist_not;
 
-        const f_number_unsigned_t name_length = strnlen(group_data.gr_name, length);
+        if (name) {
+          const f_number_unsigned_t name_length = strnlen(group_data.gr_name, length);
 
-        name->used = 0;
+          name->used = 0;
 
-        status = f_memory_array_increase_by(name_length + 1, sizeof(f_char_t), (void **) &name->string, &name->used, &name->size);
-        if (F_status_is_error(status)) return status;
+          status = f_memory_array_increase_by(name_length + 1, sizeof(f_char_t), (void **) &name->string, &name->used, &name->size);
+          if (F_status_is_error(status)) return status;
 
-        memcpy(name->string, group_data.gr_name, sizeof(f_char_t) * name_length);
+          memcpy(name->string, group_data.gr_name, sizeof(f_char_t) * name_length);
 
-        name->string[name_length] = 0;
-        name->used = name_length;
+          name->string[name_length] = 0;
+          name->used = name_length;
+        }
 
         return F_okay;
       }
@@ -319,15 +321,15 @@ extern "C" {
 
     const f_number_unsigned_t name_length = strnlen(group_data.gr_name, length);
 
-    name->used = 0;
-
-    status = f_memory_array_increase_by(name_length + 1, sizeof(f_char_t), (void **) &name->string, &name->used, &name->size);
-    if (F_status_is_error(status)) return status;
+    if (name) {
+      status = f_memory_array_increase_by(name_length + 1, sizeof(f_char_t), (void **) &name->string, &name->used, &name->size);
+      if (F_status_is_error(status)) return status;
 
-    memcpy(name->string, group_data.gr_name, sizeof(f_char_t) * name_length);
+      memcpy(name->string, group_data.gr_name, sizeof(f_char_t) * name_length);
 
-    name->string[name_length] = 0;
-    name->used = name_length;
+      name->string[name_length] = 0;
+      name->used = name_length;
+    }
 
     return F_okay;
   }
@@ -335,9 +337,6 @@ extern "C" {
 
 #ifndef _di_f_account_id_by_name_
   f_status_t f_account_id_by_name(const f_string_static_t name, f_uid_t * const id) {
-    #ifndef _di_level_0_parameter_checking_
-      if (!id) return F_status_set_error(F_parameter);
-    #endif // _di_level_0_parameter_checking_
 
     const size_t length_max = sysconf(_SC_GETPW_R_SIZE_MAX);
 
@@ -376,7 +375,9 @@ extern "C" {
       else {
         if (!pointer) return F_exist_not;
 
-        *id = (f_uid_t) password.pw_uid;
+        if (id) {
+          *id = (f_uid_t) password.pw_uid;
+        }
 
         return F_okay;
       }
@@ -401,7 +402,9 @@ extern "C" {
 
     if (!pointer) return F_exist_not;
 
-    *id = (f_uid_t) password.pw_uid;
+    if (id) {
+      *id = (f_uid_t) password.pw_uid;
+    }
 
     return F_okay;
   }
@@ -409,11 +412,10 @@ extern "C" {
 
 #ifndef _di_f_account_name_by_id_
   f_status_t f_account_name_by_id(const f_uid_t id, f_string_dynamic_t * const name) {
-    #ifndef _di_level_0_parameter_checking_
-      if (!name) return F_status_set_error(F_parameter);
-    #endif // _di_level_0_parameter_checking_
 
-    name->used = 0;
+    if (name) {
+      name->used = 0;
+    }
 
     f_status_t status = F_okay;
 
@@ -456,15 +458,15 @@ extern "C" {
 
         const f_number_unsigned_t name_length = strnlen(password.pw_name, length);
 
-        name->used = 0;
-
-        status = f_memory_array_increase_by(name_length + 1, sizeof(f_char_t), (void **) &name->string, &name->used, &name->size);
-        if (F_status_is_error(status)) return status;
+        if (name) {
+          status = f_memory_array_increase_by(name_length + 1, sizeof(f_char_t), (void **) &name->string, &name->used, &name->size);
+          if (F_status_is_error(status)) return status;
 
-        memcpy(name->string, password.pw_name, sizeof(f_char_t) * name_length);
+          memcpy(name->string, password.pw_name, sizeof(f_char_t) * name_length);
 
-        name->string[name_length] = 0;
-        name->used = name_length;
+          name->string[name_length] = 0;
+          name->used = name_length;
+        }
 
         return F_okay;
       }
@@ -491,15 +493,15 @@ extern "C" {
 
     const f_number_unsigned_t name_length = strnlen(password.pw_name, length);
 
-    name->used = 0;
+    if (name) {
+      status = f_memory_array_increase_by(name_length + 1, sizeof(f_char_t), (void **) &name->string, &name->used, &name->size);
+      if (F_status_is_error(status)) return status;
 
-    status = f_memory_array_increase_by(name_length + 1, sizeof(f_char_t), (void **) &name->string, &name->used, &name->size);
-    if (F_status_is_error(status)) return status;
+      memcpy(name->string, password.pw_name, sizeof(f_char_t) * name_length);
 
-    memcpy(name->string, password.pw_name, sizeof(f_char_t) * name_length);
-
-    name->string[name_length] = 0;
-    name->used = name_length;
+      name->string[name_length] = 0;
+      name->used = name_length;
+    }
 
     return F_okay;
   }

diff --git a/level_0/f_account/c/account.h b/level_0/f_account/c/account.h
index f05eda567ea9c18e8f4544c271263bd1673bfa31..4119abe39657fbf4763a6c8c6417338a06096534 100644 (file)
--- a/level_0/f_account/c/account.h
+++ b/level_0/f_account/c/account.h
@@ -42,6 +42,8 @@ extern "C" {
  *   This is replaced with by the account information.
  *   All strings will be NULL terminated.
  *
+ *   Must not be NULL.
+ *
  * @return
  *   F_okay on success.
  *
@@ -75,6 +77,8 @@ extern "C" {
  *   This is replaced with by the account information.
  *   All strings will be NULL terminated.
  *
+ *   Must not be NULL.
+ *
  * @return
  *   F_okay on success.
  *
@@ -106,6 +110,9 @@ extern "C" {
  * @param id
  *   The id associated with the given name.
  *
+ *   If NULL, then then this doesn't return the ID.
+ *   This is useful for determining the validity of an ID without actually caring about the value itself.
+ *
  * @return
  *   F_okay on success.
  *
@@ -133,6 +140,9 @@ extern "C" {
  *   This is replaced with by the group name.
  *   The name will be NULL terminated after the name.used.
  *
+ *   If NULL, then then this doesn't return the name.
+ *   This is useful for determining the validity of an ID without actually caring about the value itself.
+ *
  * @return
  *   F_okay on success.
  *
@@ -164,6 +174,9 @@ extern "C" {
  * @param id
  *   The id associated with the given name.
  *
+ *   If NULL, then then this doesn't return the ID.
+ *   This is useful for determining the validity of an ID without actually caring about the value itself.
+ *
  * @return
  *   F_okay on success.
  *
@@ -191,6 +204,9 @@ extern "C" {
  *   This is replaced with by the user name.
  *   The name will be NULL terminated after the name.used.
  *
+ *   If NULL, then then this doesn't return the name.
+ *   This is useful for determining the validity of an ID without actually caring about the value itself.
+ *
  * @return
  *   F_okay on success.
  *

diff --git a/level_0/f_account/tests/unit/c/test-account-group_id_by_name.c b/level_0/f_account/tests/unit/c/test-account-group_id_by_name.c
index b8167c651570485f6eecebc7d820f639176090e9..e2b55c98791281c8ba0e276b66e2df8cb1358587 100644 (file)
--- a/level_0/f_account/tests/unit/c/test-account-group_id_by_name.c
+++ b/level_0/f_account/tests/unit/c/test-account-group_id_by_name.c
@@ -68,16 +68,16 @@ void test__f_account_group_id_by_name__not_found(void **state) {
 
     assert_int_equal(status, F_exist_not);
   }
-}
-
-void test__f_account_group_id_by_name__parameter_checking(void **state) {
-
-  const f_string_static_t name = f_string_static_t_initialize;
 
   {
+    will_return(__wrap_sysconf, size);
+    will_return(__wrap_getgrnam_r, false);
+    will_return(__wrap_getgrnam_r, &group_data);
+    will_return(__wrap_getgrnam_r, (struct group *) 0);
+
     const f_status_t status = f_account_group_id_by_name(name, 0);
 
-    assert_int_equal(status, F_status_set_error(F_parameter));
+    assert_int_equal(status, F_exist_not);
   }
 }
 
@@ -110,6 +110,20 @@ void test__f_account_group_id_by_name__works(void **state) {
     assert_int_equal(status, F_okay);
     assert_int_equal(gid, group_data.gr_gid);
   }
+
+  {
+    will_return(__wrap_sysconf, size);
+    will_return(__wrap_getgrnam_r, false);
+    will_return(__wrap_getgrnam_r, &group_data);
+    will_return(__wrap_getgrnam_r, &pointer);
+
+    name.string = group_data.gr_name;
+    name.used = strlen(group_data.gr_name);
+
+    const f_status_t status = f_account_group_id_by_name(name, 0);
+
+    assert_int_equal(status, F_okay);
+  }
 }
 
 #ifdef __cplusplus

diff --git a/level_0/f_account/tests/unit/c/test-account-group_id_by_name.h b/level_0/f_account/tests/unit/c/test-account-group_id_by_name.h
index c4093a3263113f224b3c688c3c0a9035d486af1e..27cebae208a7f7584aa6a479d701a9a9abe2d596 100644 (file)
--- a/level_0/f_account/tests/unit/c/test-account-group_id_by_name.h
+++ b/level_0/f_account/tests/unit/c/test-account-group_id_by_name.h
@@ -25,13 +25,6 @@ extern void test__f_account_group_id_by_name__fails(void **state);
 extern void test__f_account_group_id_by_name__not_found(void **state);
 
 /**
- * Test that parameter checking works as expected.
- *
- * @see f_account_group_id_by_name()
- */
-extern void test__f_account_group_id_by_name__parameter_checking(void **state);
-
-/**
  * Test that function works.
  *
  * @see f_account_group_id_by_name()

diff --git a/level_0/f_account/tests/unit/c/test-account-group_name_by_id.c b/level_0/f_account/tests/unit/c/test-account-group_name_by_id.c
index ae18c737a9ef3f0b15c41528957477170a8b25b6..a52e2402177a2e86933a8113c897cdcc41c18eb9 100644 (file)
--- a/level_0/f_account/tests/unit/c/test-account-group_name_by_id.c
+++ b/level_0/f_account/tests/unit/c/test-account-group_name_by_id.c
@@ -63,16 +63,18 @@ void test__f_account_group_name_by_id__not_found(void **state) {
     assert_int_equal(status, F_exist_not);
   }
 
-  free((void *) name.string);
-}
-
-void test__f_account_group_name_by_id__parameter_checking(void **state) {
-
   {
-    const f_status_t status = f_account_group_name_by_id(0, 0);
+    will_return(__wrap_sysconf, size);
+    will_return(__wrap_getgrgid_r, false);
+    will_return(__wrap_getgrgid_r, &group_data);
+    will_return(__wrap_getgrgid_r, (struct group *) 0);
+
+    const f_status_t status = f_account_group_name_by_id(gid, 0);
 
-    assert_int_equal(status, F_status_set_error(F_parameter));
+    assert_int_equal(status, F_exist_not);
   }
+
+  free((void *) name.string);
 }
 
 void test__f_account_group_name_by_id__works(void **state) {
@@ -103,6 +105,17 @@ void test__f_account_group_name_by_id__works(void **state) {
     assert_string_equal(name.string, group_data.gr_name);
   }
 
+  {
+    will_return(__wrap_sysconf, size);
+    will_return(__wrap_getgrgid_r, false);
+    will_return(__wrap_getgrgid_r, &group_data);
+    will_return(__wrap_getgrgid_r, &pointer);
+
+    const f_status_t status = f_account_group_name_by_id(gid, 0);
+
+    assert_int_equal(status, F_okay);
+  }
+
   free((void *) name.string);
 }
 

diff --git a/level_0/f_account/tests/unit/c/test-account-group_name_by_id.h b/level_0/f_account/tests/unit/c/test-account-group_name_by_id.h
index 73f6cc7f8136c59e490878469903ec749fe39b1b..94d0a629294152f541783987ef36ddd357f83b30 100644 (file)
--- a/level_0/f_account/tests/unit/c/test-account-group_name_by_id.h
+++ b/level_0/f_account/tests/unit/c/test-account-group_name_by_id.h
@@ -25,13 +25,6 @@ extern void test__f_account_group_name_by_id__fails(void **state);
 extern void test__f_account_group_name_by_id__not_found(void **state);
 
 /**
- * Test that parameter checking works as expected.
- *
- * @see f_account_group_name_by_id()
- */
-extern void test__f_account_group_name_by_id__parameter_checking(void **state);
-
-/**
  * Test that function works.
  *
  * @see f_account_group_name_by_id()

diff --git a/level_0/f_account/tests/unit/c/test-account-id_by_name.c b/level_0/f_account/tests/unit/c/test-account-id_by_name.c
index 636932d584f0979359ee93a650705103ea972b00..f8183b5363b47284082f5af32a564e4dac0483b4 100644 (file)
--- a/level_0/f_account/tests/unit/c/test-account-id_by_name.c
+++ b/level_0/f_account/tests/unit/c/test-account-id_by_name.c
@@ -68,16 +68,16 @@ void test__f_account_id_by_name__not_found(void **state) {
 
     assert_int_equal(status, F_exist_not);
   }
-}
-
-void test__f_account_id_by_name__parameter_checking(void **state) {
-
-  const f_string_static_t name = f_string_static_t_initialize;
 
   {
+    will_return(__wrap_sysconf, size);
+    will_return(__wrap_getpwnam_r, false);
+    will_return(__wrap_getpwnam_r, &password);
+    will_return(__wrap_getpwnam_r, (struct passwd *) 0);
+
     const f_status_t status = f_account_id_by_name(name, 0);
 
-    assert_int_equal(status, F_status_set_error(F_parameter));
+    assert_int_equal(status, F_exist_not);
   }
 }
 
@@ -112,6 +112,20 @@ void test__f_account_id_by_name__works(void **state) {
     assert_int_equal(status, F_okay);
     assert_int_equal(uid, password.pw_uid);
   }
+
+  {
+    will_return(__wrap_sysconf, size);
+    will_return(__wrap_getpwnam_r, false);
+    will_return(__wrap_getpwnam_r, &password);
+    will_return(__wrap_getpwnam_r, &pointer);
+
+    name.string = password.pw_name;
+    name.used = strlen(password.pw_name);
+
+    const f_status_t status = f_account_id_by_name(name, 0);
+
+    assert_int_equal(status, F_okay);
+  }
 }
 
 #ifdef __cplusplus

diff --git a/level_0/f_account/tests/unit/c/test-account-id_by_name.h b/level_0/f_account/tests/unit/c/test-account-id_by_name.h
index d73880b2380de45700e074fb246f52af636660e5..af4ef31efeeab7337766d38466c19b199273105f 100644 (file)
--- a/level_0/f_account/tests/unit/c/test-account-id_by_name.h
+++ b/level_0/f_account/tests/unit/c/test-account-id_by_name.h
@@ -25,13 +25,6 @@ extern void test__f_account_id_by_name__fails(void **state);
 extern void test__f_account_id_by_name__not_found(void **state);
 
 /**
- * Test that parameter checking works as expected.
- *
- * @see f_account_id_by_name()
- */
-extern void test__f_account_id_by_name__parameter_checking(void **state);
-
-/**
  * Test that function works.
  *
  * @see f_account_id_by_name()

diff --git a/level_0/f_account/tests/unit/c/test-account-name_by_id.c b/level_0/f_account/tests/unit/c/test-account-name_by_id.c
index d77786fb98998b8ae25173b9377ad5e8ab037d69..685b899d757aa4f22f869e2a37811c54941dac90 100644 (file)
--- a/level_0/f_account/tests/unit/c/test-account-name_by_id.c
+++ b/level_0/f_account/tests/unit/c/test-account-name_by_id.c
@@ -63,16 +63,18 @@ void test__f_account_name_by_id__not_found(void **state) {
     assert_int_equal(status, F_exist_not);
   }
 
-  free((void *) name.string);
-}
-
-void test__f_account_name_by_id__parameter_checking(void **state) {
-
   {
-    const f_status_t status = f_account_name_by_id(0, 0);
+    will_return(__wrap_sysconf, size);
+    will_return(__wrap_getpwuid_r, false);
+    will_return(__wrap_getpwuid_r, &password);
+    will_return(__wrap_getpwuid_r, (struct passwd *) 0);
+
+    const f_status_t status = f_account_name_by_id(uid, 0);
 
-    assert_int_equal(status, F_status_set_error(F_parameter));
+    assert_int_equal(status, F_exist_not);
   }
+
+  free((void *) name.string);
 }
 
 void test__f_account_name_by_id__works(void **state) {
@@ -105,6 +107,17 @@ void test__f_account_name_by_id__works(void **state) {
     assert_string_equal(name.string, password.pw_name);
   }
 
+  {
+    will_return(__wrap_sysconf, size);
+    will_return(__wrap_getpwuid_r, false);
+    will_return(__wrap_getpwuid_r, &password);
+    will_return(__wrap_getpwuid_r, &pointer);
+
+    const f_status_t status = f_account_name_by_id(uid, 0);
+
+    assert_int_equal(status, F_okay);
+  }
+
   free((void *) name.string);
 }
 

diff --git a/level_0/f_account/tests/unit/c/test-account-name_by_id.h b/level_0/f_account/tests/unit/c/test-account-name_by_id.h
index 12d853878ccf67cda8e8f6506ac8abfcfe054aca..5ba8c0b3c367b8b3997593729e5cc98989d48143 100644 (file)
--- a/level_0/f_account/tests/unit/c/test-account-name_by_id.h
+++ b/level_0/f_account/tests/unit/c/test-account-name_by_id.h
@@ -25,13 +25,6 @@ extern void test__f_account_name_by_id__fails(void **state);
 extern void test__f_account_name_by_id__not_found(void **state);
 
 /**
- * Test that parameter checking works as expected.
- *
- * @see f_account_name_by_id()
- */
-extern void test__f_account_name_by_id__parameter_checking(void **state);
-
-/**
  * Test that function works.
  *
  * @see f_account_name_by_id()

diff --git a/level_0/f_account/tests/unit/c/test-account.c b/level_0/f_account/tests/unit/c/test-account.c
index 7af0e57f0f209ff83696737f4f6138891efa0797..c595967822373b723b69869a06299b69cd461146 100644 (file)
--- a/level_0/f_account/tests/unit/c/test-account.c
+++ b/level_0/f_account/tests/unit/c/test-account.c
@@ -58,10 +58,10 @@ int main(void) {
     #ifndef _di_level_0_parameter_checking_
       cmocka_unit_test(test__f_account_by_id__parameter_checking),
       cmocka_unit_test(test__f_account_by_name__parameter_checking),
-      cmocka_unit_test(test__f_account_group_id_by_name__parameter_checking),
-      cmocka_unit_test(test__f_account_group_name_by_id__parameter_checking),
-      cmocka_unit_test(test__f_account_id_by_name__parameter_checking),
-      cmocka_unit_test(test__f_account_name_by_id__parameter_checking),
+      // f_account_group_id_by_name() doesn't use parameter checking.
+      // f_account_group_name_by_id() doesn't use parameter checking.
+      // f_account_id_by_name() doesn't use parameter checking.
+      // f_account_name_by_id() doesn't use parameter checking.
 
       // f_accounts_delete_callback() doesn't use parameter checking.
       // f_accounts_destroy_callback() doesn't use parameter checking.