-
Notifications
You must be signed in to change notification settings - Fork 875
hrw4u: Fix u4wrh raw %{...} passthrough for unresolved HRW variables #13206
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
Clendenin
wants to merge
1
commit into
apache:master
Choose a base branch
from
Clendenin:bugfix/u4wrh-raw-pct
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| REMAP { | ||
| if inbound.conn.client-cert.APRN-RAW { | ||
| inbound.req.X-Cert = "{inbound.conn.client-cert.APRN-RAW}"; | ||
| } | ||
| } |
3 changes: 3 additions & 0 deletions
3
tools/hrw4u/tests/data/conds/bare-client-cert-aprn.output.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| cond %{REMAP_PSEUDO_HOOK} | ||
| cond %{CLIENT-CERT:APRN-RAW} | ||
| set-header X-Cert "%{CLIENT-CERT:APRN-RAW}" |
5 changes: 5 additions & 0 deletions
5
tools/hrw4u/tests/data/conds/bare-client-cert-san-dns.input.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| REMAP { | ||
| if inbound.conn.client-cert.SAN.DNS { | ||
| inbound.req.X-Cert = "{inbound.conn.client-cert.SAN.DNS}"; | ||
| } | ||
| } |
3 changes: 3 additions & 0 deletions
3
tools/hrw4u/tests/data/conds/bare-client-cert-san-dns.output.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| cond %{REMAP_PSEUDO_HOOK} | ||
| cond %{CLIENT-CERT:SAN:DNS} | ||
| set-header X-Cert "%{CLIENT-CERT:SAN:DNS}" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| REMAP { | ||
| if inbound.url.url == "https://download.swift.org/" { | ||
| inbound.status = 301; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| cond %{REMAP_PSEUDO_HOOK} | ||
| cond %{CLIENT-URL} ="https://download.swift.org/" | ||
| set-status 301 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| # | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| from __future__ import annotations | ||
|
|
||
| import re | ||
| from pathlib import Path | ||
|
|
||
| import pytest | ||
| from antlr4 import InputStream, CommonTokenStream | ||
|
|
||
| from hrw4u.errors import ErrorCollector | ||
| from hrw4u.hrw4uLexer import hrw4uLexer | ||
| from hrw4u.hrw4uParser import hrw4uParser | ||
| from hrw4u.visitor import HRW4UVisitor | ||
| from u4wrh.hrw_visitor import HRWInverseVisitor | ||
| from u4wrh.u4wrhLexer import u4wrhLexer | ||
| from u4wrh.u4wrhParser import u4wrhParser | ||
|
|
||
| _RAW_PERCENT_RE = re.compile(r"%\{[^}]*\}") | ||
|
|
||
|
|
||
| def _hrw_to_hrw4u(hrw_text: str, filename: str) -> tuple[str, ErrorCollector]: | ||
| lexer = u4wrhLexer(InputStream(hrw_text)) | ||
| stream = CommonTokenStream(lexer) | ||
| parser = u4wrhParser(stream) | ||
| tree = parser.program() | ||
| collector = ErrorCollector() | ||
| visitor = HRWInverseVisitor(filename=filename, error_collector=collector) | ||
| hrw4u_text = "\n".join(visitor.visit(tree)) | ||
| return hrw4u_text, collector | ||
|
|
||
|
|
||
| def _hrw4u_to_hrw(hrw4u_text: str, filename: str) -> tuple[str, ErrorCollector]: | ||
| lexer = hrw4uLexer(InputStream(hrw4u_text)) | ||
| stream = CommonTokenStream(lexer) | ||
| parser = hrw4uParser(stream) | ||
| tree = parser.program() | ||
| collector = ErrorCollector() | ||
| visitor = HRW4UVisitor(filename=filename, error_collector=collector) | ||
| hrw_text = "\n".join(visitor.visit(tree) or []) | ||
| return hrw_text, collector | ||
|
|
||
|
|
||
| @pytest.mark.reverse | ||
| @pytest.mark.parametrize( | ||
| "fixture_name", | ||
| [ | ||
| "bare-client-url", | ||
| "bare-client-cert-aprn", | ||
| "bare-client-cert-san-dns", | ||
| ], | ||
| ) | ||
| def test_u4wrh_round_trip_no_raw_percent(fixture_name: str) -> None: | ||
| """u4wrh must never emit raw %{...} in HRW4U output for legacy bare HRW tags. | ||
|
|
||
| Verifies both HRW -> HRW4U produces valid, error-free HRW4U AND that | ||
| HRW4U re-parses through hrw4u without errors (round-trip). | ||
| """ | ||
| fixture_dir = Path("tests/data/conds") | ||
| hrw_path = fixture_dir / f"{fixture_name}.output.txt" | ||
| hrw_text = hrw_path.read_text() | ||
|
|
||
| hrw4u_text, u4wrh_errors = _hrw_to_hrw4u(hrw_text, str(hrw_path)) | ||
| assert not u4wrh_errors.has_errors(), (f"u4wrh produced errors for {fixture_name}:\n{u4wrh_errors.get_error_summary()}") | ||
|
|
||
| assert not _RAW_PERCENT_RE.search(hrw4u_text), ( | ||
| f"u4wrh emitted raw %{{...}} in HRW4U output for {fixture_name}:\n{hrw4u_text}") | ||
|
|
||
| _, hrw4u_errors = _hrw4u_to_hrw(hrw4u_text, str(hrw_path)) | ||
| assert not hrw4u_errors.has_errors(), ( | ||
| f"hrw4u failed to re-parse u4wrh HRW4U output for {fixture_name}:\n" | ||
| f"HRW4U:\n{hrw4u_text}\nErrors:\n{hrw4u_errors.get_error_summary()}") |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Clendenin This has to be addressed.