# Copyright 2019 Red Hat, Inc. # All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. import os import tempfile from unittest import mock from oslo_utils import importutils from ironic.common import images from ironic.conductor import task_manager from ironic.drivers.modules import image_utils from ironic.tests.unit.db import base as db_base from ironic.tests.unit.db import utils as db_utils from ironic.tests.unit.objects import utils as obj_utils sushy = importutils.try_import('sushy') INFO_DICT = db_utils.get_test_redfish_info() class RedfishImageHandlerTestCase(db_base.DbTestCase): def setUp(self): super(RedfishImageHandlerTestCase, self).setUp() self.config(enabled_hardware_types=['redfish'], enabled_power_interfaces=['redfish'], enabled_boot_interfaces=['redfish-virtual-media'], enabled_management_interfaces=['redfish'], enabled_inspect_interfaces=['redfish'], enabled_bios_interfaces=['redfish']) self.node = obj_utils.create_test_node( self.context, driver='redfish', driver_info=INFO_DICT) def test__append_filename_param_without_qs(self): img_handler_obj = image_utils.ImageHandler(self.node.driver) res = img_handler_obj._append_filename_param( 'http://a.b/c', 'b.img') expected = 'http://a.b/c?filename=b.img' self.assertEqual(expected, res) def test__append_filename_param_with_qs(self): img_handler_obj = image_utils.ImageHandler(self.node.driver) res = img_handler_obj._append_filename_param( 'http://a.b/c?d=e&f=g', 'b.img') expected = 'http://a.b/c?d=e&f=g&filename=b.img' self.assertEqual(expected, res) def test__append_filename_param_with_filename(self): img_handler_obj = image_utils.ImageHandler(self.node.driver) res = img_handler_obj._append_filename_param( 'http://a.b/c?filename=bootme.img', 'b.img') expected = 'http://a.b/c?filename=bootme.img' self.assertEqual(expected, res) @mock.patch.object(image_utils, 'swift', autospec=True) def test_publish_image_swift(self, mock_swift): img_handler_obj = image_utils.ImageHandler(self.node.driver) mock_swift_api = mock_swift.SwiftAPI.return_value mock_swift_api.get_temp_url.return_value = 'https://a.b/c.f?e=f' url = img_handler_obj.publish_image('file.iso', 'boot.iso') self.assertEqual( 'https://a.b/c.f?e=f&filename=file.iso', url) mock_swift.SwiftAPI.assert_called_once_with() mock_swift_api.create_object.assert_called_once_with( mock.ANY, mock.ANY, mock.ANY, mock.ANY) mock_swift_api.get_temp_url.assert_called_once_with( mock.ANY, mock.ANY, mock.ANY) @mock.patch.object(image_utils, 'swift', autospec=True) def test_unpublish_image_swift(self, mock_swift): with task_manager.acquire(self.context, self.node.uuid, shared=True) as task: img_handler_obj = image_utils.ImageHandler(self.node.driver) object_name = 'image-%s' % task.node.uuid img_handler_obj.unpublish_image(object_name) mock_swift.SwiftAPI.assert_called_once_with() mock_swift_api = mock_swift.SwiftAPI.return_value mock_swift_api.delete_object.assert_called_once_with( 'ironic_redfish_container', object_name) @mock.patch.object(image_utils.ImageHandler, '_is_swift_enabled', autospec=True) @mock.patch.object(os, 'chmod', autospec=True) @mock.patch.object(image_utils, 'shutil', autospec=True) @mock.patch.object(os, 'link', autospec=True) @mock.patch.object(os, 'mkdir', autospec=True) def test_publish_image_local_link( self, mock_mkdir, mock_link, mock_shutil, mock_chmod, mock__is_swift): img_handler_obj = image_utils.ImageHandler(self.node.driver) mock__is_swift.return_value = False self.config(use_swift=False, group='redfish') self.config(http_url='http://localhost', group='deploy') url = img_handler_obj.publish_image('file.iso', 'boot.iso') self.assertEqual( 'http://localhost/redfish/boot.iso?filename=file.iso', url) mock_mkdir.assert_called_once_with('/httpboot/redfish', 0o755) mock_link.assert_called_once_with( 'file.iso', '/httpboot/redfish/boot.iso') mock_chmod.assert_called_once_with('file.iso', 0o644) @mock.patch.object(image_utils.ImageHandler, '_is_swift_enabled', autospec=True) @mock.patch.object(os, 'chmod', autospec=True) @mock.patch.object(image_utils, 'shutil', autospec=True) @mock.patch.object(os, 'link', autospec=True) @mock.patch.object(os, 'mkdir', autospec=True) def test_publish_image_local_copy(self, mock_mkdir, mock_link, mock_shutil, mock_chmod, mock__is_swift): mock__is_swift.return_value = False self.config(use_swift=False, group='redfish') self.config(http_url='http://localhost', group='deploy') img_handler_obj = image_utils.ImageHandler(self.node.driver) mock_link.side_effect = OSError() url = img_handler_obj.publish_image('file.iso', 'boot.iso') self.assertEqual( 'http://localhost/redfish/boot.iso?filename=file.iso', url) mock_mkdir.assert_called_once_with('/httpboot/redfish', 0o755) mock_shutil.copyfile.assert_called_once_with( 'file.iso', '/httpboot/redfish/boot.iso') mock_chmod.assert_called_once_with('/httpboot/redfish/boot.iso', 0o644) @mock.patch.object(image_utils.ImageHandler, '_is_swift_enabled', autospec=True) @mock.patch.object(image_utils, 'ironic_utils', autospec=True) def test_unpublish_image_local(self, mock_ironic_utils, mock__is_swift): self.config(use_swift=False, group='redfish') mock__is_swift.return_value = False with task_manager.acquire(self.context, self.node.uuid, shared=True) as task: img_handler_obj = image_utils.ImageHandler(self.node.driver) object_name = 'image-%s' % task.node.uuid expected_file = '/httpboot/redfish/' + object_name img_handler_obj.unpublish_image(object_name) mock_ironic_utils.unlink_without_raise.assert_called_once_with( expected_file) class RedfishImageUtilsTestCase(db_base.DbTestCase): def setUp(self): super(RedfishImageUtilsTestCase, self).setUp() self.config(enabled_hardware_types=['redfish'], enabled_power_interfaces=['redfish'], enabled_boot_interfaces=['redfish-virtual-media'], enabled_management_interfaces=['redfish'], enabled_inspect_interfaces=['redfish'], enabled_bios_interfaces=['redfish']) self.node = obj_utils.create_test_node( self.context, driver='redfish', driver_info=INFO_DICT) @mock.patch.object(image_utils.ImageHandler, 'unpublish_image', autospec=True) def test_cleanup_floppy_image(self, mock_unpublish): with task_manager.acquire(self.context, self.node.uuid, shared=True) as task: image_utils.cleanup_floppy_image(task) object_name = 'image-%s' % task.node.uuid mock_unpublish.assert_called_once_with(mock.ANY, object_name) @mock.patch.object(image_utils.ImageHandler, 'publish_image', autospec=True) @mock.patch.object(images, 'create_vfat_image', autospec=True) def test_prepare_floppy_image( self, mock_create_vfat_image, mock_publish_image): with task_manager.acquire(self.context, self.node.uuid, shared=True) as task: expected_url = 'https://a.b/c.f?e=f' mock_publish_image.return_value = expected_url url = image_utils.prepare_floppy_image(task) object_name = 'image-%s' % task.node.uuid mock_publish_image.assert_called_once_with(mock.ANY, mock.ANY, object_name) mock_create_vfat_image.assert_called_once_with( mock.ANY, parameters=mock.ANY) self.assertEqual(expected_url, url) @mock.patch.object(image_utils.ImageHandler, 'unpublish_image', autospec=True) def test_cleanup_iso_image(self, mock_unpublish): with task_manager.acquire(self.context, self.node.uuid, shared=True) as task: image_utils.cleanup_iso_image(task) object_name = 'boot-%s.iso' % task.node.uuid mock_unpublish.assert_called_once_with(mock.ANY, object_name) @mock.patch.object(image_utils.ImageHandler, 'publish_image', autospec=True) @mock.patch.object(images, 'create_boot_iso', autospec=True) def test__prepare_iso_image_uefi( self, mock_create_boot_iso, mock_publish_image): with task_manager.acquire(self.context, self.node.uuid, shared=True) as task: task.node.instance_info.update(deploy_boot_mode='uefi') expected_url = 'https://a.b/c.f?e=f' mock_publish_image.return_value = expected_url url = image_utils._prepare_iso_image( task, 'http://kernel/img', 'http://ramdisk/img', 'http://bootloader/img', root_uuid=task.node.uuid) object_name = 'boot-%s.iso' % task.node.uuid mock_publish_image.assert_called_once_with( mock.ANY, mock.ANY, object_name) mock_create_boot_iso.assert_called_once_with( mock.ANY, mock.ANY, 'http://kernel/img', 'http://ramdisk/img', boot_mode='uefi', esp_image_href='http://bootloader/img', kernel_params='nofb nomodeset vga=normal', root_uuid='1be26c0b-03f2-4d2e-ae87-c02d7f33c123', base_iso=None, inject_files=None) self.assertEqual(expected_url, url) @mock.patch.object(image_utils.ImageHandler, 'publish_image', autospec=True) @mock.patch.object(images, 'create_boot_iso', autospec=True) def test__prepare_iso_image_default_boot_mode( self, mock_create_boot_iso, mock_publish_image): self.config(default_boot_mode='uefi', group='deploy') with task_manager.acquire(self.context, self.node.uuid, shared=True) as task: image_utils._prepare_iso_image( task, 'http://kernel/img', 'http://ramdisk/img', bootloader_href=None, root_uuid=task.node.uuid, base_iso='/path/to/baseiso') mock_create_boot_iso.assert_called_once_with( mock.ANY, mock.ANY, 'http://kernel/img', 'http://ramdisk/img', boot_mode='uefi', esp_image_href=None, kernel_params='nofb nomodeset vga=normal', root_uuid='1be26c0b-03f2-4d2e-ae87-c02d7f33c123', base_iso='/path/to/baseiso', inject_files=None) @mock.patch.object(image_utils.ImageHandler, 'publish_image', autospec=True) @mock.patch.object(images, 'create_boot_iso', autospec=True) def test__prepare_iso_image_bios( self, mock_create_boot_iso, mock_publish_image): with task_manager.acquire(self.context, self.node.uuid, shared=True) as task: expected_url = 'https://a.b/c.f?e=f' mock_publish_image.return_value = expected_url url = image_utils._prepare_iso_image( task, 'http://kernel/img', 'http://ramdisk/img', bootloader_href=None, root_uuid=task.node.uuid, base_iso=None) object_name = 'boot-%s.iso' % task.node.uuid mock_publish_image.assert_called_once_with( mock.ANY, mock.ANY, object_name) mock_create_boot_iso.assert_called_once_with( mock.ANY, mock.ANY, 'http://kernel/img', 'http://ramdisk/img', boot_mode='bios', esp_image_href=None, kernel_params='nofb nomodeset vga=normal', root_uuid='1be26c0b-03f2-4d2e-ae87-c02d7f33c123', base_iso=None, inject_files=None) self.assertEqual(expected_url, url) @mock.patch.object(image_utils.ImageHandler, 'publish_image', autospec=True) @mock.patch.object(images, 'create_boot_iso', autospec=True) def test__prepare_iso_image_kernel_params( self, mock_create_boot_iso, mock_publish_image): with task_manager.acquire(self.context, self.node.uuid, shared=True) as task: kernel_params = 'network-config=base64-cloudinit-blob' task.node.instance_info.update(kernel_append_params=kernel_params) image_utils._prepare_iso_image( task, 'http://kernel/img', 'http://ramdisk/img', bootloader_href=None, root_uuid=task.node.uuid, base_iso='/path/to/baseiso') mock_create_boot_iso.assert_called_once_with( mock.ANY, mock.ANY, 'http://kernel/img', 'http://ramdisk/img', boot_mode='bios', esp_image_href=None, kernel_params=kernel_params, root_uuid='1be26c0b-03f2-4d2e-ae87-c02d7f33c123', base_iso='/path/to/baseiso', inject_files=None) def test__find_param(self): param_dict = { 'ilo_deploy_kernel': 'kernel', 'ilo_deploy_ramdisk': 'ramdisk', 'ilo_bootloader': 'bootloader' } param_str = "deploy_kernel" expected = "kernel" actual = image_utils._find_param(param_str, param_dict) self.assertEqual(actual, expected) def test__find_param_not_found(self): param_dict = { 'ilo_deploy_ramdisk': 'ramdisk', 'ilo_bootloader': 'bootloader' } param_str = "deploy_kernel" expected = None actual = image_utils._find_param(param_str, param_dict) self.assertEqual(actual, expected) @mock.patch.object(image_utils, '_find_param', autospec=True) @mock.patch.object(image_utils, '_prepare_iso_image', autospec=True) def test_prepare_deploy_iso(self, mock__prepare_iso_image, find_mock): with task_manager.acquire(self.context, self.node.uuid, shared=True) as task: d_info = { 'ilo_deploy_kernel': 'kernel', 'ilo_deploy_ramdisk': 'ramdisk', 'ilo_bootloader': 'bootloader' } task.node.driver_info.update(d_info) find_call_list = [ mock.call('deploy_kernel', d_info), mock.call('deploy_ramdisk', d_info), mock.call('bootloader', d_info) ] find_mock.side_effect = [ 'kernel', 'ramdisk', 'bootloader' ] task.node.instance_info.update(deploy_boot_mode='uefi') image_utils.prepare_deploy_iso(task, {}, 'deploy', d_info) mock__prepare_iso_image.assert_called_once_with( task, 'kernel', 'ramdisk', 'bootloader', params={}, inject_files={}) find_mock.assert_has_calls(find_call_list) @mock.patch.object(image_utils, '_find_param', autospec=True) @mock.patch.object(image_utils, '_prepare_iso_image', autospec=True) def test_prepare_deploy_iso_network_data( self, mock__prepare_iso_image, find_mock): with task_manager.acquire(self.context, self.node.uuid, shared=True) as task: d_info = { 'ilo_deploy_kernel': 'kernel', 'ilo_deploy_ramdisk': 'ramdisk' } task.node.driver_info.update(d_info) task.node.instance_info.update() find_call_list = [ mock.call('deploy_kernel', d_info), mock.call('deploy_ramdisk', d_info), mock.call('bootloader', d_info) ] find_mock.side_effect = [ 'kernel', 'ramdisk', None ] network_data = {'a': ['b']} mock_get_node_nw_data = mock.MagicMock(return_value=network_data) task.driver.network.get_node_network_data = mock_get_node_nw_data image_utils.prepare_deploy_iso(task, {}, 'deploy', d_info) expected_files = { b"""{ "a": [ "b" ] }""": 'openstack/latest/network_data.json' } mock__prepare_iso_image.assert_called_once_with( task, 'kernel', 'ramdisk', bootloader_href=None, params={}, inject_files=expected_files) find_mock.assert_has_calls(find_call_list) @mock.patch.object(image_utils, '_find_param', autospec=True) @mock.patch.object(image_utils, '_prepare_iso_image', autospec=True) def test_prepare_deploy_iso_tls(self, mock__prepare_iso_image, find_mock): with tempfile.NamedTemporaryFile(delete=False) as tf: temp_name = tf.name self.addCleanup(lambda: os.unlink(temp_name)) self.config(api_ca_file=temp_name, group='agent') tf.write(b'I can haz SSLz') with task_manager.acquire(self.context, self.node.uuid, shared=True) as task: d_info = { 'ilo_deploy_kernel': 'kernel', 'ilo_deploy_ramdisk': 'ramdisk', 'ilo_bootloader': 'bootloader' } task.node.driver_info.update(d_info) find_call_list = [ mock.call('deploy_kernel', d_info), mock.call('deploy_ramdisk', d_info), mock.call('bootloader', d_info) ] find_mock.side_effect = [ 'kernel', 'ramdisk', 'bootloader' ] task.node.instance_info.update(deploy_boot_mode='uefi') image_utils.prepare_deploy_iso(task, {}, 'deploy', d_info) expected_files = { b"""[DEFAULT] cafile = /etc/ironic-python-agent/ironic.crt """: 'etc/ironic-python-agent.d/ironic-tls.conf', temp_name: 'etc/ironic-python-agent/ironic.crt' } mock__prepare_iso_image.assert_called_once_with( task, 'kernel', 'ramdisk', 'bootloader', params={}, inject_files=expected_files) find_mock.assert_has_calls(find_call_list) @mock.patch.object(image_utils, '_find_param', autospec=True) @mock.patch.object(image_utils, '_prepare_iso_image', autospec=True) @mock.patch.object(images, 'create_boot_iso', autospec=True) def test_prepare_boot_iso(self, mock_create_boot_iso, mock__prepare_iso_image, find_mock): with task_manager.acquire(self.context, self.node.uuid, shared=True) as task: d_info = { 'ilo_deploy_kernel': 'kernel', 'ilo_deploy_ramdisk': 'ramdisk', 'ilo_bootloader': 'bootloader' } task.node.driver_info.update(d_info) task.node.instance_info.update( {'image_source': 'http://boot/iso', 'kernel': 'http://kernel/img', 'ramdisk': 'http://ramdisk/img'}) find_call_list = [ mock.call('bootloader', d_info) ] find_mock.side_effect = [ 'bootloader' ] image_utils.prepare_boot_iso( task, d_info, root_uuid=task.node.uuid) mock__prepare_iso_image.assert_called_once_with( mock.ANY, 'http://kernel/img', 'http://ramdisk/img', 'bootloader', root_uuid=task.node.uuid, base_iso=None) find_mock.assert_has_calls(find_call_list) @mock.patch.object(image_utils, '_find_param', autospec=True) @mock.patch.object(image_utils, '_prepare_iso_image', autospec=True) @mock.patch.object(images, 'create_boot_iso', autospec=True) def test_prepare_boot_iso_user_supplied(self, mock_create_boot_iso, mock__prepare_iso_image, find_mock): with task_manager.acquire(self.context, self.node.uuid, shared=True) as task: d_info = { 'deploy_kernel': 'kernel', 'deploy_ramdisk': 'ramdisk', 'bootloader': 'bootloader' } task.node.driver_info.update(d_info) task.node.instance_info.update( {'boot_iso': 'http://boot/iso'}) find_call_list = [ mock.call('bootloader', d_info) ] find_mock.side_effect = [ 'bootloader' ] image_utils.prepare_boot_iso( task, d_info, root_uuid=task.node.uuid) mock__prepare_iso_image.assert_called_once_with( mock.ANY, None, None, 'bootloader', root_uuid=task.node.uuid, base_iso='http://boot/iso') find_mock.assert_has_calls(find_call_list)