tests failing with new Markdown?

[MeggyCal]

Hi,

when I run tests with Markdown 3.3.4, I get an error:

[  129s] =================================== FAILURES ===================================
[  129s] __________________ TestViewNamesAndDescriptions.test_markdown __________________
[  129s] tests/test_description.py:168: in test_markdown
[  129s]     assert apply_markdown(DESCRIPTION) == MARKDOWN_BASE % MARKDOWN_gte_33
[  129s] E   AssertionError: assert ('<h2 id="an-example-docstring">an example docstring</h2>\n'\n '<ul>\n'\n '<li>list</li>\n'\n '<li>list</li>\n'\n '</ul>\n'\n '<h3 id="another-header">another header</h3>\n'\n '<pre><code>code block\n'\n '</code></pre>\n'\n '<p>indented</p>\n'\n '<h2 id="hash-style-header">hash style header</h2>\n'\n '<p><code>json\n'\n '[{\n'\n '    "alpha": 1,\n'\n '    "beta": "this is a string"\n'\n '}]</code></p>') == ('<h2 id="an-example-docstring">an example docstring</h2>\n'\n '<ul>\n'\n '<li>list</li>\n'\n '<li>list</li>\n'\n '</ul>\n'\n '<h3 id="another-header">another header</h3>\n'\n '<pre><code>code block\n'\n '</code></pre>\n'\n '<p>indented</p>\n'\n '<h2 id="hash-style-header">hash style header</h2>\n'\n '<div class="highlight"><pre><span></span><span class="p">[{</span><br />    '\n '<span class="nt">&quot;alpha&quot;</span><span class="p">:</span> <span '\n 'class="mi">1</span><span class="p">,</span><br />    <span '\n 'class="nt">&quot;beta&quot;</span><span class="p">:</span> <span '\n 'class="s2">&quot;this is a string&quot;</span><br /><span '\n 'class="p">}]</span><br /></pre></div>\n'\n '<p><br /></p>')
[  129s] E       <h2 id="an-example-docstring">an example docstring</h2>
[  129s] E       <ul>
[  129s] E       <li>list</li>
[  129s] E       <li>list</li>
[  129s] E       </ul>
[  129s] E       <h3 id="another-header">another header</h3>
[  129s] E       <pre><code>code block
[  129s] E       </code></pre>
[  129s] E       <p>indented</p>
[  129s] E       <h2 id="hash-style-header">hash style header</h2>
[  129s] E     - <div class="highlight"><pre><span></span><span class="p">[{</span><br />    <span class="nt">&quot;alpha&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span><br />    <span class="nt">&quot;beta&quot;</span><span class="p">:</span> <span class="s2">&quot;this is a string&quot;</span><br /><span class="p">}]</span><br /></pre></div>
[  129s] E     - <p><br /></p>
[  129s] E     + <p><code>json
[  129s] E     + [{
[  129s] E     +     "alpha": 1,
[  129s] E     +     "beta": "this is a string"
[  129s] E     + }]</code></p>

Maybe it is related to Python-Markdown/markdown@1279074? Or am I wrong?

[tomchristie]

Not sure - have you checked which version the CI tests last ran with?

You can have a look into that here... https://github.com/encode/django-rest-framework/actions/workflows/main.yml

[MeggyCal]

I think that the last python-Markdown version was 3.3, as I looked at last commit at master with python38 (I did not check all builds).

[MeggyCal]

