fresco 3.3.1__py3-none-any.whl → 3.3.3__py3-none-any.whl

fresco/tests/test_request.py

@@ -0,0 +1,448 @@
+# encoding=UTF-8
+# Copyright 2015 Oliver Cope
+#
+# Licensed 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 io import BytesIO
+import datetime
+
+import pytest
+
+from fresco import FrescoApp, exceptions
+from fresco.tests import fixtures
+
+context = FrescoApp().requestcontext
+
+
+class TestRequestProperties(object):
+    def test_url_script_name_only(self):
+        with context(SCRIPT_NAME="/foo/bar", PATH_INFO="") as c:
+            assert c.request.url == "http://localhost/foo/bar"
+
+    def test_url_script_name_path_info(self):
+        with context(SCRIPT_NAME="/foo/bar", PATH_INFO="/baz") as c:
+            assert c.request.url == "http://localhost/foo/bar/baz"
+
+    def test_url_normalizes_host_port(self):
+        with context(HTTP_HOST="localhost:80") as c:
+            assert c.request.url == "http://localhost/"
+        with context(HTTP_HOST="localhost:81") as c:
+            assert c.request.url == "http://localhost:81/"
+
+    def test_url_normalizes_host_ssl_port(self):
+        with context(
+            environ={"wsgi.url_scheme": "https"}, HTTP_HOST="localhost:443"
+        ) as c:
+            assert c.request.url == "https://localhost/"
+
+    def test_url_ignores_server_port_if_host_header_present(self):
+        with context(
+            environ={"wsgi.url_scheme": "https", "SERVER_PORT": "81"},
+            HTTP_HOST="localhost",
+        ) as c:
+            assert c.request.url == "https://localhost/"
+
+    def test_as_string(self):
+        with context("http://example.org/foo?bar=baz") as c:
+            assert str(c.request) == "<Request GET http://example.org/foo?bar=baz>"
+
+    def test_url_returns_full_url(self):
+        with context("http://example.org/foo?bar=baz") as c:
+            assert c.request.url == "http://example.org/foo?bar=baz"
+
+    def test_path_returns_correct_path_when_script_name_empty(self):
+        with context(SCRIPT_NAME="", PATH_INFO="/foo/bar") as c:
+            assert c.request.path == "/foo/bar"
+
+    def test_path_returns_correct_path(self):
+        with context(SCRIPT_NAME="/foo", PATH_INFO="/bar") as c:
+            assert c.request.path == "/foo/bar"
+
+    def test_query_decodes_unicode(self):
+        with context("/?q=%C3%A0") as c:
+            assert c.request.query["q"] == b"\xc3\xa0".decode("utf8")
+
+    def test_form_decodes_unicode(self):
+        with context("/?q=%C3%A0") as c:
+            assert c.request.form["q"] == b"\xc3\xa0".decode("utf8")
+
+    def test_body_decodes_unicode(self):
+        with context(
+            wsgi_input=b"\xc3\xa0",
+            CONTENT_LENGTH="2",
+            CONTENT_TYPE="text/plain; charset=UTF-8",
+        ) as c:
+            assert c.request.body == b"\xc3\xa0".decode("UTF-8")
+
+    def test_body_raises_bad_request_for_invalid_encoding(self):
+        with context(
+            wsgi_input=b"\xc3a",
+            CONTENT_LENGTH="2",
+            CONTENT_TYPE="text/plain; charset=UTF-8",
+        ) as c:
+            with pytest.raises(exceptions.BadRequest):
+                c.request.body
+
+    def test_body_bytes_does_not_decode(self):
+        with context(
+            wsgi_input=b"\xc3a",
+            CONTENT_LENGTH="2",
+            CONTENT_TYPE="text/plain; charset=UTF-8",
+        ) as c:
+            c.request.body_bytes == b"\xc3a"
+
+    def test_get_json_decodes_json(self):
+        with context(
+            wsgi_input=b'{"foo": "bar"}',
+            CONTENT_LENGTH="14",
+            CONTENT_TYPE="application/json",
+        ) as c:
+            c.request.get_json() == {"foo": "bar"}
+
+    def test_get_json_ignores_mime_type(self):
+        with context(
+            wsgi_input=b'{"foo": "bar"}',
+            CONTENT_LENGTH="14",
+            CONTENT_TYPE="application/broken",
+        ) as c:
+            c.request.get_json() == {"foo": "bar"}
+
+    def test_get_json_passes_args_to_decoder(self):
+        with context(
+            wsgi_input=b'{"foo": 1}',
+            CONTENT_LENGTH="10",
+            CONTENT_TYPE="application/broken",
+        ) as c:
+            c.request.get_json(parse_int=lambda s: s + "!") == {"foo": "1!"}
+
+    def test_get_does_type_conversion(self):
+        with context(
+            QUERY_STRING="x=10",
+            CONTENT_LENGTH="10",
+            CONTENT_TYPE="application/broken",
+        ) as c:
+            assert c.request.get("x") == "10"
+            assert c.request.get("x", type=int) == 10
+            with pytest.raises(exceptions.BadRequest):
+                c.request.get("y", type=int)
+            assert c.request.get("y", None, type=int) is None
+
+    def test_is_secure_returns_correct_value(self):
+        with context("https://example.org/") as c:
+            assert c.request.is_secure is True
+        with context("http://example.org/") as c:
+            assert c.request.is_secure is False
+
+    def test_getint_returns_int(self):
+        with context("http://example.org/?a=4") as c:
+            assert c.request.getint("a") == 4
+
+    def test_getint_raises_badrequest(self):
+        with pytest.raises(exceptions.BadRequest):
+            with context("http://example.org/") as c:
+                c.request.getint("a")
+
+        with pytest.raises(exceptions.BadRequest):
+            with context("http://example.org/?a=four") as c:
+                c.request.getint("a")
+
+        with pytest.raises(exceptions.BadRequest):
+            with context("http://example.org/?a=four") as c:
+                assert c.request.getint("a", 0) == 0
+
+    def test_getint_returns_default(self):
+        with context("http://example.org/") as c:
+            assert c.request.getint("a", 0) == 0
+
+    def test_now(self):
+        with context("http://example.org/") as c:
+            now = c.request.now
+            assert now.tzinfo is datetime.timezone.utc
+            assert now is c.request.now
+
+
+class TestPathEncoding(object):
+    def test_url_is_quoted(self):
+        with context(SCRIPT_NAME=fixtures.wsgi_unicode_path, PATH_INFO="") as c:
+            assert c.request.url == "http://localhost" + fixtures.quoted_unicode_path
+
+    def test_application_url_is_quoted(self):
+        with context(SCRIPT_NAME=fixtures.wsgi_unicode_path, PATH_INFO="") as c:
+            assert (
+                c.request.application_url
+                == "http://localhost" + fixtures.quoted_unicode_path
+            )
+
+    def test_parsed_url_is_quoted(self):
+        with context(SCRIPT_NAME=fixtures.wsgi_unicode_path, PATH_INFO="") as c:
+            assert c.request.parsed_url.path == fixtures.quoted_unicode_path
+
+    def test_path_is_unquoted(self):
+        with context(SCRIPT_NAME=fixtures.wsgi_unicode_path, PATH_INFO="") as c:
+            assert c.request.path == fixtures.unquoted_unicode_path
+
+    def test_script_name_is_unquoted(self):
+        with context(SCRIPT_NAME=fixtures.wsgi_unicode_path, PATH_INFO="") as c:
+            assert c.request.script_name == fixtures.unquoted_unicode_path
+
+    def test_path_info_is_unquoted(self):
+        with context(PATH_INFO=fixtures.wsgi_unicode_path) as c:
+            assert c.request.path_info == fixtures.unquoted_unicode_path
+
+    def test_invalid_path_info_encoding_raises_bad_request(self):
+        with context(PATH_INFO=fixtures.misquoted_wsgi_unicode_path) as c:
+            with pytest.raises(exceptions.BadRequest):
+                c.request.path_info
+
+    def test_invalid_script_name_encoding_raises_bad_request(self):
+        with context(SCRIPT_NAME=fixtures.misquoted_wsgi_unicode_path) as c:
+            with pytest.raises(exceptions.BadRequest):
+                c.request.script_name
+
+
+class TestMakeURL(object):
+    def assert_equal_with_query(self, url1, url2):
+        if "?" not in url1:
+            assert url1 == url2
+            return
+
+        base1, _, q1 = url1.partition("?")
+        base2, _, q2 = url2.partition("?")
+        assert base1 == base2
+        assert sorted(q1.split(";")) == sorted(q2.split(";"))
+
+    def test_it_returns_request_url(self):
+        with context(SCRIPT_NAME="/script", PATH_INFO="/pathinfo") as c:
+            assert c.request.make_url() == "http://localhost/script/pathinfo"
+
+    def test_it_doesnt_double_quote_request_url(self):
+        with context(SCRIPT_NAME="/script name", PATH_INFO="/path info") as c:
+            assert c.request.make_url() == "http://localhost/script%20name/path%20info"
+
+    def test_it_doesnt_double_quote_supplied_path_info(self):
+        with context() as c:
+            assert c.request.make_url(PATH_INFO="/x y") == "http://localhost/x%20y"
+
+    def test_can_replace_path(self):
+        with context(SCRIPT_NAME="/script", PATH_INFO="/pathinfo") as c:
+            assert c.request.make_url(path="/foo bar") == "http://localhost/foo%20bar"
+
+    def test_it_joins_path(self):
+        with context(SCRIPT_NAME="/script name", PATH_INFO="/path info/") as c:
+            assert (
+                c.request.make_url(path="a/b c")
+                == "http://localhost/script%20name/path%20info/a/b%20c"
+            )
+
+    def test_query_not_included_by_default(self):
+        with context(QUERY_STRING="query=foo") as c:
+            assert c.request.make_url() == "http://localhost/"
+
+    def test_query_dict(self):
+        with context() as c:
+            self.assert_equal_with_query(
+                c.request.make_url(query={"a": 1, "b": "2 3"}),
+                "http://localhost/?a=1&b=2+3",
+            )
+
+    def test_query_drops_items_with_None_value(self):
+        with context() as c:
+            self.assert_equal_with_query(
+                c.request.make_url(query={"a": 1, "b": None}),
+                "http://localhost/?a=1",
+            )
+            self.assert_equal_with_query(
+                c.request.make_url(query=[("a", 1), ("b", None)]),
+                "http://localhost/?a=1",
+            )
+
+    def test_query_kwargs(self):
+        with context() as c:
+            self.assert_equal_with_query(
+                c.request.make_url(query={"a": 1}, b=2),
+                "http://localhost/?a=1&b=2",
+            )
+
+    def test_unicode_path(self):
+        e = b"\xc3\xa9".decode("utf8")  # e-acute
+        with context() as c:
+            assert c.request.make_url(path=e) == "http://localhost/%C3%A9"
+
+    def test_unicode_path_info(self):
+        e = b"\xc3\xa9".decode("utf8")  # e-acute
+        with context() as c:
+            assert c.request.make_url(PATH_INFO=e) == "http://localhost/%C3%A9"
+
+    def test_unicode_query(self):
+        e = b"\xc3\xa9".decode("utf8")  # e-acute
+        with context() as c:
+            assert c.request.make_url(query={"e": e}) == "http://localhost/?e=%C3%A9"
+
+    def test_it_quotes_paths(self):
+        with context() as c:
+            assert c.request.make_url(path="/a b") == "http://localhost/a%20b"
+
+    def test_replace_query_replaces_existing(self):
+        with context(QUERY_STRING="a=1") as c:
+            assert (
+                c.request.make_url(query_replace={"a": "2"}) == "http://localhost/?a=2"
+            )
+
+    def test_replace_query_adds_new_value(self):
+        with context(QUERY_STRING="a=1") as c:
+            self.assert_equal_with_query(
+                c.request.make_url(query_replace={"b": "2"}),
+                "http://localhost/?a=1&b=2",
+            )
+
+    def test_add_query_doesnt_replace_existing(self):
+        with context(QUERY_STRING="a=1") as c:
+            self.assert_equal_with_query(
+                c.request.make_url(query_add={"a": "2"}),
+                "http://localhost/?a=1&a=2",
+            )
+
+    def test_add_query_works_on_specified_query(self):
+        with context(QUERY_STRING="a=1") as c:
+            assert (
+                c.request.make_url(query="", query_add={"a": "2"})
+                == "http://localhost/?a=2"
+            )
+
+    def test_add_query_does_not_mutate_request_query(self):
+        with context(QUERY_STRING="a=1") as c:
+            c.request.make_url(query_add={"a": "2"})
+            assert list(c.request.query.allitems()) == [("a", "1")]
+
+
+class TestResolveURL(object):
+    def test_relative_path(self):
+        with context(SCRIPT_NAME="/script", PATH_INFO="/pathinfo") as c:
+            assert c.request.resolve_url("foo") == "http://localhost/script/foo"
+
+    def test_absolute_path_unspecified_relative(self):
+        with context(SCRIPT_NAME="/script", PATH_INFO="/pathinfo") as c:
+            assert (
+                c.request.resolve_url("/foo", relative="app")
+                == "http://localhost/script/foo"
+            )
+
+    def test_absolute_path_app_relative(self):
+        with context(SCRIPT_NAME="/script", PATH_INFO="/pathinfo") as c:
+            assert (
+                c.request.resolve_url("/foo", relative="app")
+                == "http://localhost/script/foo"
+            )
+
+    def test_absolute_path_server_relative(self):
+        with context(SCRIPT_NAME="/script", PATH_INFO="/pathinfo") as c:
+            assert (
+                c.request.resolve_url("/foo", relative="server")
+                == "http://localhost/foo"
+            )
+
+    def test_ignores_server_port_if_host_header_present(self):
+        with context(
+            environ={"wsgi.url_scheme": "https", "SERVER_PORT": "81"},
+            HTTP_HOST="localhost",
+        ) as c:
+            assert c.request.resolve_url("/foo") == "https://localhost/foo"
+
+
+class TestCurrentRequest(object):
+    def test_currentrequest_returns_current_request(self):
+        from fresco import currentrequest
+
+        with context() as c:
+            assert currentrequest() is c.request
+
+    def test_currentrequest_returns_None(self):
+        from fresco import currentrequest
+
+        assert currentrequest() is None
+
+
+class TestMultipart(object):
+    filename = "test.txt"
+    filedata = "123456\n"
+    boundary = "---------------------------1234"
+
+    post_data = (
+        (
+            "--{boundary}\r\n"
+            "Content-Disposition: form-data; "
+            'name="uploaded_file"; filename="{filename}"\r\n'
+            "Content-Type: text/plain\r\n"
+            "\r\n"
+            "{filedata}\r\n"
+            "--{boundary}"
+            "--\r\n"
+        )
+        .format(boundary=boundary, filedata=filedata, filename=filename)
+        .encode("latin1")
+    )
+
+    request_args = {
+        "wsgi_input": post_data,
+        "REQUEST_METHOD": "POST",
+        "CONTENT_TYPE": "multipart/form-data; boundary=" + boundary,
+        "CONTENT_LENGTH": str(len(post_data)),
+    }
+
+    def test_files_populated(self):
+        with FrescoApp().requestcontext(**self.request_args) as c:
+            request = c.request
+
+            assert len(request.files) == 1
+            assert "uploaded_file" in request.files
+
+    def test_file_content_available(self):
+        with FrescoApp().requestcontext(**self.request_args) as c:
+            request = c.request
+
+            b = BytesIO()
+            request.files["uploaded_file"].save(b)
+        assert b.getvalue() == self.filedata.encode("latin1")
+
+    def test_headers_available(self):
+        with FrescoApp().requestcontext(**self.request_args) as c:
+            request = c.request
+
+            assert (
+                request.files["uploaded_file"].headers["content-type"] == "text/plain"
+            )
+            assert request.files["uploaded_file"].filename == self.filename
+
+    def test_quotes_in_input_names_are_decoded(self):
+        """
+        Field names in multipart form data must be decoded as RFC822
+        quoted-strings
+        """
+        data = (
+            b"----BOUNDARY\r\n"
+            b'Content-Disposition: form-data; name="\\"qtext\\"";\r\n'
+            b"\r\n"
+            b"foo\r\n"
+            b"----BOUNDARY"
+            b"--\r\n"
+        )
+
+        env = {
+            "wsgi_input": data,
+            "REQUEST_METHOD": "POST",
+            "CONTENT_TYPE": "multipart/form-data; boundary=--BOUNDARY",
+            "CONTENT_LENGTH": str(len(data)),
+        }
+
+        with FrescoApp().requestcontext(**env) as c:
+            assert list(c.request.form.items()) == [('"qtext"', "foo")]

