Skip to content

Commit 42567bd

Browse files
agentzhagentzh
committed
docs: made the "Test Suite" section up to date (I hope).
1 parent 7720bc7 commit 42567bd

File tree

3 files changed

+130
-105
lines changed

3 files changed

+130
-105
lines changed

‎README

Lines changed: 46 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -6139,77 +6139,82 @@ Changes
61396139
Test Suite
61406140
The following dependencies are required to run the test suite:
61416141

6142-
* Nginx version >= 0.8.54
6142+
* Nginx version >= 1.4.2
61436143

61446144
* Perl modules:
61456145

6146-
* test-nginx: http://github.com/agentzh/test-nginx
6146+
* Test::Nginx: http://github.com/agentzh/test-nginx
61476147

61486148
* Nginx modules:
61496149

6150-
* echo-nginx-module: http://github.com/agentzh/echo-nginx-module
6150+
* ngx_devel_kit (<https://github.com/simpl/ngx_devel_kit>)
61516151

6152-
* drizzle-nginx-module:
6153-
http://github.com/chaoslawful/drizzle-nginx-module
6152+
* ngx_set_misc (<http://github.com/agentzh/set-misc-nginx-module>)
61546153

6155-
* rds-json-nginx-module:
6156-
http://github.com/agentzh/rds-json-nginx-module
6154+
* ngx_auth_request
6155+
(<http://mdounin.ru/files/ngx_http_auth_request_module-0.2.tar.g
6156+
z>) (this is not needed if you're using Nginx 1.5.4+.
61576157

6158-
* set-misc-nginx-module:
6159-
http://github.com/agentzh/set-misc-nginx-module
6158+
* ngx_echo (<http://github.com/agentzh/echo-nginx-module>)
61606159

6161-
* headers-more-nginx-module:
6162-
http://github.com/agentzh/headers-more-nginx-module
6160+
* ngx_memc (<http://github.com/agentzh/memc-nginx-module>)
61636161

6164-
* memc-nginx-module: http://github.com/agentzh/memc-nginx-module
6162+
* ngx_srcache (<http://github.com/agentzh/srcache-nginx-module>)
61656163

6166-
* srcache-nginx-module:
6167-
http://github.com/agentzh/srcache-nginx-module
6164+
* ngx_lua (i.e., this module)
61686165

6169-
* ngx_auth_request:
6170-
http://mdounin.ru/hg/ngx_http_auth_request_module/
6166+
* ngx_headers_more
6167+
(<http://github.com/agentzh/headers-more-nginx-module>)
61716168

6172-
* C libraries:
6169+
* ngx_drizzle
6170+
(<http://github.com/chaoslawful/drizzle-nginx-module>)
61736171

6174-
* yajl: https://github.com/lloyd/yajl
6172+
* ngx_rds_json (<http://github.com/agentzh/rds-json-nginx-module>)
61756173

6176-
* Lua modules:
6174+
* ngx_coolkit (<https://github.com/FRiCKLE/ngx_coolkit>)
61776175

6178-
* lua-yajl: https://github.com/brimworks/lua-yajl
6176+
* ngx_redis2 (<http://github.com/agentzh/redis2-nginx-module>)
61796177

6180-
* Note: the compiled module has to be placed in
6181-
'/usr/local/lib/lua/5.1/'
6178+
The order in which these modules are added during configuration is
6179+
important because the position of any filter module in the filtering
6180+
chain determines the final output, for example. The correct adding order
6181+
is shown above.
6182+
6183+
* 3rd-party Lua libraries:
6184+
6185+
* lua-cjson
6186+
(<http://www.kyne.com.au/~mark/software/lua-cjson.php>)
61826187

61836188
* Applications:
61846189

61856190
* mysql: create database 'ngx_test', grant all privileges to user
61866191
'ngx_test', password is 'ngx_test'
61876192

6188-
* memcached
6189-
6190-
The order in which these modules are added during configuration is
6191-
important as the position of any filter module in the filtering chain
6192-
determines the final output. The correct adding order is:
6193-
6194-
1. ngx_devel_kit
6195-
6196-
2. set-misc-nginx-module
6197-
6198-
3. ngx_http_auth_request_module
6199-
6200-
4. echo-nginx-module
6193+
* memcached: listening on the default port, 11211.
62016194

6202-
5. memc-nginx-module
6195+
* redis: listening on the default port, 6379.
62036196

6204-
6. lua-nginx-module (i.e. this module)
6197+
See also the developer build script
6198+
(<https://github.com/chaoslawful/lua-nginx-module/blob/master/util/build
6199+
2.sh>) for more details on setting up the testing environment.
62056200

6206-
7. headers-more-nginx-module
6201+
To run the whole test suite in the default testing mode: cd
6202+
/path/to/lua-nginx-module export PATH=/path/to/your/nginx/sbin:$PATH
6203+
prove -I/path/to/test-nginx/lib -r t
62076204

6208-
8. srcache-nginx-module
6205+
To run specific test files: cd /path/to/lua-nginx-module export
6206+
PATH=/path/to/your/nginx/sbin:$PATH prove -I/path/to/test-nginx/lib
6207+
t/002-content.t t/003-errors.t
62096208

6210-
9. drizzle-nginx-module
6209+
To run a specific test block in a particular test file, add the line
6210+
"--- ONLY" to the test block you want to run, and then use the `prove`
6211+
utility to run that ".t" file.
62116212

6212-
10. rds-json-nginx-module
6213+
There are also various testing modes based on mockeagain, valgrind, and
6214+
etc. Refer to the Test::Nginx documentation
6215+
(<http://search.cpan.org/perldoc?Test::Nginx>) for more details for
6216+
various advanced testing modes. See also the test reports for the Nginx
6217+
test cluster running on Amazon EC2: http://qa.openresty.org.
62136218

62146219
Copyright and License
62156220
This module is licensed under the BSD license.

‎README.markdown

Lines changed: 42 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5425,45 +5425,55 @@ Test Suite
54255425

54265426
The following dependencies are required to run the test suite:
54275427

5428-
* Nginx version >= 0.8.54
5428+
* Nginx version >= 1.4.2
54295429

54305430
* Perl modules:
5431-
* test-nginx: <http://github.com/agentzh/test-nginx>
5431+
* Test::Nginx: <http://github.com/agentzh/test-nginx>
54325432

54335433
* Nginx modules:
5434-
* echo-nginx-module: <http://github.com/agentzh/echo-nginx-module>
5435-
* drizzle-nginx-module: <http://github.com/chaoslawful/drizzle-nginx-module>
5436-
* rds-json-nginx-module: <http://github.com/agentzh/rds-json-nginx-module>
5437-
* set-misc-nginx-module: <http://github.com/agentzh/set-misc-nginx-module>
5438-
* headers-more-nginx-module: <http://github.com/agentzh/headers-more-nginx-module>
5439-
* memc-nginx-module: <http://github.com/agentzh/memc-nginx-module>
5440-
* srcache-nginx-module: <http://github.com/agentzh/srcache-nginx-module>
5441-
* ngx_auth_request: <http://mdounin.ru/hg/ngx_http_auth_request_module/>
5442-
5443-
* C libraries:
5444-
* yajl: <https://github.com/lloyd/yajl>
5445-
5446-
* Lua modules:
5447-
* lua-yajl: <https://github.com/brimworks/lua-yajl>
5448-
* Note: the compiled module has to be placed in '/usr/local/lib/lua/5.1/'
5434+
* [ngx_devel_kit](https://github.com/simpl/ngx_devel_kit)
5435+
* [ngx_set_misc](http://github.com/agentzh/set-misc-nginx-module)
5436+
* [ngx_auth_request](http://mdounin.ru/files/ngx_http_auth_request_module-0.2.tar.gz) (this is not needed if you're using Nginx 1.5.4+.
5437+
* [ngx_echo](http://github.com/agentzh/echo-nginx-module)
5438+
* [ngx_memc](http://github.com/agentzh/memc-nginx-module)
5439+
* [ngx_srcache](http://github.com/agentzh/srcache-nginx-module)
5440+
* ngx_lua (i.e., this module)
5441+
* [ngx_headers_more](http://github.com/agentzh/headers-more-nginx-module)
5442+
* [ngx_drizzle](http://github.com/chaoslawful/drizzle-nginx-module)
5443+
* [ngx_rds_json](http://github.com/agentzh/rds-json-nginx-module)
5444+
* [ngx_coolkit](https://github.com/FRiCKLE/ngx_coolkit)
5445+
* [ngx_redis2](http://github.com/agentzh/redis2-nginx-module)
5446+
5447+
The order in which these modules are added during configuration is important because the position of any filter module in the
5448+
filtering chain determines the final output, for example. The correct adding order is shown above.
5449+
5450+
* 3rd-party Lua libraries:
5451+
* [lua-cjson](http://www.kyne.com.au/~mark/software/lua-cjson.php)
54495452

54505453
* Applications:
54515454
* mysql: create database 'ngx_test', grant all privileges to user 'ngx_test', password is 'ngx_test'
5452-
* memcached
5453-
5454-
The order in which these modules are added during configuration is important as the position of any filter module in the
5455-
filtering chain determines the final output. The correct adding order is:
5456-
5457-
1. ngx_devel_kit
5458-
1. set-misc-nginx-module
5459-
1. ngx_http_auth_request_module
5460-
1. echo-nginx-module
5461-
1. memc-nginx-module
5462-
1. lua-nginx-module (i.e. this module)
5463-
1. headers-more-nginx-module
5464-
1. srcache-nginx-module
5465-
1. drizzle-nginx-module
5466-
1. rds-json-nginx-module
5455+
* memcached: listening on the default port, 11211.
5456+
* redis: listening on the default port, 6379.
5457+
5458+
See also the [developer build script](https://github.com/chaoslawful/lua-nginx-module/blob/master/util/build2.sh) for more details on setting up the testing environment.
5459+
5460+
To run the whole test suite in the default testing mode:
5461+
5462+
cd /path/to/lua-nginx-module
5463+
export PATH=/path/to/your/nginx/sbin:$PATH
5464+
prove -I/path/to/test-nginx/lib -r t
5465+
5466+
5467+
To run specific test files:
5468+
5469+
cd /path/to/lua-nginx-module
5470+
export PATH=/path/to/your/nginx/sbin:$PATH
5471+
prove -I/path/to/test-nginx/lib t/002-content.t t/003-errors.t
5472+
5473+
5474+
To run a specific test block in a particular test file, add the line `--- ONLY` to the test block you want to run, and then use the `prove` utility to run that `.t` file.
5475+
5476+
There are also various testing modes based on mockeagain, valgrind, and etc. Refer to the [Test::Nginx documentation](http://search.cpan.org/perldoc?Test::Nginx) for more details for various advanced testing modes. See also the test reports for the Nginx test cluster running on Amazon EC2: <http://qa.openresty.org.>
54675477

54685478
Copyright and License
54695479
=====================

‎doc/HttpLuaModule.wiki

Lines changed: 42 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5235,45 +5235,55 @@ http://openresty.org/#Changes
52355235
52365236
The following dependencies are required to run the test suite:
52375237
5238-
* Nginx version >= 0.8.54
5238+
* Nginx version >= 1.4.2
52395239
52405240
* Perl modules:
5241-
** test-nginx: http://github.com/agentzh/test-nginx
5241+
** Test::Nginx: http://github.com/agentzh/test-nginx
52425242
52435243
* Nginx modules:
5244-
** echo-nginx-module: http://github.com/agentzh/echo-nginx-module
5245-
** drizzle-nginx-module: http://github.com/chaoslawful/drizzle-nginx-module
5246-
** rds-json-nginx-module: http://github.com/agentzh/rds-json-nginx-module
5247-
** set-misc-nginx-module: http://github.com/agentzh/set-misc-nginx-module
5248-
** headers-more-nginx-module: http://github.com/agentzh/headers-more-nginx-module
5249-
** memc-nginx-module: http://github.com/agentzh/memc-nginx-module
5250-
** srcache-nginx-module: http://github.com/agentzh/srcache-nginx-module
5251-
** ngx_auth_request: http://mdounin.ru/hg/ngx_http_auth_request_module/
5252-
5253-
* C libraries:
5254-
** yajl: https://github.com/lloyd/yajl
5255-
5256-
* Lua modules:
5257-
** lua-yajl: https://github.com/brimworks/lua-yajl
5258-
*** Note: the compiled module has to be placed in '/usr/local/lib/lua/5.1/'
5244+
** [https://github.com/simpl/ngx_devel_kit ngx_devel_kit]
5245+
** [http://github.com/agentzh/set-misc-nginx-module ngx_set_misc]
5246+
** [http://mdounin.ru/files/ngx_http_auth_request_module-0.2.tar.gz ngx_auth_request] (this is not needed if you're using Nginx 1.5.4+.
5247+
** [http://github.com/agentzh/echo-nginx-module ngx_echo]
5248+
** [http://github.com/agentzh/memc-nginx-module ngx_memc]
5249+
** [http://github.com/agentzh/srcache-nginx-module ngx_srcache]
5250+
** ngx_lua (i.e., this module)
5251+
** [http://github.com/agentzh/headers-more-nginx-module ngx_headers_more]
5252+
** [http://github.com/chaoslawful/drizzle-nginx-module ngx_drizzle]
5253+
** [http://github.com/agentzh/rds-json-nginx-module ngx_rds_json]
5254+
** [https://github.com/FRiCKLE/ngx_coolkit ngx_coolkit]
5255+
** [http://github.com/agentzh/redis2-nginx-module ngx_redis2]
5256+
5257+
The order in which these modules are added during configuration is important because the position of any filter module in the
5258+
filtering chain determines the final output, for example. The correct adding order is shown above.
5259+
5260+
* 3rd-party Lua libraries:
5261+
** [http://www.kyne.com.au/~mark/software/lua-cjson.php lua-cjson]
52595262
52605263
* Applications:
52615264
** mysql: create database 'ngx_test', grant all privileges to user 'ngx_test', password is 'ngx_test'
5262-
** memcached
5263-
5264-
The order in which these modules are added during configuration is important as the position of any filter module in the
5265-
filtering chain determines the final output. The correct adding order is:
5266-
5267-
# ngx_devel_kit
5268-
# set-misc-nginx-module
5269-
# ngx_http_auth_request_module
5270-
# echo-nginx-module
5271-
# memc-nginx-module
5272-
# lua-nginx-module (i.e. this module)
5273-
# headers-more-nginx-module
5274-
# srcache-nginx-module
5275-
# drizzle-nginx-module
5276-
# rds-json-nginx-module
5265+
** memcached: listening on the default port, 11211.
5266+
** redis: listening on the default port, 6379.
5267+
5268+
See also the [https://github.com/chaoslawful/lua-nginx-module/blob/master/util/build2.sh developer build script] for more details on setting up the testing environment.
5269+
5270+
To run the whole test suite in the default testing mode:
5271+
<geshi lang="text">
5272+
cd /path/to/lua-nginx-module
5273+
export PATH=/path/to/your/nginx/sbin:$PATH
5274+
prove -I/path/to/test-nginx/lib -r t
5275+
</geshi>
5276+
5277+
To run specific test files:
5278+
<geshi lang="text">
5279+
cd /path/to/lua-nginx-module
5280+
export PATH=/path/to/your/nginx/sbin:$PATH
5281+
prove -I/path/to/test-nginx/lib t/002-content.t t/003-errors.t
5282+
</geshi>
5283+
5284+
To run a specific test block in a particular test file, add the line <code>--- ONLY</code> to the test block you want to run, and then use the `prove` utility to run that <code>.t</code> file.
5285+
5286+
There are also various testing modes based on mockeagain, valgrind, and etc. Refer to the [http://search.cpan.org/perldoc?Test::Nginx Test::Nginx documentation] for more details for various advanced testing modes. See also the test reports for the Nginx test cluster running on Amazon EC2: http://qa.openresty.org.
52775287
52785288
= Copyright and License =
52795289

0 commit comments

Comments
 (0)