class TestSystemPrepare:
@fixture(autouse=True)
def inject_fixtures(self, caplog):
self._caplog = caplog
@patch('kiwi.system.prepare.RootInit')
@patch('kiwi.system.prepare.RootBind')
@patch('kiwi.logger.Logger.get_logfile')
def setup(self, mock_get_logfile, mock_root_bind, mock_root_init):
Defaults.set_platform_name('x86_64')
mock_get_logfile.return_value = None
description = XMLDescription(description='../data/example_config.xml',
derived_from='derived/description')
self.description_dir = os.path.dirname(description.description_origin)
self.xml = description.load()
self.manager = MagicMock(return_value=MagicMock())
self.manager.package_requests = ['foo']
self.manager.collection_requests = ['foo']
self.manager.product_requests = ['foo']
root_init = MagicMock()
mock_root_init.return_value = root_init
root_bind = MagicMock()
root_bind.root_dir = 'root_dir'
mock_root_bind.return_value = root_bind
self.state = XMLState(self.xml)
self.system = SystemPrepare(xml_state=self.state,
root_dir='root_dir',
allow_existing=True)
mock_root_init.assert_called_once_with('root_dir', True)
root_init.create.assert_called_once_with()
mock_root_bind.assert_called_once_with(root_init)
root_bind.setup_intermediate_config.assert_called_once_with()
root_bind.mount_kernel_file_systems.assert_called_once_with()
@patch('kiwi.system.prepare.RootImport.new')
@patch('kiwi.system.prepare.RootInit')
@patch('kiwi.system.prepare.RootBind')
@patch('kiwi.logger.Logger.get_logfile')
def test_init_with_derived_from_image(self, mock_get_logfile,
mock_root_bind, mock_root_init,
mock_root_import):
mock_get_logfile.return_value = 'logfile'
description = XMLDescription(description='../data/example_config.xml',
derived_from='derived/description')
xml = description.load()
root_init = MagicMock()
mock_root_init.return_value = root_init
root_import = Mock()
root_import.sync_data = Mock()
mock_root_import.return_value = root_import
root_bind = MagicMock()
root_bind.root_dir = 'root_dir'
mock_root_bind.return_value = root_bind
state = XMLState(xml,
profiles=['containerFlavour'],
build_type='docker')
uri = Mock()
get_derived_from_image_uri = Mock(return_value=uri)
state.get_derived_from_image_uri = get_derived_from_image_uri
system = SystemPrepare(
xml_state=state,
root_dir='root_dir',
)
mock_root_init.assert_called_once_with('root_dir', False)
root_init.create.assert_called_once_with()
mock_root_import.assert_called_once_with('root_dir', uri,
state.build_type.get_image())
root_import.sync_data.assert_called_once_with()
mock_root_bind.assert_called_once_with(root_init)
root_bind.setup_intermediate_config.assert_called_once_with()
root_bind.mount_kernel_file_systems.assert_called_once_with()
assert system.issue_message == '{headline}: {reason}'
@patch('kiwi.system.prepare.CommandProcess.poll_show_progress')
def test_install_bootstrap_packages_raises(self, mock_poll):
mock_poll.side_effect = Exception('some_error')
with raises(KiwiBootStrapPhaseFailed) as issue:
self.system.install_bootstrap(self.manager)
assert issue.value.message == self.system.issue_message.format(
headline='Bootstrap package installation failed',
reason='some_error')
@patch('kiwi.system.prepare.CommandProcess.poll_show_progress')
@patch('kiwi.system.prepare.ArchiveTar')
def test_install_bootstrap_archives_raises(self, mock_tar, mock_poll):
mock_tar.side_effect = Exception
with raises(KiwiBootStrapPhaseFailed):
self.system.install_bootstrap(self.manager)
@patch('kiwi.system.prepare.CommandProcess.poll')
def test_update_system_raises(self, mock_poll):
mock_poll.side_effect = Exception
with raises(KiwiSystemUpdateFailed):
self.system.update_system(self.manager)
@patch('kiwi.system.prepare.CommandProcess.poll_show_progress')
def test_install_packages_raises(self, mock_poll):
mock_poll.side_effect = Exception
with raises(KiwiSystemInstallPackagesFailed):
self.system.install_packages(self.manager, ['package'])
@patch('kiwi.system.prepare.CommandProcess.poll_show_progress')
def test_install_system_packages_raises(self, mock_poll):
mock_poll.side_effect = Exception
with raises(KiwiInstallPhaseFailed):
self.system.install_system(self.manager)
@patch('kiwi.system.prepare.CommandProcess.poll_show_progress')
@patch('kiwi.system.prepare.ArchiveTar')
def test_install_system_archives_raises(self, mock_tar, mock_poll):
mock_tar.side_effect = KiwiInstallPhaseFailed
with raises(KiwiInstallPhaseFailed):
self.system.install_system(self.manager)
@patch('kiwi.system.prepare.CommandProcess.poll_show_progress')
def test_delete_packages_raises(self, mock_poll):
mock_poll.side_effect = Exception
with raises(KiwiSystemDeletePackagesFailed):
self.system.delete_packages(self.manager, ['package'])
@patch('kiwi.system.prepare.Repository.new')
@patch('kiwi.system.prepare.Uri')
@patch('kiwi.system.prepare.PackageManager')
@patch('kiwi.xml_state.XMLState.get_package_manager')
@patch('os.path.exists')
def test_setup_repositories(self, mock_exists, mock_package_manager,
mock_manager, mock_uri, mock_repo):
mock_exists.return_value = True
mock_package_manager.return_value = 'package-manager-name'
uri = Mock()
mock_uri.return_value = uri
self.system.root_bind = Mock()
uri.is_remote = Mock(return_value=False)
uri.translate = Mock(return_value='uri')
uri.alias = Mock(return_value='uri-alias')
uri.credentials_file_name = Mock(return_value='credentials-file')
repo = Mock()
mock_repo.return_value = repo
self.system.setup_repositories(
clear_cache=True,
signing_keys=['key-file-a.asc', 'key-file-b.asc'])
mock_repo.assert_called_once_with(
self.system.root_bind, 'package-manager-name', [
'check_signatures', 'exclude_docs',
'_install_langs%POSIX:C:C.UTF-8:en_US:de_DE'
])
# mock local repos will be translated and bind mounted
assert uri.translate.call_args_list == [call(), call()]
assert self.system.root_bind.mount_shared_directory.call_args_list == [
call('uri'), call('uri')
]
assert uri.alias.call_args_list == [call(), call()]
assert repo.add_repo.call_args_list == [
call('uri-alias', 'uri', None, 42, None, None, None, None,
'credentials-file', None, None, 'baseurl', False),
call('uri-alias', 'uri', 'rpm-md', None, None, None, None, None,
'credentials-file', None, None, None, False)
]
assert repo.delete_repo_cache.call_args_list == [
call('uri-alias'), call('uri-alias')
]
repo.setup_package_database_configuration.assert_called_once_with()
repo.import_trusted_keys.assert_called_once_with(
['key-file-a.asc', 'key-file-b.asc'])
@patch('kiwi.system.prepare.Repository.new')
@patch('kiwi.system.prepare.Uri')
@patch('kiwi.system.prepare.PackageManager')
@patch('kiwi.xml_state.XMLState.get_package_manager')
@patch('os.path.exists')
def test_setup_repositories_local_not_existing(self, mock_exists,
mock_package_manager,
mock_manager, mock_uri,
mock_repo):
mock_exists.return_value = False
mock_package_manager.return_value = 'package-manager-name'
uri = Mock()
mock_uri.return_value = uri
self.system.root_bind = Mock()
uri.is_remote = Mock(return_value=False)
uri.translate = Mock(return_value='uri')
uri.alias = Mock(return_value='uri-alias')
repo = Mock()
mock_repo.return_value = repo
with self._caplog.at_level(logging.WARNING):
self.system.setup_repositories()
@patch('kiwi.xml_state.XMLState.get_bootstrap_collection_type')
@patch('kiwi.system.prepare.CommandProcess.poll_show_progress')
@patch('kiwi.system.prepare.ArchiveTar')
@patch('os.path.exists')
def test_install_bootstrap(self, mock_exists, mock_tar, mock_poll,
mock_collection_type):
mock_exists.return_value = True
tar = Mock()
tar.extract = Mock()
mock_tar.return_value = tar
mock_collection_type.return_value = 'onlyRequired'
self.system.install_bootstrap(self.manager)
self.manager.process_only_required.assert_called_once_with()
self.manager.request_package.assert_any_call('filesystem')
self.manager.request_package.assert_any_call('zypper')
self.manager.request_collection.assert_called_once_with(
'bootstrap-collection')
self.manager.request_product.assert_called_once_with('kiwi')
self.manager.process_install_requests_bootstrap.assert_called_once_with(
self.system.root_bind)
mock_tar.assert_called_once_with('{0}/bootstrap.tgz'.format(
self.description_dir))
tar.extract.assert_called_once_with('root_dir')
self.manager.post_process_install_requests_bootstrap.assert_called_once_with(
self.system.root_bind)
@patch('kiwi.xml_state.XMLState.get_bootstrap_packages_sections')
def test_install_bootstrap_skipped(self, mock_bootstrap_section):
mock_bootstrap_section.return_value = []
self.system.install_bootstrap(self.manager)
with self._caplog.at_level(logging.WARNING):
mock_bootstrap_section.assert_called_once_with()
@patch('kiwi.xml_state.XMLState.get_bootstrap_collection_type')
@patch('kiwi.system.prepare.CommandProcess.poll_show_progress')
@patch('kiwi.system.prepare.ArchiveTar')
@patch('os.path.exists')
def test_install_bootstrap_archive_from_derived_description(
self, mock_exists, mock_tar, mock_poll, mock_collection_type):
mock_exists.return_value = False
self.system.install_bootstrap(self.manager)
mock_tar.assert_called_once_with('derived/description/bootstrap.tgz')
@patch('kiwi.xml_state.XMLState.get_system_collection_type')
@patch('kiwi.system.prepare.CommandProcess.poll_show_progress')
@patch('kiwi.system.prepare.ArchiveTar')
@patch('os.path.exists')
def test_install_system(self, mock_exists, mock_tar, mock_poll,
mock_collection_type):
mock_exists.return_value = True
tar = Mock()
tar.extract = Mock()
mock_tar.return_value = tar
mock_collection_type.return_value = 'onlyRequired'
self.system.install_system(self.manager)
self.manager.process_only_required.assert_called_once_with()
self.manager.request_package.assert_any_call(
'plymouth-branding-openSUSE')
self.manager.request_collection.assert_any_call('base')
self.manager.request_product.assert_any_call('openSUSE')
self.manager.request_package_exclusion.assert_any_call('foo')
self.manager.process_install_requests.assert_called_once_with()
mock_tar.assert_called_once_with('/absolute/path/to/image.tgz')
tar.extract.assert_called_once_with('root_dir')
@patch('kiwi.system.prepare.CommandProcess.poll_show_progress')
def test_install_packages(self, mock_poll):
self.system.install_packages(self.manager, ['foo'])
self.manager.request_package.assert_called_once_with('foo')
@patch('kiwi.system.prepare.CommandProcess.poll_show_progress')
def test_delete_packages(self, mock_poll):
self.system.delete_packages(self.manager, ['foo'])
self.manager.request_package.assert_called_once_with('foo')
@patch('kiwi.system.prepare.CommandProcess.poll_show_progress')
def test_pinch_system(self, mock_poll):
self.system.pinch_system(self.manager, force=False)
self.system.pinch_system(self.manager, force=True)
self.manager.process_delete_requests.assert_has_calls(
[call(False), call(True)])
@patch('kiwi.system.prepare.CommandProcess.poll_show_progress')
def test_pinch_system_raises(self, mock_poll):
mock_poll.side_effect = Exception
with raises(KiwiPackagesDeletePhaseFailed):
self.system.pinch_system(self.manager)
self.manager.process_delete_requests.assert_called_once_with(False)
@patch(
'kiwi.package_manager.zypper.PackageManagerZypper.process_delete_requests'
)
@patch('kiwi.system.prepare.Repository.new')
@patch('kiwi.system.prepare.CommandProcess.poll_show_progress')
def test_pinch_system_without_manager(self, mock_poll, mock_repo,
mock_requests):
self.system.pinch_system()
mock_repo.assert_called_once_with(ANY, 'zypper')
mock_requests.assert_called_once_with(False)
@patch('kiwi.system.prepare.CommandProcess.poll')
def test_update_system(self, mock_poll):
self.system.update_system(self.manager)
self.manager.update.assert_called_once_with()
def test_destructor(self):
self.system.__del__()
self.system.root_bind.cleanup.assert_called_once_with()
@patch('kiwi.system.prepare.Repository.new')
@patch('kiwi.system.prepare.PackageManager.new')
def test_clean_package_manager_leftovers(self, mock_manager, mock_repo):
manager = Mock()
mock_manager.return_value = manager
self.system.clean_package_manager_leftovers()
manager.clean_leftovers.assert_called_once_with()
def test_destructor_raising(self):
self.system.root_bind = Mock()
self.system.root_bind.cleanup.side_effect = ValueError("nothing")
with self._caplog.at_level(logging.INFO):
del self.system
assert 'Cleaning up SystemPrepare instance' in self._caplog.text
assert 'Cleaning up SystemPrepare instance failed, '
'got an exception of type ValueError: nothing' in self._caplog.text
def process(self): # noqa: C901
"""
Build a system image from the specified description. The
build command combines the prepare and create commands
"""
self.manual = Help()
if self._help():
return
Privileges.check_for_root_permissions()
abs_target_dir_path = os.path.abspath(
self.command_args['--target-dir']
)
build_dir = os.sep.join([abs_target_dir_path, 'build'])
image_root = os.sep.join([build_dir, 'image-root'])
Path.create(build_dir)
if not self.global_args['--logfile']:
log.set_logfile(
os.sep.join([abs_target_dir_path, 'build', 'image-root.log'])
)
self.load_xml_description(
self.command_args['--description']
)
build_checks = self.checks_before_command_args
build_checks.update(
{
'check_target_directory_not_in_shared_cache':
[abs_target_dir_path]
}
)
self.run_checks(build_checks)
if self.command_args['--ignore-repos']:
self.xml_state.delete_repository_sections()
elif self.command_args['--ignore-repos-used-for-build']:
self.xml_state.delete_repository_sections_used_for_build()
if self.command_args['--set-repo']:
self.xml_state.set_repository(
*self.sextuple_token(self.command_args['--set-repo'])
)
if self.command_args['--add-repo']:
for add_repo in self.command_args['--add-repo']:
self.xml_state.add_repository(
*self.sextuple_token(add_repo)
)
if self.command_args['--set-container-tag']:
self.xml_state.set_container_config_tag(
self.command_args['--set-container-tag']
)
if self.command_args['--add-container-label']:
for add_label in self.command_args['--add-container-label']:
try:
(name, value) = add_label.split('=', 1)
self.xml_state.add_container_config_label(name, value)
except Exception:
log.warning(
'Container label {0} ignored. Invalid format: '
'expected labelname=value'.format(add_label)
)
if self.command_args['--set-container-derived-from']:
self.xml_state.set_derived_from_image_uri(
self.command_args['--set-container-derived-from']
)
self.run_checks(self.checks_after_command_args)
log.info('Preparing new root system')
system = SystemPrepare(
self.xml_state,
image_root,
self.command_args['--allow-existing-root']
)
manager = system.setup_repositories(
self.command_args['--clear-cache'],
self.command_args['--signing-key']
)
system.install_bootstrap(
manager, self.command_args['--add-bootstrap-package']
)
system.install_system(
manager
)
if self.command_args['--add-package']:
system.install_packages(
manager, self.command_args['--add-package']
)
if self.command_args['--delete-package']:
system.delete_packages(
manager, self.command_args['--delete-package']
)
profile = Profile(self.xml_state)
defaults = Defaults()
defaults.to_profile(profile)
profile.create(
Defaults.get_profile_file(image_root)
)
setup = SystemSetup(
self.xml_state, image_root
)
setup.import_description()
setup.import_overlay_files()
setup.import_image_identifier()
setup.setup_groups()
setup.setup_users()
setup.setup_keyboard_map()
setup.setup_locale()
setup.setup_plymouth_splash()
setup.setup_timezone()
setup.setup_permissions()
# make sure manager instance is cleaned up now
del manager
# setup permanent image repositories after cleanup
setup.import_repositories_marked_as_imageinclude()
setup.call_config_script()
# handle uninstall package requests, gracefully uninstall
# with dependency cleanup
system.pinch_system(force=False)
# handle delete package requests, forced uninstall without
# any dependency resolution
system.pinch_system(force=True)
# delete any custom rpm macros created
system.clean_package_manager_leftovers()
# make sure system instance is cleaned up now
del system
setup.call_image_script()
# make sure setup instance is cleaned up now
del setup
log.info('Creating system image')
image_builder = ImageBuilder.new(
self.xml_state,
abs_target_dir_path,
image_root,
custom_args={
'signing_keys': self.command_args['--signing-key'],
'xz_options': self.runtime_config.get_xz_options()
}
)
result = image_builder.create()
result.print_results()
result.dump(
os.sep.join([abs_target_dir_path, 'kiwi.result'])
)
def process(self):
"""
Prepare and install a new system for chroot access
"""
self.manual = Help()
if self._help():
return
Privileges.check_for_root_permissions()
self.load_xml_description(self.command_args['--description'])
abs_root_path = os.path.abspath(self.command_args['--root'])
prepare_checks = self.checks_before_command_args
prepare_checks.update(
{'check_target_directory_not_in_shared_cache': [abs_root_path]})
self.run_checks(prepare_checks)
if self.command_args['--ignore-repos']:
self.xml_state.delete_repository_sections()
elif self.command_args['--ignore-repos-used-for-build']:
self.xml_state.delete_repository_sections_used_for_build()
if self.command_args['--set-repo']:
self.xml_state.set_repository(
*self.sextuple_token(self.command_args['--set-repo']))
if self.command_args['--add-repo']:
for add_repo in self.command_args['--add-repo']:
self.xml_state.add_repository(*self.sextuple_token(add_repo))
if self.command_args['--set-container-tag']:
self.xml_state.set_container_config_tag(
self.command_args['--set-container-tag'])
if self.command_args['--add-container-label']:
for add_label in self.command_args['--add-container-label']:
try:
(name, value) = add_label.split('=', 1)
self.xml_state.add_container_config_label(name, value)
except Exception:
log.warning('Container label {0} ignored. Invalid format: '
'expected labelname=value'.format(add_label))
if self.command_args['--set-container-derived-from']:
self.xml_state.set_derived_from_image_uri(
self.command_args['--set-container-derived-from'])
self.run_checks(self.checks_after_command_args)
log.info('Preparing system')
system = SystemPrepare(self.xml_state, abs_root_path,
self.command_args['--allow-existing-root'])
manager = system.setup_repositories(self.command_args['--clear-cache'],
self.command_args['--signing-key'],
self.global_args['--target-arch'])
system.install_bootstrap(manager,
self.command_args['--add-bootstrap-package'])
setup = SystemSetup(self.xml_state, abs_root_path)
setup.import_description()
# call post_bootstrap.sh script if present
setup.call_post_bootstrap_script()
system.install_system(manager)
if self.command_args['--add-package']:
system.install_packages(manager,
self.command_args['--add-package'])
if self.command_args['--delete-package']:
system.delete_packages(manager,
self.command_args['--delete-package'])
profile = Profile(self.xml_state)
defaults = Defaults()
defaults.to_profile(profile)
profile.create(Defaults.get_profile_file(abs_root_path))
setup.import_overlay_files()
setup.import_image_identifier()
setup.setup_groups()
setup.setup_users()
setup.setup_keyboard_map()
setup.setup_locale()
setup.setup_plymouth_splash()
setup.setup_timezone()
setup.setup_permissions()
# make sure manager instance is cleaned up now
del manager
# setup permanent image repositories after cleanup
setup.import_repositories_marked_as_imageinclude()
# call config.sh script if present
setup.call_config_script()
# handle uninstall package requests, gracefully uninstall
# with dependency cleanup
system.pinch_system(force=False)
# handle delete package requests, forced uninstall without
# any dependency resolution
system.pinch_system(force=True)
# delete any custom rpm macros created
system.clean_package_manager_leftovers()
# make sure system instance is cleaned up now
del system