mirror/json-c
1
0
Fork 0
mirror of https://github.com/json-c/json-c.git synced 2026-03-13 18:19:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

general callback, safer API & related tests

Browse Source 
- Changed json_pointer_set_with_array_cb to json_pointer_set_with_cb, related cb updated
- Added tests(test_safe_json_pointer_set.*) for new-exported funcs, also updated cmake & meson

Signed-off-by: lone <lonechan314@qq.com>
This commit is contained in:
lone
2026-02-09 14:01:38 +08:00
parent bda8299eb1
commit c293d9b61c
10 changed files with 387 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
json-c.sym
View File

@@ -182,5 +182,8 @@ JSONC_0.18 {
} JSONC_0.17; } JSONC_0.17;
JSONC_0.19 { JSONC_0.19 {
# global: global:
json_pointer_set_with_limit_index;
json_pointer_set_with_cb;
json_object_array_put_with_idx_limit_cb;
} JSONC_0.18; } JSONC_0.18;

22
json_patch.c
View File

@@ -108,8 +108,9 @@ static int json_patch_apply_remove(struct json_object **res, const char *path, s
return rc; return rc;
} }
// callback for json_pointer_set_with_array_cb() // callback for json_pointer_set_with_cb()
static int json_object_array_insert_idx_cb(struct json_object *parent, size_t idx, // key is ignored because this callback is only for arrays
static int json_object_array_insert_idx_cb(struct json_object *parent, const char *key, size_t idx,
struct json_object *value, void *priv) struct json_object *value, void *priv)
{ {
int rc; int rc;
@@ -117,7 +118,7 @@ static int json_object_array_insert_idx_cb(struct json_object *parent, size_t id
if (idx > json_object_array_length(parent)) if (idx > json_object_array_length(parent))
{ {
// Note: will propagate back out through json_pointer_set_with_array_cb() // Note: will propagate back out through json_pointer_set_with_cb()
errno = EINVAL; errno = EINVAL;
return -1; return -1;
} }
@@ -148,8 +149,8 @@ static int json_patch_apply_add_replace(struct json_object **res,
return -1; return -1;
} }
rc = json_pointer_set_with_array_cb(res, path, json_object_get(value), rc = json_pointer_set_with_cb(res, path, json_object_get(value),
json_object_array_insert_idx_cb, &add); json_object_array_insert_idx_cb, 0, &add);
if (rc) if (rc)
{ {
_set_err(errno, "Failed to set value at path referenced by 'path' field"); _set_err(errno, "Failed to set value at path referenced by 'path' field");
@@ -159,8 +160,9 @@ static int json_patch_apply_add_replace(struct json_object **res,
return rc; return rc;
} }
// callback for json_pointer_set_with_array_cb() // callback for json_pointer_set_with_cb()
static int json_object_array_move_cb(struct json_object *parent, size_t idx, // key is ignored because this callback is only for arrays
static int json_object_array_move_cb(struct json_object *parent, const char *key, size_t idx,
struct json_object *value, void *priv) struct json_object *value, void *priv)
{ {
int rc; int rc;
@@ -178,7 +180,7 @@ static int json_object_array_move_cb(struct json_object *parent, size_t idx,
if (idx > len) if (idx > len)
{ {
// Note: will propagate back out through json_pointer_set_with_array_cb() // Note: will propagate back out through json_pointer_set_with_cb()
errno = EINVAL; errno = EINVAL;
return -1; return -1;
} }
@@ -193,7 +195,7 @@ static int json_patch_apply_move_copy(struct json_object **res,
struct json_object *patch_elem, struct json_object *patch_elem,
const char *path, int move, struct json_patch_error *patch_error) const char *path, int move, struct json_patch_error *patch_error)
{ {
json_pointer_array_set_cb array_set_cb; json_pointer_set_cb array_set_cb;
struct json_pointer_get_result from; struct json_pointer_get_result from;
struct json_object *jfrom; struct json_object *jfrom;
const char *from_s; const char *from_s;
@@ -244,7 +246,7 @@ static int json_patch_apply_move_copy(struct json_object **res,
array_set_cb = json_object_array_move_cb; array_set_cb = json_object_array_move_cb;
} }
rc = json_pointer_set_with_array_cb(res, path, from.obj, array_set_cb, &from); rc = json_pointer_set_with_cb(res, path, from.obj, array_set_cb, 0, &from);
if (rc) if (rc)
{ {
_set_err(errno, "Failed to set value at path referenced by 'path' field"); _set_err(errno, "Failed to set value at path referenced by 'path' field");

99
json_pointer.c
View File

@@ -120,15 +120,9 @@ static int json_pointer_get_single_path(struct json_object *obj, char *path,
return 0; return 0;
} }
static int json_object_array_put_idx_cb(struct json_object *parent, size_t idx,
struct json_object *value, void *priv)
{
return json_object_array_put_idx(parent, idx, value);
}
static int json_pointer_set_single_path(struct json_object *parent, const char *path, static int json_pointer_set_single_path(struct json_object *parent, const char *path,
struct json_object *value, struct json_object *value,
json_pointer_array_set_cb array_set_cb, void *priv) json_pointer_set_cb set_cb, int cb_handles_obj, void *priv)
{ {
if (json_object_is_type(parent, json_type_array)) if (json_object_is_type(parent, json_type_array))
{ {
@@ -138,14 +132,23 @@ static int json_pointer_set_single_path(struct json_object *parent, const char *
return json_object_array_add(parent, value); return json_object_array_add(parent, value);
if (!is_valid_index(path, &idx)) if (!is_valid_index(path, &idx))
return -1; return -1;
return array_set_cb(parent, idx, value, priv); return set_cb(parent, NULL, idx, value, priv);
} }
/* path replacements should have been done in json_pointer_get_single_path(), /* path replacements should have been done in json_pointer_get_single_path(),
* and we should still be good here * and we should still be good here
*/ */
if (json_object_is_type(parent, json_type_object)) if (json_object_is_type(parent, json_type_object))
return json_object_object_add(parent, path, value); {
if (cb_handles_obj)
{
return set_cb(parent, path, (size_t)-1, value, priv);
}
else
{
return json_object_object_add(parent, path, value);
}
}
/* Getting here means that we tried to "dereference" a primitive JSON type /* Getting here means that we tried to "dereference" a primitive JSON type
* (like string, int, bool).i.e. add a sub-object to it * (like string, int, bool).i.e. add a sub-object to it
@@ -298,9 +301,9 @@ out:
return rc; return rc;
} }
int json_pointer_set_with_array_cb(struct json_object **obj, const char *path, int json_pointer_set_with_cb(struct json_object **obj, const char *path,
struct json_object *value, struct json_object *value,
json_pointer_array_set_cb array_set_cb, void *priv) json_pointer_set_cb set_cb, int cb_handles_obj, void *priv)
{ {
const char *endp; const char *endp;
char *path_copy = NULL; char *path_copy = NULL;
@@ -330,7 +333,7 @@ int json_pointer_set_with_array_cb(struct json_object **obj, const char *path,
if ((endp = strrchr(path, '/')) == path) if ((endp = strrchr(path, '/')) == path)
{ {
path++; path++;
return json_pointer_set_single_path(*obj, path, value, array_set_cb, priv); return json_pointer_set_single_path(*obj, path, value, set_cb, cb_handles_obj, priv);
} }
/* pass a working copy to the recursive call */ /* pass a working copy to the recursive call */
@@ -347,12 +350,21 @@ int json_pointer_set_with_array_cb(struct json_object **obj, const char *path,
return rc; return rc;
endp++; endp++;
return json_pointer_set_single_path(set, endp, value, array_set_cb, priv); return json_pointer_set_single_path(set, endp, value, set_cb, cb_handles_obj, priv);
}
static int default_put_cb(struct json_object *parent, const char *key, size_t idx,
struct json_object *value, void *priv)
{
if (key == NULL)
return json_object_array_put_idx(parent, idx, value);
else
return json_object_object_add(parent, key, value);
} }
int json_pointer_set(struct json_object **obj, const char *path, struct json_object *value) int json_pointer_set(struct json_object **obj, const char *path, struct json_object *value)
{ {
return json_pointer_set_with_array_cb(obj, path, value, json_object_array_put_idx_cb, NULL); return json_pointer_set_with_cb(obj, path, value, default_put_cb, 1, NULL);
} }
int json_pointer_setf(struct json_object **obj, struct json_object *value, const char *path_fmt, int json_pointer_setf(struct json_object **obj, struct json_object *value, const char *path_fmt,
@@ -407,8 +419,7 @@ int json_pointer_setf(struct json_object **obj, struct json_object *value, const
set_single_path: set_single_path:
endp++; endp++;
rc = json_pointer_set_single_path(set, endp, value, rc = json_pointer_set_single_path(set, endp, value, default_put_cb, 1, NULL);
json_object_array_put_idx_cb, NULL);
out: out:
free(path_copy); free(path_copy);
return rc; return rc;
@@ -420,33 +431,45 @@ int json_pointer_set_with_limit_index(struct json_object **obj, const char *path
// -1 means no limits // -1 means no limits
if (limit_index == (size_t)-1) if (limit_index == (size_t)-1)
{ {
return json_pointer_set_with_array_cb(obj, path, value, json_object_array_put_idx_cb, NULL); return json_pointer_set_with_cb(obj, path, value, default_put_cb, 1, NULL);
} }
return json_pointer_set_with_array_cb(obj, path, value, return json_pointer_set_with_cb(obj, path, value,
json_object_array_put_idx_with_limit_cb, &limit_index); json_object_array_put_with_idx_limit_cb, 0, &limit_index);
} }
/* safe callback for array index limit */ /* safe callback for array index limit */
int json_object_array_put_idx_with_limit_cb(struct json_object *jso, size_t idx, int json_object_array_put_with_idx_limit_cb(struct json_object *jso, const char *key, size_t idx,
struct json_object *jso_new, void *priv) struct json_object *jso_new, void *priv)
{ {
size_t max_idx; size_t max_idx;
// use priv as a size_t pointer to pass in the maximum allowed index
if (!priv)
{
errno = EINVAL;
return -1;
}
max_idx = *(size_t*)priv;
// Check against a maximum to prevent excessive memory allocations. if (key == NULL)
// An extremely large index, even if it doesn't overflow size_t, {
// will cause a huge memory allocation request via realloc, // array operation
// leading to an OOM. // use priv as a size_t pointer to pass in the maximum allowed index.
if (idx > max_idx) // The priv is required context for this callback and must not be NULL.
{ if (!priv)
errno = EINVAL; {
return -1; errno = EFAULT;
} return -1;
return json_object_array_put_idx(jso, idx, jso_new); }
max_idx = *(size_t*)priv;
// Check against a maximum to prevent excessive memory allocations.
// An extremely large index, even if it doesn't overflow size_t,
// will cause a huge memory allocation request via realloc,
// leading to an OOM.
if (idx > max_idx)
{
errno = EINVAL;
return -1;
}
return json_object_array_put_idx(jso, idx, jso_new);
}
else
{
// object operation
return json_object_object_add(jso, key, jso_new);
}
} }

28
json_pointer.h
View File

@@ -133,9 +133,14 @@ JSON_EXPORT int json_pointer_set_with_limit_index(struct json_object **obj, cons
/** /**
* Callback function type. * Callback function type.
*
* When setting an array element, 'key' will be NULL and 'idx' will be the
* target index.
* When setting an object field, 'key' will be the target key and 'idx' will
* be -1.
*/ */
typedef int(*json_pointer_array_set_cb)(json_object *parent, size_t idx, typedef int(*json_pointer_set_cb)(json_object *parent, const char *key, size_t idx,
json_object *value, void *priv); json_object *value, void *priv);
/** /**
* Variant of 'json_pointer_set()' that allows specifying a custom callback * Variant of 'json_pointer_set()' that allows specifying a custom callback
@@ -143,26 +148,29 @@ typedef int(*json_pointer_array_set_cb)(json_object *parent, size_t idx,
* @param obj the json_object instance/tree to which to add a sub-object * @param obj the json_object instance/tree to which to add a sub-object
* @param path a (RFC6901) string notation for the sub-object to set in the tree * @param path a (RFC6901) string notation for the sub-object to set in the tree
* @param value object to set at path * @param value object to set at path
* @param array_set_cb A custom callback function to handle setting the element * @param set_cb A custom callback function to handle setting the element
* within an array * @param cb_handles_obj If 0, the callback is only invoked for array modifications.
* @param priv A private pointer passed through to the array_set_cb callback, * If 1, the callback is invoked for both array and object
* modifications.
* @param priv A private pointer passed through to the set_cb callback,
* for user-defined context * for user-defined context
* *
* @return negative if an error (or not found), or 0 if succeeded * @return negative if an error (or not found), or 0 if succeeded
*/ */
JSON_EXPORT int json_pointer_set_with_array_cb(struct json_object **obj, const char *path, JSON_EXPORT int json_pointer_set_with_cb(struct json_object **obj, const char *path,
struct json_object *value, struct json_object *value,
json_pointer_array_set_cb array_set_cb, void *priv); json_pointer_set_cb set_cb, int cb_handles_obj, void *priv);
/** /**
* A secure callback for 'json_pointer_set_with_array_cb()' that enforces a * A safer callback for 'json_pointer_set_with_cb()' that enforces a
* maximum array index. * maximum array index.
* *
* This function can be used as the 'array_set_cb' argument to prevent OOM. * This function can be used as the 'set_cb' argument to prevent OOM.
* It expects the 'priv' argument to be a valid pointer to a 'size_t' variable * It expects the 'priv' argument to be a valid pointer to a 'size_t' variable
* that holds the maximum allowed index. * that holds the maximum allowed index.
* *
* @param jso the parent json_object array. * @param jso the parent json_object array.
* @param key the object field where the element is to be placed, should be NULL here.
* @param idx the index where the element is to be placed. * @param idx the index where the element is to be placed.
* @param jso_new the new json_object to place at the index. * @param jso_new the new json_object to place at the index.
* @param priv A pointer to a 'size_t' variable specifying the maximum index. * @param priv A pointer to a 'size_t' variable specifying the maximum index.
@@ -170,7 +178,7 @@ JSON_EXPORT int json_pointer_set_with_array_cb(struct json_object **obj, const c
* *
* @return 0 on success, or a negative value if idx exceeds the limit or 'priv' is NULL. * @return 0 on success, or a negative value if idx exceeds the limit or 'priv' is NULL.
*/ */
JSON_EXPORT int json_object_array_put_idx_with_limit_cb(struct json_object *jso, size_t idx, JSON_EXPORT int json_object_array_put_with_idx_limit_cb(struct json_object *jso, const char *key, size_t idx,
struct json_object *jso_new, void *priv); struct json_object *jso_new, void *priv);
#ifdef __cplusplus #ifdef __cplusplus

15
json_pointer_private.h
View File

@@ -29,12 +29,19 @@ struct json_pointer_get_result {
int json_pointer_get_internal(struct json_object *obj, const char *path, int json_pointer_get_internal(struct json_object *obj, const char *path,
struct json_pointer_get_result *res); struct json_pointer_get_result *res);
typedef int(*json_pointer_array_set_cb)(json_object *parent, size_t idx, // replaced by json_pointer_set_cb
json_object *value, void *priv); // typedef int(*json_pointer_array_set_cb)(json_object *parent, size_t idx,
// json_object *value, void *priv);
typedef int(*json_pointer_set_cb)(json_object *parent, const char *key, size_t idx,
json_object *value, void *priv);
int json_pointer_set_with_array_cb(struct json_object **obj, const char *path, // replaced by json_pointer_set_with_cb
// int json_pointer_set_with_array_cb(struct json_object **obj, const char *path,
// struct json_object *value,
// json_pointer_array_set_cb array_set_cb, void *priv);
int json_pointer_set_with_cb(struct json_object **obj, const char *path,
struct json_object *value, struct json_object *value,
json_pointer_array_set_cb array_set_cb, void *priv); json_pointer_set_cb set_cb, int cb_handles_obj, void *priv);
#ifdef __cplusplus #ifdef __cplusplus
} }

1
tests/CMakeLists.txt
View File

@@ -39,6 +39,7 @@ set(ALL_TEST_NAMES
if (NOT DISABLE_JSON_POINTER) if (NOT DISABLE_JSON_POINTER)
set(ALL_TEST_NAMES ${ALL_TEST_NAMES} test_json_pointer) set(ALL_TEST_NAMES ${ALL_TEST_NAMES} test_json_pointer)
set(ALL_TEST_NAMES ${ALL_TEST_NAMES} test_safe_json_pointer_set)
if (NOT DISABLE_JSON_PATCH) if (NOT DISABLE_JSON_PATCH)
set(ALL_TEST_NAMES ${ALL_TEST_NAMES} test_json_patch) set(ALL_TEST_NAMES ${ALL_TEST_NAMES} test_json_patch)
endif() endif()

1
tests/meson.build
View File

@@ -27,6 +27,7 @@ test_cases = [
['test_visit', 'test_visit.expected'], ['test_visit', 'test_visit.expected'],
['test_object_iterator', 'test_object_iterator.expected'], ['test_object_iterator', 'test_object_iterator.expected'],
['test_json_pointer', 'test_json_pointer.expected'], ['test_json_pointer', 'test_json_pointer.expected'],
['test_safe_json_pointer_set', 'test_safe_json_pointer_set.expected'],
['test_json_patch', 'test_json_patch.expected'], ['test_json_patch', 'test_json_patch.expected'],
] ]

242
tests/test_safe_json_pointer_set.c Normal file
View File

@@ -0,0 +1,242 @@
#ifdef NDEBUG
#undef NDEBUG
#endif
#include <assert.h>
#include <errno.h>
#include <stdio.h>
#include <string.h>
#include "json.h"
static const char *input_json_str = "{ "
"'foo': ['bar', 'baz'], "
"'': 0, "
"'a/b': 1, "
"'c%d': 2, "
"'e^f': 3, "
"'g|h': 4, "
"'i\\\\j': 5, "
"'k\\\"l': 6, "
"' ': 7, "
"'m~n': 8 "
"}";
static void test_example_set_with_limit_index(void)
{
struct json_object *jo2, *jo1 = json_tokener_parse(input_json_str);
size_t limit_index = 10;
// testing if json_pointer_set_with_limit_index() works as json_pointer_set()
assert(jo1 != NULL);
printf("PASSED - SET_WITH_LIMIT - LOADED TEST JSON\n");
printf("%s\n", json_object_get_string(jo1));
assert(0 == json_pointer_set_with_limit_index(&jo1, "/foo/1", json_object_new_string("cod"), limit_index));
assert(0 == strcmp("cod", json_object_get_string(json_object_array_get_idx(
json_object_object_get(jo1, "foo"), 1))));
printf("PASSED - SET_WITH_LIMIT - 'cod' in /foo/1\n");
assert(0 != json_pointer_set_with_limit_index(&jo1, "/fud/gaw", (jo2 = json_tokener_parse("[1,2,3]")), limit_index));
assert(errno == ENOENT);
printf("PASSED - SET_WITH_LIMIT - non-existing /fud/gaw\n");
assert(0 == json_pointer_set_with_limit_index(&jo1, "/fud", json_object_new_object(), limit_index));
printf("PASSED - SET_WITH_LIMIT - /fud == {}\n");
assert(0 == json_pointer_set_with_limit_index(&jo1, "/fud/gaw", jo2, limit_index)); /* re-using jo2 from above */
printf("PASSED - SET_WITH_LIMIT - /fug/gaw == [1,2,3]\n");
assert(0 == json_pointer_set_with_limit_index(&jo1, "/fud/gaw/0", json_object_new_int(0), limit_index));
assert(0 == json_pointer_setf(&jo1, json_object_new_int(0), "%s%s/%d", "/fud", "/gaw", 0));
printf("PASSED - SET_WITH_LIMIT - /fug/gaw == [0,2,3]\n");
assert(0 == json_pointer_set_with_limit_index(&jo1, "/fud/gaw/-", json_object_new_int(4), limit_index));
printf("PASSED - SET_WITH_LIMIT - /fug/gaw == [0,2,3,4]\n");
assert(0 == json_pointer_set_with_limit_index(&jo1, "/", json_object_new_int(9), limit_index));
printf("PASSED - SET_WITH_LIMIT - / == 9\n");
jo2 = json_tokener_parse(
"{ 'foo': [ 'bar', 'cod' ], '': 9, 'a/b': 1, 'c%d': 2, 'e^f': 3, 'g|h': 4, 'i\\\\j': "
"5, 'k\\\"l': 6, ' ': 7, 'm~n': 8, 'fud': { 'gaw': [ 0, 2, 3, 4 ] } }");
assert(json_object_equal(jo2, jo1));
printf("PASSED - SET_WITH_LIMIT - Final JSON is: %s\n", json_object_get_string(jo1));
json_object_put(jo2);
assert(0 == json_pointer_set_with_limit_index(&jo1, "", json_object_new_int(10), limit_index));
assert(10 == json_object_get_int(jo1));
printf("%s\n", json_object_get_string(jo1));
json_object_put(jo1);
jo1 = json_tokener_parse("[0, 1, 2, 3]");
jo2 = json_tokener_parse("[0, 1, 2, 3, null, null, null, 7]");
assert(0 == json_pointer_set_with_limit_index(&jo1, "/7", json_object_new_int(7), limit_index));
assert(1 == json_object_equal(jo1, jo2));
json_object_put(jo1);
jo1 = json_tokener_parse("[0, 1, 2, 3]");
assert(0 == json_pointer_setf(&jo1, json_object_new_int(7), "/%u", 7));
assert(1 == json_object_equal(jo1, jo2));
json_object_put(jo1);
json_object_put(jo2);
// testing with limit_index
jo1 = json_tokener_parse("{'foo': ['bar', 'baz']}");
jo2 = json_tokener_parse("{'foo': ['bar', 'cod']}");
assert(0 == json_pointer_set_with_limit_index(&jo1, "/foo/1", json_object_new_string("cod"), limit_index));
assert(json_object_equal(jo1, jo2));
printf("PASSED - SET_LIMIT - Set value within limit (/foo/1 with limit 10)\n");
assert(0 == json_pointer_set_with_limit_index(&jo1, "/bar", json_object_new_string("new_field"), limit_index));
printf("PASSED - SET_LIMIT - Set value on an object (limit is ignored)\n");
assert(0 == json_pointer_set_with_limit_index(&jo1, "/foo/20", json_object_new_string("big_index"), (size_t)-1));
printf("PASSED - SET_LIMIT - Set value with limit_index = -1 (no limit)\n");
json_object_put(jo1);
json_object_put(jo2);
}
static void test_wrong_inputs_set_with_limit_index(void)
{
struct json_object *jo2, *jo1 = json_tokener_parse(input_json_str);
size_t limit_index = 10;
// testing if json_pointer_set_with_limit_index() works as json_pointer_set()
assert(jo1 != NULL);
printf("PASSED - SET_WITH_LIMIT - LOADED TEST JSON\n");
printf("%s\n", json_object_get_string(jo1));
assert(0 != json_pointer_set_with_limit_index(NULL, NULL, NULL, limit_index));
assert(0 != json_pointer_set_with_limit_index(&jo1, NULL, NULL, limit_index));
printf("PASSED - SET_WITH_LIMIT - failed with NULL params for input json & path\n");
assert(0 != json_pointer_set_with_limit_index(&jo1, "foo/bar", (jo2 = json_object_new_string("cod")), limit_index));
printf("PASSED - SET_WITH_LIMIT - failed 'cod' with path 'foo/bar'\n");
json_object_put(jo2);
// assert(0 !=
// json_pointer_setf(&jo1, (jo2 = json_object_new_string("cod")), "%s", "foo/bar"));
// printf("PASSED - SET_WITH_LIMIT - failed 'cod' with path 'foo/bar'\n");
// json_object_put(jo2);
assert(0 != json_pointer_set_with_limit_index(&jo1, "0", (jo2 = json_object_new_string("cod")), limit_index));
printf("PASSED - SET_WITH_LIMIT - failed with invalid array index'\n");
json_object_put(jo2);
jo2 = json_object_new_string("whatever");
assert(0 != json_pointer_set_with_limit_index(&jo1, "/fud/gaw", jo2, limit_index));
assert(0 == json_pointer_set_with_limit_index(&jo1, "/fud", json_object_new_object(), limit_index));
assert(0 == json_pointer_set_with_limit_index(&jo1, "/fud/gaw", jo2, limit_index)); /* re-using jo2 from above */
// ownership of jo2 transferred into jo1
jo2 = json_object_new_int(0);
assert(0 != json_pointer_set_with_limit_index(&jo1, "/fud/gaw/0", jo2, limit_index));
json_object_put(jo2);
jo2 = json_object_new_int(0);
assert(0 != json_pointer_set_with_limit_index(&jo1, "/fud/gaw/", jo2, limit_index));
json_object_put(jo2);
printf("PASSED - SET_WITH_LIMIT - failed to set index to non-array\n");
// assert(0 == json_pointer_setf(&jo1, json_object_new_string("cod"), "%s", "\0"));
json_object_put(jo1);
// testing with limit_index
jo1 = json_tokener_parse("{'foo': ['bar', 'baz']}");
errno = 0;
jo2 = json_object_new_string("out_of_bounds");
assert(0 != json_pointer_set_with_limit_index(&jo1, "/foo/20", jo2, limit_index));
assert(errno == EINVAL);
printf("PASSED - SET_LIMIT - Failed to set index 20 with limit 10\n");
// The value object was not consumed, so we must put it.
json_object_put(jo2);
// corner case: setting an index that equals the limit (should be ok, as it's idx > max_idx)
errno = 0;
assert(0 == json_pointer_set_with_limit_index(&jo1, "/foo/10", json_object_new_string("at_the_limit"), limit_index));
printf("PASSED - SET_LIMIT - Succeeded to set index 10 with limit 10\n");
json_object_put(jo1);
}
// callback for testing json_pointer_set_with_cb()
static int test_cb_print_msg(json_object *parent, const char *key, size_t idx,
json_object *value, void *priv)
{
printf("PASSED - SET_WITH_CB - This callback is called\n");
return 0;
}
// callback for testing json_pointer_set_with_cb() with rejection logic
static int test_cb_reject_logic(json_object *parent, const char *key, size_t idx,
json_object *value, void *priv)
{
// Reject any operation if the key is "reject"
if (key && strcmp(key, "reject") == 0)
{
printf("PASSED - SET_WITH_CB - Callback correctly identified key 'reject' to reject\n");
return -1;
}
return 0;
}
static void test_set_with_cb(void)
{
struct json_object *jo1 = json_tokener_parse(input_json_str);
size_t limit_index = 5;
assert(jo1 != NULL);
printf("PASSED - SET_WITH_CB - LOADED TEST JSON\n");
printf("%s\n", json_object_get_string(jo1));
assert(0 == json_pointer_set_with_cb(&jo1, "/foo/1", json_object_new_string("cod"), test_cb_print_msg, 1, NULL));
printf("PASSED - SET_WITH_CB - callback test_cb_print_msg for /foo/1\n");
assert(0 == json_pointer_set_with_cb(&jo1, "/foo/4", json_object_new_string("in"), json_object_array_put_with_idx_limit_cb, 0, &limit_index));
printf("PASSED - SET_WITH_CB - callback json_object_array_put_with_idx_limit_cb for /foo/4 with limit_index 5\n");
assert(0 == json_pointer_set_with_cb(&jo1, "/foo/5", json_object_new_string("border"), json_object_array_put_with_idx_limit_cb, 0, &limit_index));
printf("PASSED - SET_WITH_CB - failed with callback json_object_array_put_with_idx_limit_cb for /foo/5 with limit_index 5\n");
assert(0 != json_pointer_set_with_cb(&jo1, "/foo/10", json_object_new_string("out"), json_object_array_put_with_idx_limit_cb, 0, &limit_index));
assert(errno == EINVAL);
printf("PASSED - SET_WITH_CB - failed with callback json_object_array_put_with_idx_limit_cb for /foo/10 with limit_index 5\n");
assert(0 != json_pointer_set_with_cb(&jo1, "/foo/2", json_object_new_string("null_priv"), json_object_array_put_with_idx_limit_cb, 0, NULL));
assert(errno == EFAULT);
printf("PASSED - SET_WITH_CB - failed with callback json_object_array_put_with_idx_limit_cb with NULL priv\n");
json_object_put(jo1);
jo1 = json_tokener_parse("{'foo': 'bar'}");
assert(jo1 != NULL);
assert(0 == json_pointer_set_with_cb(&jo1, "/foo", json_object_new_string("cod"), test_cb_print_msg, 1, NULL));
printf("PASSED - SET_WITH_CB - cb_handles_obj=1: callback was triggered for object operation\n");
assert(0 == json_pointer_set_with_cb(&jo1, "/new_key", json_object_new_string("new_value"), test_cb_print_msg, 0, NULL));
printf("PASSED - SET_WITH_CB - cb_handles_obj=0: callback was NOT triggered for object operation, default logic was used\n");
json_object_put(jo1);
// testing rejection logic callback
jo1 = json_tokener_parse("{'data': {} }");
assert(jo1 != NULL);
assert(0 == json_pointer_set_with_cb(&jo1, "/data/accept", json_object_new_string("accepted_value"), test_cb_reject_logic, 1, NULL));
printf("PASSED - SET_WITH_CB - Rejection callback approved an allowed key\n");
assert(0 != json_pointer_set_with_cb(&jo1, "/data/reject", json_object_new_string("rejected_value"), test_cb_reject_logic, 1, NULL));
printf("PASSED - SET_WITH_CB - Rejection callback rejected a forbidden key\n");
json_object_put(jo1);
}
int main(int argc, char **argv)
{
test_example_set_with_limit_index();
test_wrong_inputs_set_with_limit_index();
test_set_with_cb();
return 0;
}

36
tests/test_safe_json_pointer_set.expected Normal file
View File

@@ -0,0 +1,36 @@
PASSED - SET_WITH_LIMIT - LOADED TEST JSON
{ "foo": [ "bar", "baz" ], "": 0, "a\/b": 1, "c%d": 2, "e^f": 3, "g|h": 4, "i\\j": 5, "k\"l": 6, " ": 7, "m~n": 8 }
PASSED - SET_WITH_LIMIT - 'cod' in /foo/1
PASSED - SET_WITH_LIMIT - non-existing /fud/gaw
PASSED - SET_WITH_LIMIT - /fud == {}
PASSED - SET_WITH_LIMIT - /fug/gaw == [1,2,3]
PASSED - SET_WITH_LIMIT - /fug/gaw == [0,2,3]
PASSED - SET_WITH_LIMIT - /fug/gaw == [0,2,3,4]
PASSED - SET_WITH_LIMIT - / == 9
PASSED - SET_WITH_LIMIT - Final JSON is: { "foo": [ "bar", "cod" ], "": 9, "a\/b": 1, "c%d": 2, "e^f": 3, "g|h": 4, "i\\j": 5, "k\"l": 6, " ": 7, "m~n": 8, "fud": { "gaw": [ 0, 2, 3, 4 ] } }
10
PASSED - SET_LIMIT - Set value within limit (/foo/1 with limit 10)
PASSED - SET_LIMIT - Set value on an object (limit is ignored)
PASSED - SET_LIMIT - Set value with limit_index = -1 (no limit)
PASSED - SET_WITH_LIMIT - LOADED TEST JSON
{ "foo": [ "bar", "baz" ], "": 0, "a\/b": 1, "c%d": 2, "e^f": 3, "g|h": 4, "i\\j": 5, "k\"l": 6, " ": 7, "m~n": 8 }
PASSED - SET_WITH_LIMIT - failed with NULL params for input json & path
PASSED - SET_WITH_LIMIT - failed 'cod' with path 'foo/bar'
PASSED - SET_WITH_LIMIT - failed with invalid array index'
PASSED - SET_WITH_LIMIT - failed to set index to non-array
PASSED - SET_LIMIT - Failed to set index 20 with limit 10
PASSED - SET_LIMIT - Succeeded to set index 10 with limit 10
PASSED - SET_WITH_CB - LOADED TEST JSON
{ "foo": [ "bar", "baz" ], "": 0, "a\/b": 1, "c%d": 2, "e^f": 3, "g|h": 4, "i\\j": 5, "k\"l": 6, " ": 7, "m~n": 8 }
PASSED - SET_WITH_CB - This callback is called
PASSED - SET_WITH_CB - callback test_cb_print_msg for /foo/1
PASSED - SET_WITH_CB - callback json_object_array_put_with_idx_limit_cb for /foo/4 with limit_index 5
PASSED - SET_WITH_CB - failed with callback json_object_array_put_with_idx_limit_cb for /foo/5 with limit_index 5
PASSED - SET_WITH_CB - failed with callback json_object_array_put_with_idx_limit_cb for /foo/10 with limit_index 5
PASSED - SET_WITH_CB - failed with callback json_object_array_put_with_idx_limit_cb with NULL priv
PASSED - SET_WITH_CB - This callback is called
PASSED - SET_WITH_CB - cb_handles_obj=1: callback was triggered for object operation
PASSED - SET_WITH_CB - cb_handles_obj=0: callback was NOT triggered for object operation, default logic was used
PASSED - SET_WITH_CB - Rejection callback approved an allowed key
PASSED - SET_WITH_CB - Callback correctly identified key 'reject' to reject
PASSED - SET_WITH_CB - Rejection callback rejected a forbidden key

1
tests/test_safe_json_pointer_set.test Symbolic link
View File

@@ -0,0 +1 @@
test_basic.test