b6d9b5632e
This patch modifies how checksums are stored - it uses BSD-style checksums. The filename with the checksum can now be customized depending on actual compose run and metadata. This required adding another option to the checksumming phase. Documentation is updated and includes example for creating names used in Fedora. Signed-off-by: Lubomír Sedlář <lsedlar@redhat.com>
131 lines
4.6 KiB
Python
131 lines
4.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
import os
|
|
from kobo import shortcuts
|
|
|
|
from .base import PhaseBase
|
|
|
|
|
|
MULTIPLE_CHECKSUMS_ERROR = (
|
|
'Config option "media_checksum_one_file" requires only one checksum'
|
|
' to be configured in "media_checksums".'
|
|
)
|
|
|
|
|
|
class ImageChecksumPhase(PhaseBase):
|
|
"""Go through images specified in image manifest and generate their
|
|
checksums. The manifest will be updated with the checksums.
|
|
"""
|
|
|
|
name = 'image_checksum'
|
|
|
|
config_options = (
|
|
{
|
|
"name": "media_checksums",
|
|
"expected_types": [list],
|
|
"optional": True,
|
|
},
|
|
{
|
|
"name": "media_checksum_one_file",
|
|
"expected_types": [bool],
|
|
"optional": True,
|
|
},
|
|
{
|
|
"name": "media_checksum_base_filename",
|
|
"expected_types": [str],
|
|
"optional": True,
|
|
}
|
|
)
|
|
|
|
def __init__(self, compose):
|
|
super(ImageChecksumPhase, self).__init__(compose)
|
|
self.checksums = self.compose.conf.get('media_checksums', ['md5', 'sha1', 'sha256'])
|
|
self.one_file = self.compose.conf.get('media_checksum_one_file', False)
|
|
|
|
def validate(self):
|
|
errors = []
|
|
try:
|
|
super(ImageChecksumPhase, self).validate()
|
|
except ValueError as exc:
|
|
errors = exc.message.split('\n')
|
|
|
|
if self.one_file and len(self.checksums) != 1:
|
|
errors.append(MULTIPLE_CHECKSUMS_ERROR)
|
|
|
|
if errors:
|
|
raise ValueError('\n'.join(errors))
|
|
|
|
def _get_images(self):
|
|
"""Returns a mapping from directories to sets of ``Image``s.
|
|
|
|
The paths to dirs are absolute.
|
|
"""
|
|
top_dir = self.compose.paths.compose.topdir()
|
|
images = {}
|
|
for variant in self.compose.im.images:
|
|
for arch in self.compose.im.images[variant]:
|
|
for image in self.compose.im.images[variant][arch]:
|
|
path = os.path.dirname(os.path.join(top_dir, image.path))
|
|
images.setdefault((variant, path), set()).add(image)
|
|
return images
|
|
|
|
def _get_base_filename(self, variant):
|
|
base_checksum_name = self.compose.conf.get('media_checksum_base_filename', '')
|
|
if base_checksum_name:
|
|
base_checksum_name = base_checksum_name % {
|
|
'release_short': self.compose.ci_base.release.short,
|
|
'release_id': self.compose.ci_base.release_id,
|
|
'variant': variant,
|
|
'version': self.compose.ci_base.release.version,
|
|
'date': self.compose.compose_date,
|
|
'type_suffix': self.compose.compose_type_suffix,
|
|
'respin': self.compose.compose_respin,
|
|
}
|
|
base_checksum_name += '-'
|
|
return base_checksum_name
|
|
|
|
def run(self):
|
|
for (variant, path), images in self._get_images().iteritems():
|
|
checksums = {}
|
|
base_checksum_name = self._get_base_filename(variant)
|
|
for image in images:
|
|
filename = os.path.basename(image.path)
|
|
full_path = os.path.join(path, filename)
|
|
if not os.path.exists(full_path):
|
|
continue
|
|
|
|
digests = shortcuts.compute_file_checksums(full_path, self.checksums)
|
|
for checksum, digest in digests.iteritems():
|
|
checksums.setdefault(checksum, {})[filename] = digest
|
|
image.add_checksum(None, checksum, digest)
|
|
if not self.one_file:
|
|
dump_checksums(path, checksum,
|
|
{filename: digest},
|
|
'%s.%sSUM' % (filename, checksum.upper()))
|
|
|
|
if not checksums:
|
|
continue
|
|
|
|
if self.one_file:
|
|
dump_checksums(path, self.checksums[0],
|
|
checksums[self.checksums[0]],
|
|
base_checksum_name + 'CHECKSUM')
|
|
else:
|
|
for checksum in self.checksums:
|
|
dump_checksums(path, checksum,
|
|
checksums[checksum],
|
|
'%s%sSUM' % (base_checksum_name, checksum.upper()))
|
|
|
|
|
|
def dump_checksums(dir, alg, checksums, filename):
|
|
"""Create file with checksums.
|
|
|
|
:param dir: where to put the file
|
|
:param alg: which method was used
|
|
:param checksums: mapping from filenames to checksums
|
|
:param filename: what to call the file
|
|
"""
|
|
with open(os.path.join(dir, filename), 'w') as f:
|
|
for file, checksum in checksums.iteritems():
|
|
f.write('%s (%s) = %s\n' % (alg.upper(), file, checksum))
|