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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
|
# Copyright 2009-2011 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
"""Tests for ftparchive.py"""
__metaclass__ = type
import difflib
import os
import re
import shutil
from tempfile import mkdtemp
import unittest
from zope.component import getUtility
from lp.archivepublisher.config import getPubConfig
from lp.archivepublisher.diskpool import DiskPool
from lp.archivepublisher.model.ftparchive import (
AptFTPArchiveFailure,
f_touch,
FTPArchiveHandler,
)
from lp.archivepublisher.publishing import Publisher
from lp.registry.interfaces.distribution import IDistributionSet
from lp.registry.interfaces.pocket import PackagePublishingPocket
from lp.services.config import config
from lp.services.log.logger import (
BufferLogger,
DevNullLogger,
)
from lp.testing import TestCaseWithFactory
from lp.testing.layers import (
LaunchpadZopelessLayer,
ZopelessDatabaseLayer,
)
def sanitize_apt_ftparchive_Sources_output(text):
# XXX: maxb 2010-04-15 bug=563503: Filter Checksums-* stanzas out of
# apt-ftparchive Sources file content, such that the output of lucid
# apt-ftparchive is the same as on karmic.
return re.subn(r'(?sm)^Checksums-.*?(?=^[^ ])', '', text)[0]
class SamplePublisher:
"""Publisher emulation test class."""
def __init__(self, archive):
self.archive = archive
class FakeSelectResult:
"""Receive a list and emulate a SelectResult object."""
def __init__(self, result):
self._result = result
def __iter__(self):
return iter(self._result)
def count(self):
return len(self._result)
def __getslice__(self, i, j):
return self._result[i:j]
class TestFTPArchive(TestCaseWithFactory):
layer = LaunchpadZopelessLayer
def setUp(self):
super(TestFTPArchive, self).setUp()
self.layer.switchDbUser(config.archivepublisher.dbuser)
self._distribution = getUtility(IDistributionSet)['ubuntutest']
self._archive = self._distribution.main_archive
self._config = getPubConfig(self._archive)
self._config.setupArchiveDirs()
self._sampledir = os.path.join(
config.root, "lib", "lp", "archivepublisher", "tests",
"apt-data")
self._distsdir = self._config.distsroot
self._confdir = self._config.miscroot
self._pooldir = self._config.poolroot
self._overdir = self._config.overrideroot
self._listdir = self._config.overrideroot
self._tempdir = self._config.temproot
self._logger = BufferLogger()
self._dp = DiskPool(self._pooldir, self._tempdir, self._logger)
self._publisher = SamplePublisher(self._archive)
def tearDown(self):
super(TestFTPArchive, self).tearDown()
shutil.rmtree(self._config.distroroot)
def _verifyFile(self, filename, directory, output_filter=None):
"""Compare byte-to-byte the given file and the respective sample.
It's a poor way of testing files generated by apt-ftparchive.
"""
result_path = os.path.join(directory, filename)
result_text = open(result_path).read()
if output_filter is not None:
result_text = output_filter(result_text)
sample_path = os.path.join(self._sampledir, filename)
sample_text = open(sample_path).read()
# When the comparison between the sample text and the generated text
# differ, just printing the strings will be less than optimal. Use
# difflib to get a line-by-line comparison that makes it much more
# immediately obvious what the differences are.
diff_lines = difflib.ndiff(
sample_text.splitlines(), result_text.splitlines())
self.assertEqual(sample_text, result_text, '\n'.join(diff_lines))
def _verifyEmpty(self, path):
"""Assert that the given file is empty."""
with open(path) as result_file:
self.assertEqual("", result_file.read())
def _addRepositoryFile(self, component, sourcename, leafname):
"""Create a repository file."""
fullpath = self._dp.pathFor(component, sourcename, leafname)
dirname = os.path.dirname(fullpath)
if not os.path.exists(dirname):
os.makedirs(dirname)
leaf = os.path.join(self._sampledir, leafname)
leafcontent = file(leaf).read()
file(fullpath, "w").write(leafcontent)
def _setUpFTPArchiveHandler(self):
fa = FTPArchiveHandler(
self._logger, self._config, self._dp, self._distribution,
self._publisher)
return fa
def test_getSourcesForOverrides(self):
# getSourcesForOverrides returns a list of tuples containing:
# (sourcename, suite, component, section)
# Reconfigure FTPArchiveHandler to retrieve sampledata overrides.
fa = self._setUpFTPArchiveHandler()
ubuntu = getUtility(IDistributionSet).getByName('ubuntu')
hoary = ubuntu.getSeries('hoary')
fa.publisher.archive = hoary.main_archive
published_sources = fa.getSourcesForOverrides(
hoary, PackagePublishingPocket.RELEASE)
# For the above query, we are depending on the sample data to
# contain seven rows of SourcePackagePublishghistory data.
expectedSources = [
('linux-source-2.6.15', 'hoary', 'main', 'base'),
('libstdc++', 'hoary', 'main', 'base'),
('cnews', 'hoary', 'universe', 'base'),
('alsa-utils', 'hoary', 'main', 'base'),
('pmount', 'hoary', 'main', 'editors'),
('netapplet', 'hoary', 'main', 'web'),
('evolution', 'hoary', 'main', 'editors'),
]
self.assertEqual(expectedSources, list(published_sources))
def test_getBinariesForOverrides(self):
# getBinariesForOverrides returns a list of tuples containing:
# (sourcename, suite, component, section, priority)
# Reconfigure FTPArchiveHandler to retrieve sampledata overrides.
fa = self._setUpFTPArchiveHandler()
ubuntu = getUtility(IDistributionSet).getByName('ubuntu')
hoary = ubuntu.getSeries('hoary')
fa.publisher.archive = hoary.main_archive
published_binaries = fa.getBinariesForOverrides(
hoary, PackagePublishingPocket.RELEASE)
expectedBinaries = [
('pmount', 'hoary', 'main', 'base', 'extra'),
('pmount', 'hoary', 'universe', 'editors', 'important'),
]
self.assertEqual(expectedBinaries, list(published_binaries))
def test_getBinariesForOverrides_with_no_architectures(self):
# getBinariesForOverrides() copes with uninitiazed distroseries
# (no architectures), returning an empty ResultSet.
fa = self._setUpFTPArchiveHandler()
breezy_autotest = self._distribution.getSeries('breezy-autotest')
self.assertEquals([], list(breezy_autotest.architectures))
published_binaries = fa.getBinariesForOverrides(
breezy_autotest, PackagePublishingPocket.RELEASE)
self.assertEqual([], list(published_binaries))
def test_publishOverrides(self):
# publishOverrides write the expected files on disk.
fa = self._setUpFTPArchiveHandler()
source_overrides = FakeSelectResult(
[('foo', 'hoary-test', 'main', 'misc')])
binary_overrides = FakeSelectResult(
[('foo', 'hoary-test', 'main', 'misc', 'extra')])
fa.publishOverrides(source_overrides, binary_overrides)
# Check that the overrides lists generated by LP exist and have the
# expected contents.
self._verifyFile("override.hoary-test.main", self._overdir)
self._verifyFile("override.hoary-test.main.src", self._overdir)
self._verifyFile("override.hoary-test.extra.main", self._overdir)
def test_getSourceFiles(self):
# getSourceFiles returns a list of tuples containing:
# (sourcename, suite, filename, component)
# Reconfigure FTPArchiveHandler to retrieve sampledata records.
fa = self._setUpFTPArchiveHandler()
ubuntu = getUtility(IDistributionSet).getByName('ubuntu')
hoary = ubuntu.getSeries('hoary')
fa.distro = ubuntu
fa.publisher.archive = hoary.main_archive
sources_files = fa.getSourceFiles(
hoary, PackagePublishingPocket.RELEASE)
expected_files = [
('alsa-utils', 'hoary', 'alsa-utils_1.0.9a-4ubuntu1.dsc', 'main'),
('evolution', 'hoary', 'evolution-1.0.tar.gz', 'main'),
('netapplet', 'hoary', 'netapplet_1.0.0.orig.tar.gz', 'main'),
]
self.assertEqual(expected_files, list(sources_files))
def test_getBinaryFiles(self):
# getBinaryFiles returns a list of tuples containing:
# (sourcename, suite, filename, component, architecture)
# Reconfigure FTPArchiveHandler to retrieve sampledata records.
fa = self._setUpFTPArchiveHandler()
ubuntu = getUtility(IDistributionSet).getByName('ubuntu')
hoary = ubuntu.getSeries('hoary')
fa.distro = ubuntu
fa.publisher.archive = hoary.main_archive
binary_files = fa.getBinaryFiles(
hoary, PackagePublishingPocket.RELEASE)
expected_files = [(
'pmount',
'hoary',
'pmount_1.9-1_all.deb',
'main',
'binary-hppa',
)]
self.assertEqual(expected_files, list(binary_files))
def test_publishFileLists(self):
# publishFileLists writes the expected files on disk.
fa = self._setUpFTPArchiveHandler()
source_files = FakeSelectResult(
[('foo', 'hoary-test', 'foo_1.dsc', 'main')])
binary_files = FakeSelectResult(
[('foo', 'hoary-test', 'foo_1_i386.deb', 'main', 'binary-i386')])
fa.publishFileLists(source_files, binary_files)
# Check that the file lists generated by LP exist and have the
# expected contents.
self._verifyFile("hoary-test_main_source", self._listdir)
self._verifyFile("hoary-test_main_binary-i386", self._listdir)
def test_generateConfig(self):
# Generate apt-ftparchive configuration file and run it.
# Setup FTPArchiveHandler with a real Publisher for Ubuntutest.
publisher = Publisher(
self._logger, self._config, self._dp, self._archive)
fa = FTPArchiveHandler(self._logger, self._config, self._dp,
self._distribution, publisher)
fa.createEmptyPocketRequests(fullpublish=True)
# Calculate overrides.
source_overrides = FakeSelectResult(
[('foo', 'hoary-test', 'main', 'misc'), ])
binary_overrides = FakeSelectResult(
[('foo', 'hoary-test', 'main', 'misc', 'extra')])
fa.publishOverrides(source_overrides, binary_overrides)
# Calculate filelists.
source_files = FakeSelectResult(
[('foo', 'hoary-test', 'foo_1.dsc', 'main')])
binary_files = FakeSelectResult(
[('foo', 'hoary-test', 'foo_1_i386.deb', 'main', 'binary-i386')])
fa.publishFileLists(source_files, binary_files)
# Add mentioned files in the repository pool/.
self._addRepositoryFile('main', 'foo', 'foo_1.dsc')
self._addRepositoryFile('main', 'foo', 'foo_1_i386.deb')
# When include_long_descriptions is set, apt.conf has
# LongDescription "true" for that series.
hoary_test = self._distribution.getSeries('hoary-test')
self.assertTrue(hoary_test.include_long_descriptions)
breezy_autotest = self._distribution.getSeries('breezy-autotest')
breezy_autotest.include_long_descriptions = False
# XXX cprov 2007-03-21: Relying on byte-to-byte configuration file
# comparing is weak. We should improve this methodology to avoid
# wasting time on test failures due to irrelevant format changes.
apt_conf = fa.generateConfig(fullpublish=True)
self._verifyFile("apt.conf", self._confdir)
# XXX cprov 2007-03-21: This is an extra problem. Running a-f on
# developer machines is wasteful. We need to find a away to split
# those kind of tests and avoid to run it when performing 'make
# check'. Although they should remain active in PQM to avoid possible
# regressions.
fa.runApt(apt_conf)
self._verifyFile("Packages",
os.path.join(self._distsdir, "hoary-test", "main", "binary-i386"))
self._verifyEmpty(
os.path.join(
self._distsdir, "hoary-test", "main", "debian-installer",
"binary-i386", "Packages"))
self._verifyFile("Sources",
os.path.join(self._distsdir, "hoary-test", "main", "source"),
sanitize_apt_ftparchive_Sources_output)
# XXX cprov 2007-03-21: see above, byte-to-byte configuration
# comparing is weak.
# Test that a publisher run now will generate an empty apt
# config and nothing else.
apt_conf = fa.generateConfig()
assert len(file(apt_conf).readlines()) == 24
# XXX cprov 2007-03-21: see above, do not run a-f on dev machines.
fa.runApt(apt_conf)
def test_generateConfig_empty_and_careful(self):
# Generate apt-ftparchive config for an specific empty suite.
#
# By passing 'careful_apt' option associated with 'allowed_suite'
# we can publish only a specific group of the suites even if they
# are still empty. It makes APT clients happier during development
# cycle.
#
# This test should check:
#
# * if apt.conf was generated correctly.
# * a-f runs based on this config without any errors
# * a-f *only* creates the wanted archive indexes.
allowed_suites = set()
allowed_suites.add(('hoary-test', PackagePublishingPocket.UPDATES))
publisher = Publisher(
self._logger, self._config, self._dp,
allowed_suites=allowed_suites, archive=self._archive)
fa = FTPArchiveHandler(self._logger, self._config, self._dp,
self._distribution, publisher)
fa.createEmptyPocketRequests(fullpublish=True)
# createEmptyPocketRequests creates empty override and file
# listings.
lists = (
'hoary-test-updates_main_source',
'hoary-test-updates_main_binary-i386',
'hoary-test-updates_main_debian-installer_binary-i386',
'override.hoary-test-updates.main',
'override.hoary-test-updates.extra.main',
'override.hoary-test-updates.main.src',
)
for listname in lists:
path = os.path.join(self._config.overrideroot, listname)
self.assertTrue(os.path.exists(path))
self.assertEquals("", open(path).read())
# XXX cprov 2007-03-21: see above, byte-to-byte configuration
# comparing is weak.
apt_conf = fa.generateConfig(fullpublish=True)
self.assertTrue(os.path.exists(apt_conf))
apt_conf_content = file(apt_conf).read()
sample_content = file(
os.path.join(
self._sampledir, 'apt_conf_single_empty_suite_test')).read()
self.assertEqual(apt_conf_content, sample_content)
# XXX cprov 2007-03-21: see above, do not run a-f on dev machines.
fa.runApt(apt_conf)
self.assertTrue(os.path.exists(
os.path.join(self._distsdir, "hoary-test-updates", "main",
"binary-i386", "Packages")))
self.assertTrue(os.path.exists(
os.path.join(self._distsdir, "hoary-test-updates", "main",
"debian-installer", "binary-i386", "Packages")))
self.assertTrue(os.path.exists(
os.path.join(self._distsdir, "hoary-test-updates", "main",
"source", "Sources")))
self.assertFalse(os.path.exists(
os.path.join(self._distsdir, "hoary-test", "main",
"binary-i386", "Packages")))
self.assertFalse(os.path.exists(
os.path.join(self._distsdir, "hoary-test", "main",
"debian-installer", "binary-i386", "Packages")))
self.assertFalse(os.path.exists(
os.path.join(self._distsdir, "hoary-test", "main",
"source", "Sources")))
class TestFTPArchiveRunApt(TestCaseWithFactory):
"""Test `FTPArchive`'s execution of apt-ftparchive."""
layer = ZopelessDatabaseLayer
def _makeMatchingDistroArchSeries(self):
"""Create two `DistroArchSeries` for the same distro and processor."""
distro = self.factory.makeDistribution()
processor = self.factory.makeProcessor()
return (
self.factory.makeDistroArchSeries(
distroseries=self.factory.makeDistroSeries(distro),
processorfamily=processor.family,
architecturetag=processor.name)
for counter in (1, 2))
def test_getArchitectureTags_starts_out_empty(self):
fa = FTPArchiveHandler(
DevNullLogger(), None, None, self.factory.makeDistribution(),
None)
self.assertContentEqual([], fa._getArchitectureTags())
def test_getArchitectureTags_includes_enabled_architectures(self):
distroarchseries = self.factory.makeDistroArchSeries()
fa = FTPArchiveHandler(
DevNullLogger(), None, None,
distroarchseries.distroseries.distribution, None)
self.assertContentEqual(
[distroarchseries.architecturetag], fa._getArchitectureTags())
def test_getArchitectureTags_considers_all_series(self):
distro = self.factory.makeDistribution()
affluent_antilope = self.factory.makeDistroSeries(distribution=distro)
bilious_baboon = self.factory.makeDistroSeries(distribution=distro)
affluent_arch = self.factory.makeDistroArchSeries(
distroseries=affluent_antilope)
bilious_arch = self.factory.makeDistroArchSeries(
distroseries=bilious_baboon)
fa = FTPArchiveHandler(DevNullLogger(), None, None, distro, None)
self.assertContentEqual(
[affluent_arch.architecturetag, bilious_arch.architecturetag],
fa._getArchitectureTags())
def test_getArchitectureTags_ignores_disabled_architectures(self):
distroarchseries = self.factory.makeDistroArchSeries()
distroarchseries.enabled = False
fa = FTPArchiveHandler(
DevNullLogger(), None, None,
distroarchseries.distroseries.distribution, None)
self.assertContentEqual([], fa._getArchitectureTags())
def test_getArchitectureTags_contains_no_duplicates(self):
ominous_okapi, pilfering_puppy = self._makeMatchingDistroArchSeries()
fa = FTPArchiveHandler(
DevNullLogger(), None, None,
ominous_okapi.distroseries.distribution, None)
self.assertEqual(1, len(list(fa._getArchitectureTags())))
self.assertContentEqual(
[ominous_okapi.architecturetag], fa._getArchitectureTags())
def test_getArchitectureTags_counts_any_architecture_enabled_once(self):
manic_mantis, nervous_nit = self._makeMatchingDistroArchSeries()
nervous_nit.enabled = False
fa = FTPArchiveHandler(
DevNullLogger(), None, None,
manic_mantis.distroseries.distribution, None)
self.assertContentEqual(
[manic_mantis.architecturetag], fa._getArchitectureTags())
def test_runApt_reports_failure(self):
# If we sabotage apt-ftparchive, runApt notices that it failed
# and raises an exception.
distroarchseries = self.factory.makeDistroArchSeries()
distro = distroarchseries.distroseries.distribution
fa = FTPArchiveHandler(DevNullLogger(), None, None, distro, None)
self.assertRaises(AptFTPArchiveFailure, fa.runApt, "bogus-config")
class TestFTouch(unittest.TestCase):
"""Tests for f_touch function."""
def setUp(self):
self.test_folder = mkdtemp()
def tearDown(self):
shutil.rmtree(self.test_folder)
def test_f_touch_new_file(self):
# Test f_touch correctly creates a new file.
f_touch(self.test_folder, "file_to_touch")
self.assertTrue(os.path.exists("%s/file_to_touch" % self.test_folder))
def test_f_touch_existing_file(self):
# Test f_touch truncates existing files.
f = open("%s/file_to_truncate" % self.test_folder, "w")
test_contents = "I'm some test contents"
f.write(test_contents)
f.close()
f_touch(self.test_folder, "file_to_leave_alone")
f = open("%s/file_to_leave_alone" % self.test_folder, "r")
contents = f.read()
f.close()
self.assertEqual("", contents)
|