def test_find_toc_by_id(self):
"""
Test finding the relevant TOC item by the tag ID.
"""
index = search_index.SearchIndex()
md = dedent("""
# Heading 1
## Heading 2
### Heading 3
""")
toc = get_toc(get_markdown_toc(md))
toc_item = index._find_toc_by_id(toc, "heading-1")
self.assertEqual(toc_item.url, "#heading-1")
self.assertEqual(toc_item.title, "Heading 1")
toc_item2 = index._find_toc_by_id(toc, "heading-2")
self.assertEqual(toc_item2.url, "#heading-2")
self.assertEqual(toc_item2.title, "Heading 2")
toc_item3 = index._find_toc_by_id(toc, "heading-3")
self.assertEqual(toc_item3.url, "#heading-3")
self.assertEqual(toc_item3.title, "Heading 3")
def test_create_search_index(self):
html_content = """
<h1 id="heading-1">Heading 1</h1>
<p>Content 1</p>
<h2 id="heading-2">Heading 2</h1>
<p>Content 2</p>
<h3 id="heading-3">Heading 3</h1>
<p>Content 3</p>
"""
cfg = load_config()
pages = [
Page('Home', File('index.md', cfg['docs_dir'], cfg['site_dir'], cfg['use_directory_urls']), cfg),
Page('About', File('about.md', cfg['docs_dir'], cfg['site_dir'], cfg['use_directory_urls']), cfg)
]
md = dedent("""
# Heading 1
## Heading 2
### Heading 3
""")
toc = get_toc(get_markdown_toc(md))
full_content = ''.join("""Heading{0}Content{0}""".format(i) for i in range(1, 4))
for page in pages:
# Fake page.read_source() and page.render()
page.markdown = md
page.toc = toc
page.content = html_content
index = search_index.SearchIndex()
index.add_entry_from_context(page)
self.assertEqual(len(index._entries), 4)
loc = page.url
self.assertEqual(index._entries[0]['title'], page.title)
self.assertEqual(strip_whitespace(index._entries[0]['text']), full_content)
self.assertEqual(index._entries[0]['location'], loc)
self.assertEqual(index._entries[1]['title'], "Heading 1")
self.assertEqual(index._entries[1]['text'], "Content 1")
self.assertEqual(index._entries[1]['location'], "{0}#heading-1".format(loc))
self.assertEqual(index._entries[2]['title'], "Heading 2")
self.assertEqual(strip_whitespace(index._entries[2]['text']), "Content2")
self.assertEqual(index._entries[2]['location'], "{0}#heading-2".format(loc))
self.assertEqual(index._entries[3]['title'], "Heading 3")
self.assertEqual(strip_whitespace(index._entries[3]['text']), "Content3")
self.assertEqual(index._entries[3]['location'], "{0}#heading-3".format(loc))
def test_prebuild_index_python(self, mock_lunr):
mock_lunr.return_value.serialize.return_value = {'mock': 'index'}
index = search_index.SearchIndex(prebuild_index='python', lang='en')
expected = {
'docs': [],
'config': {'prebuild_index': 'python', 'lang': 'en'},
'index': {'mock': 'index'}
}
result = json.loads(index.generate_search_index())
self.assertEqual(mock_lunr.call_count, 1)
self.assertEqual(result, expected)
def test_prebuild_index_python_missing_lunr(self):
# When the lunr.py dependencies are not installed no prebuilt index is created.
index = search_index.SearchIndex(prebuild_index='python', lang='en')
expected = {
'docs': [],
'config': {
'prebuild_index': 'python',
'lang': 'en'
}
}
result = json.loads(index.generate_search_index())
self.assertEqual(result, expected)
def test_prebuild_index_false(self, mock_popen):
# See https://stackoverflow.com/a/36501078/866026
mock_popen.return_value = mock.Mock()
mock_popen_obj = mock_popen.return_value
mock_popen_obj.communicate.return_value = ('', '')
mock_popen_obj.returncode = 0
index = search_index.SearchIndex(prebuild_index=False)
expected = {'docs': [], 'config': {'prebuild_index': False}}
result = json.loads(index.generate_search_index())
self.assertEqual(mock_popen.call_count, 0)
self.assertEqual(mock_popen_obj.communicate.call_count, 0)
self.assertEqual(result, expected)
def test_prebuild_index_raises_ioerror(self, mock_popen):
# See https://stackoverflow.com/a/36501078/866026
mock_popen.return_value = mock.Mock()
mock_popen_obj = mock_popen.return_value
mock_popen_obj.communicate.side_effect = IOError
mock_popen_obj.returncode = 1
index = search_index.SearchIndex(prebuild_index=True)
expected = {'docs': [], 'config': {'prebuild_index': True}}
result = json.loads(index.generate_search_index())
self.assertEqual(mock_popen.call_count, 1)
self.assertEqual(mock_popen_obj.communicate.call_count, 1)
self.assertEqual(result, expected)
def test_prebuild_index(self, mock_popen):
# See https://stackoverflow.com/a/36501078/866026
mock_popen.return_value = mock.Mock()
mock_popen_obj = mock_popen.return_value
mock_popen_obj.communicate.return_value = ('{"mock": "index"}', None)
mock_popen_obj.returncode = 0
index = search_index.SearchIndex(prebuild_index=True)
expected = {
'docs': [],
'config': {'prebuild_index': True},
'index': {'mock': 'index'}
}
result = json.loads(index.generate_search_index())
self.assertEqual(mock_popen.call_count, 1)
self.assertEqual(mock_popen_obj.communicate.call_count, 1)
self.assertEqual(result, expected)
def test_search_indexing_options(self):
def test_page(title, filename, config):
test_page = Page(
title,
File(filename, config['docs_dir'], config['site_dir'],
config['use_directory_urls']), config)
test_page.content = """
<h1 id="heading-1">Heading 1</h1>
<p>Content 1</p>
<h2 id="heading-2">Heading 2</h1>
<p>Content 2</p>
<h3 id="heading-3">Heading 3</h1>
<p>Content 3</p>"""
test_page.markdown = dedent("""
# Heading 1
## Heading 2
### Heading 3""")
test_page.toc = get_toc(get_markdown_toc(test_page.markdown))
return test_page
validate = {
'full':
(lambda data: self.assertEqual(len(data[0]), 4) and self.
assertTrue([x for x in data[0][0] if x['title'] and x['text']])),
'sections': (
lambda data:
# Sanity
self.assertEqual(len(data[0]), 4) and
# Page
(self.assertEqual(data[0][0]['title'], data[1].title) and self.
assertTrue(data[0][0]['text'])) and
# Headings
self.assertTrue(
[x for x in data[0][1:] if x['title'] and not x['text']])),
'titles': (
lambda data:
# Sanity
self.assertEqual(len(data[0]), 1) and self.assertFalse(
[x for x in data[0] if x['text']]))
}
for option in ['full', 'sections', 'titles']:
plugin = search.SearchPlugin()
# Load plugin config, overriding indexing for test case
errors, warnings = plugin.load_config({'indexing': option})
self.assertEqual(errors, [])
self.assertEqual(warnings, [])
base_cfg = load_config()
base_cfg['plugins']['search'].config['indexing'] = option
pages = [
test_page('Home', 'index.md', base_cfg),
test_page('About', 'about.md', base_cfg)
]
for page in pages:
index = search_index.SearchIndex(**plugin.config)
index.add_entry_from_context(page)
data = index.generate_search_index()
validate[option]((json.loads(data)['docs'], page))
def test_create_search_index(self):
html_content = """
<h1 id="heading-1">Heading 1</h1>
<p>Content 1</p>
<h2 id="heading-2">Heading 2</h1>
<p>Content 2</p>
<h3 id="heading-3">Heading 3</h1>
<p>Content 3</p>
"""
pages = [
{
'Home': 'index.md'
},
{
'About': 'about.md'
},
]
site_navigation = nav.SiteNavigation(load_config(pages=pages))
md = dedent("""
# Heading 1
## Heading 2
### Heading 3
""")
toc = markdown_to_toc(md)
full_content = ''.join("""Heading{0}Content{0}""".format(i)
for i in range(1, 4))
for page in site_navigation:
# Fake page.read_source() and page.render()
page.markdown = md
page.toc = toc
page.content = html_content
index = search_index.SearchIndex()
index.add_entry_from_context(page)
self.assertEqual(len(index._entries), 4)
loc = page.abs_url
self.assertEqual(index._entries[0]['title'], page.title)
self.assertEqual(strip_whitespace(index._entries[0]['text']),
full_content)
self.assertEqual(index._entries[0]['location'], loc)
self.assertEqual(index._entries[1]['title'], "Heading 1")
self.assertEqual(index._entries[1]['text'], "Content 1")
self.assertEqual(index._entries[1]['location'],
"{0}#heading-1".format(loc))
self.assertEqual(index._entries[2]['title'], "Heading 2")
self.assertEqual(strip_whitespace(index._entries[2]['text']),
"Content2")
self.assertEqual(index._entries[2]['location'],
"{0}#heading-2".format(loc))
self.assertEqual(index._entries[3]['title'], "Heading 3")
self.assertEqual(strip_whitespace(index._entries[3]['text']),
"Content3")
self.assertEqual(index._entries[3]['location'],
"{0}#heading-3".format(loc))
