Skip to content

Location regex should respect Exact paths #13374

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dacohen
Copy link

@dacohen dacohen commented May 15, 2025

If a location is marked as Exact, and the ingress uses regex matching, the resulting location block should respect this.

What this PR does / why we need it:

Even when an ingress has regex matching enabled, Exact paths should still be respected. Currently, they're ignored, which leads to non-intuitive behavior.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • CVE Report (Scanner found CVE and adding report)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation only

Which issue/s this PR fixes

fixes #11397

How Has This Been Tested?

A test case was added to validate that the change generates the expected location block in the resulting nginx config.

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have added unit and/or e2e tests to cover my changes.
  • All new and existing tests passed.

Copy link

netlify bot commented May 15, 2025

Deploy Preview for kubernetes-ingress-nginx canceled.

Name Link
🔨 Latest commit 504dfb0
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-ingress-nginx/deploys/68257d3d165a330008d06bc0

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 15, 2025
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: dacohen
Once this PR has been reviewed and has the lgtm label, please assign strongjz for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the needs-kind Indicates a PR lacks a `kind/foo` label and requires one. label May 15, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @dacohen!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/ingress-nginx has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @dacohen. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-priority needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 15, 2025
If a location is marked as Exact, and the ingress uses regex matching, the resulting location block should respect this.
@dacohen dacohen force-pushed the exact_regex_locations branch from e40fb53 to 504dfb0 Compare May 15, 2025 05:35
@tao12345666333 tao12345666333 requested a review from Copilot May 19, 2025 07:32
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the handling of exact paths when regex matching is enabled, ensuring that exact location blocks are generated correctly in the nginx configuration. Key changes include new e2e test cases validating exact path behavior, updates to the rewrite annotation tests to use terminating regex patterns, and modifications to both the location building logic and its tests.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
test/e2e/ingress/pathtype_exact.go Added tests checking that exact paths are respected under regex matching conditions
test/e2e/annotations/rewrite.go Updated location regex patterns to include end-of-string markers where needed
internal/ingress/controller/template/template_test.go Extended tests to cover the new behavior for exact paths
internal/ingress/controller/template/template.go Modified the buildLocation function to generate regex with '$' for exact paths when regex matching is enforced


if location.PathType != nil && *location.PathType == networkingv1.PathTypeExact {
if enforceRegex {
return fmt.Sprintf(`~* "^%s$"`, path)
Copy link
Preview

Copilot AI May 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider adding an inline comment above this branch to explain that appending '$' ensures the regex matches exactly and avoids unintended partial matches when enforceRegex is true.

Copilot uses AI. Check for mistakes.

@tao12345666333
Copy link
Member

Thank you for your contribution, but I have some concerns about introducing breaking changes at this time.

cc @strongjz @Gacko

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
3 participants