Now I checked all of them and it still appears to me they run with Markdown 3.3 (https://pypi.org/project/Markdown/#history)

[MeggyCal]

Hello? I still run into this issue. In case it wasn't clear from my reply, Markdown 3.3 is older than 3.3.4. Could you please also try to run the tests with recent Markdown?

[jayvdb]

I've encountered two failures on openSUSE packaging, using python310-Markdown-3.4.1 package as dependency.

[   47s] =================================== FAILURES ===================================
[   47s] __________________ TestViewNamesAndDescriptions.test_markdown __________________
[   47s] 
[   47s] self = <tests.test_description.TestViewNamesAndDescriptions testMethod=test_markdown>
[   47s] 
[   47s]     @pytest.mark.skipif(not apply_markdown, reason="Markdown is not installed")
[   47s]     def test_markdown(self):
[   47s]         """
[   47s]         Ensure markdown to HTML works as expected.
[   47s]         """
[   47s] >       assert apply_markdown(DESCRIPTION) == MARKDOWN_DOCSTRING
[   47s] E       assert '<h2 id="an-example-docstring">an example docstring</h2>\n<ul>\n<li>list</li>\n<li>list</li>\n</ul>\n<h3 id="another-header">another header</h3>\n<pre><code>code block\n</code></pre>\n<p>indented</p>\n<h2 id="hash-style-header">hash style header</h2>\n<div class="highlight"><pre><span></span><span class="p">[{</span><br /><span class="w">    </span><span class="nt">&quot;alpha&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><br /><span class="w">    </span><span class="nt">&quot;beta&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;this is a string&quot;</span><br /><span class="p">}]</span><br /></pre></div>\n<p><br /></p>' == '<h2 id="an-example-docstring">an example docstring</h2>\n<ul>\n<li>list</li>\n<li>list</li>\n</ul>\n<h3 id="another-header">another header</h3>\n<pre><code>code block\n</code></pre>\n<p>indented</p>\n<h2 id="hash-style-header">hash style header</h2>\n<div class="highlight"><pre><span></span><span class="p">[{</span><span class="w"></span><br /><span class="w">    </span><span class="nt">&quot;alpha&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"></span><br /><span class="w">    </span><span class="nt">&quot;beta&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;this is a string&quot;</span><span class="w"></span><br /><span class="p">}]</span><span class="w"></span><br /></pre></div>\n<p><br /></p>'
[   47s] E           <h2 id="an-example-docstring">an example docstring</h2>
[   47s] E           <ul>
[   47s] E           <li>list</li>
[   47s] E           <li>list</li>
[   47s] E           </ul>
[   47s] E           <h3 id="another-header">another header</h3>
[   47s] E           <pre><code>code block
[   47s] E           </code></pre>
[   47s] E           <p>indented</p>
[   47s] E           <h2 id="hash-style-header">hash style header</h2>
[   47s] E         - <div class="highlight"><pre><span></span><span class="p">[{</span><span class="w"></span><br /><span class="w">    </span><span class="nt">&quot;alpha&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"></span><br /><span class="w">    </span><span class="nt">&quot;beta&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;this is a string&quot;</span><span class="w"></span><br /><span class="p">}]</span><span class="w"></span><br /></pre></div>
[   47s] E         + <div class="highlight"><pre><span></span><span class="p">[{</span><br /><span class="w">    </span><span class="nt">&quot;alpha&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><br /><span class="w">    </span><span class="nt">&quot;beta&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;this is a string&quot;</span><br /><span class="p">}]</span><br /></pre></div>
[   47s] E           <p><br /></p>
[   47s] 
[   47s] tests/test_description.py:147: AssertionError
[   47s] _________ TestDocumentationRenderer.test_shell_code_example_rendering __________
[   47s] 
[   47s] self = <tests.test_renderers.TestDocumentationRenderer testMethod=test_shell_code_example_rendering>
[   47s] 
[   47s]     def test_shell_code_example_rendering(self):
[   47s]         template = loader.get_template('rest_framework/docs/langs/shell.html')
[   47s]         context = {
[   47s]             'document': coreapi.Document(url='https://api.example.org/'),
[   47s]             'link_key': 'testcases > list',
[   47s]             'link': coreapi.Link(url='/data/', action='get', fields=[]),
[   47s]         }
[   47s]         html = template.render(context)
[   47s] >       assert 'testcases list' in html
[   47s] E       assert 'testcases list' in '\n<pre class="highlight shell hide" data-language="shell"><code><span class="c1"># Load the schema document</span>\n$<span class="w"> </span>coreapi<span class="w"> </span>get<span class="w"> </span>https://api.example.org/\n\n<span class="c1"># Interact with the API endpoint</span>\n$<span class="w"> </span>coreapi<span class="w"> </span>action<span class="w"> </span>testcases<span class="w"> </span>list\n</code></pre>\n'
[   47s] 
[   47s] tests/test_renderers.py:855: AssertionError