Test failures with Pygments 2.1

[Ryan J Ollos]

The automated tests that ran when committing the fix for #12325 revealed some test case failures. Pygments 2.1 was released on 2016-01-17. Test failures were not seen with Pygments 2.0.2.

======================================================================
FAIL: test_extra_mimetypes (trac.mimeview.tests.pygments.PygmentsRendererTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/rjollos/Documents/Workspace/trac-dev/teo-rjollos.git/trac/mimeview/tests/pygments.py", line 123, in test_extra_mimetypes
    mimeview.get_mimetype('file.ini'))
AssertionError: 'text/x-ini; charset=utf-8' != u'text/inf; charset=utf-8'

======================================================================
FAIL: test_python_hello (trac.mimeview.tests.pygments.PygmentsRendererTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/rjollos/Documents/Workspace/trac-dev/teo-rjollos.git/trac/mimeview/tests/pygments.py", line 74, in test_python_hello
    self._test('python_hello', result)
  File "/Users/rjollos/Documents/Workspace/trac-dev/teo-rjollos.git/trac/mimeview/tests/pygments.py", line 62, in _test
    self.assertEqual(exp, res)
AssertionError: '        <span class="k">return</span> <span class="s">"Hello World!"</span>' != '        <span class="k">return</span> <span class="s2">"Hello World!"</span>'

======================================================================
FAIL: test_python_hello_mimeview (trac.mimeview.tests.pygments.PygmentsRendererTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/rjollos/Documents/Workspace/trac-dev/teo-rjollos.git/trac/mimeview/tests/pygments.py", line 85, in test_python_hello_mimeview
    self._test('python_hello_mimeview', result)
  File "/Users/rjollos/Documents/Workspace/trac-dev/teo-rjollos.git/trac/mimeview/tests/pygments.py", line 62, in _test
    self.assertEqual(exp, res)
AssertionError: '        <span class="k">return</span> <span class="s">"Hello World!"</span>' != '        <span class="k">return</span> <span class="s2">"Hello World!"</span>'

----------------------------------------------------------------------
Ran 1795 tests in 108.513s

FAILED (failures=3)
make: *** [unit-test] Error 1

[Ryan J Ollos]

First issue seems to be due to addition of a mimetype for ini.

Pygments 2.1:

>>> from pygments.lexers import get_lexer_by_name
>>> lexer = get_lexer_by_name('ini')
>>> lexer.mimetypes
['text/x-ini', 'text/inf']

Pygments 2.0.2:

>>> from pygments.lexers import get_lexer_by_name
>>> lexer = get_lexer_by_name('ini')
>>> lexer.mimetypes
['text/x-ini']

[Ryan J Ollos]

Now I remember looking at this some time ago. When there are multiple mimetypes for a given ​Short name (also referred to as aliases​ and keywords​), the last mimetype overwrites the previously stored mimetype: tags/trac-1.0.9/trac/mimeview/api.py@:932-933#L922​.

So I imagine we can fix this similar to how we fix the Babel tests when the CLDR data is updated:

trac/mimeview/tests/pygments.py

@@ -119 +119 @@
         Pygments supports it.
         """
         mimeview = Mimeview(self.env)
-        self.assertEqual('text/x-ini; charset=utf-8',
-                         mimeview.get_mimetype('file.ini'))
-        self.assertEqual('text/x-ini; charset=utf-8',
-                         mimeview.get_mimetype('file.cfg'))
+        self.assertIn(mimeview.get_mimetype('file.ini'),
+                      ('text/x-ini; charset=utf-8',
+                       'text/inf; charset=utf-8'))  # Pygment 2.1+
+        self.assertIn(mimeview.get_mimetype('file.cfg'),
+                      ('text/x-ini; charset=utf-8',
+                       'text/inf; charset=utf-8'))  # Pygment 2.1+
         self.assertEqual('text/x-ini; charset=utf-8',
                          mimeview.get_mimetype('file.text/x-ini'))

[Ryan J Ollos]

Regarding second and third errors, in Pygments 2.1 strings are being assigned Token.Literal.String.Double rather than Token.Literal.String.

Pygments 2.1:

>>> from pygments.lexers import PythonLexer
>>> pl = PythonLexer()
>>> s = """
... def hello():
...     return "Hello World!"
... """
>>> tokens = pl.get_tokens(s)
>>> for t in tokens:
...   print t
... 
(Token.Keyword, u'def')
(Token.Text, u' ')
(Token.Name.Function, u'hello')
(Token.Punctuation, u'(')
(Token.Punctuation, u')')
(Token.Punctuation, u':')
(Token.Text, u'\n')
(Token.Text, u'    ')
(Token.Keyword, u'return')
(Token.Text, u' ')
(Token.Literal.String.Double, u'"')
(Token.Literal.String.Double, u'Hello World!')
(Token.Literal.String.Double, u'"')
(Token.Text, u'\n')

Pygments 2.0.2:

>>> from pygments.lexers import get_lexer_by_name
>>> lexer = get_lexer_by_name('ini')
>>> lexer.mimetypes
['text/x-ini']
>>> from pygments.lexers import PythonLexer
>>> pl = PythonLexer()
>>> s = """
... def hello():
...     return "Hello World!"
... """
>>> tokens = pl.get_tokens(s)
>>> for t in tokens:
...   print t
... 
(Token.Keyword, u'def')
(Token.Text, u' ')
(Token.Name.Function, u'hello')
(Token.Punctuation, u'(')
(Token.Punctuation, u')')
(Token.Punctuation, u':')
(Token.Text, u'\n')
(Token.Text, u'    ')
(Token.Keyword, u'return')
(Token.Text, u' ')
(Token.Literal.String, u'"')
(Token.Literal.String, u'Hello World!')
(Token.Literal.String, u'"')
(Token.Text, u'\n')

[Ryan J Ollos]

Looks like comment:3 changes are due to ​issue 685.

[Ryan J Ollos]

Proposed changes in log:rjollos.git:t12326_pygments_2.1.