async def test_async_render_name(tracked_request):
ensure_installed()
template = jinja2.Template("Hello {{ name }}!", enable_async=True)
template.name = "mytemplate.html"
result = await template.render_async(name="World")
assert result == "Hello World!"
assert tracked_request.complete_spans[0].tags["name"] == "mytemplate.html"
def test_ensure_installed_twice(caplog):
ensure_installed()
ensure_installed()
assert caplog.record_tuples == 2 * [(
"scout_apm.instruments.jinja2",
logging.DEBUG,
"Instrumenting Jinja2.",
)]
def test_render_template_name(tracked_request):
ensure_installed()
template = jinja2.Template("Hello {{ name }}!")
template.name = "mytemplate.html"
result = template.render(name="World")
assert result == "Hello World!"
assert tracked_request.complete_spans[0].tags["name"] == "mytemplate.html"
def test_ensure_installed_twice(caplog):
ensure_installed()
ensure_installed()
assert caplog.record_tuples == 2 * [(
"scout_apm.instruments.jinja2",
logging.INFO,
"Ensuring Jinja2 instrumentation is installed.",
)]
async def test_async_render(tracked_request):
ensure_installed()
template = jinja2.Template("Hello {{ name }}!", enable_async=True)
result = await template.render_async(name="World")
assert result == "Hello World!"
assert len(tracked_request.complete_spans) == 1
span = tracked_request.complete_spans[0]
assert span.operation == "Template/Render"
assert span.tags["name"] is None
def test_ensure_installed_fail_no_render_async_attribute(caplog):
mock_template = mock.patch("scout_apm.instruments.jinja2.Template")
with mock_not_attempted(), mock_template as mocked_template:
del mocked_template.render_async
ensure_installed()
jinja2.Environment()
assert caplog.record_tuples == [
("scout_apm.instruments.jinja2", logging.DEBUG, "Instrumenting Jinja2.",)
]
def test_ensure_installed_fail_no_template(caplog):
mock_no_template = mock.patch("scout_apm.instruments.jinja2.Template",
new=None)
with mock_not_attempted(), mock_no_template:
ensure_installed()
assert caplog.record_tuples == [
(
"scout_apm.instruments.jinja2",
logging.DEBUG,
"Instrumenting Jinja2.",
),
(
"scout_apm.instruments.jinja2",
logging.DEBUG,
"Couldn't import jinja2.Template - probably not installed.",
),
]
def test_ensure_installed_fail_no_template(caplog):
mock_no_template = mock.patch("scout_apm.instruments.jinja2.Template",
new=None)
with mock_not_attempted, mock_no_template:
ensure_installed()
assert caplog.record_tuples == [
(
"scout_apm.instruments.jinja2",
logging.INFO,
"Ensuring Jinja2 instrumentation is installed.",
),
(
"scout_apm.instruments.jinja2",
logging.INFO,
"Unable to import jinja2.Template",
),
]
def test_ensure_installed_fail_no_render_attribute(caplog):
mock_template = mock.patch("scout_apm.instruments.jinja2.Template")
with mock_not_attempted(), mock_template as mocked_template:
# Remove render attribute
del mocked_template.render
ensure_installed()
assert len(caplog.record_tuples) == 2
assert caplog.record_tuples[0] == (
"scout_apm.instruments.jinja2",
logging.DEBUG,
"Instrumenting Jinja2.",
)
logger, level, message = caplog.record_tuples[1]
assert logger == "scout_apm.instruments.jinja2"
assert level == logging.WARNING
assert message.startswith(
"Failed to instrument jinja2.Template.render: AttributeError")
def test_ensure_installed_fail_wrap_render_async(caplog):
mock_wrap_render_async = mock.patch(
"scout_apm.instruments.jinja2.wrapped_render_async")
with mock_not_attempted(
), mock_wrap_render_async as mocked_wrap_render_async:
mocked_wrap_render_async.side_effect = ValueError("Boom!")
ensure_installed()
assert len(caplog.record_tuples) == 2
assert caplog.record_tuples[0] == (
"scout_apm.instruments.jinja2",
logging.DEBUG,
"Instrumenting Jinja2.",
)
logger, level, message = caplog.record_tuples[1]
assert logger == "scout_apm.instruments.jinja2"
assert level == logging.WARNING
assert message.startswith(
"Failed to instrument jinja2.Template.render_async: ValueError")