Skip to content

Verify nginx config in functional tests #2014

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kate-osborn opened this issue May 22, 2024 · 1 comment · Fixed by #2522
Closed

Verify nginx config in functional tests #2014

kate-osborn opened this issue May 22, 2024 · 1 comment · Fixed by #2522
Assignees
Labels
refined Requirements are refined and the issue is ready to be implemented. size/large Estimated to be completed within two weeks tests Pull requests that update tests
Milestone

Comments

@kate-osborn
Copy link
Contributor

kate-osborn commented May 22, 2024

As a maintainer of NGF
I want to verify that our NGINX config is what we expect for every functional test we have
So that do not just test for the correct behavior from NGF as a whole, but we also test that we are setting the right configuration for the behavior we expect.

Acceptance

  • NGINX configuration verification is added as a feature to our testing framework.
    • Assert that a directive is present in a given location. E.g. client_max_body size is set to 2MB in the server context.
  • ClientSettingsPolicy functional test is updated to verify NGINX configuration applied.

Dev Notes

  • Some tool might be available to print out NGINX config in JSON format. Crossplane?
@mpstefan mpstefan added tests Pull requests that update tests needs-more-info Issue needs more information from creator labels Jun 3, 2024
@mpstefan
Copy link
Collaborator

mpstefan commented Jun 5, 2024

What do we want to test here, specifically? Are we going to check that the NGINX matches exactly what we expect? Is this valuable if we have to update our tests after each change that affects configuration?

@mpstefan mpstefan removed the needs-more-info Issue needs more information from creator label Jun 17, 2024
@mpstefan mpstefan added this to the v2.0.0 milestone Jun 17, 2024
@mpstefan mpstefan added refined Requirements are refined and the issue is ready to be implemented. size/large Estimated to be completed within two weeks labels Sep 3, 2024
@sjberman sjberman self-assigned this Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refined Requirements are refined and the issue is ready to be implemented. size/large Estimated to be completed within two weeks tests Pull requests that update tests
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants