1 # Copyright (C) 2012, Ansgar Burchardt <ansgar@debian.org>
3 # Parts based on code that is
4 # Copyright (C) 2001-2006, James Troup <james@nocrew.org>
5 # Copyright (C) 2009-2010, Joerg Jaspert <joerg@debian.org>
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 2 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along
18 # with this program; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 """module provided pre-acceptance tests
23 Please read the documentation for the L{Check} class for the interface.
26 from daklib.config import Config
27 from daklib.dbconn import *
28 import daklib.dbconn as dbconn
29 from daklib.regexes import *
30 from daklib.textutils import fix_maintainer, ParseMaintError
31 import daklib.lintian as lintian
32 import daklib.utils as utils
36 from apt_pkg import version_compare
41 # TODO: replace by subprocess
44 class Reject(Exception):
45 """exception raised by failing checks"""
49 """base class for checks
51 checks are called by L{daklib.archive.ArchiveUpload}. Failing tests should
52 raise a L{daklib.checks.Reject} exception including a human-readable
53 description why the upload should be rejected.
55 def check(self, upload):
58 @type upload: L{daklib.archive.ArchiveUpload}
59 @param upload: upload to check
61 @raise daklib.checks.Reject: upload should be rejected
64 def per_suite_check(self, upload, suite):
65 """do per-suite checks
67 @type upload: L{daklib.archive.ArchiveUpload}
68 @param upload: upload to check
70 @type suite: L{daklib.dbconn.Suite}
71 @param suite: suite to check
73 @raise daklib.checks.Reject: upload should be rejected
78 """allow to force ignore failing test
80 C{True} if it is acceptable to force ignoring a failing test,
85 class SignatureCheck(Check):
86 """Check signature of changes and dsc file (if included in upload)
88 Make sure the signature is valid and done by a known user.
90 def check(self, upload):
91 changes = upload.changes
92 if not changes.valid_signature:
93 raise Reject("Signature for .changes not valid.")
94 if changes.source is not None:
95 if not changes.source.valid_signature:
96 raise Reject("Signature for .dsc not valid.")
97 if changes.source.primary_fingerprint != changes.primary_fingerprint:
98 raise Reject(".changes and .dsc not signed by the same key.")
99 if upload.fingerprint is None or upload.fingerprint.uid is None:
100 raise Reject(".changes signed by unknown key.")
102 class ChangesCheck(Check):
103 """Check changes file for syntax errors."""
104 def check(self, upload):
105 changes = upload.changes
106 control = changes.changes
107 fn = changes.filename
109 for field in ('Distribution', 'Source', 'Binary', 'Architecture', 'Version', 'Maintainer', 'Files', 'Changes', 'Description'):
110 if field not in control:
111 raise Reject('{0}: misses mandatory field {1}'.format(fn, field))
113 source_match = re_field_source.match(control['Source'])
115 raise Reject('{0}: Invalid Source field'.format(fn))
116 version_match = re_field_version.match(control['Version'])
117 if not version_match:
118 raise Reject('{0}: Invalid Version field'.format(fn))
119 version_without_epoch = version_match.group('without_epoch')
121 match = re_file_changes.match(fn)
123 raise Reject('{0}: Does not match re_file_changes'.format(fn))
124 if match.group('package') != source_match.group('package'):
125 raise Reject('{0}: Filename does not match Source field'.format(fn))
126 if match.group('version') != version_without_epoch:
127 raise Reject('{0}: Filename does not match Version field'.format(fn))
129 for bn in changes.binary_names:
130 if not re_field_package.match(bn):
131 raise Reject('{0}: Invalid binary package name {1}'.format(fn, bn))
133 if 'source' in changes.architectures and changes.source is None:
134 raise Reject("Changes has architecture source, but no source found.")
135 if changes.source is not None and 'source' not in changes.architectures:
136 raise Reject("Upload includes source, but changes does not say so.")
139 fix_maintainer(changes.changes['Maintainer'])
140 except ParseMaintError as e:
141 raise Reject('{0}: Failed to parse Maintainer field: {1}'.format(changes.filename, e))
144 changed_by = changes.changes.get('Changed-By')
145 if changed_by is not None:
146 fix_maintainer(changed_by)
147 except ParseMaintError as e:
148 raise Reject('{0}: Failed to parse Changed-By field: {1}'.format(changes.filename, e))
150 if len(changes.files) == 0:
151 raise Reject("Changes includes no files.")
153 for bugnum in changes.closed_bugs:
154 if not re_isanum.match(bugnum):
155 raise Reject('{0}: "{1}" in Closes field is not a number'.format(changes.filename, bugnum))
159 class HashesCheck(Check):
160 """Check hashes in .changes and .dsc are valid."""
161 def check(self, upload):
162 changes = upload.changes
163 for f in changes.files.itervalues():
164 f.check(upload.directory)
165 source = changes.source
166 if source is not None:
167 for f in source.files.itervalues():
168 f.check(upload.directory)
170 class BinaryCheck(Check):
171 """Check binary packages for syntax errors."""
172 def check(self, upload):
173 for binary in upload.changes.binaries:
174 self.check_binary(upload, binary)
176 binary_names = set([ binary.control['Package'] for binary in upload.changes.binaries ])
177 for bn in binary_names:
178 if bn not in upload.changes.binary_names:
179 raise Reject('Package {0} is not mentioned in Binary field in changes'.format(bn))
183 def check_binary(self, upload, binary):
184 fn = binary.hashed_file.filename
185 control = binary.control
187 for field in ('Package', 'Architecture', 'Version', 'Description'):
188 if field not in control:
189 raise Reject('{0}: Missing mandatory field {0}.'.format(fn, field))
193 package = control['Package']
194 if not re_field_package.match(package):
195 raise Reject('{0}: Invalid Package field'.format(fn))
197 version = control['Version']
198 version_match = re_field_version.match(version)
199 if not version_match:
200 raise Reject('{0}: Invalid Version field'.format(fn))
201 version_without_epoch = version_match.group('without_epoch')
203 architecture = control['Architecture']
204 if architecture not in upload.changes.architectures:
205 raise Reject('{0}: Architecture not in Architecture field in changes file'.format(fn))
206 if architecture == 'source':
207 raise Reject('{0}: Architecture "source" invalid for binary packages'.format(fn))
209 source = control.get('Source')
210 if source is not None and not re_field_source.match(source):
211 raise Reject('{0}: Invalid Source field'.format(fn))
215 match = re_file_binary.match(fn)
216 if package != match.group('package'):
217 raise Reject('{0}: filename does not match Package field'.format(fn))
218 if version_without_epoch != match.group('version'):
219 raise Reject('{0}: filename does not match Version field'.format(fn))
220 if architecture != match.group('architecture'):
221 raise Reject('{0}: filename does not match Architecture field'.format(fn))
223 # check dependency field syntax
225 for field in ('Breaks', 'Conflicts', 'Depends', 'Enhances', 'Pre-Depends',
226 'Provides', 'Recommends', 'Replaces', 'Suggests'):
227 value = control.get(field)
228 if value is not None:
229 if value.strip() == '':
230 raise Reject('{0}: empty {1} field'.format(fn, field))
232 apt_pkg.parse_depends(value)
234 raise Reject('{0}: APT could not parse {1} field'.format(fn, field))
236 for field in ('Built-Using',):
237 value = control.get(field)
238 if value is not None:
239 if value.strip() == '':
240 raise Reject('{0}: empty {1} field'.format(fn, field))
242 apt_pkg.parse_src_depends(value)
244 raise Reject('{0}: APT could not parse {1} field'.format(fn, field))
246 class BinaryTimestampCheck(Check):
247 """check timestamps of files in binary packages
249 Files in the near future cause ugly warnings and extreme time travel
250 can cause errors on extraction.
252 def check(self, upload):
254 future_cutoff = time.time() + cnf.find_i('Dinstall::FutureTimeTravelGrace', 24*3600)
255 past_cutoff = time.mktime(time.strptime(cnf.find('Dinstall::PastCutoffYear', '1984'), '%Y'))
257 class TarTime(object):
259 self.future_files = dict()
260 self.past_files = dict()
261 def callback(self, member, data):
262 if member.mtime > future_cutoff:
263 future_files[member.name] = member.mtime
264 elif member.mtime < past_cutoff:
265 past_files[member.name] = member.mtime
267 def format_reason(filename, direction, files):
268 reason = "{0}: has {1} file(s) with a timestamp too far in the {2}:\n".format(filename, len(files), direction)
269 for fn, ts in files.iteritems():
270 reason += " {0} ({1})".format(fn, time.ctime(ts))
273 for binary in upload.changes.binaries:
274 filename = binary.hashed_file.filename
275 path = os.path.join(upload.directory, filename)
276 deb = apt_inst.DebFile(path)
278 deb.control.go(tar.callback)
280 raise Reject(format_reason(filename, 'future', tar.future_files))
282 raise Reject(format_reason(filename, 'past', tar.past_files))
284 class SourceCheck(Check):
285 """Check source package for syntax errors."""
286 def check_filename(self, control, filename, regex):
287 # In case we have an .orig.tar.*, we have to strip the Debian revison
288 # from the version number. So handle this special case first.
290 match = re_file_orig.match(filename)
293 match = regex.match(filename)
296 raise Reject('{0}: does not match regular expression for source filenames'.format(filename))
297 if match.group('package') != control['Source']:
298 raise Reject('{0}: filename does not match Source field'.format(filename))
300 version = control['Version']
302 version = re_field_version_upstream.match(version).group('upstream')
303 version_match = re_field_version.match(version)
304 version_without_epoch = version_match.group('without_epoch')
305 if match.group('version') != version_without_epoch:
306 raise Reject('{0}: filename does not match Version field'.format(filename))
308 def check(self, upload):
309 if upload.changes.source is None:
312 changes = upload.changes.changes
313 source = upload.changes.source
315 dsc_fn = source._dsc_file.filename
318 if not re_field_package.match(control['Source']):
319 raise Reject('{0}: Invalid Source field'.format(dsc_fn))
320 if control['Source'] != changes['Source']:
321 raise Reject('{0}: Source field does not match Source field in changes'.format(dsc_fn))
322 if control['Version'] != changes['Version']:
323 raise Reject('{0}: Version field does not match Version field in changes'.format(dsc_fn))
326 self.check_filename(control, dsc_fn, re_file_dsc)
327 for f in source.files.itervalues():
328 self.check_filename(control, f.filename, re_file_source)
330 # check dependency field syntax
331 for field in ('Build-Conflicts', 'Build-Conflicts-Indep', 'Build-Depends', 'Build-Depends-Arch', 'Build-Depends-Indep'):
332 value = control.get(field)
333 if value is not None:
334 if value.strip() == '':
335 raise Reject('{0}: empty {1} field'.format(dsc_fn, field))
337 apt_pkg.parse_src_depends(value)
338 except Exception as e:
339 raise Reject('{0}: APT could not parse {1} field: {2}'.format(dsc_fn, field, e))
341 rejects = utils.check_dsc_files(dsc_fn, control, source.files.keys())
343 raise Reject("\n".join(rejects))
347 class SingleDistributionCheck(Check):
348 """Check that the .changes targets only a single distribution."""
349 def check(self, upload):
350 if len(upload.changes.distributions) != 1:
351 raise Reject("Only uploads to a single distribution are allowed.")
353 class ACLCheck(Check):
354 """Check the uploader is allowed to upload the packages in .changes"""
355 def _check_dm(self, upload):
356 # This code is not very nice, but hopefully works until we can replace
357 # DM-Upload-Allowed, cf. https://lists.debian.org/debian-project/2012/06/msg00029.html
358 session = upload.session
360 if 'source' not in upload.changes.architectures:
361 raise Reject('DM uploads must include source')
362 for f in upload.changes.files.itervalues():
363 if f.section == 'byhand' or f.section[:4] == "raw-":
364 raise Reject("Uploading byhand packages is not allowed for DMs.")
366 # Reject NEW packages
367 distributions = upload.changes.distributions
368 assert len(distributions) == 1
369 suite = session.query(Suite).filter_by(suite_name=distributions[0]).one()
370 overridesuite = suite
371 if suite.overridesuite is not None:
372 overridesuite = session.query(Suite).filter_by(suite_name=suite.overridesuite).one()
373 if upload._check_new(overridesuite):
374 raise Reject('Uploading NEW packages is not allowed for DMs.')
376 # Check DM-Upload-Allowed
377 last_suites = ['unstable', 'experimental']
378 if suite.suite_name.endswith('-backports'):
379 last_suites = [suite.suite_name]
380 last = session.query(DBSource).filter_by(source=upload.changes.changes['Source']) \
381 .join(DBSource.suites).filter(Suite.suite_name.in_(last_suites)) \
382 .order_by(DBSource.version.desc()).limit(1).first()
384 raise Reject('No existing source found in {0}'.format(' or '.join(last_suites)))
385 if not last.dm_upload_allowed:
386 raise Reject('DM-Upload-Allowed is not set in {0}={1}'.format(last.source, last.version))
388 # check current Changed-by is in last Maintainer or Uploaders
389 uploader_names = [ u.name for u in last.uploaders ]
390 changed_by_field = upload.changes.changes.get('Changed-By', upload.changes.changes['Maintainer'])
391 if changed_by_field not in uploader_names:
392 raise Reject('{0} is not an uploader for {1}={2}'.format(changed_by_field, last.source, last.version))
394 # check Changed-by is the DM
395 changed_by = fix_maintainer(changed_by_field)
396 uid = upload.fingerprint.uid
398 raise Reject('Unknown uid for fingerprint {0}'.format(upload.fingerprint.fingerprint))
399 if uid.uid != changed_by[3] and uid.name != changed_by[2]:
400 raise Reject('DMs are not allowed to sponsor uploads (expected {0} <{1}> as maintainer, but got {2})'.format(uid.name, uid.uid, changed_by_field))
402 # Try to catch hijacks.
403 # This doesn't work correctly. Uploads to experimental can still
404 # "hijack" binaries from unstable. Also one can hijack packages
405 # via buildds (but people who try this should not be DMs).
406 for binary_name in upload.changes.binary_names:
407 binaries = session.query(DBBinary).join(DBBinary.source) \
408 .join(DBBinary.suites).filter(Suite.suite_name.in_(upload.changes.distributions)) \
409 .filter(DBBinary.package == binary_name)
410 for binary in binaries:
411 if binary.source.source != upload.changes.changes['Source']:
412 raise Reject('DMs must not hijack binaries (binary={0}, other-source={1})'.format(binary_name, binary.source.source))
416 def check(self, upload):
417 fingerprint = upload.fingerprint
418 source_acl = fingerprint.source_acl
419 if source_acl is None:
420 if 'source' in upload.changes.architectures:
421 raise Reject('Fingerprint {0} must not upload source'.format(fingerprint.fingerprint))
422 elif source_acl.access_level == 'dm':
423 self._check_dm(upload)
424 elif source_acl.access_level != 'full':
425 raise Reject('Unknown source_acl access level {0} for fingerprint {1}'.format(source_acl.access_level, fingerprint.fingerprint))
427 bin_architectures = set(upload.changes.architectures)
428 bin_architectures.discard('source')
429 binary_acl = fingerprint.binary_acl
430 if binary_acl is None:
431 if len(bin_architectures) > 0:
432 raise Reject('Fingerprint {0} must not upload binary packages'.format(fingerprint.fingerprint))
433 elif binary_acl.access_level == 'map':
434 query = upload.session.query(BinaryACLMap).filter_by(fingerprint=fingerprint)
435 allowed_architectures = [ m.architecture.arch_string for m in query ]
437 for arch in upload.changes.architectures:
438 if arch not in allowed_architectures:
439 raise Reject('Fingerprint {0} must not upload binaries for architecture {1}'.format(fingerprint.fingerprint, arch))
440 elif binary_acl.access_level != 'full':
441 raise Reject('Unknown binary_acl access level {0} for fingerprint {1}'.format(binary_acl.access_level, fingerprint.fingerprint))
445 class UploadBlockCheck(Check):
446 """check for upload blocks"""
447 def check(self, upload):
448 session = upload.session
449 control = upload.changes.changes
451 source = re_field_source.match(control['Source']).group('package')
452 version = control['Version']
453 blocks = session.query(UploadBlock).filter_by(source=source) \
454 .filter((UploadBlock.version == version) | (UploadBlock.version == None))
457 if block.fingerprint == upload.fingerprint:
458 raise Reject('Manual upload block in place for package {0} and fingerprint {1}:\n{2}'.format(source, upload.fingerprint.fingerprint, block.reason))
459 if block.uid == upload.fingerprint.uid:
460 raise Reject('Manual upload block in place for package {0} and uid {1}:\n{2}'.format(source, block.uid.uid, block.reason))
464 class TransitionCheck(Check):
465 """check for a transition"""
466 def check(self, upload):
467 if 'source' not in upload.changes.architectures:
470 transitions = self.get_transitions()
471 if transitions is None:
474 source = re_field_source.match(control['Source']).group('package')
476 for trans in transitions:
477 t = transitions[trans]
481 # Will be None if nothing is in testing.
482 current = get_source_in_suite(source, "testing", session)
483 if current is not None:
484 compare = apt_pkg.version_compare(current.version, expected)
486 if current is None or compare < 0:
487 # This is still valid, the current version in testing is older than
488 # the new version we wait for, or there is none in testing yet
490 # Check if the source we look at is affected by this.
491 if source in t['packages']:
492 # The source is affected, lets reject it.
494 rejectmsg = "{0}: part of the {1} transition.\n\n".format(source, trans)
496 if current is not None:
497 currentlymsg = "at version {0}".format(current.version)
499 currentlymsg = "not present in testing"
501 rejectmsg += "Transition description: {0}\n\n".format(t["reason"])
503 rejectmsg += "\n".join(textwrap.wrap("""Your package
504 is part of a testing transition designed to get {0} migrated (it is
505 currently {1}, we need version {2}). This transition is managed by the
506 Release Team, and {3} is the Release-Team member responsible for it.
507 Please mail debian-release@lists.debian.org or contact {3} directly if you
508 need further assistance. You might want to upload to experimental until this
509 transition is done.""".format(source, currentlymsg, expected,t["rm"])))
511 raise Reject(rejectmsg)
515 def get_transitions(self):
517 path = cnf.get('Dinstall::ReleaseTransitions', '')
518 if path == '' or not os.path.exists(path):
521 contents = file(path, 'r').read()
523 transitions = yaml.load(contents)
525 except yaml.YAMLError as msg:
526 utils.warn('Not checking transitions, the transitions file is broken: {0}'.format(msg))
530 class NoSourceOnlyCheck(Check):
531 """Check for source-only upload
533 Source-only uploads are only allowed if Dinstall::AllowSourceOnlyUploads is
534 set. Otherwise they are rejected.
536 def check(self, upload):
537 if Config().find_b("Dinstall::AllowSourceOnlyUploads"):
539 changes = upload.changes
540 if changes.source is not None and len(changes.binaries) == 0:
541 raise Reject('Source-only uploads are not allowed.')
544 class LintianCheck(Check):
545 """Check package using lintian"""
546 def check(self, upload):
547 changes = upload.changes
549 # Only check sourceful uploads.
550 if changes.source is None:
552 # Only check uploads to unstable or experimental.
553 if 'unstable' not in changes.distributions and 'experimental' not in changes.distributions:
557 if 'Dinstall::LintianTags' not in cnf:
559 tagfile = cnf['Dinstall::LintianTags']
561 with open(tagfile, 'r') as sourcefile:
562 sourcecontent = sourcefile.read()
564 lintiantags = yaml.load(sourcecontent)['lintian']
565 except yaml.YAMLError as msg:
566 raise Exception('Could not read lintian tags file {0}, YAML error: {1}'.format(tagfile, msg))
568 fd, temp_filename = utils.temp_filename()
569 temptagfile = os.fdopen(fd, 'w')
570 for tags in lintiantags.itervalues():
572 print >>temptagfile, tag
575 changespath = os.path.join(upload.directory, changes.filename)
578 cmd = "lintian --show-overrides --tags-from-file {0} {1}".format(temp_filename, changespath)
579 result, output = commands.getstatusoutput(cmd)
581 os.unlink(temp_filename)
584 utils.warn("lintian failed for %s [return code: %s]." % \
585 (changespath, result))
586 utils.warn(utils.prefix_multi_line_string(output, \
587 " [possible output:] "))
589 parsed_tags = lintian.parse_lintian_output(output)
590 rejects = list(lintian.generate_reject_messages(parsed_tags, lintiantags))
591 if len(rejects) != 0:
592 raise Reject('\n'.join(rejects))
596 class SourceFormatCheck(Check):
597 """Check source format is allowed in the target suite"""
598 def per_suite_check(self, upload, suite):
599 source = upload.changes.source
600 session = upload.session
604 source_format = source.dsc['Format']
605 query = session.query(SrcFormat).filter_by(format_name=source_format).filter(SrcFormat.suites.contains(suite))
606 if query.first() is None:
607 raise Reject('source format {0} is not allowed in suite {1}'.format(source_format, suite.suite_name))
609 class SuiteArchitectureCheck(Check):
610 def per_suite_check(self, upload, suite):
611 session = upload.session
612 for arch in upload.changes.architectures:
613 query = session.query(Architecture).filter_by(arch_string=arch).filter(Architecture.suites.contains(suite))
614 if query.first() is None:
615 raise Reject('Architecture {0} is not allowed in suite {2}'.format(arch, suite.suite_name))
619 class VersionCheck(Check):
620 """Check version constraints"""
621 def _highest_source_version(self, session, source_name, suite):
622 db_source = session.query(DBSource).filter_by(source=source_name) \
623 .filter(DBSource.suites.contains(suite)).order_by(DBSource.version.desc()).first()
624 if db_source is None:
627 return db_source.version
629 def _highest_binary_version(self, session, binary_name, suite, architecture):
630 db_binary = session.query(DBBinary).filter_by(package=binary_name) \
631 .filter(DBBinary.suites.contains(suite)) \
632 .join(DBBinary.architecture) \
633 .filter(Architecture.arch_string.in_(['all', architecture])) \
634 .order_by(DBBinary.version.desc()).first()
635 if db_binary is None:
638 return db_binary.version
640 def _version_checks(self, upload, suite, op):
641 session = upload.session
643 if upload.changes.source is not None:
644 source_name = upload.changes.source.dsc['Source']
645 source_version = upload.changes.source.dsc['Version']
646 v = self._highest_source_version(session, source_name, suite)
647 if v is not None and not op(version_compare(source_version, v)):
648 raise Reject('Version check failed (source={0}, version={1}, other-version={2}, suite={3})'.format(source_name, source_version, v, suite.suite_name))
650 for binary in upload.changes.binaries:
651 binary_name = binary.control['Package']
652 binary_version = binary.control['Version']
653 architecture = binary.control['Architecture']
654 v = self._highest_binary_version(session, binary_name, suite, architecture)
655 if v is not None and not op(version_compare(binary_version, v)):
656 raise Reject('Version check failed (binary={0}, version={1}, other-version={2}, suite={3})'.format(binary_name, binary_version, v, suite.suite_name))
658 def per_suite_check(self, upload, suite):
659 session = upload.session
661 vc_newer = session.query(dbconn.VersionCheck).filter_by(suite=suite) \
662 .filter(dbconn.VersionCheck.check.in_(['MustBeNewerThan', 'Enhances']))
663 must_be_newer_than = [ vc.reference for vc in vc_newer ]
664 # Must be newer than old versions in `suite`
665 must_be_newer_than.append(suite)
667 for s in must_be_newer_than:
668 self._version_checks(upload, s, lambda result: result > 0)
670 vc_older = session.query(dbconn.VersionCheck).filter_by(suite=suite, check='MustBeOlderThan')
671 must_be_older_than = [ vc.reference for vc in vc_older ]
673 for s in must_be_older_than:
674 self._version_checks(upload, s, lambda result: result < 0)