2021-01-17 08:48:48 -05:00
|
|
|
start_server {tags {"protocol network"}} {
|
2010-10-15 11:25:20 -04:00
|
|
|
test "Handle an empty query" {
|
|
|
|
reconnect
|
|
|
|
r write "\r\n"
|
|
|
|
r flush
|
|
|
|
assert_equal "PONG" [r ping]
|
|
|
|
}
|
2010-05-14 11:31:11 -04:00
|
|
|
|
2010-10-15 11:25:20 -04:00
|
|
|
test "Negative multibulk length" {
|
|
|
|
reconnect
|
|
|
|
r write "*-10\r\n"
|
|
|
|
r flush
|
|
|
|
assert_equal PONG [r ping]
|
|
|
|
}
|
2010-05-14 11:31:11 -04:00
|
|
|
|
2010-10-15 13:15:38 -04:00
|
|
|
test "Out of range multibulk length" {
|
|
|
|
reconnect
|
2021-10-03 02:13:09 -04:00
|
|
|
r write "*3000000000\r\n"
|
2010-10-15 13:15:38 -04:00
|
|
|
r flush
|
|
|
|
assert_error "*invalid multibulk length*" {r read}
|
|
|
|
}
|
|
|
|
|
2010-10-15 11:25:20 -04:00
|
|
|
test "Wrong multibulk payload header" {
|
|
|
|
reconnect
|
|
|
|
r write "*3\r\n\$3\r\nSET\r\n\$1\r\nx\r\nfooz\r\n"
|
|
|
|
r flush
|
|
|
|
assert_error "*expected '$', got 'f'*" {r read}
|
|
|
|
}
|
2010-05-14 11:31:11 -04:00
|
|
|
|
2010-10-15 11:25:20 -04:00
|
|
|
test "Negative multibulk payload length" {
|
|
|
|
reconnect
|
|
|
|
r write "*3\r\n\$3\r\nSET\r\n\$1\r\nx\r\n\$-10\r\n"
|
|
|
|
r flush
|
|
|
|
assert_error "*invalid bulk length*" {r read}
|
|
|
|
}
|
2010-05-14 11:31:11 -04:00
|
|
|
|
2010-10-15 11:25:20 -04:00
|
|
|
test "Out of range multibulk payload length" {
|
|
|
|
reconnect
|
|
|
|
r write "*3\r\n\$3\r\nSET\r\n\$1\r\nx\r\n\$2000000000\r\n"
|
|
|
|
r flush
|
|
|
|
assert_error "*invalid bulk length*" {r read}
|
|
|
|
}
|
2010-08-24 05:49:05 -04:00
|
|
|
|
2010-10-15 11:25:20 -04:00
|
|
|
test "Non-number multibulk payload length" {
|
|
|
|
reconnect
|
|
|
|
r write "*3\r\n\$3\r\nSET\r\n\$1\r\nx\r\n\$blabla\r\n"
|
|
|
|
r flush
|
|
|
|
assert_error "*invalid bulk length*" {r read}
|
|
|
|
}
|
2010-05-14 11:31:11 -04:00
|
|
|
|
2010-10-15 11:25:20 -04:00
|
|
|
test "Multi bulk request not followed by bulk arguments" {
|
|
|
|
reconnect
|
|
|
|
r write "*1\r\nfoo\r\n"
|
|
|
|
r flush
|
|
|
|
assert_error "*expected '$', got 'f'*" {r read}
|
|
|
|
}
|
|
|
|
|
|
|
|
test "Generic wrong number of args" {
|
|
|
|
reconnect
|
|
|
|
assert_error "*wrong*arguments*ping*" {r ping x y z}
|
|
|
|
}
|
2012-01-06 06:54:29 -05:00
|
|
|
|
2013-12-08 05:57:03 -05:00
|
|
|
test "Unbalanced number of quotes" {
|
|
|
|
reconnect
|
|
|
|
r write "set \"\"\"test-key\"\"\" test-value\r\n"
|
|
|
|
r write "ping\r\n"
|
|
|
|
r flush
|
|
|
|
assert_error "*unbalanced*" {r read}
|
|
|
|
}
|
|
|
|
|
2012-01-06 06:54:29 -05:00
|
|
|
set c 0
|
|
|
|
foreach seq [list "\x00" "*\x00" "$\x00"] {
|
|
|
|
incr c
|
|
|
|
test "Protocol desync regression test #$c" {
|
2019-09-12 03:56:54 -04:00
|
|
|
if {$::tls} {
|
|
|
|
set s [::tls::socket [srv 0 host] [srv 0 port]]
|
|
|
|
} else {
|
|
|
|
set s [socket [srv 0 host] [srv 0 port]]
|
|
|
|
}
|
2012-01-06 06:54:29 -05:00
|
|
|
puts -nonewline $s $seq
|
|
|
|
set payload [string repeat A 1024]"\n"
|
|
|
|
set test_start [clock seconds]
|
2012-04-23 04:57:43 -04:00
|
|
|
set test_time_limit 30
|
2012-01-06 06:54:29 -05:00
|
|
|
while 1 {
|
|
|
|
if {[catch {
|
|
|
|
puts -nonewline $s payload
|
|
|
|
flush $s
|
|
|
|
incr payload_size [string length $payload]
|
|
|
|
}]} {
|
|
|
|
set retval [gets $s]
|
|
|
|
close $s
|
|
|
|
break
|
|
|
|
} else {
|
|
|
|
set elapsed [expr {[clock seconds]-$test_start}]
|
|
|
|
if {$elapsed > $test_time_limit} {
|
|
|
|
close $s
|
|
|
|
error "assertion:Redis did not closed connection after protocol desync"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
set retval
|
|
|
|
} {*Protocol error*}
|
|
|
|
}
|
|
|
|
unset c
|
2021-07-04 12:43:58 -04:00
|
|
|
|
|
|
|
# recover the broken connection
|
|
|
|
reconnect
|
|
|
|
r ping
|
|
|
|
|
|
|
|
# raw RESP response tests
|
|
|
|
r readraw 1
|
|
|
|
|
Add reply_schema to command json files (internal for now) (#10273)
Work in progress towards implementing a reply schema as part of COMMAND DOCS, see #9845
Since ironing the details of the reply schema of each and every command can take a long time, we
would like to merge this PR when the infrastructure is ready, and let this mature in the unstable branch.
Meanwhile the changes of this PR are internal, they are part of the repo, but do not affect the produced build.
### Background
In #9656 we add a lot of information about Redis commands, but we are missing information about the replies
### Motivation
1. Documentation. This is the primary goal.
2. It should be possible, based on the output of COMMAND, to be able to generate client code in typed
languages. In order to do that, we need Redis to tell us, in detail, what each reply looks like.
3. We would like to build a fuzzer that verifies the reply structure (for now we use the existing
testsuite, see the "Testing" section)
### Schema
The idea is to supply some sort of schema for the various replies of each command.
The schema will describe the conceptual structure of the reply (for generated clients), as defined in RESP3.
Note that the reply structure itself may change, depending on the arguments (e.g. `XINFO STREAM`, with
and without the `FULL` modifier)
We decided to use the standard json-schema (see https://json-schema.org/) as the reply-schema.
Example for `BZPOPMIN`:
```
"reply_schema": {
"oneOf": [
{
"description": "Timeout reached and no elements were popped.",
"type": "null"
},
{
"description": "The keyname, popped member, and its score.",
"type": "array",
"minItems": 3,
"maxItems": 3,
"items": [
{
"description": "Keyname",
"type": "string"
},
{
"description": "Member",
"type": "string"
},
{
"description": "Score",
"type": "number"
}
]
}
]
}
```
#### Notes
1. It is ok that some commands' reply structure depends on the arguments and it's the caller's responsibility
to know which is the relevant one. this comes after looking at other request-reply systems like OpenAPI,
where the reply schema can also be oneOf and the caller is responsible to know which schema is the relevant one.
2. The reply schemas will describe RESP3 replies only. even though RESP3 is structured, we want to use reply
schema for documentation (and possibly to create a fuzzer that validates the replies)
3. For documentation, the description field will include an explanation of the scenario in which the reply is sent,
including any relation to arguments. for example, for `ZRANGE`'s two schemas we will need to state that one
is with `WITHSCORES` and the other is without.
4. For documentation, there will be another optional field "notes" in which we will add a short description of
the representation in RESP2, in case it's not trivial (RESP3's `ZRANGE`'s nested array vs. RESP2's flat
array, for example)
Given the above:
1. We can generate the "return" section of all commands in [redis-doc](https://redis.io/commands/)
(given that "description" and "notes" are comprehensive enough)
2. We can generate a client in a strongly typed language (but the return type could be a conceptual
`union` and the caller needs to know which schema is relevant). see the section below for RESP2 support.
3. We can create a fuzzer for RESP3.
### Limitations (because we are using the standard json-schema)
The problem is that Redis' replies are more diverse than what the json format allows. This means that,
when we convert the reply to a json (in order to validate the schema against it), we lose information (see
the "Testing" section below).
The other option would have been to extend the standard json-schema (and json format) to include stuff
like sets, bulk-strings, error-string, etc. but that would mean also extending the schema-validator - and that
seemed like too much work, so we decided to compromise.
Examples:
1. We cannot tell the difference between an "array" and a "set"
2. We cannot tell the difference between simple-string and bulk-string
3. we cannot verify true uniqueness of items in commands like ZRANGE: json-schema doesn't cover the
case of two identical members with different scores (e.g. `[["m1",6],["m1",7]]`) because `uniqueItems`
compares (member,score) tuples and not just the member name.
### Testing
This commit includes some changes inside Redis in order to verify the schemas (existing and future ones)
are indeed correct (i.e. describe the actual response of Redis).
To do that, we added a debugging feature to Redis that causes it to produce a log of all the commands
it executed and their replies.
For that, Redis needs to be compiled with `-DLOG_REQ_RES` and run with
`--reg-res-logfile <file> --client-default-resp 3` (the testsuite already does that if you run it with
`--log-req-res --force-resp3`)
You should run the testsuite with the above args (and `--dont-clean`) in order to make Redis generate
`.reqres` files (same dir as the `stdout` files) which contain request-response pairs.
These files are later on processed by `./utils/req-res-log-validator.py` which does:
1. Goes over req-res files, generated by redis-servers, spawned by the testsuite (see logreqres.c)
2. For each request-response pair, it validates the response against the request's reply_schema
(obtained from the extended COMMAND DOCS)
5. In order to get good coverage of the Redis commands, and all their different replies, we chose to use
the existing redis test suite, rather than attempt to write a fuzzer.
#### Notes about RESP2
1. We will not be able to use the testing tool to verify RESP2 replies (we are ok with that, it's time to
accept RESP3 as the future RESP)
2. Since the majority of the test suite is using RESP2, and we want the server to reply with RESP3
so that we can validate it, we will need to know how to convert the actual reply to the one expected.
- number and boolean are always strings in RESP2 so the conversion is easy
- objects (maps) are always a flat array in RESP2
- others (nested array in RESP3's `ZRANGE` and others) will need some special per-command
handling (so the client will not be totally auto-generated)
Example for ZRANGE:
```
"reply_schema": {
"anyOf": [
{
"description": "A list of member elements",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
{
"description": "Members and their scores. Returned in case `WITHSCORES` was used.",
"notes": "In RESP2 this is returned as a flat array",
"type": "array",
"uniqueItems": true,
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": [
{
"description": "Member",
"type": "string"
},
{
"description": "Score",
"type": "number"
}
]
}
}
]
}
```
### Other changes
1. Some tests that behave differently depending on the RESP are now being tested for both RESP,
regardless of the special log-req-res mode ("Pub/Sub PING" for example)
2. Update the history field of CLIENT LIST
3. Added basic tests for commands that were not covered at all by the testsuite
### TODO
- [x] (maybe a different PR) add a "condition" field to anyOf/oneOf schemas that refers to args. e.g.
when `SET` return NULL, the condition is `arguments.get||arguments.condition`, for `OK` the condition
is `!arguments.get`, and for `string` the condition is `arguments.get` - https://github.com/redis/redis/issues/11896
- [x] (maybe a different PR) also run `runtest-cluster` in the req-res logging mode
- [x] add the new tests to GH actions (i.e. compile with `-DLOG_REQ_RES`, run the tests, and run the validator)
- [x] (maybe a different PR) figure out a way to warn about (sub)schemas that are uncovered by the output
of the tests - https://github.com/redis/redis/issues/11897
- [x] (probably a separate PR) add all missing schemas
- [x] check why "SDOWN is triggered by misconfigured instance replying with errors" fails with --log-req-res
- [x] move the response transformers to their own file (run both regular, cluster, and sentinel tests - need to
fight with the tcl including mechanism a bit)
- [x] issue: module API - https://github.com/redis/redis/issues/11898
- [x] (probably a separate PR): improve schemas: add `required` to `object`s - https://github.com/redis/redis/issues/11899
Co-authored-by: Ozan Tezcan <ozantezcan@gmail.com>
Co-authored-by: Hanna Fadida <hanna.fadida@redislabs.com>
Co-authored-by: Oran Agra <oran@redislabs.com>
Co-authored-by: Shaya Potter <shaya@redislabs.com>
2023-03-11 03:14:16 -05:00
|
|
|
set nullres {*-1}
|
|
|
|
if {$::force_resp3} {
|
|
|
|
set nullres {_}
|
|
|
|
}
|
|
|
|
|
2021-07-04 12:43:58 -04:00
|
|
|
test "raw protocol response" {
|
|
|
|
r srandmember nonexisting_key
|
Add reply_schema to command json files (internal for now) (#10273)
Work in progress towards implementing a reply schema as part of COMMAND DOCS, see #9845
Since ironing the details of the reply schema of each and every command can take a long time, we
would like to merge this PR when the infrastructure is ready, and let this mature in the unstable branch.
Meanwhile the changes of this PR are internal, they are part of the repo, but do not affect the produced build.
### Background
In #9656 we add a lot of information about Redis commands, but we are missing information about the replies
### Motivation
1. Documentation. This is the primary goal.
2. It should be possible, based on the output of COMMAND, to be able to generate client code in typed
languages. In order to do that, we need Redis to tell us, in detail, what each reply looks like.
3. We would like to build a fuzzer that verifies the reply structure (for now we use the existing
testsuite, see the "Testing" section)
### Schema
The idea is to supply some sort of schema for the various replies of each command.
The schema will describe the conceptual structure of the reply (for generated clients), as defined in RESP3.
Note that the reply structure itself may change, depending on the arguments (e.g. `XINFO STREAM`, with
and without the `FULL` modifier)
We decided to use the standard json-schema (see https://json-schema.org/) as the reply-schema.
Example for `BZPOPMIN`:
```
"reply_schema": {
"oneOf": [
{
"description": "Timeout reached and no elements were popped.",
"type": "null"
},
{
"description": "The keyname, popped member, and its score.",
"type": "array",
"minItems": 3,
"maxItems": 3,
"items": [
{
"description": "Keyname",
"type": "string"
},
{
"description": "Member",
"type": "string"
},
{
"description": "Score",
"type": "number"
}
]
}
]
}
```
#### Notes
1. It is ok that some commands' reply structure depends on the arguments and it's the caller's responsibility
to know which is the relevant one. this comes after looking at other request-reply systems like OpenAPI,
where the reply schema can also be oneOf and the caller is responsible to know which schema is the relevant one.
2. The reply schemas will describe RESP3 replies only. even though RESP3 is structured, we want to use reply
schema for documentation (and possibly to create a fuzzer that validates the replies)
3. For documentation, the description field will include an explanation of the scenario in which the reply is sent,
including any relation to arguments. for example, for `ZRANGE`'s two schemas we will need to state that one
is with `WITHSCORES` and the other is without.
4. For documentation, there will be another optional field "notes" in which we will add a short description of
the representation in RESP2, in case it's not trivial (RESP3's `ZRANGE`'s nested array vs. RESP2's flat
array, for example)
Given the above:
1. We can generate the "return" section of all commands in [redis-doc](https://redis.io/commands/)
(given that "description" and "notes" are comprehensive enough)
2. We can generate a client in a strongly typed language (but the return type could be a conceptual
`union` and the caller needs to know which schema is relevant). see the section below for RESP2 support.
3. We can create a fuzzer for RESP3.
### Limitations (because we are using the standard json-schema)
The problem is that Redis' replies are more diverse than what the json format allows. This means that,
when we convert the reply to a json (in order to validate the schema against it), we lose information (see
the "Testing" section below).
The other option would have been to extend the standard json-schema (and json format) to include stuff
like sets, bulk-strings, error-string, etc. but that would mean also extending the schema-validator - and that
seemed like too much work, so we decided to compromise.
Examples:
1. We cannot tell the difference between an "array" and a "set"
2. We cannot tell the difference between simple-string and bulk-string
3. we cannot verify true uniqueness of items in commands like ZRANGE: json-schema doesn't cover the
case of two identical members with different scores (e.g. `[["m1",6],["m1",7]]`) because `uniqueItems`
compares (member,score) tuples and not just the member name.
### Testing
This commit includes some changes inside Redis in order to verify the schemas (existing and future ones)
are indeed correct (i.e. describe the actual response of Redis).
To do that, we added a debugging feature to Redis that causes it to produce a log of all the commands
it executed and their replies.
For that, Redis needs to be compiled with `-DLOG_REQ_RES` and run with
`--reg-res-logfile <file> --client-default-resp 3` (the testsuite already does that if you run it with
`--log-req-res --force-resp3`)
You should run the testsuite with the above args (and `--dont-clean`) in order to make Redis generate
`.reqres` files (same dir as the `stdout` files) which contain request-response pairs.
These files are later on processed by `./utils/req-res-log-validator.py` which does:
1. Goes over req-res files, generated by redis-servers, spawned by the testsuite (see logreqres.c)
2. For each request-response pair, it validates the response against the request's reply_schema
(obtained from the extended COMMAND DOCS)
5. In order to get good coverage of the Redis commands, and all their different replies, we chose to use
the existing redis test suite, rather than attempt to write a fuzzer.
#### Notes about RESP2
1. We will not be able to use the testing tool to verify RESP2 replies (we are ok with that, it's time to
accept RESP3 as the future RESP)
2. Since the majority of the test suite is using RESP2, and we want the server to reply with RESP3
so that we can validate it, we will need to know how to convert the actual reply to the one expected.
- number and boolean are always strings in RESP2 so the conversion is easy
- objects (maps) are always a flat array in RESP2
- others (nested array in RESP3's `ZRANGE` and others) will need some special per-command
handling (so the client will not be totally auto-generated)
Example for ZRANGE:
```
"reply_schema": {
"anyOf": [
{
"description": "A list of member elements",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
{
"description": "Members and their scores. Returned in case `WITHSCORES` was used.",
"notes": "In RESP2 this is returned as a flat array",
"type": "array",
"uniqueItems": true,
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": [
{
"description": "Member",
"type": "string"
},
{
"description": "Score",
"type": "number"
}
]
}
}
]
}
```
### Other changes
1. Some tests that behave differently depending on the RESP are now being tested for both RESP,
regardless of the special log-req-res mode ("Pub/Sub PING" for example)
2. Update the history field of CLIENT LIST
3. Added basic tests for commands that were not covered at all by the testsuite
### TODO
- [x] (maybe a different PR) add a "condition" field to anyOf/oneOf schemas that refers to args. e.g.
when `SET` return NULL, the condition is `arguments.get||arguments.condition`, for `OK` the condition
is `!arguments.get`, and for `string` the condition is `arguments.get` - https://github.com/redis/redis/issues/11896
- [x] (maybe a different PR) also run `runtest-cluster` in the req-res logging mode
- [x] add the new tests to GH actions (i.e. compile with `-DLOG_REQ_RES`, run the tests, and run the validator)
- [x] (maybe a different PR) figure out a way to warn about (sub)schemas that are uncovered by the output
of the tests - https://github.com/redis/redis/issues/11897
- [x] (probably a separate PR) add all missing schemas
- [x] check why "SDOWN is triggered by misconfigured instance replying with errors" fails with --log-req-res
- [x] move the response transformers to their own file (run both regular, cluster, and sentinel tests - need to
fight with the tcl including mechanism a bit)
- [x] issue: module API - https://github.com/redis/redis/issues/11898
- [x] (probably a separate PR): improve schemas: add `required` to `object`s - https://github.com/redis/redis/issues/11899
Co-authored-by: Ozan Tezcan <ozantezcan@gmail.com>
Co-authored-by: Hanna Fadida <hanna.fadida@redislabs.com>
Co-authored-by: Oran Agra <oran@redislabs.com>
Co-authored-by: Shaya Potter <shaya@redislabs.com>
2023-03-11 03:14:16 -05:00
|
|
|
} "$nullres"
|
2021-07-04 12:43:58 -04:00
|
|
|
|
|
|
|
r deferred 1
|
|
|
|
|
|
|
|
test "raw protocol response - deferred" {
|
|
|
|
r srandmember nonexisting_key
|
|
|
|
r read
|
Add reply_schema to command json files (internal for now) (#10273)
Work in progress towards implementing a reply schema as part of COMMAND DOCS, see #9845
Since ironing the details of the reply schema of each and every command can take a long time, we
would like to merge this PR when the infrastructure is ready, and let this mature in the unstable branch.
Meanwhile the changes of this PR are internal, they are part of the repo, but do not affect the produced build.
### Background
In #9656 we add a lot of information about Redis commands, but we are missing information about the replies
### Motivation
1. Documentation. This is the primary goal.
2. It should be possible, based on the output of COMMAND, to be able to generate client code in typed
languages. In order to do that, we need Redis to tell us, in detail, what each reply looks like.
3. We would like to build a fuzzer that verifies the reply structure (for now we use the existing
testsuite, see the "Testing" section)
### Schema
The idea is to supply some sort of schema for the various replies of each command.
The schema will describe the conceptual structure of the reply (for generated clients), as defined in RESP3.
Note that the reply structure itself may change, depending on the arguments (e.g. `XINFO STREAM`, with
and without the `FULL` modifier)
We decided to use the standard json-schema (see https://json-schema.org/) as the reply-schema.
Example for `BZPOPMIN`:
```
"reply_schema": {
"oneOf": [
{
"description": "Timeout reached and no elements were popped.",
"type": "null"
},
{
"description": "The keyname, popped member, and its score.",
"type": "array",
"minItems": 3,
"maxItems": 3,
"items": [
{
"description": "Keyname",
"type": "string"
},
{
"description": "Member",
"type": "string"
},
{
"description": "Score",
"type": "number"
}
]
}
]
}
```
#### Notes
1. It is ok that some commands' reply structure depends on the arguments and it's the caller's responsibility
to know which is the relevant one. this comes after looking at other request-reply systems like OpenAPI,
where the reply schema can also be oneOf and the caller is responsible to know which schema is the relevant one.
2. The reply schemas will describe RESP3 replies only. even though RESP3 is structured, we want to use reply
schema for documentation (and possibly to create a fuzzer that validates the replies)
3. For documentation, the description field will include an explanation of the scenario in which the reply is sent,
including any relation to arguments. for example, for `ZRANGE`'s two schemas we will need to state that one
is with `WITHSCORES` and the other is without.
4. For documentation, there will be another optional field "notes" in which we will add a short description of
the representation in RESP2, in case it's not trivial (RESP3's `ZRANGE`'s nested array vs. RESP2's flat
array, for example)
Given the above:
1. We can generate the "return" section of all commands in [redis-doc](https://redis.io/commands/)
(given that "description" and "notes" are comprehensive enough)
2. We can generate a client in a strongly typed language (but the return type could be a conceptual
`union` and the caller needs to know which schema is relevant). see the section below for RESP2 support.
3. We can create a fuzzer for RESP3.
### Limitations (because we are using the standard json-schema)
The problem is that Redis' replies are more diverse than what the json format allows. This means that,
when we convert the reply to a json (in order to validate the schema against it), we lose information (see
the "Testing" section below).
The other option would have been to extend the standard json-schema (and json format) to include stuff
like sets, bulk-strings, error-string, etc. but that would mean also extending the schema-validator - and that
seemed like too much work, so we decided to compromise.
Examples:
1. We cannot tell the difference between an "array" and a "set"
2. We cannot tell the difference between simple-string and bulk-string
3. we cannot verify true uniqueness of items in commands like ZRANGE: json-schema doesn't cover the
case of two identical members with different scores (e.g. `[["m1",6],["m1",7]]`) because `uniqueItems`
compares (member,score) tuples and not just the member name.
### Testing
This commit includes some changes inside Redis in order to verify the schemas (existing and future ones)
are indeed correct (i.e. describe the actual response of Redis).
To do that, we added a debugging feature to Redis that causes it to produce a log of all the commands
it executed and their replies.
For that, Redis needs to be compiled with `-DLOG_REQ_RES` and run with
`--reg-res-logfile <file> --client-default-resp 3` (the testsuite already does that if you run it with
`--log-req-res --force-resp3`)
You should run the testsuite with the above args (and `--dont-clean`) in order to make Redis generate
`.reqres` files (same dir as the `stdout` files) which contain request-response pairs.
These files are later on processed by `./utils/req-res-log-validator.py` which does:
1. Goes over req-res files, generated by redis-servers, spawned by the testsuite (see logreqres.c)
2. For each request-response pair, it validates the response against the request's reply_schema
(obtained from the extended COMMAND DOCS)
5. In order to get good coverage of the Redis commands, and all their different replies, we chose to use
the existing redis test suite, rather than attempt to write a fuzzer.
#### Notes about RESP2
1. We will not be able to use the testing tool to verify RESP2 replies (we are ok with that, it's time to
accept RESP3 as the future RESP)
2. Since the majority of the test suite is using RESP2, and we want the server to reply with RESP3
so that we can validate it, we will need to know how to convert the actual reply to the one expected.
- number and boolean are always strings in RESP2 so the conversion is easy
- objects (maps) are always a flat array in RESP2
- others (nested array in RESP3's `ZRANGE` and others) will need some special per-command
handling (so the client will not be totally auto-generated)
Example for ZRANGE:
```
"reply_schema": {
"anyOf": [
{
"description": "A list of member elements",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
{
"description": "Members and their scores. Returned in case `WITHSCORES` was used.",
"notes": "In RESP2 this is returned as a flat array",
"type": "array",
"uniqueItems": true,
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": [
{
"description": "Member",
"type": "string"
},
{
"description": "Score",
"type": "number"
}
]
}
}
]
}
```
### Other changes
1. Some tests that behave differently depending on the RESP are now being tested for both RESP,
regardless of the special log-req-res mode ("Pub/Sub PING" for example)
2. Update the history field of CLIENT LIST
3. Added basic tests for commands that were not covered at all by the testsuite
### TODO
- [x] (maybe a different PR) add a "condition" field to anyOf/oneOf schemas that refers to args. e.g.
when `SET` return NULL, the condition is `arguments.get||arguments.condition`, for `OK` the condition
is `!arguments.get`, and for `string` the condition is `arguments.get` - https://github.com/redis/redis/issues/11896
- [x] (maybe a different PR) also run `runtest-cluster` in the req-res logging mode
- [x] add the new tests to GH actions (i.e. compile with `-DLOG_REQ_RES`, run the tests, and run the validator)
- [x] (maybe a different PR) figure out a way to warn about (sub)schemas that are uncovered by the output
of the tests - https://github.com/redis/redis/issues/11897
- [x] (probably a separate PR) add all missing schemas
- [x] check why "SDOWN is triggered by misconfigured instance replying with errors" fails with --log-req-res
- [x] move the response transformers to their own file (run both regular, cluster, and sentinel tests - need to
fight with the tcl including mechanism a bit)
- [x] issue: module API - https://github.com/redis/redis/issues/11898
- [x] (probably a separate PR): improve schemas: add `required` to `object`s - https://github.com/redis/redis/issues/11899
Co-authored-by: Ozan Tezcan <ozantezcan@gmail.com>
Co-authored-by: Hanna Fadida <hanna.fadida@redislabs.com>
Co-authored-by: Oran Agra <oran@redislabs.com>
Co-authored-by: Shaya Potter <shaya@redislabs.com>
2023-03-11 03:14:16 -05:00
|
|
|
} "$nullres"
|
2021-07-04 12:43:58 -04:00
|
|
|
|
|
|
|
test "raw protocol response - multiline" {
|
|
|
|
r sadd ss a
|
|
|
|
assert_equal [r read] {:1}
|
|
|
|
r srandmember ss 100
|
|
|
|
assert_equal [r read] {*1}
|
|
|
|
assert_equal [r read] {$1}
|
|
|
|
assert_equal [r read] {a}
|
|
|
|
}
|
|
|
|
|
|
|
|
# restore connection settings
|
|
|
|
r readraw 0
|
|
|
|
r deferred 0
|
|
|
|
|
|
|
|
# check the connection still works
|
|
|
|
assert_equal [r ping] {PONG}
|
2021-07-14 12:14:31 -04:00
|
|
|
|
|
|
|
test {RESP3 attributes} {
|
|
|
|
r hello 3
|
2022-02-06 17:10:05 -05:00
|
|
|
assert_equal {Some real reply following the attribute} [r debug protocol attrib]
|
|
|
|
assert_equal {key-popularity {key:123 90}} [r attributes]
|
|
|
|
|
|
|
|
# make sure attributes are not kept from previous command
|
|
|
|
r ping
|
|
|
|
assert_error {*attributes* no such element in array} {r attributes}
|
2021-07-14 12:14:31 -04:00
|
|
|
|
|
|
|
# restore state
|
|
|
|
r hello 2
|
2022-02-06 17:10:05 -05:00
|
|
|
set _ ""
|
|
|
|
} {} {needs:debug resp3}
|
2021-07-14 12:14:31 -04:00
|
|
|
|
|
|
|
test {RESP3 attributes readraw} {
|
|
|
|
r hello 3
|
|
|
|
r readraw 1
|
|
|
|
r deferred 1
|
|
|
|
|
|
|
|
r debug protocol attrib
|
|
|
|
assert_equal [r read] {|1}
|
|
|
|
assert_equal [r read] {$14}
|
|
|
|
assert_equal [r read] {key-popularity}
|
|
|
|
assert_equal [r read] {*2}
|
|
|
|
assert_equal [r read] {$7}
|
|
|
|
assert_equal [r read] {key:123}
|
|
|
|
assert_equal [r read] {:90}
|
|
|
|
assert_equal [r read] {$39}
|
|
|
|
assert_equal [r read] {Some real reply following the attribute}
|
|
|
|
|
|
|
|
# restore state
|
|
|
|
r readraw 0
|
|
|
|
r deferred 0
|
|
|
|
r hello 2
|
|
|
|
set _ {}
|
2021-11-18 16:01:56 -05:00
|
|
|
} {} {needs:debug resp3}
|
2021-07-14 12:14:31 -04:00
|
|
|
|
|
|
|
test {RESP3 attributes on RESP2} {
|
|
|
|
r hello 2
|
|
|
|
set res [r debug protocol attrib]
|
|
|
|
set _ $res
|
2021-11-18 16:01:56 -05:00
|
|
|
} {Some real reply following the attribute} {needs:debug}
|
2021-07-14 12:14:31 -04:00
|
|
|
|
|
|
|
test "test big number parsing" {
|
|
|
|
r hello 3
|
|
|
|
r debug protocol bignum
|
|
|
|
} {1234567999999999999999999999999999999} {needs:debug resp3}
|
|
|
|
|
|
|
|
test "test bool parsing" {
|
|
|
|
r hello 3
|
|
|
|
assert_equal [r debug protocol true] 1
|
|
|
|
assert_equal [r debug protocol false] 0
|
|
|
|
r hello 2
|
|
|
|
assert_equal [r debug protocol true] 1
|
|
|
|
assert_equal [r debug protocol false] 0
|
|
|
|
set _ {}
|
|
|
|
} {} {needs:debug resp3}
|
2021-08-03 04:37:19 -04:00
|
|
|
|
|
|
|
test "test verbatim str parsing" {
|
|
|
|
r hello 3
|
|
|
|
r debug protocol verbatim
|
|
|
|
} "This is a verbatim\nstring" {needs:debug resp3}
|
|
|
|
|
2021-10-03 02:13:09 -04:00
|
|
|
test "test large number of args" {
|
|
|
|
r flushdb
|
|
|
|
set args [split [string trim [string repeat "k v " 10000]]]
|
|
|
|
lappend args "{k}2" v2
|
|
|
|
r mset {*}$args
|
|
|
|
assert_equal [r get "{k}2"] v2
|
|
|
|
}
|
2021-10-05 05:17:36 -04:00
|
|
|
|
|
|
|
test "test argument rewriting - issue 9598" {
|
|
|
|
# INCRBYFLOAT uses argument rewriting for correct float value propagation.
|
|
|
|
# We use it to make sure argument rewriting works properly. It's important
|
|
|
|
# this test is run under valgrind to verify there are no memory leaks in
|
|
|
|
# arg buffer handling.
|
|
|
|
r flushdb
|
|
|
|
|
|
|
|
# Test normal argument handling
|
|
|
|
r set k 0
|
|
|
|
assert_equal [r incrbyfloat k 1.0] 1
|
|
|
|
|
|
|
|
# Test argument handing in multi-state buffers
|
|
|
|
r multi
|
|
|
|
r incrbyfloat k 1.0
|
|
|
|
assert_equal [r exec] 2
|
|
|
|
}
|
2021-10-03 02:13:09 -04:00
|
|
|
|
2010-05-14 11:31:11 -04:00
|
|
|
}
|
2011-07-28 08:40:06 -04:00
|
|
|
|
|
|
|
start_server {tags {"regression"}} {
|
|
|
|
test "Regression for a crash with blocking ops and pipelining" {
|
|
|
|
set rd [redis_deferring_client]
|
|
|
|
set fd [r channel]
|
|
|
|
set proto "*3\r\n\$5\r\nBLPOP\r\n\$6\r\nnolist\r\n\$1\r\n0\r\n"
|
|
|
|
puts -nonewline $fd $proto$proto
|
|
|
|
flush $fd
|
|
|
|
set res {}
|
|
|
|
|
|
|
|
$rd rpush nolist a
|
|
|
|
$rd read
|
|
|
|
$rd rpush nolist a
|
|
|
|
$rd read
|
2021-11-15 04:07:43 -05:00
|
|
|
$rd close
|
2011-07-28 08:40:06 -04:00
|
|
|
}
|
|
|
|
}
|