Add a test for when the ansi extension is enabled.

Author: jamadden

src/sphinxcontrib/programoutput/__init__.py

@@ -32,21 +32,22 @@
 
     .. moduleauthor::  Sebastian Wiesner  <lunaryorn@gmail.com>
 """
-
-from __future__ import print_function, division, absolute_import
-
-import sys
 import os
-import shlex
 import re
-from subprocess import Popen, PIPE, STDOUT
-from collections import defaultdict, namedtuple
+import shlex
+import sys
+from collections import defaultdict
+from collections import namedtuple
+from subprocess import PIPE
+from subprocess import STDOUT
+from subprocess import Popen
 
 from docutils import nodes
 from docutils.parsers import rst
-from docutils.parsers.rst.directives import flag, unchanged, nonnegative_int
+from docutils.parsers.rst.directives import flag
+from docutils.parsers.rst.directives import nonnegative_int
+from docutils.parsers.rst.directives import unchanged
 from docutils.statemachine import StringList
-
 from sphinx.util import logging as sphinx_logging
 
 __version__ = '0.19.dev0'
@@ -106,7 +107,7 @@ def _create_output_node(output, use_ansi, app=None):
 
     try:
         from erbsland.sphinx.ansi.parser import ANSILiteralBlock
-    except ImportError:
+    except ImportError: # pragma: no cover
         logger.warning(
             "programoutput_use_ansi is enabled, but erbsland ANSI support is "
             "not available. Stripping ANSI escape codes instead. Install "

src/sphinxcontrib/programoutput/tests/test_directive.py

@@ -29,9 +29,10 @@
 import unittest
 from unittest.mock import patch as Patch
 
-
-from docutils.nodes import caption, container, literal_block, system_message
-
+from docutils.nodes import caption
+from docutils.nodes import container
+from docutils.nodes import literal_block
+from docutils.nodes import system_message
 from sphinxcontrib.programoutput import Command
 
 from . import AppMixin
@@ -42,6 +43,8 @@ def with_content(content, **kwargs):
     Always use a bare 'python' in the *content* string.
 
     It will be replaced with ``sys.executable``.
+
+    Keyword arguments go directly into the Sphinx configuration.
     """
     if 'python' in content:
         # XXX: This probably breaks if there are spaces in sys.executable.
@@ -439,7 +442,6 @@ def test_name_with_caption(self):
         self.assert_output(self.doctree, 'spam', caption='mycaption', name='myname')
         self.assert_cache(self.app, 'echo spam', 'spam')
 
-
     @with_content("""\
     .. program-output:: python -c 'import json; d = {"foo": "bar"}; print(json.dumps(d))'
        :language: json""",
@@ -450,7 +452,6 @@ def test_language_json(self):
         self.assertEqual(literal.astext(), '{"foo": "bar"}')
         self.assertEqual(literal["language"], "json")
 
-
     @with_content("""\
     .. program-output:: echo spam""",
                   programoutput_use_ansi=True)
@@ -464,24 +465,39 @@ def test_use_ansi_config_forwarded(self):
         self.assertTrue(create_output_node.call_args.args[1])
         self.assert_cache(self.app, 'echo spam', 'spam')
 
-
     @with_content("""\
     .. program-output:: python -c 'print("\\x1b[31mspam\\x1b[0m")'""",
                   programoutput_use_ansi=True)
-    def test_use_ansi_missing_dependency(self):
+    def test_use_ansi_missing_extension(self):
         with Patch('sphinxcontrib.programoutput.logger.warning') as patch_warning:
             doctree = self.doctree
 
         self.assert_output(doctree, 'spam')
         patch_warning.assert_called_once()
         warning = patch_warning.call_args.args[0]
         self.assertIn('programoutput_use_ansi is enabled', warning)
+        self.assertIn("but 'erbsland.sphinx.ansi' is not enabled", warning)
         self.assert_cache(
             self.app,
             sys.executable + " -c 'print(\"\\x1b[31mspam\\x1b[0m\")'",
             '\x1b[31mspam\x1b[0m'
         )
 
+    @with_content("""\
+    .. program-output:: python -c 'print("\\x1b[31mspam\\x1b[0m")'""",
+                  programoutput_use_ansi=True,
+                  extensions=['sphinxcontrib.programoutput', 'erbsland.sphinx.ansi'])
+    def test_use_ansi_enabled_extension(self):
+        with Patch('sphinxcontrib.programoutput.logger.warning') as patch_warning:
+            doctree = self.doctree
+
+        self.assert_output(doctree, '\x1b[31mspam\x1b[0m')
+        patch_warning.assert_not_called()
+        self.assert_cache(
+            self.app,
+            sys.executable + " -c 'print(\"\\x1b[31mspam\\x1b[0m\")'",
+            '\x1b[31mspam\x1b[0m'
+        )
 
 def test_suite():
     return unittest.defaultTestLoader.loadTestsFromName(__name__)