#! /usr/bin/env python3 # Author: engelbert gruber # Copyright: This module has been placed in the public domain. """ Tests for manpage writer. """ from pathlib import Path import sys import unittest if __name__ == '__main__': # prepend the "docutils root" to the Python library path # so we import the local `docutils` package. sys.path.insert(0, str(Path(__file__).resolve().parents[2])) from docutils.core import publish_string class WriterPublishTestCase(unittest.TestCase): maxDiff = None def test_publish(self): writer_name = 'manpage' for name, cases in totest.items(): for casenum, (case_input, case_expected) in enumerate(cases): with self.subTest(id=f'totest[{name!r}][{casenum}]'): output = publish_string( source=case_input, writer_name=writer_name, settings_overrides={ '_disable_config': True, 'strict_visitor': True, }).decode() self.assertEqual(case_expected, output) indend_macros = r""". .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. """ totest = {} totest['blank'] = [ ["", r""".\" Man page generated from reStructuredText. . """ + indend_macros + """.TH "" "" "" "" .SH NAME \\- \n\ .\\" Generated by docutils manpage writer. . """], [r"""Hello, world. ============= .. WARNING:: This broke docutils-sphinx. """, r""".\" Man page generated from reStructuredText. . """ + indend_macros + """.TH "HELLO, WORLD." "" "" "" .SH NAME Hello, world. \\- \n\ .sp \\fBWARNING:\\fP .INDENT 0.0 .INDENT 3.5 This broke docutils\\-sphinx. .UNINDENT .UNINDENT .\\" Generated by docutils manpage writer. . """], ] totest['simple'] = [ ["""\ ======== simple ======== --------------- The way to go --------------- :Author: someone@somewhere.net :Date: 2009-08-05 :Copyright: public domain :Version: 0.1 :Manual section: 1 :Manual group: text processing :Arbitrary field: some text SYNOPSIS ======== :: K.I.S.S keep it simple. DESCRIPTION =========== General rule of life. OPTIONS ======= --config= Read configuration settings from , if it exists. --version, -V Show this program's version number and exit. --help, -h Show this help message and exit. OtHeR SECTION ============= link to http://docutils.sourceforge.io With mixed case. .. Attention:: Admonition with title * bullet list * bull and list .. admonition:: homegrown something important . period at line start. and . in a line and at line start .in a paragraph """, r""".\" Man page generated from reStructuredText. . """ + indend_macros + r""".TH "SIMPLE" "1" "2009-08-05" "0.1" "text processing" .SH NAME simple \- The way to go .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp .EX K.I.S.S keep it simple. .EE .UNINDENT .UNINDENT .SH DESCRIPTION .sp General rule of life. .SH OPTIONS .INDENT 0.0 .TP .BI \-\-config\fB= Read configuration settings from , if it exists. .TP .B \-\-version\fP,\fB \-V Show this program\(aqs version number and exit. .TP .B \-\-help\fP,\fB \-h Show this help message and exit. .UNINDENT .SH OTHER SECTION .sp link to .sp With mixed case. .sp \fBATTENTION!:\fP .INDENT 0.0 .INDENT 3.5 Admonition with title .INDENT 0.0 .IP \(bu 2 bullet list .IP \(bu 2 bull and list .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .INDENT 3.5 .IP "homegrown" .sp something important .UNINDENT .UNINDENT .sp \&. period at line start. .sp and . in a line and at line start \&.in a paragraph .SH AUTHOR someone@somewhere.net Arbitrary field: some text .SH COPYRIGHT public domain .\" Generated by docutils manpage writer. . """], ] totest['table'] = [ ["""\ ====== ===== head and ====== ===== 1 2 abc so ====== ===== """, '''\ \'\\" t .\\" Man page generated from reStructuredText. . ''' + indend_macros + '''.TH "" "" "" "" .SH NAME \\- \n\ .INDENT 0.0 .INDENT 3.5 .TS box center; l|l. T{ head T}\tT{ and T} _ T{ 1 T}\tT{ 2 T} _ T{ abc T}\tT{ so T} .TE .UNINDENT .UNINDENT .\\" Generated by docutils manpage writer. . '''] ] totest['optiongroup'] = [ [""" optin group with dot as group item $ bla bla bla # bla bla bla . bla bla bla [ bla bla bla ] bla bla bla """, """\ .\\" Man page generated from reStructuredText. . """ + indend_macros + """.TH "" "" "" "" .SH NAME \\- \n\ optin group with dot as group item .INDENT 0.0 .TP .B $ bla bla bla .UNINDENT .INDENT 0.0 .TP .B # bla bla bla .UNINDENT .INDENT 0.0 .TP .B \\&. bla bla bla .UNINDENT .INDENT 0.0 .TP .B [ bla bla bla .UNINDENT .INDENT 0.0 .TP .B ] bla bla bla .UNINDENT .\\" Generated by docutils manpage writer. . """], ] totest['definitionlist'] = [ [""" ==================== Definition List Test ==================== :Abstract: Docinfo is required. Section ======= :term1: Description of Term 1 Description of Term 1 Description of Term 1 Description of Term 1 Description of Term 1 Description of Term 1 Description of Term 1 Description of Term 1 Description of Term 1 Description of Term 1 """, '''\ .\\" Man page generated from reStructuredText. . ''' + indend_macros + '''.TH "DEFINITION LIST TEST" "" "" "" .SH NAME Definition List Test \\- \n\ ''' + '''.SS Abstract .sp Docinfo is required. .SH SECTION .INDENT 0.0 .TP .B term1 Description of Term 1 Description of Term 1 Description of Term 1 Description of Term 1 Description of Term 1 .sp Description of Term 1 Description of Term 1 Description of Term 1 Description of Term 1 Description of Term 1 .UNINDENT .\\" Generated by docutils manpage writer. . '''], ] totest['cmdlineoptions'] = [ ["""optional arguments: -h, --help show this help --output FILE, -o FILE output filename -i DEVICE, --input DEVICE input device """, r""".\" Man page generated from reStructuredText. . """ + indend_macros + """.TH "" "" "" "" .SH NAME \\- \n\ .INDENT 0.0 .TP .B optional arguments: .INDENT 7.0 .TP .B \\-h\\fP,\\fB \\-\\-help show this help .TP .BI \\-\\-output \\ FILE\\fR,\\fB \\ \\-o \\ FILE output filename .TP .BI \\-i \\ DEVICE\\fR,\\fB \\ \\-\\-input \\ DEVICE input device .UNINDENT .UNINDENT .\\" Generated by docutils manpage writer. . """], ] totest['citation'] = [ [""".. [docutils] blah blah blah .. [empty_citation] """, r""".\" Man page generated from reStructuredText. . """ + indend_macros + """.TH "" "" "" "" .SH NAME \\- \n\ .IP [docutils] 5 blah blah blah .IP [empty_citation] 5 .\\" Generated by docutils manpage writer. . """], ] totest['rubric'] = [ [""".. rubric:: some rubric - followed by - a list """, r""".\" Man page generated from reStructuredText. . """ + indend_macros + """.TH "" "" "" "" .SH NAME \\- \n\ some rubric .INDENT 0.0 .IP \\(bu 2 followed by .IP \\(bu 2 a list .UNINDENT .\\" Generated by docutils manpage writer. . """], ] totest['double_quote'] = [ ["""in "defintion list" double quotes must be escaped on macro invocations. They are "escaped" anywhere. """, r""".\" Man page generated from reStructuredText. . """ + indend_macros + """.TH "" "" "" "" .SH NAME \\- \n\ .INDENT 0.0 .TP .B in \\(dqdefintion list\\(dq double quotes must be escaped on macro invocations. .UNINDENT .sp They are \\(dqescaped\\(dq anywhere. .\\" Generated by docutils manpage writer. . """], ] totest['man_header'] = [ [""" ============ page title ============ in short -------- :Manual section: 3 :Manual group: the books :Version: 0.0 :Date: 3/Nov/2022 Test title, docinfo to man page header. """, r""".\" Man page generated from reStructuredText. . """ + indend_macros + r""".TH "PAGE TITLE" "3" "3/Nov/2022" "0.0" "the books" .SH NAME page title \- in short .sp Test title, docinfo to man page header. .\" Generated by docutils manpage writer. . """], ] if __name__ == '__main__': unittest.main()