nginx-proxy-manager/test
Tom Winnerl 6dafc15686 test(upstreams): unit tests and Cypress spec
Unit tests for candidate merging, the reachability check, DNS and Docker
API discovery (with recorded Docker API fixtures), the health monitor and
the shared helpers. The Cypress spec exercises the /api/upstreams endpoints
against the e2e stack, including permissions and validation errors.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 09:03:56 +01:00
..
cypress test(upstreams): unit tests and Cypress spec 2026-11-14 09:03:56 +01:00
docker Fix access list rules and SSL missing from re-rendered host configs 2026-10-05 22:13:31 +10:00
nginx-semantics fix(review): apply rewrite-phase guards of included files to cached assets 2026-11-14 09:03:56 +01:00
.eslintrc.json Major update to cypress 2024-05-21 12:53:07 +10:00
.gitignore Major update to cypress 2024-05-21 12:53:07 +10:00
.prettierrc v2.1.0 (#293) 2020-02-19 15:55:06 +11:00
host-header-smoke.py Fix for changing the upstream Host from $host to $forward_host 2026-11-09 22:09:34 +10:00
jsconfig.json Cypress ... 2026-01-27 11:22:16 +10:00
multi-reporter.json Cypress fixes 2020-08-06 12:47:24 +10:00
package.json Update all deps, and cypress 2026-11-04 20:54:23 +10:00
README.md fix(proxy): isolate cached assets by forwarded authority 2026-10-14 14:48:22 +08:00
vacuum-rules.yaml Swagger/openapi schema mega fixes and Cypress validation/enforcement 2025-10-30 11:50:51 +10:00
vacuum.conf.yaml Swagger/openapi schema mega fixes and Cypress validation/enforcement 2025-10-30 11:50:51 +10:00
yarn.lock Update all deps, and cypress 2026-11-04 20:54:23 +10:00

Cypress Test Suite

Host Header Regression Test

Run python3 test/host-header-smoke.py <built-image> from the repository root. The backend CI build runs this check against the image it builds. It creates a disposable NPM container and renders a proxy host through the backend's normal configuration generator, including a custom location. A synthetic HTTPS upstream checks that the forwarded Host matches Origin and Referer, and echoes the request method, path and body. Coverage includes HTTP and HTTPS, explicit default and nonstandard ports, mixed-case names, IPv6 authorities, and HTTP/1.0 without Host. All test traffic and published Docker ports use loopback; the container and its anonymous volumes are removed on completion.

Running Locally

cd nginxproxymanager/test
yarn install
yarn run cypress

VS Code

Editor settings are not committed to the repository, typically because each developer has their own settings. Below is a list of common setting that may help, so feel free to try them or ignore them, you are a strong independent developer. You can add settings to either "user" or "workspace" but we recommend using "workspace" as each project is different.

ESLint

The ESLint extension only works on JavaScript files by default, so add the following to your workspace settings and reload VSCode.

"eslint.autoFixOnSave": true,
"eslint.validate": [
	{ "language": "javascript", "autoFix": true },
	"html"
]

NOTE: If you've also set the editor.formatOnSave option to true in your settings.json, you'll need to add the following config to prevent running 2 formatting commands on save for JavaScript and TypeScript files:

"editor.formatOnSave": true,
"[javascript]": {
	"editor.formatOnSave": false,
},
"[javascriptreact]": {
	"editor.formatOnSave": false,
},
"[typescript]": {
	"editor.formatOnSave": false,
},
"[typescriptreact]": {
	"editor.formatOnSave": false,
},

Forwarded Host image test

Run python3 test/host-header-smoke.py <built-image> from the repository root. The test waits for the manager, generated HTTP/HTTPS proxy host, both location paths and its synthetic upstream. It verifies Host/Origin/Referer consistency, request bodies and HTTP/1.0 fallback, then uses a dynamic upstream counter to prove cache hits and isolation between client authorities on ports 232 and 233. Requests run through docker exec, so a remote Docker daemon or containerized CI agent needs no shared loopback interface or published ports. The CI image build script invokes this test against the image it just built.