Test::Nginx(3pm)

📦
version 0.32.9.g58cf0d5 · 2 versions
, in ubuntu stonking

✨ Test::Nginx ✨

okay bestie, welcome to Test::Nginx (that's the Test::Nginx(3pm) page you just opened, hi 💖) — a data-driven test scaffold for Nginx C module and Nginx/OpenResty-based libraries and applications. yes she does it all. 💅

🌸 DESCRIPTION 🌸

so this distribution? it hands you two testing modules for Nginx C module development:

  • Test::Nginx::Socket — bestie this is the highly recommended one, periodt. 👑
    • and guess what, this library also has the following subclasses:
      • Test::Nginx::Socket::Lua
      • Test::Nginx::Socket::Lua::Stream
      • Test::Nginx::Socket::Lua::Dgram
  • Test::Nginx::LWP — this one is obsolete. it's giving throwback, ngl. 💀

all of them are based on Test::Base, so they're all cousins fr fr.

usually, Test::Nginx::Socket is the preference because it works on a much lower level and is not that fault tolerant like Test::Nginx::LWP. lowkey the whole point.

also — and this is the tea ☕ — a lot of connection hang issues (like a 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, and that will conceal such issues from the testers. so like, LWP is literally hiding the crime. 🙈

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. iconic number honestly.

you can specify a different port number by setting his port number to the TEST_NGINX_PORT environment, as in:

export TEST_NGINX_PORT=1989

slay. that's it, that's the whole thing. ✨

📖 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

go read it bestie, it's giving educational. 🦋

🔥 Nginx C modules that use Test::Nginx to drive their test suites 🔥

look at that roster. main character energy across the board. 👑

💖 INSTALLATION 💖

if you have cpan installed, you can simply run the command to install this module:

sudo cpan Test::Nginx

if you want to install from the source code directory directly, you can run:

sudo cpan .

if you prefer cpanm to cpan (like I do!), you can replace cpan in the commands above with cpanm. we love a one-word swap. 🫶

otherwise you can install this module in the good old way below:

perl Makefile.PL
make
sudo make install

old school, still valid, still eating. 💅

🌈 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. not me casually offering you the keys to the kingdom. 🔑

🎀 DEBIAN PACKAGES 🎀

António P. P. Almeida is maintaining a Debian package for this module in his Debian repository:

http://debian.perusio.net

shoutout António, doing the lord's work. 🙌

🧚 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

both vibes, both valid, join whichever speaks your language bestie. 💜

⭐ AUTHORS ⭐

  • Yichun Zhang (agentzh) "<agentzh@gmail.com>", OpenResty Inc.
  • Antoine BONAVITA "<antoine.bonavita@gmail.com>"

two icons. two legends. 🫡

Copyright (c) 2009-2025, 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:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • 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.
  • 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.

(that's the all-caps legal bit, bestie — dramatic on purpose, don't fear it, just respect it. ✋💀)

🌸 SEE ALSO 🌸

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

go forth and test, my love. ✨

and that's a wrap, bestie! 💖 this page is perl v5.40.1 coded, dated 2026-08-10, and it's Test::Nginx(3pm) — the user-contributed Perl documentation, one of one, no notes. stay hydrated, keep your ports open, and go write some slay tests. 🦋💅👑

📦 where this page comes from