
The proposed changes concern two steps: First, when creating the RAID configuration, have a GPT partition table type (this is not necessary, but more natural with UEFI). Also, leave some space, either for the EFI partitions or the BIOS boot partitions, outside the Software RAID. Secondly, when installing the bootloader, make sure the correct boot partitions are created or relocated. Change-Id: Icf0a76b0de89e7a8494363ec91b2f1afda4faa3b Story: #2006379 Task: #37635
1043 lines
43 KiB
Python
1043 lines
43 KiB
Python
# Copyright 2011 Justin Santa Barbara
|
|
# Copyright 2012 Hewlett-Packard Development Company, L.P.
|
|
#
|
|
# 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 errno
|
|
import glob
|
|
import io
|
|
import os
|
|
import shutil
|
|
import subprocess
|
|
import tarfile
|
|
import tempfile
|
|
|
|
from ironic_lib import utils as ironic_utils
|
|
import mock
|
|
from oslo_concurrency import processutils
|
|
from oslo_serialization import base64
|
|
import testtools
|
|
|
|
from ironic_python_agent import errors
|
|
from ironic_python_agent import hardware
|
|
from ironic_python_agent.tests.unit import base as ironic_agent_base
|
|
from ironic_python_agent import utils
|
|
|
|
PARTED_OUTPUT_UNFORMATTED = '''Model: whatever
|
|
Disk /dev/sda: 450GB
|
|
Sector size (logical/physical): 512B/512B
|
|
Partition Table: {}
|
|
Disk Flags:
|
|
|
|
Number Start End Size File system Name Flags
|
|
14 1049kB 5243kB 4194kB bios_grub
|
|
15 5243kB 116MB 111MB fat32 boot, esp
|
|
1 116MB 2361MB 2245MB ext4
|
|
'''
|
|
|
|
PARTED_OUTPUT_UNFORMATTED_NOFS = '''Model: whatever
|
|
Disk /dev/sda: 480GB
|
|
Sector size (logical/physical): 512B/512B
|
|
Partition Table: gpt
|
|
Disk Flags:
|
|
|
|
Number Start End Size File system Name Flags
|
|
1 1049kB 9437kB 8389kB ESP boot, esp
|
|
2 9437kB 17.8MB 8389kB BSP bios_grub
|
|
3 17.8MB 40.0GB 40.0GB
|
|
4 479GB 480GB 68.1MB
|
|
'''
|
|
|
|
PARTED_OUTPUT_NO_EFI = '''Model: whatever
|
|
Disk /dev/sda: 450GB
|
|
Sector size (logical/physical): 512B/512B
|
|
Partition Table: gpt
|
|
Disk Flags:
|
|
|
|
Number Start End Size File system Name Flags
|
|
14 1049kB 5243kB 4194kB bios_grub
|
|
1 116MB 2361MB 2245MB ext4
|
|
'''
|
|
|
|
|
|
class ExecuteTestCase(ironic_agent_base.IronicAgentTest):
|
|
# This test case does call utils.execute(), so don't block access to the
|
|
# execute calls.
|
|
block_execute = False
|
|
|
|
# We do mock out the call to ironic_utils.execute() so we don't actually
|
|
# 'execute' anything, as utils.execute() calls ironic_utils.execute()
|
|
@mock.patch.object(ironic_utils, 'execute', autospec=True)
|
|
def test_execute(self, mock_execute):
|
|
utils.execute('/usr/bin/env', 'false', check_exit_code=False)
|
|
mock_execute.assert_called_once_with('/usr/bin/env', 'false',
|
|
check_exit_code=False)
|
|
|
|
|
|
class GetAgentParamsTestCase(ironic_agent_base.IronicAgentTest):
|
|
|
|
@mock.patch('oslo_log.log.getLogger', autospec=True)
|
|
@mock.patch('builtins.open', autospec=True)
|
|
def test__read_params_from_file_fail(self, logger_mock, open_mock):
|
|
open_mock.side_effect = Exception
|
|
params = utils._read_params_from_file('file-path')
|
|
self.assertEqual({}, params)
|
|
|
|
@mock.patch('builtins.open', autospec=True)
|
|
def test__read_params_from_file(self, open_mock):
|
|
kernel_line = 'api-url=http://localhost:9999 baz foo=bar\n'
|
|
open_mock.return_value.__enter__ = lambda s: s
|
|
open_mock.return_value.__exit__ = mock.Mock()
|
|
read_mock = open_mock.return_value.read
|
|
read_mock.return_value = kernel_line
|
|
params = utils._read_params_from_file('file-path')
|
|
open_mock.assert_called_once_with('file-path')
|
|
read_mock.assert_called_once_with()
|
|
self.assertEqual('http://localhost:9999', params['api-url'])
|
|
self.assertEqual('bar', params['foo'])
|
|
self.assertNotIn('baz', params)
|
|
|
|
@mock.patch.object(utils, '_set_cached_params', autospec=True)
|
|
@mock.patch.object(utils, '_read_params_from_file', autospec=True)
|
|
@mock.patch.object(utils, '_get_cached_params', autospec=True)
|
|
def test_get_agent_params_kernel_cmdline(self, get_cache_mock,
|
|
read_params_mock,
|
|
set_cache_mock):
|
|
get_cache_mock.return_value = {}
|
|
expected_params = {'a': 'b'}
|
|
read_params_mock.return_value = expected_params
|
|
returned_params = utils.get_agent_params()
|
|
read_params_mock.assert_called_once_with('/proc/cmdline')
|
|
self.assertEqual(expected_params, returned_params)
|
|
set_cache_mock.assert_called_once_with(expected_params)
|
|
|
|
@mock.patch.object(utils, '_set_cached_params', autospec=True)
|
|
@mock.patch.object(utils, '_get_vmedia_params', autospec=True)
|
|
@mock.patch.object(utils, '_read_params_from_file', autospec=True)
|
|
@mock.patch.object(utils, '_get_cached_params', autospec=True)
|
|
def test_get_agent_params_vmedia(self, get_cache_mock,
|
|
read_params_mock,
|
|
get_vmedia_params_mock,
|
|
set_cache_mock):
|
|
get_cache_mock.return_value = {}
|
|
kernel_params = {'boot_method': 'vmedia'}
|
|
vmedia_params = {'a': 'b'}
|
|
expected_params = dict(
|
|
list(kernel_params.items()) + list(vmedia_params.items()))
|
|
read_params_mock.return_value = kernel_params
|
|
get_vmedia_params_mock.return_value = vmedia_params
|
|
|
|
returned_params = utils.get_agent_params()
|
|
read_params_mock.assert_called_once_with('/proc/cmdline')
|
|
self.assertEqual(expected_params, returned_params)
|
|
# Make sure information is cached
|
|
set_cache_mock.assert_called_once_with(expected_params)
|
|
|
|
@mock.patch.object(utils, '_set_cached_params', autospec=True)
|
|
@mock.patch.object(utils, '_get_cached_params', autospec=True)
|
|
def test_get_agent_params_from_cache(self, get_cache_mock,
|
|
set_cache_mock):
|
|
get_cache_mock.return_value = {'a': 'b'}
|
|
returned_params = utils.get_agent_params()
|
|
expected_params = {'a': 'b'}
|
|
self.assertEqual(expected_params, returned_params)
|
|
self.assertEqual(0, set_cache_mock.call_count)
|
|
|
|
@mock.patch('builtins.open', autospec=True)
|
|
@mock.patch.object(glob, 'glob', autospec=True)
|
|
def test__get_vmedia_device(self, glob_mock, open_mock):
|
|
|
|
glob_mock.return_value = ['/sys/class/block/sda/device/model',
|
|
'/sys/class/block/sdb/device/model',
|
|
'/sys/class/block/sdc/device/model']
|
|
fobj_mock = mock.MagicMock()
|
|
mock_file_handle = mock.MagicMock()
|
|
mock_file_handle.__enter__.return_value = fobj_mock
|
|
open_mock.return_value = mock_file_handle
|
|
|
|
fobj_mock.read.side_effect = ['scsi disk', Exception, 'Virtual Media']
|
|
vmedia_device_returned = utils._get_vmedia_device()
|
|
self.assertEqual('sdc', vmedia_device_returned)
|
|
|
|
@mock.patch.object(shutil, 'rmtree', autospec=True)
|
|
@mock.patch.object(tempfile, 'mkdtemp', autospec=True)
|
|
@mock.patch.object(utils, '_read_params_from_file', autospec=True)
|
|
@mock.patch.object(os.path, 'exists', autospec=True)
|
|
@mock.patch.object(os, 'mkdir', autospec=True)
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test__get_vmedia_params_by_label_lower_case(
|
|
self, execute_mock, mkdir_mock, exists_mock, read_params_mock,
|
|
mkdtemp_mock, rmtree_mock):
|
|
mkdtemp_mock.return_value = "/tempdir"
|
|
|
|
null_output = ["", ""]
|
|
expected_params = {'a': 'b'}
|
|
read_params_mock.return_value = expected_params
|
|
exists_mock.side_effect = [True, False]
|
|
execute_mock.side_effect = [null_output, null_output]
|
|
|
|
returned_params = utils._get_vmedia_params()
|
|
|
|
execute_mock.assert_any_call('mount', "/dev/disk/by-label/ir-vfd-dev",
|
|
"/tempdir")
|
|
read_params_mock.assert_called_once_with("/tempdir/parameters.txt")
|
|
exists_mock.assert_called_once_with("/dev/disk/by-label/ir-vfd-dev")
|
|
execute_mock.assert_any_call('umount', "/tempdir")
|
|
self.assertEqual(expected_params, returned_params)
|
|
mkdtemp_mock.assert_called_once_with()
|
|
rmtree_mock.assert_called_once_with("/tempdir")
|
|
|
|
@mock.patch.object(shutil, 'rmtree', autospec=True)
|
|
@mock.patch.object(tempfile, 'mkdtemp', autospec=True)
|
|
@mock.patch.object(utils, '_read_params_from_file', autospec=True)
|
|
@mock.patch.object(os.path, 'exists', autospec=True)
|
|
@mock.patch.object(os, 'mkdir', autospec=True)
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test__get_vmedia_params_by_label_upper_case(
|
|
self, execute_mock, mkdir_mock, exists_mock, read_params_mock,
|
|
mkdtemp_mock, rmtree_mock):
|
|
mkdtemp_mock.return_value = "/tempdir"
|
|
|
|
null_output = ["", ""]
|
|
expected_params = {'a': 'b'}
|
|
read_params_mock.return_value = expected_params
|
|
exists_mock.side_effect = [False, True]
|
|
execute_mock.side_effect = [null_output, null_output]
|
|
|
|
returned_params = utils._get_vmedia_params()
|
|
|
|
execute_mock.assert_any_call('mount', "/dev/disk/by-label/IR-VFD-DEV",
|
|
"/tempdir")
|
|
read_params_mock.assert_called_once_with("/tempdir/parameters.txt")
|
|
exists_mock.assert_has_calls(
|
|
[mock.call("/dev/disk/by-label/ir-vfd-dev"),
|
|
mock.call("/dev/disk/by-label/IR-VFD-DEV")])
|
|
execute_mock.assert_any_call('umount', "/tempdir")
|
|
self.assertEqual(expected_params, returned_params)
|
|
mkdtemp_mock.assert_called_once_with()
|
|
rmtree_mock.assert_called_once_with("/tempdir")
|
|
|
|
@mock.patch.object(shutil, 'rmtree', autospec=True)
|
|
@mock.patch.object(tempfile, 'mkdtemp', autospec=True)
|
|
@mock.patch.object(utils, '_get_vmedia_device', autospec=True)
|
|
@mock.patch.object(utils, '_read_params_from_file', autospec=True)
|
|
@mock.patch.object(os.path, 'exists', autospec=True)
|
|
@mock.patch.object(os, 'mkdir', autospec=True)
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test__get_vmedia_params_by_device(self, execute_mock, mkdir_mock,
|
|
exists_mock, read_params_mock,
|
|
get_device_mock, mkdtemp_mock,
|
|
rmtree_mock):
|
|
mkdtemp_mock.return_value = "/tempdir"
|
|
|
|
null_output = ["", ""]
|
|
expected_params = {'a': 'b'}
|
|
read_params_mock.return_value = expected_params
|
|
exists_mock.side_effect = [False, False]
|
|
execute_mock.side_effect = [null_output, null_output]
|
|
get_device_mock.return_value = "sda"
|
|
|
|
returned_params = utils._get_vmedia_params()
|
|
|
|
exists_mock.assert_has_calls(
|
|
[mock.call("/dev/disk/by-label/ir-vfd-dev"),
|
|
mock.call("/dev/disk/by-label/IR-VFD-DEV")])
|
|
execute_mock.assert_any_call('mount', "/dev/sda",
|
|
"/tempdir")
|
|
read_params_mock.assert_called_once_with("/tempdir/parameters.txt")
|
|
execute_mock.assert_any_call('umount', "/tempdir")
|
|
self.assertEqual(expected_params, returned_params)
|
|
mkdtemp_mock.assert_called_once_with()
|
|
rmtree_mock.assert_called_once_with("/tempdir")
|
|
|
|
@mock.patch.object(utils, '_get_vmedia_device', autospec=True)
|
|
@mock.patch.object(os.path, 'exists', autospec=True)
|
|
def test__get_vmedia_params_cannot_find_dev(self, exists_mock,
|
|
get_device_mock):
|
|
get_device_mock.return_value = None
|
|
exists_mock.return_value = False
|
|
self.assertRaises(errors.VirtualMediaBootError,
|
|
utils._get_vmedia_params)
|
|
|
|
@mock.patch.object(shutil, 'rmtree', autospec=True)
|
|
@mock.patch.object(tempfile, 'mkdtemp', autospec=True)
|
|
@mock.patch.object(utils, '_get_vmedia_device', autospec=True)
|
|
@mock.patch.object(utils, '_read_params_from_file', autospec=True)
|
|
@mock.patch.object(os.path, 'exists', autospec=True)
|
|
@mock.patch.object(os, 'mkdir', autospec=True)
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test__get_vmedia_params_mount_fails(self, execute_mock,
|
|
mkdir_mock, exists_mock,
|
|
read_params_mock,
|
|
get_device_mock, mkdtemp_mock,
|
|
rmtree_mock):
|
|
mkdtemp_mock.return_value = "/tempdir"
|
|
|
|
expected_params = {'a': 'b'}
|
|
exists_mock.return_value = True
|
|
read_params_mock.return_value = expected_params
|
|
get_device_mock.return_value = "sda"
|
|
|
|
execute_mock.side_effect = processutils.ProcessExecutionError()
|
|
|
|
self.assertRaises(errors.VirtualMediaBootError,
|
|
utils._get_vmedia_params)
|
|
|
|
execute_mock.assert_any_call('mount', "/dev/disk/by-label/ir-vfd-dev",
|
|
"/tempdir")
|
|
mkdtemp_mock.assert_called_once_with()
|
|
rmtree_mock.assert_called_once_with("/tempdir")
|
|
|
|
@mock.patch.object(shutil, 'rmtree', autospec=True)
|
|
@mock.patch.object(tempfile, 'mkdtemp', autospec=True)
|
|
@mock.patch.object(utils, '_get_vmedia_device', autospec=True)
|
|
@mock.patch.object(utils, '_read_params_from_file', autospec=True)
|
|
@mock.patch.object(os.path, 'exists', autospec=True)
|
|
@mock.patch.object(os, 'mkdir', autospec=True)
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test__get_vmedia_params_umount_fails(self, execute_mock, mkdir_mock,
|
|
exists_mock, read_params_mock,
|
|
get_device_mock, mkdtemp_mock,
|
|
rmtree_mock):
|
|
mkdtemp_mock.return_value = "/tempdir"
|
|
|
|
null_output = ["", ""]
|
|
expected_params = {'a': 'b'}
|
|
exists_mock.return_value = True
|
|
read_params_mock.return_value = expected_params
|
|
get_device_mock.return_value = "sda"
|
|
|
|
execute_mock.side_effect = [null_output,
|
|
processutils.ProcessExecutionError()]
|
|
|
|
returned_params = utils._get_vmedia_params()
|
|
|
|
execute_mock.assert_any_call('mount', "/dev/disk/by-label/ir-vfd-dev",
|
|
"/tempdir")
|
|
read_params_mock.assert_called_once_with("/tempdir/parameters.txt")
|
|
execute_mock.assert_any_call('umount', "/tempdir")
|
|
self.assertEqual(expected_params, returned_params)
|
|
mkdtemp_mock.assert_called_once_with()
|
|
rmtree_mock.assert_called_once_with("/tempdir")
|
|
|
|
@mock.patch.object(shutil, 'rmtree', autospec=True)
|
|
@mock.patch.object(tempfile, 'mkdtemp', autospec=True)
|
|
@mock.patch.object(utils, '_get_vmedia_device', autospec=True)
|
|
@mock.patch.object(utils, '_read_params_from_file', autospec=True)
|
|
@mock.patch.object(os.path, 'exists', autospec=True)
|
|
@mock.patch.object(os, 'mkdir', autospec=True)
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test__get_vmedia_params_rmtree_fails(self, execute_mock, mkdir_mock,
|
|
exists_mock, read_params_mock,
|
|
get_device_mock, mkdtemp_mock,
|
|
rmtree_mock):
|
|
mkdtemp_mock.return_value = "/tempdir"
|
|
rmtree_mock.side_effect = Exception
|
|
|
|
null_output = ["", ""]
|
|
expected_params = {'a': 'b'}
|
|
exists_mock.return_value = True
|
|
read_params_mock.return_value = expected_params
|
|
get_device_mock.return_value = "sda"
|
|
|
|
execute_mock.return_value = null_output
|
|
|
|
returned_params = utils._get_vmedia_params()
|
|
|
|
execute_mock.assert_any_call('mount', "/dev/disk/by-label/ir-vfd-dev",
|
|
"/tempdir")
|
|
read_params_mock.assert_called_once_with("/tempdir/parameters.txt")
|
|
execute_mock.assert_any_call('umount', "/tempdir")
|
|
self.assertEqual(expected_params, returned_params)
|
|
mkdtemp_mock.assert_called_once_with()
|
|
rmtree_mock.assert_called_once_with("/tempdir")
|
|
|
|
|
|
class TestFailures(testtools.TestCase):
|
|
def test_get_error(self):
|
|
f = utils.AccumulatedFailures()
|
|
self.assertFalse(f)
|
|
self.assertIsNone(f.get_error())
|
|
|
|
f.add('foo')
|
|
f.add('%s', 'bar')
|
|
f.add(RuntimeError('baz'))
|
|
self.assertTrue(f)
|
|
|
|
exp = ('The following errors were encountered:\n* foo\n* bar\n* baz')
|
|
self.assertEqual(exp, f.get_error())
|
|
|
|
def test_raise(self):
|
|
class FakeException(Exception):
|
|
pass
|
|
|
|
f = utils.AccumulatedFailures(exc_class=FakeException)
|
|
self.assertIsNone(f.raise_if_needed())
|
|
f.add('foo')
|
|
self.assertRaisesRegex(FakeException, 'foo', f.raise_if_needed)
|
|
|
|
|
|
class TestUtils(testtools.TestCase):
|
|
|
|
def _get_journalctl_output(self, mock_execute, lines=None, units=None):
|
|
contents = b'Krusty Krab'
|
|
mock_execute.return_value = (contents, '')
|
|
data = utils.get_journalctl_output(lines=lines, units=units)
|
|
|
|
cmd = ['journalctl', '--full', '--no-pager', '-b']
|
|
if lines is not None:
|
|
cmd.extend(['-n', str(lines)])
|
|
if units is not None:
|
|
[cmd.extend(['-u', u]) for u in units]
|
|
|
|
mock_execute.assert_called_once_with(*cmd, binary=True,
|
|
log_stdout=False)
|
|
self.assertEqual(contents, data.read())
|
|
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test_get_journalctl_output(self, mock_execute):
|
|
self._get_journalctl_output(mock_execute)
|
|
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test_get_journalctl_output_with_lines(self, mock_execute):
|
|
self._get_journalctl_output(mock_execute, lines=123)
|
|
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test_get_journalctl_output_with_units(self, mock_execute):
|
|
self._get_journalctl_output(mock_execute, units=['fake-unit1',
|
|
'fake-unit2'])
|
|
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test_get_journalctl_output_fail(self, mock_execute):
|
|
mock_execute.side_effect = processutils.ProcessExecutionError()
|
|
self.assertRaises(errors.CommandExecutionError,
|
|
self._get_journalctl_output, mock_execute)
|
|
|
|
def test_gzip_and_b64encode(self):
|
|
contents = b'Squidward Tentacles'
|
|
io_dict = {'fake-name': io.BytesIO(bytes(contents))}
|
|
data = utils.gzip_and_b64encode(io_dict=io_dict)
|
|
self.assertIsInstance(data, str)
|
|
|
|
res = io.BytesIO(base64.decode_as_bytes(data))
|
|
with tarfile.open(fileobj=res) as tar:
|
|
members = [(m.name, m.size) for m in tar]
|
|
self.assertEqual([('fake-name', len(contents))], members)
|
|
|
|
member = tar.extractfile('fake-name')
|
|
self.assertEqual(contents, member.read())
|
|
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test_get_command_output(self, mock_execute):
|
|
contents = b'Sandra Sandy Cheeks'
|
|
mock_execute.return_value = (contents, '')
|
|
data = utils.get_command_output(['foo'])
|
|
|
|
mock_execute.assert_called_once_with(
|
|
'foo', binary=True, log_stdout=False)
|
|
self.assertEqual(contents, data.read())
|
|
|
|
@mock.patch.object(subprocess, 'check_call', autospec=True)
|
|
def test_guess_root_disk_primary_sort(self, mock_call):
|
|
block_devices = [
|
|
hardware.BlockDevice(name='/dev/sdc',
|
|
model='too small',
|
|
size=4294967295,
|
|
rotational=True),
|
|
hardware.BlockDevice(name='/dev/sda',
|
|
model='bigger than sdb',
|
|
size=21474836480,
|
|
rotational=True),
|
|
hardware.BlockDevice(name='/dev/sdb',
|
|
model='',
|
|
size=10737418240,
|
|
rotational=True),
|
|
hardware.BlockDevice(name='/dev/sdd',
|
|
model='bigger than sdb',
|
|
size=21474836480,
|
|
rotational=True),
|
|
]
|
|
device = utils.guess_root_disk(block_devices)
|
|
self.assertEqual(device.name, '/dev/sdb')
|
|
|
|
@mock.patch.object(subprocess, 'check_call', autospec=True)
|
|
def test_guess_root_disk_secondary_sort(self, mock_call):
|
|
block_devices = [
|
|
hardware.BlockDevice(name='/dev/sdc',
|
|
model='_',
|
|
size=10737418240,
|
|
rotational=True),
|
|
hardware.BlockDevice(name='/dev/sdb',
|
|
model='_',
|
|
size=10737418240,
|
|
rotational=True),
|
|
hardware.BlockDevice(name='/dev/sda',
|
|
model='_',
|
|
size=10737418240,
|
|
rotational=True),
|
|
hardware.BlockDevice(name='/dev/sdd',
|
|
model='_',
|
|
size=10737418240,
|
|
rotational=True),
|
|
]
|
|
device = utils.guess_root_disk(block_devices)
|
|
self.assertEqual(device.name, '/dev/sda')
|
|
|
|
@mock.patch.object(subprocess, 'check_call', autospec=True)
|
|
def test_guess_root_disk_disks_too_small(self, mock_call):
|
|
block_devices = [
|
|
hardware.BlockDevice(name='/dev/sda',
|
|
model='too small',
|
|
size=4294967295,
|
|
rotational=True),
|
|
hardware.BlockDevice(name='/dev/sdb',
|
|
model='way too small',
|
|
size=1,
|
|
rotational=True),
|
|
]
|
|
self.assertRaises(errors.DeviceNotFound,
|
|
utils.guess_root_disk, block_devices)
|
|
|
|
@mock.patch.object(subprocess, 'check_call', autospec=True)
|
|
def test_is_journalctl_present(self, mock_call):
|
|
self.assertTrue(utils.is_journalctl_present())
|
|
|
|
@mock.patch.object(subprocess, 'check_call', autospec=True)
|
|
def test_is_journalctl_present_false(self, mock_call):
|
|
os_error = OSError()
|
|
os_error.errno = errno.ENOENT
|
|
mock_call.side_effect = os_error
|
|
self.assertFalse(utils.is_journalctl_present())
|
|
|
|
@mock.patch.object(utils, 'gzip_and_b64encode', autospec=True)
|
|
@mock.patch.object(utils, 'is_journalctl_present', autospec=True)
|
|
@mock.patch.object(utils, 'get_command_output', autospec=True)
|
|
@mock.patch.object(utils, 'get_journalctl_output', autospec=True)
|
|
def test_collect_system_logs_journald(
|
|
self, mock_logs, mock_outputs, mock_journalctl, mock_gzip_b64):
|
|
mock_journalctl.return_value = True
|
|
ret = 'Patrick Star'
|
|
mock_gzip_b64.return_value = ret
|
|
|
|
logs_string = utils.collect_system_logs()
|
|
self.assertEqual(ret, logs_string)
|
|
mock_logs.assert_called_once_with(lines=None)
|
|
calls = [mock.call(['ps', 'au']), mock.call(['df', '-a']),
|
|
mock.call(['iptables', '-L']), mock.call(['ip', 'addr']),
|
|
mock.call(['lshw', '-quiet', '-json'])]
|
|
mock_outputs.assert_has_calls(calls, any_order=True)
|
|
mock_gzip_b64.assert_called_once_with(
|
|
file_list=[],
|
|
io_dict={'journal': mock.ANY, 'ip_addr': mock.ANY, 'ps': mock.ANY,
|
|
'df': mock.ANY, 'iptables': mock.ANY, 'lshw': mock.ANY,
|
|
'lsblk': mock.ANY, 'mdstat': mock.ANY})
|
|
|
|
@mock.patch.object(utils, 'gzip_and_b64encode', autospec=True)
|
|
@mock.patch.object(utils, 'is_journalctl_present', autospec=True)
|
|
@mock.patch.object(utils, 'get_command_output', autospec=True)
|
|
def test_collect_system_logs_non_journald(
|
|
self, mock_outputs, mock_journalctl, mock_gzip_b64):
|
|
mock_journalctl.return_value = False
|
|
ret = 'SpongeBob SquarePants'
|
|
mock_gzip_b64.return_value = ret
|
|
|
|
logs_string = utils.collect_system_logs()
|
|
self.assertEqual(ret, logs_string)
|
|
calls = [mock.call(['dmesg']), mock.call(['ps', 'au']),
|
|
mock.call(['df', '-a']), mock.call(['iptables', '-L']),
|
|
mock.call(['ip', 'addr']),
|
|
mock.call(['lshw', '-quiet', '-json'])]
|
|
mock_outputs.assert_has_calls(calls, any_order=True)
|
|
mock_gzip_b64.assert_called_once_with(
|
|
file_list=['/var/log'],
|
|
io_dict={'iptables': mock.ANY, 'ip_addr': mock.ANY, 'ps': mock.ANY,
|
|
'dmesg': mock.ANY, 'df': mock.ANY, 'lshw': mock.ANY,
|
|
'lsblk': mock.ANY, 'mdstat': mock.ANY})
|
|
|
|
def test_get_ssl_client_options(self):
|
|
# defaults
|
|
conf = mock.Mock(insecure=False, cafile=None,
|
|
keyfile=None, certfile=None)
|
|
self.assertEqual((True, None), utils.get_ssl_client_options(conf))
|
|
|
|
# insecure=True overrides cafile
|
|
conf = mock.Mock(insecure=True, cafile='spam',
|
|
keyfile=None, certfile=None)
|
|
self.assertEqual((False, None), utils.get_ssl_client_options(conf))
|
|
|
|
# cafile returned as verify when not insecure
|
|
conf = mock.Mock(insecure=False, cafile='spam',
|
|
keyfile=None, certfile=None)
|
|
self.assertEqual(('spam', None), utils.get_ssl_client_options(conf))
|
|
|
|
# only both certfile and keyfile produce non-None result
|
|
conf = mock.Mock(insecure=False, cafile=None,
|
|
keyfile=None, certfile='ham')
|
|
self.assertEqual((True, None), utils.get_ssl_client_options(conf))
|
|
|
|
conf = mock.Mock(insecure=False, cafile=None,
|
|
keyfile='ham', certfile=None)
|
|
self.assertEqual((True, None), utils.get_ssl_client_options(conf))
|
|
|
|
conf = mock.Mock(insecure=False, cafile=None,
|
|
keyfile='spam', certfile='ham')
|
|
self.assertEqual((True, ('ham', 'spam')),
|
|
utils.get_ssl_client_options(conf))
|
|
|
|
def test_device_extractor(self):
|
|
self.assertEqual(
|
|
'md0',
|
|
utils.extract_device('md0p1')
|
|
)
|
|
self.assertEqual(
|
|
'/dev/md0',
|
|
utils.extract_device('/dev/md0p1')
|
|
)
|
|
self.assertEqual(
|
|
'sda',
|
|
utils.extract_device('sda12')
|
|
)
|
|
self.assertEqual(
|
|
'/dev/sda',
|
|
utils.extract_device('/dev/sda12')
|
|
)
|
|
self.assertEqual(
|
|
'nvme0n1',
|
|
utils.extract_device('nvme0n1p12')
|
|
)
|
|
self.assertEqual(
|
|
'/dev/nvme0n1',
|
|
utils.extract_device('/dev/nvme0n1p12')
|
|
)
|
|
self.assertEqual(
|
|
'/dev/hello',
|
|
utils.extract_device('/dev/hello42')
|
|
)
|
|
self.assertIsNone(
|
|
utils.extract_device('/dev/sda')
|
|
)
|
|
self.assertIsNone(
|
|
utils.extract_device('whatevernotmatchin12a')
|
|
)
|
|
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test_get_efi_part_on_device(self, mocked_execute):
|
|
parted_ret = PARTED_OUTPUT_UNFORMATTED.format('gpt')
|
|
mocked_execute.side_effect = [
|
|
(parted_ret, None)
|
|
]
|
|
ret = utils.get_efi_part_on_device('/dev/sda')
|
|
mocked_execute.assert_has_calls(
|
|
[mock.call('parted', '-s', '/dev/sda', '--', 'print')]
|
|
)
|
|
self.assertEqual('15', ret)
|
|
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test_get_efi_part_on_device_without_fs(self, mocked_execute):
|
|
parted_ret = PARTED_OUTPUT_UNFORMATTED_NOFS
|
|
mocked_execute.side_effect = [
|
|
(parted_ret, None)
|
|
]
|
|
ret = utils.get_efi_part_on_device('/dev/sda')
|
|
mocked_execute.assert_has_calls(
|
|
[mock.call('parted', '-s', '/dev/sda', '--', 'print')]
|
|
)
|
|
self.assertEqual('1', ret)
|
|
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test_get_efi_part_on_device_not_found(self, mocked_execute):
|
|
mocked_execute.side_effect = [
|
|
(PARTED_OUTPUT_NO_EFI, None)
|
|
]
|
|
self.assertIsNone(utils.get_efi_part_on_device('/dev/sda'))
|
|
mocked_execute.assert_has_calls(
|
|
[mock.call('parted', '-s', '/dev/sda', '--', 'print')]
|
|
)
|
|
|
|
def test_extract_capability_from_dict(self):
|
|
expected_dict = {"hello": "world"}
|
|
root = {"capabilities": expected_dict}
|
|
|
|
self.assertDictEqual(
|
|
expected_dict,
|
|
utils.parse_capabilities(root))
|
|
|
|
def test_extract_capability_from_json_string(self):
|
|
root = {'capabilities': '{"test": "world"}'}
|
|
self.assertDictEqual(
|
|
{"test": "world"},
|
|
utils.parse_capabilities(root))
|
|
|
|
def test_extract_capability_from_old_format_caps(self):
|
|
root = {'capabilities': 'test:world:2,hello:test1,badformat'}
|
|
self.assertDictEqual(
|
|
{'hello': 'test1'},
|
|
utils.parse_capabilities(root))
|
|
|
|
@mock.patch.object(os.path, 'isdir', return_value=True, autospec=True)
|
|
def test_boot_mode_fallback_uefi(self, mock_os):
|
|
node = {}
|
|
boot_mode = utils.get_node_boot_mode(node)
|
|
self.assertEqual('uefi', boot_mode)
|
|
mock_os.assert_called_once_with('/sys/firmware/efi')
|
|
|
|
@mock.patch.object(os.path, 'isdir', return_value=False, autospec=True)
|
|
def test_boot_mode_fallback_bios(self, mock_os):
|
|
node = {}
|
|
boot_mode = utils.get_node_boot_mode(node)
|
|
self.assertEqual('bios', boot_mode)
|
|
mock_os.assert_called_once_with('/sys/firmware/efi')
|
|
|
|
@mock.patch.object(os.path, 'isdir', return_value=False, autospec=True)
|
|
def test_boot_mode_from_driver_internal_info(self, mock_os):
|
|
node = {
|
|
'driver_internal_info': {
|
|
'deploy_boot_mode': 'uefi'
|
|
},
|
|
}
|
|
boot_mode = utils.get_node_boot_mode(node)
|
|
self.assertEqual('uefi', boot_mode)
|
|
mock_os.assert_called_once_with('/sys/firmware/efi')
|
|
|
|
@mock.patch.object(os.path, 'isdir', return_value=False, autospec=True)
|
|
def test_boot_mode_from_properties_str(self, mock_os):
|
|
node = {
|
|
'driver_internal_info': {
|
|
'deploy_boot_mode': 'bios'
|
|
},
|
|
'properties': {
|
|
'capabilities': 'boot_mode:uefi'
|
|
}
|
|
}
|
|
boot_mode = utils.get_node_boot_mode(node)
|
|
self.assertEqual('uefi', boot_mode)
|
|
mock_os.assert_called_once_with('/sys/firmware/efi')
|
|
|
|
@mock.patch.object(os.path, 'isdir', return_value=False, autospec=True)
|
|
def test_boot_mode_from_properties_dict(self, mock_os):
|
|
node = {
|
|
'driver_internal_info': {
|
|
'deploy_boot_mode': 'bios'
|
|
},
|
|
'properties': {
|
|
'capabilities': {
|
|
'boot_mode': 'uefi'
|
|
}
|
|
}
|
|
}
|
|
boot_mode = utils.get_node_boot_mode(node)
|
|
self.assertEqual('uefi', boot_mode)
|
|
mock_os.assert_called_once_with('/sys/firmware/efi')
|
|
|
|
@mock.patch.object(os.path, 'isdir', return_value=False, autospec=True)
|
|
def test_boot_mode_from_properties_json_str(self, mock_os):
|
|
node = {
|
|
'driver_internal_info': {
|
|
'deploy_boot_mode': 'bios'
|
|
},
|
|
'properties': {
|
|
'capabilities': '{"boot_mode": "uefi"}'
|
|
}
|
|
}
|
|
boot_mode = utils.get_node_boot_mode(node)
|
|
self.assertEqual('uefi', boot_mode)
|
|
mock_os.assert_called_once_with('/sys/firmware/efi')
|
|
|
|
@mock.patch.object(os.path, 'isdir', return_value=False, autospec=True)
|
|
def test_boot_mode_override_with_instance_info(self, mock_os):
|
|
node = {
|
|
'driver_internal_info': {
|
|
'deploy_boot_mode': 'bios'
|
|
},
|
|
'properties': {
|
|
'capabilities': {
|
|
'boot_mode': 'bios'
|
|
}
|
|
},
|
|
'instance_info': {
|
|
'deploy_boot_mode': 'uefi'
|
|
}
|
|
}
|
|
|
|
boot_mode = utils.get_node_boot_mode(node)
|
|
self.assertEqual('uefi', boot_mode)
|
|
mock_os.assert_called_once_with('/sys/firmware/efi')
|
|
|
|
@mock.patch.object(os.path, 'isdir', return_value=False, autospec=True)
|
|
def test_boot_mode_implicit_with_secure_boot(self, mock_os):
|
|
node = {
|
|
'driver_internal_info': {
|
|
'deploy_boot_mode': 'bios'
|
|
},
|
|
'properties': {
|
|
'capabilities': {
|
|
'boot_mode': 'bios',
|
|
'secure_boot': 'TrUe'
|
|
}
|
|
},
|
|
'instance_info': {
|
|
'deploy_boot_mode': 'bios'
|
|
}
|
|
}
|
|
|
|
boot_mode = utils.get_node_boot_mode(node)
|
|
self.assertEqual('uefi', boot_mode)
|
|
mock_os.assert_has_calls([])
|
|
|
|
@mock.patch.object(os.path, 'isdir', return_value=False, autospec=True)
|
|
def test_secure_boot_overriden_with_instance_info_caps(self, mock_os):
|
|
node = {
|
|
'driver_internal_info': {
|
|
'deploy_boot_mode': 'bios'
|
|
},
|
|
'properties': {
|
|
'capabilities': {
|
|
'boot_mode': 'bios',
|
|
'secure_boot': 'false'
|
|
}
|
|
},
|
|
'instance_info': {
|
|
'deploy_boot_mode': 'bios',
|
|
'capabilities': {
|
|
'secure_boot': 'true'
|
|
}
|
|
}
|
|
}
|
|
|
|
boot_mode = utils.get_node_boot_mode(node)
|
|
self.assertEqual('uefi', boot_mode)
|
|
mock_os.assert_has_calls([])
|
|
|
|
@mock.patch.object(os.path, 'isdir', return_value=True, autospec=True)
|
|
def test_boot_mode_invalid_cap(self, mock_os):
|
|
# In case of invalid boot mode specified we fallback to ramdisk boot
|
|
# mode
|
|
node = {
|
|
'driver_internal_info': {
|
|
'deploy_boot_mode': 'bios'
|
|
},
|
|
'properties': {
|
|
'capabilities': {
|
|
'boot_mode': 'sfkshfks'
|
|
}
|
|
}
|
|
}
|
|
boot_mode = utils.get_node_boot_mode(node)
|
|
self.assertEqual('uefi', boot_mode)
|
|
mock_os.assert_called_once_with('/sys/firmware/efi')
|
|
|
|
@mock.patch.object(utils, 'get_node_boot_mode', return_value='bios',
|
|
autospec=True)
|
|
def test_specified_partition_table_type(self, mock_boot_mode):
|
|
node = {}
|
|
label = utils.get_partition_table_type_from_specs(node)
|
|
self.assertEqual('msdos', label)
|
|
mock_boot_mode.assert_called_once_with(node)
|
|
|
|
@mock.patch.object(utils, 'get_node_boot_mode', return_value='uefi',
|
|
autospec=True)
|
|
def test_specified_partition_table_type_gpt(self, mock_boot_mode):
|
|
node = {}
|
|
label = utils.get_partition_table_type_from_specs(node)
|
|
self.assertEqual('gpt', label)
|
|
mock_boot_mode.assert_called_once_with(node)
|
|
|
|
@mock.patch.object(utils, 'get_node_boot_mode', return_value='bios',
|
|
autospec=True)
|
|
def test_specified_partition_table_type_with_disk_label(self,
|
|
mock_boot_mode):
|
|
node = {
|
|
'properties': {
|
|
'capabilities': 'disk_label:gpt'
|
|
}
|
|
}
|
|
label = utils.get_partition_table_type_from_specs(node)
|
|
self.assertEqual('gpt', label)
|
|
mock_boot_mode.assert_has_calls([])
|
|
|
|
@mock.patch.object(utils, 'get_node_boot_mode', return_value='bios',
|
|
autospec=True)
|
|
def test_specified_partition_table_type_with_instance_disk_label(
|
|
self, mock_boot_mode):
|
|
# In case of invalid boot mode specified we fallback to ramdisk boot
|
|
# mode
|
|
node = {
|
|
'instance_info': {
|
|
'capabilities': 'disk_label:gpt'
|
|
}
|
|
}
|
|
label = utils.get_partition_table_type_from_specs(node)
|
|
self.assertEqual('gpt', label)
|
|
mock_boot_mode.assert_has_calls([])
|
|
|
|
@mock.patch.object(utils, 'get_node_boot_mode', return_value='uefi',
|
|
autospec=True)
|
|
def test_specified_partition_table_type_disk_label_ignored_with_uefi(
|
|
self, mock_boot_mode):
|
|
# In case of invalid boot mode specified we fallback to ramdisk boot
|
|
# mode
|
|
node = {
|
|
'instance_info': {
|
|
'capabilities': 'disk_label:msdos'
|
|
}
|
|
}
|
|
label = utils.get_partition_table_type_from_specs(node)
|
|
self.assertEqual('gpt', label)
|
|
mock_boot_mode.assert_has_calls([])
|
|
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test_scan_partition_table_type_gpt(self, mocked_execute):
|
|
self._test_scan_partition_table_by_type(mocked_execute, 'gpt', 'gpt')
|
|
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test_scan_partition_table_type_msdos(self, mocked_execute):
|
|
self._test_scan_partition_table_by_type(mocked_execute, 'msdos',
|
|
'msdos')
|
|
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
def test_scan_partition_table_type_unknown(self, mocked_execute):
|
|
self._test_scan_partition_table_by_type(mocked_execute, 'whatever',
|
|
'unknown')
|
|
|
|
def _test_scan_partition_table_by_type(self, mocked_execute,
|
|
table_type_output,
|
|
expected_table_type):
|
|
|
|
parted_ret = PARTED_OUTPUT_UNFORMATTED.format(table_type_output)
|
|
|
|
mocked_execute.side_effect = [
|
|
(parted_ret, None),
|
|
]
|
|
|
|
ret = utils.scan_partition_table_type('hello')
|
|
mocked_execute.assert_has_calls(
|
|
[mock.call('parted', '-s', 'hello', '--', 'print')]
|
|
)
|
|
self.assertEqual(expected_table_type, ret)
|
|
|
|
|
|
class TestRemoveKeys(testtools.TestCase):
|
|
def test_remove_keys(self):
|
|
value = {'system_logs': 'abcd',
|
|
'key': 'value',
|
|
'other': [{'configdrive': 'foo'}, 'string', 0]}
|
|
expected = {'system_logs': '<...>',
|
|
'key': 'value',
|
|
'other': [{'configdrive': '<...>'}, 'string', 0]}
|
|
self.assertEqual(expected, utils.remove_large_keys(value))
|
|
|
|
|
|
@mock.patch.object(utils, 'execute', autospec=True)
|
|
class TestClockSyncUtils(ironic_agent_base.IronicAgentTest):
|
|
|
|
def test_determine_time_method_none(self, mock_execute):
|
|
mock_execute.side_effect = OSError
|
|
self.assertIsNone(utils.determine_time_method())
|
|
|
|
def test_determine_time_method_ntpdate(self, mock_execute):
|
|
mock_execute.side_effect = [
|
|
OSError, # No chronyd found
|
|
('', ''), # Returns nothing on ntpdate call
|
|
]
|
|
calls = [mock.call('chronyd', '-h'),
|
|
mock.call('ntpdate', '-v', check_exit_code=[0, 1])]
|
|
return_value = utils.determine_time_method()
|
|
self.assertEqual('ntpdate', return_value)
|
|
mock_execute.assert_has_calls(calls)
|
|
|
|
def test_determine_time_method_chronyd(self, mock_execute):
|
|
mock_execute.side_effect = [
|
|
('', ''), # Returns nothing on ntpdate call
|
|
]
|
|
calls = [mock.call('chronyd', '-h')]
|
|
return_value = utils.determine_time_method()
|
|
self.assertEqual('chronyd', return_value)
|
|
mock_execute.assert_has_calls(calls)
|
|
|
|
@mock.patch.object(utils, 'determine_time_method', autospec=True)
|
|
def test_sync_clock_ntp(self, mock_time_method, mock_execute):
|
|
self.config(ntp_server='192.168.1.1')
|
|
mock_time_method.return_value = 'ntpdate'
|
|
utils.sync_clock()
|
|
mock_execute.assert_has_calls([mock.call('ntpdate', '192.168.1.1')])
|
|
|
|
@mock.patch.object(utils, 'determine_time_method', autospec=True)
|
|
def test_sync_clock_ntp_raises_exception(self, mock_time_method,
|
|
mock_execute):
|
|
self.config(ntp_server='192.168.1.1')
|
|
self.config(fail_if_clock_not_set=True)
|
|
mock_time_method.return_value = 'ntpdate'
|
|
mock_execute.side_effect = processutils.ProcessExecutionError()
|
|
self.assertRaises(errors.CommandExecutionError, utils.sync_clock)
|
|
|
|
@mock.patch.object(utils, 'determine_time_method', autospec=True)
|
|
def test_sync_clock_chrony(self, mock_time_method, mock_execute):
|
|
self.config(ntp_server='192.168.1.1')
|
|
mock_time_method.return_value = 'chronyd'
|
|
utils.sync_clock()
|
|
mock_execute.assert_has_calls([
|
|
mock.call('chronyd', check_exit_code=[0, 1]),
|
|
mock.call('chronyc', 'add', 'server', '192.168.1.1'),
|
|
mock.call('chronyc', 'makestep'),
|
|
])
|
|
|
|
@mock.patch.object(utils, 'determine_time_method', autospec=True)
|
|
def test_sync_clock_chrony_already_present(self, mock_time_method,
|
|
mock_execute):
|
|
self.config(ntp_server='192.168.1.1')
|
|
mock_time_method.return_value = 'chronyd'
|
|
mock_execute.side_effect = [
|
|
('', ''),
|
|
processutils.ProcessExecutionError(
|
|
stderr='Source already present'),
|
|
('', ''),
|
|
]
|
|
utils.sync_clock()
|
|
mock_execute.assert_has_calls([
|
|
mock.call('chronyd', check_exit_code=[0, 1]),
|
|
mock.call('chronyc', 'add', 'server', '192.168.1.1'),
|
|
mock.call('chronyc', 'makestep'),
|
|
])
|
|
|
|
@mock.patch.object(utils, 'determine_time_method', autospec=True)
|
|
def test_sync_clock_chrony_failure(self, mock_time_method, mock_execute):
|
|
self.config(ntp_server='192.168.1.1')
|
|
self.config(fail_if_clock_not_set=True)
|
|
mock_time_method.return_value = 'chronyd'
|
|
mock_execute.side_effect = [
|
|
('', ''),
|
|
processutils.ProcessExecutionError(stderr='time verboten'),
|
|
]
|
|
self.assertRaisesRegex(errors.CommandExecutionError,
|
|
'Error occured adding ntp',
|
|
utils.sync_clock)
|
|
mock_execute.assert_has_calls([
|
|
mock.call('chronyd', check_exit_code=[0, 1]),
|
|
mock.call('chronyc', 'add', 'server', '192.168.1.1'),
|
|
])
|
|
|
|
@mock.patch.object(utils, 'determine_time_method', autospec=True)
|
|
def test_sync_clock_none(self, mock_time_method, mock_execute):
|
|
self.config(ntp_server='192.168.1.1')
|
|
mock_time_method.return_value = None
|
|
utils.sync_clock(ignore_errors=True)
|
|
self.assertEqual(0, mock_execute.call_count)
|
|
|
|
@mock.patch.object(utils, 'determine_time_method', autospec=True)
|
|
def test_sync_clock_ntp_server_is_none(self, mock_time_method,
|
|
mock_execute):
|
|
self.config(ntp_server=None)
|
|
mock_time_method.return_value = None
|
|
utils.sync_clock()
|
|
self.assertEqual(0, mock_execute.call_count)
|