def test_build_docs_blob_no_readme(get_readme_doc_file):
get_readme_doc_file.return_value = None
collection_loader = CollectionLoader(
'/tmpdir', 'filename', cfg=SimpleNamespace(run_ansible_doc=True))
collection_loader.content_objs = []
with pytest.raises(exc.ImporterError):
collection_loader._build_docs_blob()
def test_build_docs_blob_contents(get_readme_doc_file, get_html):
get_readme_doc_file.return_value.name = 'README.md'
get_html.return_value = '<p>A detailed guide</p>'
collection_loader = CollectionLoader(
'/tmpdir', 'filename', cfg=SimpleNamespace(run_ansible_doc=True))
collection_loader.content_objs = [
schema.Content(name='my_module', content_type=ContentType.MODULE),
schema.Content(name='my_role', content_type=ContentType.ROLE),
]
res = collection_loader._build_docs_blob()
assert attr.asdict(res) == {
'collection_readme': {
'name': 'README.md',
'html': '<p>A detailed guide</p>'
},
'documentation_files': [],
'contents': [
{
'content_name': 'my_module',
'content_type': 'module',
'doc_strings': {},
'readme_file': None,
'readme_html': None,
},
{
'content_name': 'my_role',
'content_type': 'role',
'doc_strings': {},
'readme_file': None,
'readme_html': None,
},
],
}
def test_build_docs_blob_doc_files(get_doc_files, get_readme, get_html):
get_readme.return_value.name = 'README.md'
get_html.return_value = '<p>A detailed guide</p>'
get_doc_files.return_value = [
markup_utils.DocFile(name='INTRO.md',
text='Intro text',
mimetype='text/markdown',
hash=''),
markup_utils.DocFile(name='INTRO2.md',
text='Intro text',
mimetype='text/markdown',
hash=''),
]
collection_loader = CollectionLoader('/tmpdir', 'filename')
collection_loader.content_objs = []
res = collection_loader._build_docs_blob()
assert attr.asdict(res) == {
'collection_readme': {
'name': 'README.md',
'html': '<p>A detailed guide</p>'
},
'documentation_files': [
{
'name': 'INTRO.md',
'html': '<p>A detailed guide</p>',
},
{
'name': 'INTRO2.md',
'html': '<p>A detailed guide</p>',
},
],
'contents': [],
}
def test_build_docs_blob_no_readme(get_readme_doc_file):
get_readme_doc_file.return_value = None
collection_loader = CollectionLoader('/tmpdir', 'filename')
collection_loader.content_objs = []
with pytest.raises(exc.ImporterError):
collection_loader._build_docs_blob()