[Tarantool-patches] [PATCH v3] lua/key_def: fix compare_with_key() part count check

[Tarantool-patches] [PATCH v3] lua/key_def: fix compare_with_key() part count check

[Sergey Nikiforov]

Added corresponding test

Fixes: #5307
---

Branch: https://github.com/tarantool/tarantool/tree/void234/gh-5307-fix-key_def-part-count-check-v2
Issue: https://github.com/tarantool/tarantool/issues/5307

 src/box/lua/key_def.c                         |  9 ++----
 .../gh-5307-key_def-part-count-check.test.lua | 29 +++++++++++++++++++
 2 files changed, 32 insertions(+), 6 deletions(-)
 create mode 100755 test/box-tap/gh-5307-key_def-part-count-check.test.lua

diff --git a/src/box/lua/key_def.c b/src/box/lua/key_def.c
index a781aeff9..5143ef3a4 100644
--- a/src/box/lua/key_def.c
+++ b/src/box/lua/key_def.c
@@ -360,17 +360,14 @@ lbox_key_def_compare_with_key(struct lua_State *L)
 	struct region *region = &fiber()->gc;
 	size_t region_svp = region_used(region);
 	size_t key_len;
-	const char *key_end, *key = lbox_encode_tuple_on_gc(L, 3, &key_len);
-	uint32_t part_count = mp_decode_array(&key);
-	if (key_validate_parts(key_def, key, part_count, true,
-			       &key_end) != 0) {
+	const char *key = lbox_encode_tuple_on_gc(L, 3, &key_len);
+	if (box_key_def_validate_key(key_def, key, NULL)) {
 		region_truncate(region, region_svp);
 		tuple_unref(tuple);
 		return luaT_error(L);
 	}
 
-	int rc = tuple_compare_with_key(tuple, HINT_NONE, key,
-					part_count, HINT_NONE, key_def);
+	int rc = box_tuple_compare_with_key(tuple, key, key_def);
 	region_truncate(region, region_svp);
 	tuple_unref(tuple);
 	lua_pushinteger(L, rc);
diff --git a/test/box-tap/gh-5307-key_def-part-count-check.test.lua b/test/box-tap/gh-5307-key_def-part-count-check.test.lua
new file mode 100755
index 000000000..dfd50f799
--- /dev/null
+++ b/test/box-tap/gh-5307-key_def-part-count-check.test.lua
@@ -0,0 +1,29 @@
+#!/usr/bin/env tarantool
+
+local tap = require('tap')
+local mytest = tap.test('key_def part count tests')
+
+mytest:plan(3)
+
+local key_def = require('key_def')
+local kd = key_def.new({{fieldno = 1, type = 'unsigned'}})
+local ok, res
+
+-- Should succeed
+ok, res = pcall(kd.compare_with_key, kd, {1}, {1})
+print("First: ", ok, res)
+mytest:ok(ok and res == 0, "Simple equality")
+
+-- Should succeed
+ok, res = pcall(kd.compare_with_key, kd, {1}, {2})
+print("Second: ", ok, res)
+mytest:ok(ok and res < 0, "Simple inequality")
+
+-- Should fail
+local exp_err = "Invalid key part count (expected [0..1], got 9)"
+ok, res = pcall(kd.compare_with_key, kd, {1}, {1, 2, 3, 4, 5, 6, 7, 8, 9})
+print("Third: ", ok, res)
+mytest:is_deeply({ok, tostring(res)}, {false, exp_err},
+    "Invalid key part count")
+
+os.exit(mytest:check() and 0 or 1)
-- 
2.25.1

Re: [Tarantool-patches] [PATCH v3] lua/key_def: fix compare_with_key() part count check

[Vladislav Shpilevoy]

Hi! Thanks for the patch!

It seems you didn't push the latest version on the branch.
The diff below is different from what I see in `git show`.

See 2 comments below.

> diff --git a/src/box/lua/key_def.c b/src/box/lua/key_def.c
> index a781aeff9..5143ef3a4 100644
> --- a/src/box/lua/key_def.c
> +++ b/src/box/lua/key_def.c
> @@ -360,17 +360,14 @@ lbox_key_def_compare_with_key(struct lua_State *L)
>  	struct region *region = &fiber()->gc;
>  	size_t region_svp = region_used(region);
>  	size_t key_len;
> -	const char *key_end, *key = lbox_encode_tuple_on_gc(L, 3, &key_len);
> -	uint32_t part_count = mp_decode_array(&key);
> -	if (key_validate_parts(key_def, key, part_count, true,
> -			       &key_end) != 0) {
> +	const char *key = lbox_encode_tuple_on_gc(L, 3, &key_len);
> +	if (box_key_def_validate_key(key_def, key, NULL)) {
>  		region_truncate(region, region_svp);
>  		tuple_unref(tuple);
>  		return luaT_error(L);
>  	}
>  
> -	int rc = tuple_compare_with_key(tuple, HINT_NONE, key,
> -					part_count, HINT_NONE, key_def);
> +	int rc = box_tuple_compare_with_key(tuple, key, key_def);

1. Looks good. The old version with decoding the array only once also
was fine to me though. Up to you and Alexander T.

>  	region_truncate(region, region_svp);
>  	tuple_unref(tuple);
>  	lua_pushinteger(L, rc);
> diff --git a/test/box-tap/gh-5307-key_def-part-count-check.test.lua b/test/box-tap/gh-5307-key_def-part-count-check.test.lua
> new file mode 100755
> index 000000000..dfd50f799
> --- /dev/null
> +++ b/test/box-tap/gh-5307-key_def-part-count-check.test.lua
> @@ -0,0 +1,29 @@
> +#!/usr/bin/env tarantool
> +
> +local tap = require('tap')
> +local mytest = tap.test('key_def part count tests')
> +
> +mytest:plan(3)
> +
> +local key_def = require('key_def')
> +local kd = key_def.new({{fieldno = 1, type = 'unsigned'}})
> +local ok, res
> +
> +-- Should succeed
> +ok, res = pcall(kd.compare_with_key, kd, {1}, {1})
> +print("First: ", ok, res)

2. Try to avoid print() function. By using print() you produce
output not compatible with TAP, and complicate this issue:
https://github.com/tarantool/tarantool/issues/5000

You can use test:diag() method to print any messages.