nginx-proxy-manager/test
Tom Winnerl 07917e1893 fix(review): quarantine a location behind an error without a line
Problem: a custom location with `proxy_set_header X-Test $missing_variable;`
still blocked the whole host save. nginx reports `unknown "missing_variable"
variable` without file or line (variables are checked after parsing), so the
error never reached the per-location quarantine, which needs a line inside a
location's markers. The check without this host passed, so the save was
rejected as a "conflict with another host"; in bulk mode (startup, repair of
another host) the whole host went offline instead of the one location.

Fix: lib/nginx-locations.js gets isolateFaultyLocations(). When an error has
no line and only this host's config causes it (no file named and the test
without the host passes, or the host's file named without a line),
configureHost() stubs the rendered locations: if the error stays with all of
them stubbed it comes from the host itself and the result is unchanged.
Otherwise each location is rendered alone with all the others still stubbed,
and every one that brings the same error back is quarantined. Two broken
locations with the same message are thus both found, and a working location
is never quarantined for them (stubbing one at a time would leave the other's
identical error and blame every candidate). Only when none fails alone (they
fail only together) is each one stubbed alone and the first that makes the
error go away (or change) quarantined, all of them when none does. The loop
then tests the full config again, bounded by maxQuarantines as before. In a
nested configure it is skipped when the host being saved is the cause
(causedByProtected() handles that as before). After the search the config
that failed is written back to the host's file, so a host rejected at host
level in bulk mode keeps its real config as .err for inspection, not the last
stubbed variant.

When no location is to blame (the error stays with all of them stubbed,
or the host has none), the host level check from the feat(nginx) commit
applies as before: the host is only rejected as a conflict with another
host when the error goes away with every other host's config moved aside
(failsAlone()), otherwise it fails with a host level error such as
`Advanced configuration: unknown variable "$x"`.

Tests: nginx-location-isolate.test.js with unit tests for the search and
configureHost() against a fake nginx -t that reports unknown variables
without a line: the bad location is quarantined (503 stub) and the host
stays online; two bad locations with different variables are both
quarantined; two bad locations with the same variable around a clean one
quarantine only the two, the clean one stays ok; the same variable in the
host's advanced config still rejects the host at host level with an
"Advanced configuration" message (not a conflict with another host), also
for a host without locations, and in bulk mode its .err file holds the
real config (proxy_pass, the variable), not 503 stubs, and its nginx_err
names the advanced configuration.

Cypress (ProxyHostLocations): a location with `$missing_variable` is
quarantined with an unknown-variable message, the host stays online, its
other location serves and the bad one answers 503.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 09:03:56 +01:00
..
cypress fix(review): quarantine a location behind an error without a line 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): allow variable forward paths on regex and named locations 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
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.