Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tests: adding rst doctest block tests #905

Merged
merged 1 commit into from
Mar 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions tests/unit-tests/datasets/rst/doctest-block/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#doctest-blocks

doctest-block
-------------

>>> print 'this is a Doctest block'
this is a Doctest block
40 changes: 40 additions & 0 deletions tests/unit-tests/test_rst_doctest_block.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# SPDX-License-Identifier: BSD-2-Clause
# Copyright Sphinx Confluence Builder Contributors (AUTHORS)

from bs4 import CData
from tests.lib.parse import parse
from tests.lib.testcase import ConfluenceTestCase
from tests.lib.testcase import setup_builder


class TestConfluenceRstDoctestBlock(ConfluenceTestCase):
@classmethod
def setUpClass(cls):
super().setUpClass()

cls.dataset = cls.datasets / 'rst' / 'doctest-block'

@setup_builder('confluence')
def test_storage_rst_doctest_block(self):
out_dir = self.build(self.dataset)

with parse('index', out_dir) as data:
code_macros = data.find_all('ac:structured-macro')
self.assertIsNotNone(code_macros)
self.assertEqual(len(code_macros), 1)

for code_macro in code_macros:
self.assertTrue(code_macro.has_attr('ac:name'))
self.assertEqual(code_macro['ac:name'], 'code')

doctest_block = code_macros.pop(0)

doctest_block_lang = doctest_block.find('ac:parameter',
{'ac:name': 'language'})
self.assertIsNotNone(doctest_block_lang)
self.assertEqual(doctest_block_lang.text, 'python')

doctest_block_body = doctest_block.find('ac:plain-text-body')
doctest_block_cdata = next(doctest_block_body.children, None)
self.assertIsNotNone(doctest_block_cdata)
self.assertTrue(isinstance(doctest_block_cdata, CData))