annotate README @ 540:481d705b8610

Tests: SSL support in mail backends. Socket is now embedded into every mail module. Socket methods are wrapped where appropriate. The new "SSL" extra flag specifies to accept connection over SSL.
author Sergey Kandaurov <pluknet@nginx.com>
date Fri, 03 Apr 2015 00:11:38 +0300
parents b350a2cdbf58
children d39e98893265
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
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
21 TEST_NGINX_VERBOSE
10
6d6776623948 Add some basic docs and license information.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
22
134
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
23 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
24 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
25
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
26 TEST_NGINX_LEAVE
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
27
266
b350a2cdbf58 Tests: fixed spelling errors in README.
Ruslan Ermilov <ru@nginx.com>
parents: 134
diff changeset
28 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
29 completion. Useful for debugging.
29
71ea39729fa0 Tests: memcached module generic tests.
Maxim Dounin <mdounin@mdounin.ru>
parents: 26
diff changeset
30
134
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
31 TEST_NGINX_CATLOG
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
32
266
b350a2cdbf58 Tests: fixed spelling errors in README.
Ruslan Ermilov <ru@nginx.com>
parents: 134
diff changeset
33 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
34
134
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
35 TEST_NGINX_UNSAFE
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
36
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
37 Run unsafe tests.
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
38
c4021ebb41b6 Tests: rewrite README to be more complete.
Maxim Dounin <mdounin@mdounin.ru>
parents: 133
diff changeset
39 Happy testing!