certbot/certbot-compatibility-test/nginx
Yaroslav Halchenko 86f76cd3df
Add codespell support (CI to check, not to fix) and make it fix a few typos (#10297)
Another token of gratitude for a super useful tool and service.

More about codespell: https://github.com/codespell-project/codespell .

I personally introduced it to dozens if not hundreds of projects already
and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

---------

Signed-off-by: Yaroslav O. Halchenko <debian@onerussian.com>
2025-06-24 13:14:31 +09:00
..
nginx-roundtrip-testdata Add codespell support (CI to check, not to fix) and make it fix a few typos (#10297) 2025-06-24 13:14:31 +09:00
README Initial version of nginx parser roundtrip test 2016-07-11 13:58:21 -07:00
roundtrip.py Reorganize imports (#7616) 2019-12-09 15:50:20 -05:00

Eventually there will also be a compatibility test here like the Apache one.

Right now, this is data for the roundtrip test (checking that the parser
can parse each file and that the reserialized config file it generates is
identical to the original).

If run in a virtualenv or otherwise so that certbot_nginx can be imported,
the roundtrip test can run as

python roundtrip.py nginx-roundtrip-testdata

It gives exit status 0 for success and 1 if at least one parse or roundtrip
failure occurred.


The directory nginx-roundtrip-testdata includes some config files that were
contributed to our project as well as most of the configs linked from

https://www.nginx.com/resources/wiki/start/

Some exceptions that were skipped are

https://www.nginx.com/resources/wiki/start/topics/recipes/moinmoin/
https://www.nginx.com/resources/wiki/start/topics/examples/SSL-Offloader/ (not much nginx configuration)
https://www.nginx.com/resources/wiki/start/topics/examples/xsendfile/ (likewise)
https://www.nginx.com/resources/wiki/start/topics/examples/x-accel/
https://www.nginx.com/resources/wiki/start/topics/examples/fcgiwrap/