fresco/tests/test_requestcontext.py

@@ -0,0 +1,107 @@
+# Copyright 2015 Oliver Cope
+#
+# Licensed 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 pytest
+
+from fresco import FrescoApp
+from fresco.response import Response
+from fresco.routing import GET
+from fresco.requestcontext import RequestContext
+
+
+class TestRequestContext(object):
+    def test_instantiation(self):
+        """
+        Can we cleanly instantiate a RequestContext object?
+        """
+        RequestContext()
+
+    def test_app_populates_request_object(self):
+        def view():
+            from fresco.core import context
+
+            assert context.request is not None
+            return Response([""])
+
+        app = FrescoApp()
+        app.route("/", GET, view)
+
+        with app.requestcontext("/"):
+            app.view()
+
+    def test_context_returns_correct_request_for_each_app(self):
+        from time import sleep
+        from threading import Thread, current_thread
+
+        threadcount = 3
+        itercount = 200
+        calls = []
+
+        def view():
+            from fresco.core import context
+
+            request_id = id(context.request)
+
+            def generate_response():
+                for i in range(itercount):
+                    assert id(context.request) == request_id
+                    calls.append(current_thread().ident)
+                    sleep(0.0001)
+                    yield str(request_id).encode("ascii")
+
+            return Response(list(generate_response()))
+
+        app = FrescoApp()
+        app.route("/", GET, view)
+
+        def do_request():
+            with app.requestcontext("/"):
+                app.view()
+
+        threads = [Thread(target=do_request) for i in range(threadcount)]
+
+        for t in threads:
+            t.start()
+        for t in threads:
+            t.join()
+
+        assert len(calls) == threadcount * itercount
+
+        # Check that threaded requests were genuinely interleaved
+        for i1, i2 in zip(calls[: itercount - 1], calls[1:itercount]):
+            if i1 != i2:
+                break
+        else:
+            raise AssertionError("Output does not appear interleaved")
+
+    def test_context_does_not_inherit_from_parent(self):
+        c = RequestContext()
+        c.push(foo=1)
+        c.push(bar=2)
+        with pytest.raises(AttributeError):
+            c.foo
+
+    def test_child_context_overrides_parent(self):
+        c = RequestContext()
+        c.push(foo=1)
+        c.push(foo=2)
+        assert c.foo == 2
+
+    def test_pop_context_removes_keys(self):
+        c = RequestContext()
+        c.push(foo=1)
+        c.push(foo=2)
+        assert c.foo == 2
+        c.pop()
+        assert c.foo == 1