resource: remove unused functions from rutil

Problem: Many functions in src/modules/resource/rutil.c are unused
besides their own unit tests.

Remove the following functions that have no users:

 rutil_idset_decode_test
 rutil_idkey_insert_idset
 rutil_idkey_insert_id
 rutil_idkey_merge

Update the unit test accordingly.

Author: grondo

src/modules/resource/rutil.c

@@ -99,18 +99,6 @@ int rutil_set_json_idset (json_t *o, const char *key, const struct idset *ids)
     return -1;
 }
 
-bool rutil_idset_decode_test (const char *idset, unsigned long id)
-{
-    struct idset *ids;
-    bool result;
-
-    if (!(ids = idset_decode (idset)))
-        return false;
-    result = idset_test (ids, id);
-    idset_destroy (ids);
-    return result;
-}
-
 char *rutil_read_file (const char *path, flux_error_t *errp)
 {
     int fd;
@@ -242,109 +230,6 @@ json_t *rutil_load_xml_dir (const char *path, flux_error_t *errp)
     return o;
 }
 
-static int idkey_remove_id (json_t *obj, unsigned int id)
-{
-    const char *key;
-    json_t *val;
-
-    json_object_foreach (obj, key, val) {
-        struct idset *ids;
-        char *new_key;
-
-        if (!(ids = idset_decode (key)))
-            return -1;
-        if (idset_test (ids, id)) {
-            idset_clear (ids, id);
-            if (idset_count (ids) > 0) {
-                if (!(new_key = idset_encode (ids, IDSET_FLAG_RANGE))) {
-                    idset_destroy (ids);
-                    return -1;
-                }
-                if (json_object_set (obj, new_key, val) < 0) {
-                    free (new_key);
-                    idset_destroy (ids);
-                    errno = ENOMEM;
-                    return -1;
-                }
-                free (new_key);
-            }
-            (void)json_object_del (obj, key);
-            idset_destroy (ids);
-            break;
-        }
-        idset_destroy (ids);
-    }
-    return 0;
-}
-
-/* Insert 'new_ids' into 'obj' as follows:
- * 1) remove 'new_ids' from any existing keys in 'obj'
- * 2) look for existing entry with value same as 'val'
- * 3) if found, update key to include 'new_ids'
- * 4) if not found, add key consisting only of 'new_ids' to object
- */
-int rutil_idkey_insert_idset (json_t *obj, struct idset *new_ids, json_t *val)
-{
-    const char *orig_key;
-    json_t *orig_val;
-    bool found = false;
-    struct idset *ids = NULL;
-    char *key = NULL;
-    unsigned int id;
-
-    id = idset_first (new_ids);
-    while (id != IDSET_INVALID_ID) {
-        if (idkey_remove_id (obj, id) < 0)
-            return -1;
-        id = idset_next (new_ids, id);
-    }
-    json_object_foreach (obj, orig_key, orig_val) {
-        if (json_equal (orig_val, val)) {
-            found = true;
-            break;
-        }
-    }
-    if (found) {
-        if (!(ids = idset_decode (orig_key)))
-            return -1;
-        if (idset_add (ids, new_ids) < 0)
-            goto error;
-        if (!(key = idset_encode (ids, IDSET_FLAG_RANGE)))
-            goto error;
-        if (json_object_set (obj, key, val) < 0)
-            goto error;
-        (void)json_object_del (obj, orig_key);
-    }
-    else {
-        if (!(key = idset_encode (new_ids, IDSET_FLAG_RANGE)))
-            return -1;
-        if (json_object_set (obj, key, val) < 0)
-            goto error;
-    }
-    free (key);
-    idset_destroy (ids);
-    return 0;
-error:
-    ERRNO_SAFE_WRAP (free, key);
-    idset_destroy (ids);
-    return -1;
-}
-
-int rutil_idkey_insert_id (json_t *obj, unsigned int id, json_t *val)
-{
-    struct idset *new_ids;
-    int rc = -1;
-
-    if (!(new_ids = idset_create (0, IDSET_FLAG_AUTOGROW)))
-        return -1;
-    if (idset_set (new_ids, id) < 0)
-        goto done;
-    rc = rutil_idkey_insert_idset (obj, new_ids, val);
-done:
-    idset_destroy (new_ids);
-    return rc;
-}
-
 int rutil_idkey_map (json_t *obj, rutil_idkey_map_f map, void *arg)
 {
     const char *key;
@@ -368,18 +253,6 @@ int rutil_idkey_map (json_t *obj, rutil_idkey_map_f map, void *arg)
     return 0;
 }
 
-static int idkey_merge_map (unsigned int id, json_t *val, void *arg)
-{
-    json_t *obj = arg;
-
-    return rutil_idkey_insert_id (obj, id, val);
-}
-
-int rutil_idkey_merge (json_t *obj1, json_t *obj2)
-{
-    return rutil_idkey_map (obj2, idkey_merge_map, obj1);
-}
-
 static int idkey_count_map (unsigned int id, json_t *val, void *arg)
 {
     int *count = arg;

src/modules/resource/rutil.h

@@ -20,10 +20,6 @@ int rutil_idset_diff (const struct idset *old_set,
                       struct idset **add,
                       struct idset **sub);
 
-/* Check whether id is a member of encoded idset
- */
-bool rutil_idset_decode_test (const char *idset, unsigned long id);
-
 /* Set key=val in a json object, where val is the string
  * representation of 'ids', or the empty string if 'ids' is NULL.
  */
@@ -42,28 +38,16 @@ char *rutil_read_file (const char *path, flux_error_t *errp);
 json_t *rutil_load_file (const char *path, flux_error_t *errp);
 json_t *rutil_load_xml_dir (const char *path, flux_error_t *errp);
 
-/* Build object with idset keys.
- * Start with empty json_t object, then insert objects by id.
- * If json_equal() returns true on values, they are combined.
- */
-int rutil_idkey_insert_id (json_t *obj, unsigned int id, json_t *val);
-int rutil_idkey_insert_idset (json_t *obj, struct idset *ids, json_t *val);
-
 /* Map over object with idset keys, calling 'map' for each id.
  * map function returns 0 on success, -1 with errno set to abort.
  */
 typedef int (*rutil_idkey_map_f)(unsigned int id, json_t *val, void *arg);
 int rutil_idkey_map (json_t *obj, rutil_idkey_map_f map, void *arg);
 
-/* Merge obj2 into obj1, where both are objects with idset keys.
- */
-int rutil_idkey_merge (json_t *obj1, json_t *obj2);
-
 /* Count ranks represented in idkey object.
  */
 int rutil_idkey_count (json_t *obj);
 
-
 #endif /* !_FLUX_RESOURCE_RUTIL_H */
 
 

src/modules/resource/test/rutil.c

@@ -147,18 +147,6 @@ void test_set_json_idset (void)
     idset_destroy (ids);
 }
 
-void test_idset_decode_test (void)
-{
-    ok (rutil_idset_decode_test (NULL, 0) == false,
-        "rutil_idset_decode_test idset=NULL returns false");
-    ok (rutil_idset_decode_test ("", 0) == false,
-        "rutil_idset_decode_test idset=\"\" id=0 returns false");
-    ok (rutil_idset_decode_test ("0", 0) == true,
-        "rutil_idset_decode_test idset=\"0\" id=0 returns true");
-    ok (rutil_idset_decode_test ("0", 1) == false,
-        "rutil_idset_decode_test idset=\"0\" id=1 returns false");
-}
-
 static char *create_tmp_file (const char *content)
 {
     char *path;
@@ -310,45 +298,33 @@ int mapit (unsigned int id, json_t *val, void *arg)
     return 0;
 }
 
-
-void test_idkey_basic (void)
+void test_idkey_map (void)
 {
     json_t *obj;
-    json_t *obj2;
-    json_t *val1;
-    json_t *val2;
-    json_t *val3;
     int map_count;
-
-    if (!(obj = json_object ()))
-        BAIL_OUT ("json_object failed");
-    if (!(obj2 = json_object ()))
-        BAIL_OUT ("json_object failed");
-    if (!(val1 = json_pack ("{s:s s:i}", "foo", "xyz", "bar", 42)))
-        BAIL_OUT ("json_pack failed");
-    if (!(val2 = json_pack ("{s:s s:i}", "foo", "xyz", "bar", 43)))
-        BAIL_OUT ("json_pack failed");
-    if (!(val3 = json_pack ("{s:s s:i}", "foo", "ZZZ", "bar", 42)))
-        BAIL_OUT ("json_pack failed");
-
-    ok (rutil_idkey_insert_id (obj, 0, val1) == 0,
-        "rutil_idkey_insert_id 0=val1 works");
-    ok (rutil_idkey_insert_id (obj, 1, val2) == 0,
-        "rutil_idkey_insert_id 1=val2 works");
-    ok (rutil_idkey_insert_id (obj, 2, val1) == 0,
-        "rutil_idkey_insert_id 2=val1 works");
-    ok (rutil_idkey_insert_id (obj, 3, val2) == 0,
-        "rutil_idkey_insert_id 3=val2 works");
+    json_error_t error;
+
+    /*  Recreate test object for map here.
+     *  This was created step-wise with rutil_idkey_insert_id before,
+     *   but that function has since been removed.
+     */
+    if (!(obj = json_pack_ex (&error, 0,
+                              "{s:{s:s s:i} s:{s:s s:i} s:{s:s s:i}}",
+                              "0",
+                               "foo", "ZZZ",
+                               "bar", 42,
+                              "2",
+                               "foo", "xyz",
+                               "bar", 42,
+                              "1,3",
+                               "foo", "xyz",
+                               "bar", 43)))
+        BAIL_OUT ("json_pack failed: %s", error.text);
 
     diag_obj ("obj", obj);
 
-    ok (json_object_size (obj) == 2,
-        "identical objects were compressed -> 2 keys");
-
-    ok (rutil_idkey_insert_id (obj, 0, val3) == 0,
-        "rutil_idkey_insert_id 0=val3 works");
     ok (json_object_size (obj) == 3,
-        "object update caused split -> 3 keys");
+        "object size 3 keys");
 
     map_count = 0;
     map_exit_iter = -1;
