forked from readthedocs/readthedocs.org
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_builds.py
400 lines (345 loc) · 14.7 KB
/
test_builds.py
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
from __future__ import (
absolute_import,
division,
print_function,
unicode_literals,
)
import mock
from django.test import TestCase
from django_dynamic_fixture import fixture, get
from readthedocs.builds.models import Build, Version
from readthedocs.doc_builder.config import load_yaml_config
from readthedocs.doc_builder.environments import LocalBuildEnvironment
from readthedocs.doc_builder.python_environments import Virtualenv
from readthedocs.projects.models import Project
from readthedocs.projects.tasks import UpdateDocsTaskStep
from readthedocs.rtd_tests.tests.test_config_integration import create_load
from ..mocks.environment import EnvironmentMockGroup
class BuildEnvironmentTests(TestCase):
def setUp(self):
self.mocks = EnvironmentMockGroup()
self.mocks.start()
def tearDown(self):
self.mocks.stop()
@mock.patch('readthedocs.doc_builder.config.load_config')
def test_build(self, load_config):
'''Test full build'''
load_config.side_effect = create_load()
project = get(Project,
slug='project-1',
documentation_type='sphinx',
conf_py_file='test_conf.py',
versions=[fixture()])
version = project.versions.all()[0]
self.mocks.configure_mock('api_versions', {'return_value': [version]})
self.mocks.configure_mock('api', {
'get.return_value': {'downloads': "no_url_here"}
})
self.mocks.patches['html_build'].stop()
build_env = LocalBuildEnvironment(project=project, version=version, build={})
python_env = Virtualenv(version=version, build_env=build_env)
config = load_yaml_config(version)
task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env,
version=version, search=False, localmedia=False, config=config)
task.build_docs()
# Get command and check first part of command list is a call to sphinx
self.assertEqual(self.mocks.popen.call_count, 3)
cmd = self.mocks.popen.call_args_list[2][0]
self.assertRegexpMatches(cmd[0][0], r'python')
self.assertRegexpMatches(cmd[0][1], r'sphinx-build')
@mock.patch('readthedocs.doc_builder.config.load_config')
def test_build_respects_pdf_flag(self, load_config):
'''Build output format control'''
load_config.side_effect = create_load()
project = get(Project,
slug='project-1',
documentation_type='sphinx',
conf_py_file='test_conf.py',
enable_pdf_build=True,
enable_epub_build=False,
versions=[fixture()])
version = project.versions.all()[0]
build_env = LocalBuildEnvironment(project=project, version=version, build={})
python_env = Virtualenv(version=version, build_env=build_env)
config = load_yaml_config(version)
task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env,
version=version, search=False, localmedia=False, config=config)
task.build_docs()
# The HTML and the Epub format were built.
self.mocks.html_build.assert_called_once_with()
self.mocks.pdf_build.assert_called_once_with()
# PDF however was disabled and therefore not built.
self.assertFalse(self.mocks.epub_build.called)
@mock.patch('readthedocs.doc_builder.config.load_config')
def test_build_respects_epub_flag(self, load_config):
'''Test build with epub enabled'''
load_config.side_effect = create_load()
project = get(Project,
slug='project-1',
documentation_type='sphinx',
conf_py_file='test_conf.py',
enable_pdf_build=False,
enable_epub_build=True,
versions=[fixture()])
version = project.versions.all()[0]
build_env = LocalBuildEnvironment(project=project, version=version, build={})
python_env = Virtualenv(version=version, build_env=build_env)
config = load_yaml_config(version)
task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env,
version=version, search=False, localmedia=False, config=config)
task.build_docs()
# The HTML and the Epub format were built.
self.mocks.html_build.assert_called_once_with()
self.mocks.epub_build.assert_called_once_with()
# PDF however was disabled and therefore not built.
self.assertFalse(self.mocks.pdf_build.called)
@mock.patch('readthedocs.doc_builder.config.load_config')
def test_build_respects_yaml(self, load_config):
'''Test YAML build options'''
load_config.side_effect = create_load({'formats': ['epub']})
project = get(Project,
slug='project-1',
documentation_type='sphinx',
conf_py_file='test_conf.py',
enable_pdf_build=False,
enable_epub_build=False,
versions=[fixture()])
version = project.versions.all()[0]
build_env = LocalBuildEnvironment(project=project, version=version, build={})
python_env = Virtualenv(version=version, build_env=build_env)
config = load_yaml_config(version)
task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env,
version=version, search=False, localmedia=False, config=config)
task.build_docs()
# The HTML and the Epub format were built.
self.mocks.html_build.assert_called_once_with()
self.mocks.epub_build.assert_called_once_with()
# PDF however was disabled and therefore not built.
self.assertFalse(self.mocks.pdf_build.called)
@mock.patch('readthedocs.doc_builder.config.load_config')
def test_build_pdf_latex_failures(self, load_config):
'''Build failure if latex fails'''
load_config.side_effect = create_load()
self.mocks.patches['html_build'].stop()
self.mocks.patches['pdf_build'].stop()
project = get(Project,
slug='project-1',
documentation_type='sphinx',
conf_py_file='test_conf.py',
enable_pdf_build=True,
enable_epub_build=False,
versions=[fixture()])
version = project.versions.all()[0]
assert project.conf_dir() == '/tmp/rtd'
build_env = LocalBuildEnvironment(project=project, version=version, build={})
python_env = Virtualenv(version=version, build_env=build_env)
config = load_yaml_config(version)
task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env,
version=version, search=False, localmedia=False, config=config)
# Mock out the separate calls to Popen using an iterable side_effect
returns = [
((b'', b''), 0), # sphinx-build html
((b'', b''), 0), # sphinx-build pdf
((b'', b''), 1), # latex
((b'', b''), 0), # makeindex
((b'', b''), 0), # latex
]
mock_obj = mock.Mock()
mock_obj.communicate.side_effect = [output for (output, status)
in returns]
type(mock_obj).returncode = mock.PropertyMock(
side_effect=[status for (output, status) in returns])
self.mocks.popen.return_value = mock_obj
with build_env:
task.build_docs()
self.assertEqual(self.mocks.popen.call_count, 7)
self.assertTrue(build_env.failed)
@mock.patch('readthedocs.doc_builder.config.load_config')
def test_build_pdf_latex_not_failure(self, load_config):
'''Test pass during PDF builds and bad latex failure status code'''
load_config.side_effect = create_load()
self.mocks.patches['html_build'].stop()
self.mocks.patches['pdf_build'].stop()
project = get(Project,
slug='project-2',
documentation_type='sphinx',
conf_py_file='test_conf.py',
enable_pdf_build=True,
enable_epub_build=False,
versions=[fixture()])
version = project.versions.all()[0]
assert project.conf_dir() == '/tmp/rtd'
build_env = LocalBuildEnvironment(project=project, version=version, build={})
python_env = Virtualenv(version=version, build_env=build_env)
config = load_yaml_config(version)
task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env,
version=version, search=False, localmedia=False, config=config)
# Mock out the separate calls to Popen using an iterable side_effect
returns = [
((b'', b''), 0), # sphinx-build html
((b'', b''), 0), # sphinx-build pdf
((b'Output written on foo.pdf', b''), 1), # latex
((b'', b''), 0), # makeindex
((b'', b''), 0), # latex
]
mock_obj = mock.Mock()
mock_obj.communicate.side_effect = [output for (output, status)
in returns]
type(mock_obj).returncode = mock.PropertyMock(
side_effect=[status for (output, status) in returns])
self.mocks.popen.return_value = mock_obj
with build_env:
task.build_docs()
self.assertEqual(self.mocks.popen.call_count, 7)
self.assertTrue(build_env.successful)
@mock.patch('readthedocs.projects.tasks.api_v2')
@mock.patch('readthedocs.doc_builder.config.load_config')
def test_save_config_in_build_model(self, load_config, api_v2):
load_config.side_effect = create_load()
api_v2.build.get.return_value = {}
project = get(
Project,
slug='project',
documentation_type='sphinx',
)
build = get(Build)
version = get(Version, slug='1.8', project=project)
task = UpdateDocsTaskStep(
project=project, version=version, build={'id': build.pk}
)
task.setup_vcs = mock.Mock()
task.run_setup()
build_config = task.build['config']
# For get and put
assert api_v2.build.call_count == 2
assert build_config['version'] == '1'
assert 'sphinx' in build_config
assert build_config['doctype'] == 'sphinx'
class BuildModelTests(TestCase):
def setUp(self):
self.project = get(Project)
self.version = get(Version, project=self.project)
def test_get_previous_build(self):
build_one = get(
Build,
project=self.project,
version=self.version,
config={'version': 1}
)
build_two = get(
Build,
project=self.project,
version=self.version,
config={'version': 2}
)
build_three = get(
Build,
project=self.project,
version=self.version,
config={'version': 3},
success=False,
)
self.assertIsNone(build_one.previous)
self.assertEqual(build_two.previous, build_one)
self.assertEqual(build_three.previous, build_two)
self.assertEqual(build_three.previous.previous, build_one)
def test_normal_save_config(self):
build = get(
Build,
project=self.project,
version=self.version,
config={'version': 1}
)
self.assertEqual(build.config, {'version': 1})
build.config = {'version': 2}
build.save()
self.assertEqual(build.config, {'version': 2})
def test_save_same_config(self):
build_one = get(
Build,
project=self.project,
version=self.version,
config={}
)
build_two = get(
Build,
project=self.project,
version=self.version,
config={'version': 2}
)
self.assertEqual(build_two.config, {'version': 2})
def test_save_same_config_previous_empty(self):
build_one = get(
Build,
project=self.project,
version=self.version,
config={}
)
build_two = get(
Build,
project=self.project,
version=self.version,
config={}
)
self.assertEqual(build_two.config, {})
build_two.config = {'version': 2}
build_two.save()
self.assertEqual(build_two.config, {'version': 2})
def test_do_not_save_same_config(self):
build_one = get(
Build,
project=self.project,
version=self.version,
config={'version': 1},
)
build_two = get(
Build,
project=self.project,
version=self.version,
config={},
)
build_two.config = {'version': 1}
build_two.save()
self.assertEqual(build_two.config, {'__config': build_one.pk})
self.assertEqual(build_two.get_config(), {'version': 1})
def test_do_not_save_same_config_nested(self):
build_one = get(
Build,
project=self.project,
version=self.version,
config={},
)
build_one.config = {'version': 1}
build_one.save()
build_two = get(
Build,
project=self.project,
version=self.version,
config={},
)
build_two.config = {'version': 1}
build_two.save()
build_three = get(
Build,
project=self.project,
version=self.version,
config={},
)
build_three.config = {'version': 1}
build_three.save()
build_four = get(
Build,
project=self.project,
version=self.version,
config={},
)
build_four.config = {'version': 2}
build_four.save()
self.assertEqual(build_one.get_config(), {'version': 1})
self.assertEqual(build_one.config, {'version': 1})
self.assertEqual(build_two.config, {'__config': build_one.pk})
self.assertEqual(build_three.config, {'__config': build_one.pk})
self.assertEqual(build_two.get_config(), {'version': 1})
self.assertEqual(build_three.get_config(), {'version': 1})
self.assertEqual(build_four.get_config(), {'version': 2})
self.assertEqual(build_four.config, {'version': 2})