blob: d9d4eab544fd2b624793661d9c99d905f0c1c5a7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
import os
import unittest
from cuddlefish.docs import webdocs
class WebDocTests(unittest.TestCase):
def test_create_package_doc(self):
root = os.path.join(os.getcwd() + \
'/python-lib/cuddlefish/tests/static-files')
web_docs = webdocs.WebDocs(root)
aarvark_package = web_docs.create_package_page('aardvark')
self._test_common_contents(aarvark_package)
self.assertTrue('<h1>aardvark</h1>'\
in aarvark_package)
self.assertTrue(\
'<span class="meta-header">Author</span>'\
in aarvark_package)
self.assertTrue(\
'<span class="author">Jon Smith</span>'\
in aarvark_package)
self.assertTrue(\
'<title>aardvark - Add-on SDK Documentation</title>'\
in aarvark_package)
def test_create_guide1_doc(self):
root = os.path.join(os.getcwd() + \
'/python-lib/cuddlefish/tests/static-files')
web_docs = webdocs.WebDocs(root)
guide = web_docs.create_guide_page(os.path.join(\
root + '/doc/dev-guide-source/index.blah'))
self._test_common_contents(guide)
self.assertTrue(\
'<title>An Imposing Title - Add-on SDK Documentation</title>'\
in guide)
self.assertTrue('<p><em>Some words!</em></p>'\
in guide)
self.assertTrue('<div id="version">Version '\
in guide)
def test_create_guide2_doc(self):
root = os.path.join(os.getcwd() + \
'/python-lib/cuddlefish/tests/static-files')
web_docs = webdocs.WebDocs(root)
guide = web_docs.create_guide_page(os.path.join(\
root + '/doc/dev-guide-source/no_h1.blah'))
self._test_common_contents(guide)
self.assertTrue('<title>Add-on SDK Documentation</title>'\
in guide)
self.assertTrue('<h2>A heading</h2>'\
in guide)
def test_create_module_doc(self):
root = os.path.join(os.getcwd() + \
'/python-lib/cuddlefish/tests/static-files')
web_docs = webdocs.WebDocs(root)
module = web_docs.create_module_page(os.path.join(\
root + '/packages/aardvark/doc/aardvark-feeder.blah'))
self._test_common_contents(module)
self.assertTrue(\
'<title>aardvark-feeder - Add-on SDK Documentation</title>'\
in module)
self.assertTrue(\
'<h1>aardvark-feeder</h1>'\
in module)
self.assertTrue(\
'<div class="module_description">'\
in module)
self.assertTrue(\
'<p>The <code>aardvark-feeder</code> module simplifies feeding aardvarks.</p>'\
in module)
self.assertTrue(\
'<h2 class="api_header">API Reference</h2>'\
in module)
self.assertTrue(\
'<h3 class="api_header">Functions</h3>'\
in module)
self.assertTrue(\
'<h4 class="api_name">feed(food)</h4>'\
in module)
self.assertTrue(
'<p>Feed the aardvark.</p>'\
in module)
def _test_common_contents(self, doc):
self.assertTrue(\
'<a href="packages/aardvark/index.html"' in doc)
self.assertTrue(\
'<a href="packages/anteater_files/index.html"' in doc)
self.assertTrue(\
'<a href="packages/aardvark/main.html">main</a>' in doc)
if __name__ == "__main__":
unittest.main()
|