@@ -366,91 +342,6 @@ void test_idkey_basic (void)
         "rutil_idkey_map fails when map function returns -1 with errno set");
     map_exit_iter = -1;
 
-    ok (rutil_idkey_merge (obj2, obj) == 0
-        && rutil_idkey_count (obj2) == 4
-        && json_object_size (obj) == 3,
-        "rutil_idkey_merge into empty object works");
-
-    ok (rutil_idkey_merge (obj2, obj) == 0
-        && rutil_idkey_count (obj2) == 4
-        && json_object_size (obj) == 3,
-        "rutil_idkey_merge again has no effect");
-
-    json_decref (obj);
-    json_decref (obj2);
-    json_decref (val1);
-    json_decref (val2);
-    json_decref (val3);
-}
-
-struct idkey {
-    const char *ids;
-    const char *val;
-    int ids_count;
-    int obj_count;
-};
-
-struct idkey testinput[] = {
-    { "0",          "{\"a\": 0}", 1, 1 },
-    { "1",          "{\"a\": 1}", 2, 2 },
-    { "2",          "{\"a\": 0}", 3, 2 },
-    { "3",          "{\"a\": 1}", 4, 2 },
-    { "3-15",       "{\"a\": 2}", 16, 3 },
-    { "10-12",      "{\"a\": 3}", 16, 4 },
-    { "10-12",      "{\"a\": 2}", 16, 3 },
-    { "3-15",       "{\"a\": 1}", 16, 2 },
-    { "0-15",       "{\"a\": 4}", 16, 1 },
-    { "8-1023",     "{\"a\": 5}", 1024, 2 },
-    { "0-48",       "{\"a\": 6}", 1024, 2 },
-    { 0 },
-};
-
-void test_idkey_one (json_t *obj, struct idkey *idk)
-{
-    json_t *val;
-    int rc;
-    json_t *orig;
-
-    if (!(orig = json_deep_copy (obj)))
-        BAIL_OUT ("json_deep_copy failed");
-    if (!(val = json_loads (idk->val, 0, NULL)))
-        BAIL_OUT ("json_loads %s failed", idk->val);
-    if (strlen (idk->ids) == 1) {
-        unsigned long id = strtoul (idk->ids, NULL, 10);
-        rc = rutil_idkey_insert_id (obj, id, val);
-    }
-    else {
-        struct idset *ids = idset_decode (idk->ids);
-        if (!ids)
-            BAIL_OUT ("idset_decode %s failed", idk->ids);
-        rc = rutil_idkey_insert_idset (obj, ids, val);
-        idset_destroy (ids);
-    }
-    int ids_count = rutil_idkey_count (obj);
-    int obj_count = json_object_size (obj);
-    ok (rc == 0 && ids_count == idk->ids_count && obj_count == idk->obj_count,
-        "rutil_idkey_insert \"%s\":%s: %d obj %d ids",
-        idk->ids, idk->val, idk->ids_count, idk->obj_count);
-    if (rc != 0 || ids_count != idk->ids_count || obj_count != idk->obj_count){
-        diag_obj ("before", orig);
-        diag ("rc=%d ids_count=%d obj_count=%d", rc, ids_count, obj_count);
-        diag_obj ("after", obj);
-    }
-
-    json_decref (val);
-    json_decref (orig);
-}
-
-void test_idkey (void)
-{
-    json_t *obj;
-    int i;
-
-    if (!(obj = json_object ()))
-        BAIL_OUT ("json_object failed");
-
-    for (i = 0; testinput[i].ids != NULL; i++)
-        test_idkey_one (obj, &testinput[i]);
     json_decref (obj);
 }
 
@@ -460,14 +351,12 @@ int main (int argc, char *argv[])
 
     test_idset_diff ();
     test_set_json_idset ();
-    test_idset_decode_test ();
 
     test_read_file ();
     test_load_file ();
     test_load_xml_dir ();
 
-    test_idkey_basic ();
-    test_idkey ();
+    test_idkey_map ();
 
     done_testing ();
     return (0);