Show More
@@ -1,155 +1,164 b'' | |||
|
1 | 1 | """ |
|
2 | 2 | Contains base test class for nbconvert |
|
3 | 3 | """ |
|
4 | 4 | #----------------------------------------------------------------------------- |
|
5 | 5 | #Copyright (c) 2013, the IPython Development Team. |
|
6 | 6 | # |
|
7 | 7 | #Distributed under the terms of the Modified BSD License. |
|
8 | 8 | # |
|
9 | 9 | #The full license is in the file COPYING.txt, distributed with this software. |
|
10 | 10 | #----------------------------------------------------------------------------- |
|
11 | 11 | |
|
12 | 12 | #----------------------------------------------------------------------------- |
|
13 | 13 | # Imports |
|
14 | 14 | #----------------------------------------------------------------------------- |
|
15 | 15 | |
|
16 | import io | |
|
16 | 17 | import os |
|
17 | 18 | import glob |
|
18 | 19 | import shutil |
|
19 | 20 | import unittest |
|
20 | 21 | |
|
21 | 22 | import IPython |
|
23 | from IPython.nbformat import current | |
|
22 | 24 | from IPython.utils.tempdir import TemporaryWorkingDirectory |
|
25 | from IPython.utils.path import get_ipython_package_dir | |
|
23 | 26 | from IPython.utils.process import get_output_error_code |
|
24 | 27 | from IPython.testing.tools import get_ipython_cmd |
|
25 | 28 | |
|
26 | 29 | # a trailing space allows for simpler concatenation with the other arguments |
|
27 | 30 | ipy_cmd = get_ipython_cmd(as_string=True) + " " |
|
28 | 31 | |
|
29 | 32 | #----------------------------------------------------------------------------- |
|
30 | 33 | # Classes and functions |
|
31 | 34 | #----------------------------------------------------------------------------- |
|
32 | 35 | |
|
33 | 36 | |
|
34 | 37 | class TestsBase(unittest.TestCase): |
|
35 | 38 | """Base tests class. Contains useful fuzzy comparison and nbconvert |
|
36 | 39 | functions.""" |
|
37 | 40 | |
|
38 | 41 | |
|
39 | 42 | def fuzzy_compare(self, a, b, newlines_are_spaces=True, tabs_are_spaces=True, |
|
40 | 43 | fuzzy_spacing=True, ignore_spaces=False, |
|
41 | 44 | ignore_newlines=False, case_sensitive=False, leave_padding=False): |
|
42 | 45 | """ |
|
43 | 46 | Performs a fuzzy comparison of two strings. A fuzzy comparison is a |
|
44 | 47 | comparison that ignores insignificant differences in the two comparands. |
|
45 | 48 | The significance of certain differences can be specified via the keyword |
|
46 | 49 | parameters of this method. |
|
47 | 50 | """ |
|
48 | 51 | |
|
49 | 52 | if not leave_padding: |
|
50 | 53 | a = a.strip() |
|
51 | 54 | b = b.strip() |
|
52 | 55 | |
|
53 | 56 | if ignore_newlines: |
|
54 | 57 | a = a.replace('\n', '') |
|
55 | 58 | b = b.replace('\n', '') |
|
56 | 59 | |
|
57 | 60 | if newlines_are_spaces: |
|
58 | 61 | a = a.replace('\n', ' ') |
|
59 | 62 | b = b.replace('\n', ' ') |
|
60 | 63 | |
|
61 | 64 | if tabs_are_spaces: |
|
62 | 65 | a = a.replace('\t', ' ') |
|
63 | 66 | b = b.replace('\t', ' ') |
|
64 | 67 | |
|
65 | 68 | if ignore_spaces: |
|
66 | 69 | a = a.replace(' ', '') |
|
67 | 70 | b = b.replace(' ', '') |
|
68 | 71 | |
|
69 | 72 | if fuzzy_spacing: |
|
70 | 73 | a = self.recursive_replace(a, ' ', ' ') |
|
71 | 74 | b = self.recursive_replace(b, ' ', ' ') |
|
72 | 75 | |
|
73 | 76 | if not case_sensitive: |
|
74 | 77 | a = a.lower() |
|
75 | 78 | b = b.lower() |
|
76 | 79 | |
|
77 | 80 | self.assertEqual(a, b) |
|
78 | 81 | |
|
79 | 82 | |
|
80 | 83 | def recursive_replace(self, text, search, replacement): |
|
81 | 84 | """ |
|
82 | 85 | Performs a recursive replacement operation. Replaces all instances |
|
83 | 86 | of a search string in a text string with a replacement string until |
|
84 | 87 | the search string no longer exists. Recursion is needed because the |
|
85 | 88 | replacement string may generate additional search strings. |
|
86 | 89 | |
|
87 | 90 | For example: |
|
88 | 91 | Replace "ii" with "i" in the string "Hiiii" yields "Hii" |
|
89 | 92 | Another replacement cds "Hi" (the desired output) |
|
90 | 93 | |
|
91 | 94 | Parameters |
|
92 | 95 | ---------- |
|
93 | 96 | text : string |
|
94 | 97 | Text to replace in. |
|
95 | 98 | search : string |
|
96 | 99 | String to search for within "text" |
|
97 | 100 | replacement : string |
|
98 | 101 | String to replace "search" with |
|
99 | 102 | """ |
|
100 | 103 | while search in text: |
|
101 | 104 | text = text.replace(search, replacement) |
|
102 | 105 | return text |
|
103 | 106 | |
|
104 | 107 | def create_temp_cwd(self, copy_filenames=None): |
|
105 | 108 | temp_dir = TemporaryWorkingDirectory() |
|
106 | 109 | |
|
107 | 110 | #Copy the files if requested. |
|
108 | 111 | if copy_filenames is not None: |
|
109 | 112 | self.copy_files_to(copy_filenames) |
|
110 | 113 | |
|
111 | 114 | #Return directory handler |
|
112 | 115 | return temp_dir |
|
116 | ||
|
117 | def create_empty_notebook(self, path): | |
|
118 | nb = current.new_notebook() | |
|
119 | nb.worksheets.append(current.new_worksheet()) | |
|
120 | with io.open(path, 'w', encoding='utf-8') as f: | |
|
121 | current.write(nb, f, 'json') | |
|
113 | 122 | |
|
114 | 123 | |
|
115 | 124 | def copy_files_to(self, copy_filenames, dest='.'): |
|
116 | 125 | "Copy test files into the destination directory" |
|
117 | 126 | if not os.path.isdir(dest): |
|
118 | 127 | os.makedirs(dest) |
|
119 | 128 | files_path = self._get_files_path() |
|
120 | 129 | for pattern in copy_filenames: |
|
121 | 130 | for match in glob.glob(os.path.join(files_path, pattern)): |
|
122 | 131 | shutil.copyfile(match, os.path.join(dest, os.path.basename(match))) |
|
123 | 132 | |
|
124 | 133 | |
|
125 | 134 | def _get_files_path(self): |
|
126 | 135 | |
|
127 | 136 | #Get the relative path to this module in the IPython directory. |
|
128 | 137 | names = self.__module__.split('.')[1:-1] |
|
129 | 138 | names.append('files') |
|
130 | 139 | |
|
131 | 140 | #Build a path using the IPython directory and the relative path we just |
|
132 | 141 | #found. |
|
133 |
path = |
|
|
142 | path = get_ipython_package_dir() | |
|
134 | 143 | for name in names: |
|
135 | 144 | path = os.path.join(path, name) |
|
136 | 145 | return path |
|
137 | 146 | |
|
138 | 147 | |
|
139 | 148 | def call(self, parameters, ignore_return_code=False): |
|
140 | 149 | """ |
|
141 | 150 | Execute a, IPython shell command, listening for both Errors and non-zero |
|
142 | 151 | return codes. |
|
143 | 152 | |
|
144 | 153 | Parameters |
|
145 | 154 | ---------- |
|
146 | 155 | parameters : str |
|
147 | 156 | List of parameters to pass to IPython. |
|
148 | 157 | ignore_return_code : optional bool (default False) |
|
149 | 158 | Throw an OSError if the return code |
|
150 | 159 | """ |
|
151 | 160 | |
|
152 | 161 | stdout, stderr, retcode = get_output_error_code(ipy_cmd + parameters) |
|
153 | 162 | if not (retcode == 0 or ignore_return_code): |
|
154 | 163 | raise OSError(stderr) |
|
155 | 164 | return stdout, stderr |
@@ -1,207 +1,209 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Test NbConvertApp""" |
|
3 | 3 | |
|
4 | 4 | #----------------------------------------------------------------------------- |
|
5 | 5 | # Copyright (C) 2013 The IPython Development Team |
|
6 | 6 | # |
|
7 | 7 | # Distributed under the terms of the BSD License. The full license is in |
|
8 | 8 | # the file COPYING, distributed as part of this software. |
|
9 | 9 | #----------------------------------------------------------------------------- |
|
10 | 10 | |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | # Imports |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | |
|
15 | 15 | import os |
|
16 | 16 | import glob |
|
17 | 17 | import sys |
|
18 | 18 | |
|
19 | 19 | from .base import TestsBase |
|
20 | 20 | |
|
21 | 21 | import IPython.testing.tools as tt |
|
22 | 22 | from IPython.testing import decorators as dec |
|
23 | 23 | |
|
24 | 24 | |
|
25 | 25 | #----------------------------------------------------------------------------- |
|
26 | 26 | # Constants |
|
27 | 27 | #----------------------------------------------------------------------------- |
|
28 | 28 | |
|
29 | 29 | |
|
30 | 30 | #----------------------------------------------------------------------------- |
|
31 | 31 | # Classes and functions |
|
32 | 32 | #----------------------------------------------------------------------------- |
|
33 | 33 | |
|
34 | 34 | class TestNbConvertApp(TestsBase): |
|
35 | 35 | """Collection of NbConvertApp tests""" |
|
36 | 36 | |
|
37 | 37 | |
|
38 | 38 | def test_notebook_help(self): |
|
39 | 39 | """Will help show if no notebooks are specified?""" |
|
40 | 40 | with self.create_temp_cwd(): |
|
41 | 41 | out, err = self.call('nbconvert --log-level 0', ignore_return_code=True) |
|
42 | 42 | self.assertIn("see '--help-all'", out) |
|
43 | 43 | |
|
44 | 44 | def test_help_output(self): |
|
45 | 45 | """ipython nbconvert --help-all works""" |
|
46 | 46 | tt.help_all_output_test('nbconvert') |
|
47 | 47 | |
|
48 | 48 | def test_glob(self): |
|
49 | 49 | """ |
|
50 | 50 | Do search patterns work for notebook names? |
|
51 | 51 | """ |
|
52 | 52 | with self.create_temp_cwd(['notebook*.ipynb']): |
|
53 | 53 | self.call('nbconvert --to python *.ipynb --log-level 0') |
|
54 | 54 | assert os.path.isfile('notebook1.py') |
|
55 | 55 | assert os.path.isfile('notebook2.py') |
|
56 | 56 | |
|
57 | 57 | |
|
58 | 58 | def test_glob_subdir(self): |
|
59 | 59 | """ |
|
60 | 60 | Do search patterns work for subdirectory notebook names? |
|
61 | 61 | """ |
|
62 | 62 | with self.create_temp_cwd(): |
|
63 | 63 | self.copy_files_to(['notebook*.ipynb'], 'subdir/') |
|
64 | 64 | self.call('nbconvert --to python --log-level 0 ' + |
|
65 | 65 | os.path.join('subdir', '*.ipynb')) |
|
66 | 66 | assert os.path.isfile('notebook1.py') |
|
67 | 67 | assert os.path.isfile('notebook2.py') |
|
68 | 68 | |
|
69 | 69 | |
|
70 | 70 | def test_explicit(self): |
|
71 | 71 | """ |
|
72 | 72 | Do explicit notebook names work? |
|
73 | 73 | """ |
|
74 | 74 | with self.create_temp_cwd(['notebook*.ipynb']): |
|
75 | 75 | self.call('nbconvert --log-level 0 --to python notebook2') |
|
76 | 76 | assert not os.path.isfile('notebook1.py') |
|
77 | 77 | assert os.path.isfile('notebook2.py') |
|
78 | 78 | |
|
79 | 79 | |
|
80 | 80 | @dec.onlyif_cmds_exist('pdflatex') |
|
81 | 81 | @dec.onlyif_cmds_exist('pandoc') |
|
82 | 82 | def test_filename_spaces(self): |
|
83 | 83 | """ |
|
84 | 84 | Generate PDFs with graphics if notebooks have spaces in the name? |
|
85 | 85 | """ |
|
86 | 86 | with self.create_temp_cwd(['notebook2.ipynb']): |
|
87 | 87 | os.rename('notebook2.ipynb', 'notebook with spaces.ipynb') |
|
88 | 88 | o,e = self.call('nbconvert --log-level 0 --to latex ' |
|
89 | 89 | '"notebook with spaces" --post PDF ' |
|
90 | 90 | '--PDFPostProcessor.verbose=True') |
|
91 | 91 | assert os.path.isfile('notebook with spaces.tex') |
|
92 | 92 | assert os.path.isdir('notebook with spaces_files') |
|
93 | 93 | assert os.path.isfile('notebook with spaces.pdf') |
|
94 | 94 | |
|
95 | 95 | @dec.onlyif_cmds_exist('pdflatex') |
|
96 | 96 | @dec.onlyif_cmds_exist('pandoc') |
|
97 | 97 | def test_post_processor(self): |
|
98 | 98 | """ |
|
99 | 99 | Do post processors work? |
|
100 | 100 | """ |
|
101 | 101 | with self.create_temp_cwd(['notebook1.ipynb']): |
|
102 | 102 | self.call('nbconvert --log-level 0 --to latex notebook1 ' |
|
103 | 103 | '--post PDF --PDFPostProcessor.verbose=True') |
|
104 | 104 | assert os.path.isfile('notebook1.tex') |
|
105 | 105 | assert os.path.isfile('notebook1.pdf') |
|
106 | 106 | |
|
107 | 107 | @dec.onlyif_cmds_exist('pandoc') |
|
108 | 108 | def test_spurious_cr(self): |
|
109 | 109 | """Check for extra CR characters""" |
|
110 | 110 | with self.create_temp_cwd(['notebook2.ipynb']): |
|
111 | 111 | self.call('nbconvert --log-level 0 --to latex notebook2') |
|
112 | 112 | assert os.path.isfile('notebook2.tex') |
|
113 | 113 | with open('notebook2.tex') as f: |
|
114 | 114 | tex = f.read() |
|
115 | 115 | self.call('nbconvert --log-level 0 --to html notebook2') |
|
116 | 116 | assert os.path.isfile('notebook2.html') |
|
117 | 117 | with open('notebook2.html') as f: |
|
118 | 118 | html = f.read() |
|
119 | 119 | self.assertEqual(tex.count('\r'), tex.count('\r\n')) |
|
120 | 120 | self.assertEqual(html.count('\r'), html.count('\r\n')) |
|
121 | 121 | |
|
122 | 122 | @dec.onlyif_cmds_exist('pandoc') |
|
123 | 123 | def test_png_base64_html_ok(self): |
|
124 | 124 | """Is embedded png data well formed in HTML?""" |
|
125 | 125 | with self.create_temp_cwd(['notebook2.ipynb']): |
|
126 | 126 | self.call('nbconvert --log-level 0 --to HTML ' |
|
127 | 127 | 'notebook2.ipynb --template full') |
|
128 | 128 | assert os.path.isfile('notebook2.html') |
|
129 | 129 | with open('notebook2.html') as f: |
|
130 | 130 | assert "data:image/png;base64,b'" not in f.read() |
|
131 | 131 | |
|
132 | 132 | @dec.onlyif_cmds_exist('pandoc') |
|
133 | 133 | def test_template(self): |
|
134 | 134 | """ |
|
135 | 135 | Do export templates work? |
|
136 | 136 | """ |
|
137 | 137 | with self.create_temp_cwd(['notebook2.ipynb']): |
|
138 | 138 | self.call('nbconvert --log-level 0 --to slides ' |
|
139 | 139 | 'notebook2.ipynb') |
|
140 | 140 | assert os.path.isfile('notebook2.slides.html') |
|
141 | 141 | with open('notebook2.slides.html') as f: |
|
142 | 142 | assert '/reveal.css' in f.read() |
|
143 | 143 | |
|
144 | 144 | |
|
145 | 145 | def test_glob_explicit(self): |
|
146 | 146 | """ |
|
147 | 147 | Can a search pattern be used along with matching explicit notebook names? |
|
148 | 148 | """ |
|
149 | 149 | with self.create_temp_cwd(['notebook*.ipynb']): |
|
150 | 150 | self.call('nbconvert --log-level 0 --to python ' |
|
151 | 151 | '*.ipynb notebook1.ipynb notebook2.ipynb') |
|
152 | 152 | assert os.path.isfile('notebook1.py') |
|
153 | 153 | assert os.path.isfile('notebook2.py') |
|
154 | 154 | |
|
155 | 155 | |
|
156 | 156 | def test_explicit_glob(self): |
|
157 | 157 | """ |
|
158 | 158 | Can explicit notebook names be used and then a matching search pattern? |
|
159 | 159 | """ |
|
160 | 160 | with self.create_temp_cwd(['notebook*.ipynb']): |
|
161 | 161 | self.call('nbconvert --log-level 0 --to=python ' |
|
162 | 162 | 'notebook1.ipynb notebook2.ipynb *.ipynb') |
|
163 | 163 | assert os.path.isfile('notebook1.py') |
|
164 | 164 | assert os.path.isfile('notebook2.py') |
|
165 | 165 | |
|
166 | 166 | |
|
167 | 167 | def test_default_config(self): |
|
168 | 168 | """ |
|
169 | 169 | Does the default config work? |
|
170 | 170 | """ |
|
171 | 171 | with self.create_temp_cwd(['notebook*.ipynb', 'ipython_nbconvert_config.py']): |
|
172 | 172 | self.call('nbconvert --log-level 0') |
|
173 | 173 | assert os.path.isfile('notebook1.py') |
|
174 | 174 | assert not os.path.isfile('notebook2.py') |
|
175 | 175 | |
|
176 | 176 | |
|
177 | 177 | def test_override_config(self): |
|
178 | 178 | """ |
|
179 | 179 | Can the default config be overriden? |
|
180 | 180 | """ |
|
181 | 181 | with self.create_temp_cwd(['notebook*.ipynb', |
|
182 | 182 | 'ipython_nbconvert_config.py', |
|
183 | 183 | 'override.py']): |
|
184 | 184 | self.call('nbconvert --log-level 0 --config="override.py"') |
|
185 | 185 | assert not os.path.isfile('notebook1.py') |
|
186 | 186 | assert os.path.isfile('notebook2.py') |
|
187 | 187 | |
|
188 | 188 | def test_accents_in_filename(self): |
|
189 | 189 | """ |
|
190 | 190 | Can notebook names include accents? |
|
191 | 191 | """ |
|
192 |
with self.create_temp_cwd( |
|
|
192 | with self.create_temp_cwd(): | |
|
193 | self.create_empty_notebook(u'nb1_análisis.ipynb') | |
|
193 | 194 | self.call('nbconvert --log-level 0 --to python nb1_*') |
|
194 | 195 | assert os.path.isfile(u'nb1_análisis.py') |
|
195 | 196 | |
|
196 | 197 | @dec.onlyif_cmds_exist('pdflatex') |
|
197 | 198 | @dec.onlyif_cmds_exist('pandoc') |
|
198 | 199 | def test_filename_accent(self): |
|
199 | 200 | """ |
|
200 | 201 | Generate PDFs if notebooks have an accent in their name? |
|
201 | 202 | """ |
|
202 |
with self.create_temp_cwd( |
|
|
203 | with self.create_temp_cwd(): | |
|
204 | self.create_empty_notebook(u'nb1_análisis.ipynb') | |
|
203 | 205 | o,e = self.call('nbconvert --log-level 0 --to latex ' |
|
204 | 206 | '"nb1_*" --post PDF ' |
|
205 | 207 | '--PDFPostProcessor.verbose=True') |
|
206 | 208 | assert os.path.isfile(u'nb1_análisis.tex') |
|
207 | 209 | assert os.path.isfile(u'nb1_análisis.pdf') |
|
1 | NO CONTENT: file was removed |
General Comments 0
You need to be logged in to leave comments.
Login now