annotate README @ 1961:fe6f22da53ec default tip

Tests: tests for usage of discarded body. The client_max_body_size limit should be ignored when the request body is already discarded. In HTTP/1.x, this is done by checking the r->discard_body flag when the body is being discarded, and because r->headers_in.content_length_n is 0 when it's already discarded. This, however, does not happen with HTTP/2 and HTTP/3, and therefore "error_page 413" does not work without relaxing the limit. Further, with proxy_pass, r->headers_in.content_length_n is used to determine length of the request body, and therefore is not correct if discarding of the request body isn't yet complete. While discarding the request body, r->headers_in.content_length_n contains the rest of the body to discard (or, in case of chunked request body, the rest of the current chunk to discard). Similarly, the $content_length variable uses r->headers_in.content_length if available, and also incorrect. The $content_length variable is used when proxying with fastcgi_pass, grpc_pass, and uwsgi_pass (scgi_pass uses the value calculated based on the actual request body buffers, and therefore works correctly).
author Maxim Dounin <mdounin@mdounin.ru>
date Sat, 27 Apr 2024 18:55:50 +0300
parents f3ba4c74de31
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38
9a7158a8609a Tests: fix typo.
Maxim Dounin <mdounin@mdounin.ru>
parents: 29
diff changeset
1 Test suite for nginx.
10
6d6776623948 Add some basic docs and license information.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
2
6d6776623948 Add some basic docs and license information.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
3 Use prove to run tests as one usually do for perl tests. Individual tests
6d6776623948 Add some basic docs and license information.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
4 may be run as well.
6d6776623948 Add some basic docs and license information.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
5
134
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
6 Note: tests run nginx (and backend daemons if needed) listening on localhost
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
7 and may use various ports in 8000 .. 8999 range.
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
8
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
9 Usage:
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
10
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
11 $ TEST_NGINX_BINARY=/path/to/nginx prove .
26
0880e0fafde4 Tests: implement smtp test backend and use it.
Maxim Dounin <mdounin@mdounin.ru>
parents: 18
diff changeset
12
134
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
13 By default tests expect nginx binary to be at ../nginx/objs/nginx.
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
14
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
15 Environment variables:
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
16
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
17 TEST_NGINX_BINARY
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
18
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
19 Sets path to nginx binary to be tested, defaults to "../nginx/objs/nginx".
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
20
856
d39e98893265 Tests: use TEST_NGINX_MODULES to find dynamic modules directory.
Sergey Kandaurov <pluknet@nginx.com>
parents: 266
diff changeset
21 TEST_NGINX_MODULES
d39e98893265 Tests: use TEST_NGINX_MODULES to find dynamic modules directory.
Sergey Kandaurov <pluknet@nginx.com>
parents: 266
diff changeset
22
d39e98893265 Tests: use TEST_NGINX_MODULES to find dynamic modules directory.
Sergey Kandaurov <pluknet@nginx.com>
parents: 266
diff changeset
23 Sets path to modules directory, defaults to dirname of TEST_NGINX_BINARY.
d39e98893265 Tests: use TEST_NGINX_MODULES to find dynamic modules directory.
Sergey Kandaurov <pluknet@nginx.com>
parents: 266
diff changeset
24
134
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
25 TEST_NGINX_VERBOSE
10
6d6776623948 Add some basic docs and license information.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
26
134
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
27 Be a bit more verbose (in particular, print requests sent and responses
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
28 got from nginx). Note that this requires prove -v (or HARNESS_VERBOSE).
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
29
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
30 TEST_NGINX_LEAVE
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
31
266
b350a2cdbf58 Tests: fixed spelling errors in README.
Ruslan Ermilov <ru@nginx.com>
parents: 134
diff changeset
32 If set, temporary directory with configs and logs won't be deleted on test
b350a2cdbf58 Tests: fixed spelling errors in README.
Ruslan Ermilov <ru@nginx.com>
parents: 134
diff changeset
33 completion. Useful for debugging.
29
71ea39729fa0 Tests: memcached module generic tests.
Maxim Dounin <mdounin@mdounin.ru>
parents: 26
diff changeset
34
134
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
35 TEST_NGINX_CATLOG
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
36
266
b350a2cdbf58 Tests: fixed spelling errors in README.
Ruslan Ermilov <ru@nginx.com>
parents: 134
diff changeset
37 Cat error log to stdout after test completion. Useful for debugging.
13
e8edb765595d Tests: document ports required for tests.
Maxim Dounin <mdounin@mdounin.ru>
parents: 10
diff changeset
38
134
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
39 TEST_NGINX_UNSAFE
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
40
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
41 Run unsafe tests.
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
42
1082
d0edeb90c0ab Tests: additional variables mentioned in README.
Andrei Belov <defan@nginx.com>
parents: 856
diff changeset
43 TEST_NGINX_GLOBALS
d0edeb90c0ab Tests: additional variables mentioned in README.
Andrei Belov <defan@nginx.com>
parents: 856
diff changeset
44
d0edeb90c0ab Tests: additional variables mentioned in README.
Andrei Belov <defan@nginx.com>
parents: 856
diff changeset
45 Sets additional directives in main context.
d0edeb90c0ab Tests: additional variables mentioned in README.
Andrei Belov <defan@nginx.com>
parents: 856
diff changeset
46
d0edeb90c0ab Tests: additional variables mentioned in README.
Andrei Belov <defan@nginx.com>
parents: 856
diff changeset
47 TEST_NGINX_GLOBALS_HTTP
d0edeb90c0ab Tests: additional variables mentioned in README.
Andrei Belov <defan@nginx.com>
parents: 856
diff changeset
48
d0edeb90c0ab Tests: additional variables mentioned in README.
Andrei Belov <defan@nginx.com>
parents: 856
diff changeset
49 Sets additional directives in http context.
d0edeb90c0ab Tests: additional variables mentioned in README.
Andrei Belov <defan@nginx.com>
parents: 856
diff changeset
50
1609
f3ba4c74de31 Tests: added TEST_GLOBALS_STREAM variable support.
Andrei Belov <defan@nginx.com>
parents: 1082
diff changeset
51 TEST_NGINX_GLOBALS_STREAM
f3ba4c74de31 Tests: added TEST_GLOBALS_STREAM variable support.
Andrei Belov <defan@nginx.com>
parents: 1082
diff changeset
52
f3ba4c74de31 Tests: added TEST_GLOBALS_STREAM variable support.
Andrei Belov <defan@nginx.com>
parents: 1082
diff changeset
53 Sets additional directives in stream context.
f3ba4c74de31 Tests: added TEST_GLOBALS_STREAM variable support.
Andrei Belov <defan@nginx.com>
parents: 1082
diff changeset
54
134
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
55 Happy testing!