# Copyright (c) Twisted Matrix Laboratories.
# See LICENSE for details.
"""
Tests for L{twisted.lore.man2lore}.
"""
from StringIO import StringIO
from twisted.trial.unittest import TestCase
from twisted.lore.man2lore import ManConverter
_TRANSITIONAL_XHTML_DTD = ("""\
""")
class ManConverterTestCase(TestCase):
"""
Tests for L{ManConverter}.
"""
def setUp(self):
"""
Build instance variables useful for tests.
@ivar converter: a L{ManConverter} to be used during tests.
"""
self.converter = ManConverter()
def assertConvert(self, inputLines, expectedOutput):
"""
Helper method to check conversion from a man page to a Lore output.
@param inputLines: lines of the manpages.
@type inputLines: C{list}
@param expectedOutput: expected Lore content.
@type expectedOutput: C{str}
"""
inputFile = StringIO()
for line in inputLines:
inputFile.write(line + '\n')
inputFile.seek(0)
outputFile = StringIO()
self.converter.convert(inputFile, outputFile)
self.assertEqual(
outputFile.getvalue(), _TRANSITIONAL_XHTML_DTD + expectedOutput)
def test_convert(self):
"""
Test convert on a minimal example.
"""
inputLines = ['.TH BAR "1" "Oct 2007" "" ""', "Foo\n"]
output = ("\nBAR.1\n\n\n"
"BAR.1
\n\nFoo\n\n
\n\n\n\n")
self.assertConvert(inputLines, output)
def test_TP(self):
"""
Test C{TP} parsing.
"""
inputLines = ['.TH BAR "1" "Oct 2007" "" ""',
".SH HEADER",
".TP",
"\\fB-o\\fR, \\fB--option\\fR",
"An option"]
output = ("\nBAR.1\n\n\n"
"BAR.1
\n\nHEADER
\n\n- "
"-o, --option\n
"
"- An option\n
\n\n
\n\n\n\n")
self.assertConvert(inputLines, output)
def test_TPMultipleOptions(self):
"""
Try to parse multiple C{TP} fields.
"""
inputLines = ['.TH BAR "1" "Oct 2007" "" ""',
".SH HEADER",
".TP",
"\\fB-o\\fR, \\fB--option\\fR",
"An option",
".TP",
"\\fB-n\\fR, \\fB--another\\fR",
"Another option",
]
output = ("\nBAR.1\n\n\n"
"BAR.1
\n\nHEADER
\n\n- "
"-o, --option\n
"
"- An option\n
\n\n- "
"-n, --another\n
"
"- Another option\n
\n\n
\n\n\n\n")
self.assertConvert(inputLines, output)
def test_TPMultiLineOptions(self):
"""
Try to parse multiple C{TP} fields, with options text on several lines.
"""
inputLines = ['.TH BAR "1" "Oct 2007" "" ""',
".SH HEADER",
".TP",
"\\fB-o\\fR, \\fB--option\\fR",
"An option",
"on two lines",
".TP",
"\\fB-n\\fR, \\fB--another\\fR",
"Another option",
"on two lines",
]
output = ("\nBAR.1\n\n\n"
"BAR.1
\n\nHEADER
\n\n- "
"-o, --option\n
"
"- An option\non two lines\n
\n\n"
"- -n, --another\n
"
"- Another option\non two lines\n
\n\n
\n\n"
"\n\n")
self.assertConvert(inputLines, output)
def test_ITLegacyManagement(self):
"""
Test management of BL/IT/EL used in some man pages.
"""
inputLines = ['.TH BAR "1" "Oct 2007" "" ""',
".SH HEADER",
".BL",
".IT An option",
"on two lines",
".IT",
"Another option",
"on two lines",
".EL"
]
output = ("\nBAR.1\n\n\n"
"BAR.1
\n\nHEADER
\n\n"
"- on two lines\n
- Another option\non two lines\n"
"
\n\n\n\n")
self.assertConvert(inputLines, output)
def test_interactiveCommand(self):
"""
Test management of interactive command tag.
"""
inputLines = ['.TH BAR "1" "Oct 2007" "" ""',
".SH HEADER",
".BL",
".IT IC foo AR bar",
"option 1",
".IT IC egg AR spam OP AR stuff",
"option 2",
".EL"
]
output = ("\nBAR.1\n\n\n"
"BAR.1
\n\nHEADER
\n\n"
"- foo bar
- option 1\n
- egg "
"spam [stuff]
- option 2\n
"
"\n\n\n\n")
self.assertConvert(inputLines, output)