Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Test::Nginx(3)	      User Contributed Perl Documentation	Test::Nginx(3)

NAME
       Test::Nginx - Data-driven test scaffold for Nginx C module and
       Nginx/OpenResty-based libraries and applications

DESCRIPTION
       This distribution provides two testing modules for Nginx	C module
       development:

       o   Test::Nginx::Socket (This is	highly recommended.)

	   This	library	also has the following subclasses:

	   o   Test::Nginx::Socket::Lua

	   o   Test::Nginx::Socket::Lua::Stream

	   o   Test::Nginx::Socket::Lua::Dgram

       o   Test::Nginx::LWP (This is obsolete.)

       All of them are based on	Test::Base.

       Usually,	Test::Nginx::Socket is preferred because it works on a much
       lower level and not that	fault tolerant like Test::Nginx::LWP.

       Also, a lot of connection hang issues (like wrong "r->main->count"
       value in	nginx 0.8.x) can only be captured by Test::Nginx::Socket
       because Perl's LWP::UserAgent client will close the connection itself
       which will conceal such issues from the testers.

       Test::Nginx automatically starts	an nginx instance (from	the "PATH"
       env) rooted at t/servroot/ and the default config template makes	this
       nginx instance listen on	the port 1984 by default. One can specify a
       different port number by	setting	his port number	to the
       "TEST_NGINX_PORT" environment, as in

	   export TEST_NGINX_PORT=1989

User Guide
       You can find a comprehensive user guide on this test framework in my
       upcoming	book "Programming OpenResty":

       <https://openresty.gitbooks.io/programming-openresty/content/testing/index.html>

Nginx C	modules	that use Test::Nginx to	drive their test suites
       ngx_echo
	   <https://github.com/openresty/echo-nginx-module>

       ngx_headers_more
	   <https://github.com/openresty/headers-more-nginx-module>

       ngx_chunkin
	   <http://wiki.nginx.org/NginxHttpChunkinModule>

       ngx_memc
	   <http://wiki.nginx.org/NginxHttpMemcModule>

       ngx_drizzle
	   <https://github.com/openresty/drizzle-nginx-module>

       ngx_rds_json
	   <https://github.com/openresty/rds-json-nginx-module>

       ngx_rds_csv
	   <https://github.com/openresty/rds-csv-nginx-module>

       ngx_xss
	   <https://github.com/openresty/xss-nginx-module>

       ngx_srcache
	   <https://github.com/openresty/srcache-nginx-module>

       ngx_lua
	   <https://github.com/openresty/lua-nginx-module>

       ngx_set_misc
	   <https://github.com/openresty/set-misc-nginx-module>

       ngx_array_var
	   <https://github.com/openresty/array-var-nginx-module>

       ngx_form_input
	   <https://github.com/calio/form-input-nginx-module>

       ngx_iconv
	   <https://github.com/calio/iconv-nginx-module>

       ngx_set_cconv
	   <https://github.com/liseen/set-cconv-nginx-module>

       ngx_postgres
	   <https://github.com/FRiCKLE/ngx_postgres>

       ngx_coolkit
	   <https://github.com/FRiCKLE/ngx_coolkit>

       Naxsi
	   <https://github.com/nbs-system/naxsi>

       ngx_shibboleth
	   <https://github.com/nginx-shib/nginx-http-shibboleth>

SOURCE REPOSITORY
       This module has a Git repository	on Github, which has access for	all.

       <https://github.com/openresty/test-nginx>

       If you want a commit bit, feel free to drop me a	line.

DEBIAN PACKAGES
       AntA^3nio P. P. Almeida is maintaining a	Debian package for this	module
       in his Debian repository: <http://debian.perusio.net>

Community
   English Mailing List
       The "openresty-en" mailing list is for English speakers:
       <https://groups.google.com/group/openresty-en>

   Chinese Mailing List
       The "openresty" mailing list is for Chinese speakers:
       <https://groups.google.com/group/openresty>

AUTHORS
       Yichun Zhang (agentzh) "<agentzh@gmail.com>", OpenResty Inc.

       Antoine BONAVITA	"<antoine.bonavita@gmail.com>"

COPYRIGHT & LICENSE
       Copyright (c) 2009-2017,	Yichun Zhang (agentzh) "<agentzh@gmail.com>",
       OpenResty Inc.

       Copyright (c) 2011-2012,	Antoine	Bonavita
       "<antoine.bonavita@gmail.com>".

       This module is licensed under the terms of the BSD license.

       Redistribution and use in source	and binary forms, with or without
       modification, are permitted provided that the following conditions are
       met:

       o   Redistributions of source code must retain the above	copyright
	   notice, this	list of	conditions and the following disclaimer.

       o   Redistributions in binary form must reproduce the above copyright
	   notice, this	list of	conditions and the following disclaimer	in the
	   documentation and/or	other materials	provided with the
	   distribution.

       o   Neither the name of the authors nor the names of its	contributors
	   may be used to endorse or promote products derived from this
	   software without specific prior written permission.

       THIS SOFTWARE IS	PROVIDED BY THE	COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
       IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
       TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
       PARTICULAR PURPOSE ARE DISCLAIMED. IN NO	EVENT SHALL THE	COPYRIGHT
       HOLDER OR CONTRIBUTORS BE LIABLE	FOR ANY	DIRECT,	INDIRECT, INCIDENTAL,
       SPECIAL,	EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,	BUT NOT
       LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;	LOSS OF	USE,
       DATA, OR	PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
       THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT	LIABILITY, OR TORT
       (INCLUDING NEGLIGENCE OR	OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
       OF THIS SOFTWARE, EVEN IF ADVISED OF THE	POSSIBILITY OF SUCH DAMAGE.

SEE ALSO
       Test::Nginx::LWP, Test::Nginx::Socket, Test::Base.

perl v5.24.1			  2017-04-09			Test::Nginx(3)

NAME | DESCRIPTION | User Guide | Nginx C modules that use Test::Nginx to drive their test suites | SOURCE REPOSITORY | DEBIAN PACKAGES | Community | AUTHORS | COPYRIGHT & LICENSE | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Test::Nginx&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help