NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-09-06 14:23:36 -06:00
Code Issues Actions 11 Packages Projects Releases Wiki Activity

Review comments

Browse Source
This commit is contained in:
Tobias Genannt 2025-08-21 08:06:15 +02:00
parent 18f669ba8e
commit 769edb6dcb
2 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
netbox/core/templatetags/highlight_code.py
View File

@ -4,6 +4,7 @@ from pygments import highlight
from pygments.formatters import HtmlFormatter
from pygments.lexers import get_lexer_for_filename
from pygments.util import ClassNotFound
from django.utils.html import escape
register = template.Library()
@ -16,11 +17,11 @@ def highlight_code(value, filename: str):
if not value:
return mark_safe('<pre></pre>')
if not filename:
return mark_safe(f'<pre>{value}</pre>') # Fallback to plain text if no filename is provided
return mark_safe(f'<pre>{escape(value)}</pre>') # Fallback to plain text if no filename is provided
try:
lexer = get_lexer_for_filename(filename)
except ClassNotFound:
return mark_safe(f'<pre>{value}</pre>') # Fallback to plain text if no lexer was found
return mark_safe(f'<pre>{escape(value)}</pre>') # Fallback to plain text if no lexer was found
return mark_safe(
highlight(
value,

24
netbox/core/tests/test_templatetags.py
View File

@ -17,6 +17,14 @@ FAKE_PYTHON_RESULT = """\
<div class="highlight"><pre><span></span><span class="linenos">1</span><span class="pygments-k">def</span><span class="pygments-w"> </span><span class="pygments-nf">fake_function</span><span class="pygments-p">():</span>\n<span class="linenos">2</span> <span class="pygments-nb">print</span><span class="pygments-p">(</span><span class="pygments-s2">&quot;This is a fake Python function.&quot;</span><span class="pygments-p">)</span>\n</pre></div>
"""
FAKE_BAD_NAME = 'bad.hello'
FAKE_BAD_CONTENT = """\
<script> alert('Hello'); </script>
"""
FAKE_BAD_RESULT = """\
<pre>&lt;script&gt; alert(&#x27;Hello&#x27;); &lt;/script&gt;\n</pre>\
"""
class HighlightCodeTestCase(TestCase):
def test_python_highlighting(self):
@ -32,18 +40,18 @@ class HighlightCodeTestCase(TestCase):
def test_empty_content(self):
result = highlight_code('', 'FAKE_PLAIN_TEXT_NAME')
self.assertTrue(result.startswith('<pre></pre>'))
self.assertTrue(len(result) == 11)
self.assertTrue(result == '<pre></pre>')
result = highlight_code(None, 'FAKE_PLAIN_TEXT_NAME')
self.assertTrue(result.startswith('<pre></pre>'))
self.assertTrue(len(result) == 11)
self.assertTrue(result == '<pre></pre>')
def test_empty_filename(self):
result = highlight_code(' ', '')
self.assertTrue(result.startswith('<pre> </pre>'))
self.assertTrue(len(result) == 12)
self.assertTrue(result == '<pre> </pre>')
result = highlight_code(' ', None)
self.assertTrue(result.startswith('<pre> </pre>'))
self.assertTrue(len(result) == 12)
self.assertTrue(result == '<pre> </pre>')
def test_fallback_is_safe(self):
result = highlight_code(FAKE_BAD_CONTENT, FAKE_BAD_NAME)
self.assertTrue(result == FAKE_BAD_RESULT)