2. Running Tests

1. Test Setup

Run the following command to install the NGINX Perl based testing framework:

cpan Test::Nginx

2. Run Tests

Then run this command from the root folder to execute all NGINX tests developed in the t folder:

make test

3. Understand the Nginx Test Framework

See the Test::Nginx and OpenResty Testing docs to understand syntax.

4. Understand Test Behavior

Each test spins up an instance of NGINX under the t/servroot folder which runs on the default test port of 1984.
Tests that are expected to succeed use proxy_pass to route to a target that runs after the module and simply returns.
This example returns the decrypted access token as a target API response header, to support assertions.

location /t {
    oauth_proxy on;
    oauth_proxy_cookie_name_prefix "mycompany-myproduct";
    oauth_proxy_encryption_key "4e4636356d65563e4c73233847503e3b21436e6f7629724950526f4b5e2e4e50";
    oauth_proxy_trusted_web_origin "https://www.example.com";
    oauth_proxy_cors_enabled on;
    oauth_proxy_allow_tokens on;
    
    proxy_pass http://localhost:1984/target;
}
location /target {
    add_header 'authorization' $http_authorization;
    return 200;
}

5. Troubleshoot Failed Tests

If one test out of many is failing, then edit the Makefile to run a single file instead of *.t:

test: all
	cd testing && PATH=$(NGINX_SRC_DIR)/objs:$$PATH prove -v -f t/*.t

Then add the ONLY directive to limit test execution to the single test that is failing:

--- config
location /t {
    ...
}

--- request
GET /t

--- ONLY

View the t/servroot/conf/nginx.conf file to see the deployed configuration for a test.
If required, add ngx_log_error statements to C code, then look at test logs at t/servroot/logs/error.log.
If you get cryptic permission errors or locked files, delete the t/servroot folder.