Test::Nginx::Socket::Lua::Stream(3pm)

NAME
Test::Nginx::Socket::Lua::Stream - Subclass of Test::Nginx::Socket::Lua to test NGINX stream modules

SYNOPSIS
    === TEST 1: simple test for ngx_stream_echo_module
    --- stream_server_config
    echo "Hello, stream echo!";

    --- stream_response
    Hello, stream echo!

    --- no_error_log
    [error]
    [alert]

Description
This module subclasses Test::Nginx::Socket::Lua to provide handy abstractions for testing NGINX stream-typed modules like ngx_stream_echo_module.

By default, the stream server listens on the port number N + 1 where N is the value of the environment "TEST_NGINX_SERVER_PORT" or "TEST_NGINX_PORT" (both default to 1984). One can explicitly specify the default stream server's listening port via the "TEST_NGINX_STREAM_PORT" environment.

Sections supported
All the existing sections of Test::Nginx::Socket::Lua are automatically inherited.

The following new test sections are supported:

  stream_config
Specifies custom content in the default "stream {}" configuration block.

  stream_server_config
Specifies custom content in the default "server {}" configuration block (inside "stream {}") in nginx.conf.

For example,

    --- stream_server_config
    echo "hello";

will generate something like below in nginx.conf:

    stream {
        server {
            listen 1985;
            echo "Hello, stream echo!";
        }
    }

  stream_server_config2
Specifies a second stream server which listens on the port used by the first default server plus one.

  stream_server_config3
Specifies a third stream server which listens on the port used by the first default server plus two.

  stream_request
Specifies the request data sent to the first default stream server (defined by "stream_server_config".

  stream_request2
Specifies the request data sent to the second default stream server (defined by "stream_server_config2".

  stream_request3
Specifies the request data sent to the third default stream server (defined by "stream_server_config3".

  stream_response
Specifies expected response content sent from the default stream servers. For example,

    === TEST 1: simple echo
    --- stream_server_config
    echo "Hello, stream echo!";

    --- stream_response
    Hello, stream echo!

When multiple default stream servers are specified (i.e., via "stream_server_config2" and "stream_server_config3", the responses from all these stream servers are concatenated together in the order of their specifications.

  stream_response_like
Specifies the regex pattern used to test the response data from the default stream servers.

  log_stream_response
Print out the stream response to the nginx error log with the "info" level instead of sending it out to the stream client directly.

AUTHOR
Yichun "agentzh" Zhang (章亦春) "<agentzh@gmail.com>", OpenResty Inc.

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

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.

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