Merge branch 'master' into router_slash_support

docs/_newsfragments/2044.newandimproved.rst

@@ -0,0 +1,4 @@
+An informative representation was added to :class:`testing.Result <falcon.testing.Result>`
+for easier development and interpretation of failed tests. The form of ``__repr__`` is as follows:
+``Result<{status_code} {content-type header} {content}>``, where the content part will reflect
+up to 40 bytes of the result's content.

falcon/testing/client.py

@@ -347,6 +347,19 @@ def json(self) -> Optional[Union[dict, list, str, int, float, bool]]:
 
         return json_module.loads(self.text)
 
+    def __repr__(self):
+        content_type = self.headers.get('Content-Type', '')
+
+        if len(self.content) > 40:
+            content = self.content[:20] + b'...' + self.content[-20:]
+        else:
+            content = self.content
+
+        args = [self.status, content_type, str(content)]
+
+        repr_result = ' '.join(filter(None, args))
+        return 'Result<{}>'.format(repr_result)
+
 
 class StreamedResult(_ResultBase):
     """Encapsulates the streamed result of an ASGI request.

tests/test_utils.py

@@ -764,6 +764,65 @@ def test_status(self, app):
         result = client.simulate_get()
         assert result.status == falcon.HTTP_702
 
+    @pytest.mark.parametrize(
+        'simulate',
+        [
+            testing.simulate_get,
+            testing.simulate_post,
+        ],
+    )
+    @pytest.mark.parametrize(
+        'value',
+        (
+            'd\xff\xff\x00',
+            'quick fox jumps over the lazy dog',
+            '{"hello": "WORLD!"}',
+            'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praese',
+            '{"hello": "WORLD!", "greetings": "fellow traveller"}',
+            '\xe9\xe8',
+        ),
+    )
+    def test_repr_result_when_body_varies(self, asgi, value, simulate):
+        if isinstance(value, str):
+            value = bytes(value, 'UTF-8')
+
+        if asgi:
+            resource = testing.SimpleTestResourceAsync(body=value)
+        else:
+            resource = testing.SimpleTestResource(body=value)
+
+        app = create_app(asgi)
+        app.add_route('/hello', resource)
+
+        result = simulate(app, '/hello')
+        captured_resp = resource.captured_resp
+        content = captured_resp.text
+
+        if len(value) > 40:
+            content = value[:20] + b'...' + value[-20:]
+        else:
+            content = value
+
+        args = [
+            captured_resp.status,
+            captured_resp.headers['content-type'],
+            str(content),
+        ]
+
+        expected_content = ' '.join(filter(None, args))
+
+        expected_result = 'Result<{}>'.format(expected_content)
+
+        assert str(result) == expected_result
+
+    def test_repr_without_content_type_header(self, asgi):
+        value = b'huh'
+        header = [('Not-content-type', 'no!')]
+        result = falcon.testing.Result([value], falcon.HTTP_200, header)
+
+        expected_result = 'Result<200 OK {}>'.format(value)
+        assert str(result) == expected_result
+
     def test_wsgi_iterable_not_closeable(self):
         result = testing.Result([], falcon.HTTP_200, [])
         assert not result.content