-
Notifications
You must be signed in to change notification settings - Fork 855
Add Content-Type directive to body factory .body_factory_info #12947
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
bryancall
wants to merge
4
commits into
apache:master
Choose a base branch
from
bryancall:body-factory-content-type
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.
+190
−25
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
f4ff90d
Add Content-Type directive to body factory .body_factory_info
bryancall 1b51b53
Fix Sphinx docs build: use literal markup for .body_factory_info
bryancall 0bc6d99
Address review feedback
bryancall 92275ad
Omit charset from default Content-Type in body factory responses
bryancall 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
104 changes: 104 additions & 0 deletions
104
tests/gold_tests/body_factory/body_factory_content_type.test.py
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,104 @@ | ||
| ''' | ||
| Tests that the Content-Type directive in .body_factory_info is honored | ||
| for body factory error responses. | ||
| ''' | ||
| # 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. | ||
|
|
||
| import os | ||
|
|
||
| Test.Summary = 'Verify Content-Type directive in .body_factory_info controls error response MIME type' | ||
| Test.ContinueOnFail = True | ||
|
|
||
|
|
||
| class BodyFactoryContentTypeTest: | ||
| """ | ||
| Test that the Content-Type directive in .body_factory_info is used for | ||
| body factory error responses instead of the hardcoded text/html default. | ||
|
|
||
| Two scenarios: | ||
| 1. Default: no Content-Type directive -> text/html; charset=utf-8 | ||
| 2. Custom: Content-Type: text/plain -> text/plain; charset=utf-8 | ||
| """ | ||
|
|
||
| def __init__(self): | ||
| self._setupDefaultTS() | ||
| self._setupCustomTS() | ||
|
|
||
| def _setupDefaultTS(self): | ||
| """ATS instance with default body factory (no Content-Type directive).""" | ||
| self._ts_default = Test.MakeATSProcess("ts_default") | ||
| self._ts_default.Disk.records_config.update( | ||
| { | ||
| 'proxy.config.body_factory.enable_customizations': 1, | ||
| 'proxy.config.url_remap.remap_required': 1, | ||
| }) | ||
| self._ts_default.Disk.remap_config.AddLine('map http://mapped.example.com http://127.0.0.1:65535') | ||
|
|
||
| body_factory_dir = self._ts_default.Variables.BODY_FACTORY_TEMPLATE_DIR | ||
| info_path = os.path.join(body_factory_dir, 'default', '.body_factory_info') | ||
| self._ts_default.Disk.File(info_path).WriteOn("Content-Language: en\nContent-Charset: utf-8\n") | ||
|
|
||
| def _setupCustomTS(self): | ||
| """ATS instance with Content-Type: text/plain in .body_factory_info.""" | ||
| self._ts_custom = Test.MakeATSProcess("ts_custom") | ||
| self._ts_custom.Disk.records_config.update( | ||
| { | ||
| 'proxy.config.body_factory.enable_customizations': 1, | ||
| 'proxy.config.url_remap.remap_required': 1, | ||
| }) | ||
| self._ts_custom.Disk.remap_config.AddLine('map http://mapped.example.com http://127.0.0.1:65535') | ||
|
|
||
| body_factory_dir = self._ts_custom.Variables.BODY_FACTORY_TEMPLATE_DIR | ||
| info_path = os.path.join(body_factory_dir, 'default', '.body_factory_info') | ||
| self._ts_custom.Disk.File(info_path).WriteOn("Content-Type: text/plain\n") | ||
|
|
||
| def run(self): | ||
| self._testDefaultContentType() | ||
| self._testCustomContentType() | ||
|
|
||
| def _testDefaultContentType(self): | ||
| """Without Content-Type directive, error responses should use text/html.""" | ||
| tr = Test.AddTestRun('Default body factory Content-Type is text/html') | ||
| tr.Processes.Default.StartBefore(self._ts_default) | ||
| tr.Processes.Default.Command = ( | ||
| f'curl -s -D- -o /dev/null' | ||
| f' -H "Host: unmapped.example.com"' | ||
| f' http://127.0.0.1:{self._ts_default.Variables.port}/') | ||
| tr.Processes.Default.ReturnCode = 0 | ||
| tr.Processes.Default.TimeOut = 5 | ||
| tr.Processes.Default.Streams.stdout += Testers.ContainsExpression( | ||
| 'Content-Type: text/html', 'Default body factory should produce text/html') | ||
| tr.Processes.Default.Streams.stdout += Testers.ContainsExpression('HTTP/1.1 404', 'Unmapped request should get 404') | ||
| tr.StillRunningAfter = self._ts_default | ||
|
|
||
| def _testCustomContentType(self): | ||
| """With Content-Type: text/plain, error responses should use text/plain.""" | ||
| tr = Test.AddTestRun('Custom body factory Content-Type is text/plain') | ||
| tr.Processes.Default.StartBefore(self._ts_custom) | ||
| tr.Processes.Default.Command = ( | ||
| f'curl -s -D- -o /dev/null' | ||
| f' -H "Host: unmapped.example.com"' | ||
| f' http://127.0.0.1:{self._ts_custom.Variables.port}/') | ||
| tr.Processes.Default.ReturnCode = 0 | ||
| tr.Processes.Default.TimeOut = 5 | ||
| tr.Processes.Default.Streams.stdout += Testers.ContainsExpression( | ||
| 'Content-Type: text/plain; charset=utf-8', 'Custom body factory should produce text/plain with charset') | ||
| tr.Processes.Default.Streams.stdout += Testers.ContainsExpression('HTTP/1.1 404', 'Unmapped request should get 404') | ||
| tr.StillRunningAfter = self._ts_custom | ||
|
|
||
|
|
||
| BodyFactoryContentTypeTest().run() |
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.
Content-Language: kris not a standard language tag for Korean (commonlyko/ko-KRper BCP 47). Since this section is newly documenting metadata directives, consider updating the example to use a standard tag to avoid propagating incorrect configuration patterns.