forked from orbit-oss/flask
Do not enable subdomain matching by default
Updated tests for new subdomain matching Added a test to validate matching behavior
This commit is contained in:
parent
4a7db66474
commit
8cec2010c0
4 changed files with 52 additions and 7 deletions
|
|
@ -139,6 +139,8 @@ unreleased
|
||||||
attribute on the session cookie. (`#2607`_)
|
attribute on the session cookie. (`#2607`_)
|
||||||
- Added :meth:`~flask.Flask.test_cli_runner` to create a Click runner
|
- Added :meth:`~flask.Flask.test_cli_runner` to create a Click runner
|
||||||
that can invoke Flask CLI commands for testing. (`#2636`_)
|
that can invoke Flask CLI commands for testing. (`#2636`_)
|
||||||
|
- Subdomain matching is disabled by default now. It can be turned on by
|
||||||
|
passing ``subdomain_matching=True`` to the Flask constructor.
|
||||||
|
|
||||||
.. _pallets/meta#24: https://github.com/pallets/meta/issues/24
|
.. _pallets/meta#24: https://github.com/pallets/meta/issues/24
|
||||||
.. _#1421: https://github.com/pallets/flask/issues/1421
|
.. _#1421: https://github.com/pallets/flask/issues/1421
|
||||||
|
|
|
||||||
16
flask/app.py
16
flask/app.py
|
|
@ -126,6 +126,11 @@ class Flask(_PackageBoundObject):
|
||||||
.. versionadded:: 0.13
|
.. versionadded:: 0.13
|
||||||
The `host_matching` and `static_host` parameters were added.
|
The `host_matching` and `static_host` parameters were added.
|
||||||
|
|
||||||
|
.. versionadded:: 1.0
|
||||||
|
The `subdomain_matching` parameter was added. Subdomain matching
|
||||||
|
needs to be enabled manually now. Setting `SERVER_NAME` does not
|
||||||
|
implicitly enable it.
|
||||||
|
|
||||||
:param import_name: the name of the application package
|
:param import_name: the name of the application package
|
||||||
:param static_url_path: can be used to specify a different path for the
|
:param static_url_path: can be used to specify a different path for the
|
||||||
static files on the web. Defaults to the name
|
static files on the web. Defaults to the name
|
||||||
|
|
@ -347,6 +352,7 @@ class Flask(_PackageBoundObject):
|
||||||
static_folder='static',
|
static_folder='static',
|
||||||
static_host=None,
|
static_host=None,
|
||||||
host_matching=False,
|
host_matching=False,
|
||||||
|
subdomain_matching=False,
|
||||||
template_folder='templates',
|
template_folder='templates',
|
||||||
instance_path=None,
|
instance_path=None,
|
||||||
instance_relative_config=False,
|
instance_relative_config=False,
|
||||||
|
|
@ -530,6 +536,7 @@ class Flask(_PackageBoundObject):
|
||||||
self.url_map = Map()
|
self.url_map = Map()
|
||||||
|
|
||||||
self.url_map.host_matching = host_matching
|
self.url_map.host_matching = host_matching
|
||||||
|
self.subdomain_matching = subdomain_matching
|
||||||
|
|
||||||
# tracks internally if the application already handled at least one
|
# tracks internally if the application already handled at least one
|
||||||
# request.
|
# request.
|
||||||
|
|
@ -1988,8 +1995,15 @@ class Flask(_PackageBoundObject):
|
||||||
URL adapter is created for the application context.
|
URL adapter is created for the application context.
|
||||||
"""
|
"""
|
||||||
if request is not None:
|
if request is not None:
|
||||||
return self.url_map.bind_to_environ(request.environ,
|
rv = self.url_map.bind_to_environ(request.environ,
|
||||||
server_name=self.config['SERVER_NAME'])
|
server_name=self.config['SERVER_NAME'])
|
||||||
|
# If subdomain matching is not enabled (which is the default
|
||||||
|
# we put back the default subdomain in all cases. This really
|
||||||
|
# should be the default in Werkzeug but it currently does not
|
||||||
|
# have that feature.
|
||||||
|
if not self.subdomain_matching:
|
||||||
|
rv.subdomain = self.url_map.default_subdomain
|
||||||
|
return rv
|
||||||
# We need at the very least the server name to be set for this
|
# We need at the very least the server name to be set for this
|
||||||
# to work.
|
# to work.
|
||||||
if self.config['SERVER_NAME'] is not None:
|
if self.config['SERVER_NAME'] is not None:
|
||||||
|
|
|
||||||
|
|
@ -1429,10 +1429,12 @@ def test_request_locals():
|
||||||
assert not flask.g
|
assert not flask.g
|
||||||
|
|
||||||
|
|
||||||
def test_test_app_proper_environ(app, client):
|
def test_test_app_proper_environ():
|
||||||
|
app = flask.Flask(__name__, subdomain_matching=True)
|
||||||
app.config.update(
|
app.config.update(
|
||||||
SERVER_NAME='localhost.localdomain:5000'
|
SERVER_NAME='localhost.localdomain:5000'
|
||||||
)
|
)
|
||||||
|
client = app.test_client()
|
||||||
|
|
||||||
@app.route('/')
|
@app.route('/')
|
||||||
def index():
|
def index():
|
||||||
|
|
@ -1783,8 +1785,10 @@ def test_g_iteration_protocol(app_ctx):
|
||||||
assert sorted(flask.g) == ['bar', 'foo']
|
assert sorted(flask.g) == ['bar', 'foo']
|
||||||
|
|
||||||
|
|
||||||
def test_subdomain_basic_support(app, client):
|
def test_subdomain_basic_support():
|
||||||
|
app = flask.Flask(__name__, subdomain_matching=True)
|
||||||
app.config['SERVER_NAME'] = 'localhost.localdomain'
|
app.config['SERVER_NAME'] = 'localhost.localdomain'
|
||||||
|
client = app.test_client()
|
||||||
|
|
||||||
@app.route('/')
|
@app.route('/')
|
||||||
def normal_index():
|
def normal_index():
|
||||||
|
|
@ -1801,7 +1805,9 @@ def test_subdomain_basic_support(app, client):
|
||||||
assert rv.data == b'test index'
|
assert rv.data == b'test index'
|
||||||
|
|
||||||
|
|
||||||
def test_subdomain_matching(app, client):
|
def test_subdomain_matching():
|
||||||
|
app = flask.Flask(__name__, subdomain_matching=True)
|
||||||
|
client = app.test_client()
|
||||||
app.config['SERVER_NAME'] = 'localhost.localdomain'
|
app.config['SERVER_NAME'] = 'localhost.localdomain'
|
||||||
|
|
||||||
@app.route('/', subdomain='<user>')
|
@app.route('/', subdomain='<user>')
|
||||||
|
|
@ -1812,8 +1818,10 @@ def test_subdomain_matching(app, client):
|
||||||
assert rv.data == b'index for mitsuhiko'
|
assert rv.data == b'index for mitsuhiko'
|
||||||
|
|
||||||
|
|
||||||
def test_subdomain_matching_with_ports(app, client):
|
def test_subdomain_matching_with_ports():
|
||||||
|
app = flask.Flask(__name__, subdomain_matching=True)
|
||||||
app.config['SERVER_NAME'] = 'localhost.localdomain:3000'
|
app.config['SERVER_NAME'] = 'localhost.localdomain:3000'
|
||||||
|
client = app.test_client()
|
||||||
|
|
||||||
@app.route('/', subdomain='<user>')
|
@app.route('/', subdomain='<user>')
|
||||||
def index(user):
|
def index(user):
|
||||||
|
|
@ -1823,6 +1831,23 @@ def test_subdomain_matching_with_ports(app, client):
|
||||||
assert rv.data == b'index for mitsuhiko'
|
assert rv.data == b'index for mitsuhiko'
|
||||||
|
|
||||||
|
|
||||||
|
def test_subdomain_matching_behavior():
|
||||||
|
for matching in False, True:
|
||||||
|
app = flask.Flask(__name__, subdomain_matching=matching)
|
||||||
|
app.config['SERVER_NAME'] = 'localhost.localdomain:3000'
|
||||||
|
client = app.test_client()
|
||||||
|
|
||||||
|
@app.route('/')
|
||||||
|
def index():
|
||||||
|
return 'matched without subdomain'
|
||||||
|
|
||||||
|
rv = client.get('/', 'http://127.0.0.1:3000/')
|
||||||
|
if matching:
|
||||||
|
assert rv.status_code == 404
|
||||||
|
else:
|
||||||
|
assert rv.data == b'matched without subdomain'
|
||||||
|
|
||||||
|
|
||||||
def test_multi_route_rules(app, client):
|
def test_multi_route_rules(app, client):
|
||||||
@app.route('/')
|
@app.route('/')
|
||||||
@app.route('/<test>/')
|
@app.route('/<test>/')
|
||||||
|
|
|
||||||
|
|
@ -114,9 +114,11 @@ def test_path_is_url(app):
|
||||||
assert eb.path == '/'
|
assert eb.path == '/'
|
||||||
|
|
||||||
|
|
||||||
def test_blueprint_with_subdomain(app, client):
|
def test_blueprint_with_subdomain():
|
||||||
|
app = flask.Flask(__name__, subdomain_matching=True)
|
||||||
app.config['SERVER_NAME'] = 'example.com:1234'
|
app.config['SERVER_NAME'] = 'example.com:1234'
|
||||||
app.config['APPLICATION_ROOT'] = '/foo'
|
app.config['APPLICATION_ROOT'] = '/foo'
|
||||||
|
client = app.test_client()
|
||||||
|
|
||||||
bp = flask.Blueprint('company', __name__, subdomain='xxx')
|
bp = flask.Blueprint('company', __name__, subdomain='xxx')
|
||||||
|
|
||||||
|
|
@ -304,8 +306,10 @@ def test_json_request_and_response(app, client):
|
||||||
assert rv.get_json() == json_data
|
assert rv.get_json() == json_data
|
||||||
|
|
||||||
|
|
||||||
def test_subdomain(app, client):
|
def test_subdomain():
|
||||||
|
app = flask.Flask(__name__, subdomain_matching=True)
|
||||||
app.config['SERVER_NAME'] = 'example.com'
|
app.config['SERVER_NAME'] = 'example.com'
|
||||||
|
client = app.test_client()
|
||||||
|
|
||||||
@app.route('/', subdomain='<company_id>')
|
@app.route('/', subdomain='<company_id>')
|
||||||
def view(company_id):
|
def view(company_id):
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue