[Tarantool-patches] [PATCH v3 15/16] module api: add box_key_def_validate_key()
Alexander Turenko
alexander.turenko at tarantool.org
Tue Oct 13 02:23:22 MSK 2020
The function allows to verify a key against a key definition. It accepts
a partial key.
Part of #5273
---
src/box/key_def.c | 13 +++++
src/box/key_def.h | 21 ++++++++
src/exports.h | 1 +
test/app-tap/module_api.c | 88 ++++++++++++++++++++++++++++++++
test/app-tap/module_api.test.lua | 2 +-
5 files changed, 124 insertions(+), 1 deletion(-)
diff --git a/src/box/key_def.c b/src/box/key_def.c
index da1c23135..55ac79362 100644
--- a/src/box/key_def.c
+++ b/src/box/key_def.c
@@ -627,6 +627,19 @@ box_key_def_extract_key(box_key_def_t *key_def, box_tuple_t *tuple,
return tuple_extract_key(tuple, key_def, multikey_idx, key_size_ptr);
}
+int
+box_key_def_validate_key(const box_key_def_t *key_def, const char *key)
+{
+ uint32_t part_count = mp_decode_array(&key);
+ if (part_count > key_def->part_count) {
+ diag_set(ClientError, ER_KEY_PART_COUNT, key_def->part_count,
+ part_count);
+ return -1;
+ }
+ const char *key_end;
+ return key_validate_parts(key_def, key, part_count, true, &key_end);
+}
+
/* }}} Module API functions */
int
diff --git a/src/box/key_def.h b/src/box/key_def.h
index 1b27836a8..440f2fb13 100644
--- a/src/box/key_def.h
+++ b/src/box/key_def.h
@@ -545,6 +545,27 @@ API_EXPORT char *
box_key_def_extract_key(box_key_def_t *key_def, box_tuple_t *tuple,
int multikey_idx, uint32_t *key_size_ptr);
+/**
+ * Check a key against given key definition.
+ *
+ * Verifies key parts against given key_def's field types with
+ * respect to nullability.
+ *
+ * A partial key (with less part than defined in @a key_def) is
+ * verified by given key parts, the omitted tail is not verified
+ * anyhow.
+ *
+ * Note: nil is accepted for nullable fields, but only for them.
+ *
+ * @param key_def Key definition.
+ * @param key MessagePack'ed data for matching.
+ *
+ * @retval 0 The key is valid.
+ * @retval -1 The key is invalid.
+ */
+API_EXPORT int
+box_key_def_validate_key(const box_key_def_t *key_def, const char *key);
+
/** \endcond public */
/*
diff --git a/src/exports.h b/src/exports.h
index a0c7ac84d..1d7deb518 100644
--- a/src/exports.h
+++ b/src/exports.h
@@ -35,6 +35,7 @@ EXPORT(box_key_def_extract_key)
EXPORT(box_key_def_merge)
EXPORT(box_key_def_new)
EXPORT(box_key_def_new_v2)
+EXPORT(box_key_def_validate_key)
EXPORT(box_key_def_validate_tuple)
EXPORT(box_key_part_def_create)
EXPORT(box_latch_delete)
diff --git a/test/app-tap/module_api.c b/test/app-tap/module_api.c
index 25cd8a5e7..778e7c3c0 100644
--- a/test/app-tap/module_api.c
+++ b/test/app-tap/module_api.c
@@ -1705,6 +1705,93 @@ test_key_def_extract_key(struct lua_State *L)
return 1;
}
+/**
+ * Basic <box_key_def_validate_key>() test.
+ */
+static int
+test_key_def_validate_key(struct lua_State *L)
+{
+ /*
+ * Create a key_def.
+ *
+ * | tuple
+ * | [x, x, x]
+ * | key_def ^ ^
+ * | | | |
+ * | (0) <-----+---- unsigned
+ * | | |
+ * | (1) <---- unsigned (optional)
+ */
+ box_key_part_def_t parts[2];
+ box_key_part_def_create(&parts[0]);
+ box_key_part_def_create(&parts[1]);
+ parts[0].fieldno = 2;
+ parts[0].field_type = "unsigned";
+ parts[1].fieldno = 0;
+ parts[1].field_type = "unsigned";
+ parts[1].flags |= BOX_KEY_PART_DEF_IS_NULLABLE;
+ box_key_def_t *key_def = box_key_def_new_v2(parts, 2);
+ assert(key_def != NULL);
+
+ /*
+ * Create keys to validate them against given key_def.
+ *
+ * | # | key | Is valid? |
+ * | - | -------------- | --------- |
+ * | 0 | [1, 1] | valid |
+ * | 1 | [1, null] | valid |
+ * | 2 | [1] | valid |
+ * | 3 | [] | valid |
+ * | 4 | [null] | invalid |
+ * | 5 | [1, 2, 3] | invalid |
+ * | 6 | [1, -1] | invalid |
+ */
+ const char *keys[] = {
+ /* [0] = */ "\x92\x01\x01",
+ /* [1] = */ "\x92\x01\xc0",
+ /* [2] = */ "\x91\x01",
+ /* [3] = */ "\x90",
+ /* [4] = */ "\x91\xc0",
+ /* [5] = */ "\x93\x01\x02\x03",
+ /* [6] = */ "\x92\x01\xff",
+ };
+ int expected_results[] = {
+ /* [0] = */ 0,
+ /* [1] = */ 0,
+ /* [2] = */ 0,
+ /* [3] = */ 0,
+ /* [4] = */ -1,
+ /* [5] = */ -1,
+ /* [6] = */ -1,
+ };
+ uint32_t expected_error_codes[] = {
+ /* [0] = */ box_error_code_MAX,
+ /* [1] = */ box_error_code_MAX,
+ /* [2] = */ box_error_code_MAX,
+ /* [3] = */ box_error_code_MAX,
+ /* [4] = */ ER_KEY_PART_TYPE,
+ /* [5] = */ ER_KEY_PART_COUNT,
+ /* [6] = */ ER_KEY_PART_TYPE,
+ };
+
+ for (size_t i = 0; i < lengthof(keys); ++i) {
+ int rc = box_key_def_validate_key(key_def, keys[i]);
+ assert(rc == expected_results[i]);
+
+ if (expected_error_codes[i] != box_error_code_MAX) {
+ assert(rc != 0);
+ box_error_t *e = box_error_last();
+ assert(box_error_code(e) == expected_error_codes[i]);
+ }
+ }
+
+ /* Clean up. */
+ box_key_def_delete(key_def);
+
+ lua_pushboolean(L, 1);
+ return 1;
+}
+
/* }}} key_def api v2 */
static int
@@ -2087,6 +2174,7 @@ luaopen_module_api(lua_State *L)
{"test_key_def_validate_tuple", test_key_def_validate_tuple},
{"test_key_def_merge", test_key_def_merge},
{"test_key_def_extract_key", test_key_def_extract_key},
+ {"test_key_def_validate_key", test_key_def_validate_key},
{NULL, NULL}
};
luaL_register(L, "module_api", lib);
diff --git a/test/app-tap/module_api.test.lua b/test/app-tap/module_api.test.lua
index 4de450462..4e06cf431 100755
--- a/test/app-tap/module_api.test.lua
+++ b/test/app-tap/module_api.test.lua
@@ -177,7 +177,7 @@ local function test_iscdata(test, module)
end
local test = require('tap').test("module_api", function(test)
- test:plan(33)
+ test:plan(34)
local status, module = pcall(require, 'module_api')
test:is(status, true, "module")
test:ok(status, "module is loaded")
--
2.25.0
More information about the Tarantool-patches
mailing list