x
/
cloudbase-init
Code Issues Proposed changes

Use MSFT_NetAdapter to rename adapter 

Currently renaming the adapter on windows 22 core does not cause an error but also has no effect
INFO cloudbaseinit.plugins.common.networkconfig [-] Renaming network adapter "Ethernet" to "some-adapter-name"
...
ERROR cloudbaseinit.init cloudbaseinit.exception.ItemNotFoundException: Network interface with name "some-adapter-name" not found

Using Win32_NetworkAdapter or netsh for renaming network adapters does not work,
although they do not fail, but do no-operation (probably a Windows bug).

Change-Id: I6b05b313742dd6ff2553dd67b374a8aa4fefd0a7
Signed-off-by: Adrian Vladu <avladu@cloudbasesolutions.com>
This commit is contained in:
Lukas Kranz 2023-10-18 09:33:00 +02:00 committed by Adrian Vladu
parent c9eaf6a9b6
commit ab664f4b31
2 changed files with 33 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
cloudbaseinit/osutils/windows.py
View File

@ -858,17 +858,24 @@ class WindowsUtils(base.BaseOSUtils):
'value "%(mtu)s" failed' % {'name': name, 'mtu': mtu})
def rename_network_adapter(self, old_name, new_name):
base_dir = self._get_system_dir()
netsh_path = os.path.join(base_dir, 'netsh.exe')
args = [netsh_path, "interface", "set", "interface",
'name=%s' % old_name, 'newname=%s' % new_name]
(out, err, ret_val) = self.execute_process(args, shell=False)
if ret_val:
net_adapter = self._get_network_msft_adapter(old_name)
try:
net_adapter.rename(new_name)
self._get_network_msft_adapter(new_name)
except Exception:
raise exception.CloudbaseInitException(
'Renaming interface "%(old_name)s" to "%(new_name)s" '
'failed' % {'old_name': old_name, 'new_name': new_name})
@staticmethod
def _get_network_msft_adapter(name):
conn = wmi.WMI(moniker='//./root/standardcimv2')
query = conn.MSFT_NetAdapter(Name=name)
if not len(query):
raise exception.CloudbaseInitException(
"MSFT network adapter not found: %s" % name)
return query[0]
@staticmethod
def _get_network_adapter(name):
conn = wmi.WMI(moniker='//./root/cimv2')

33
cloudbaseinit/tests/osutils/test_windows.py
View File

@ -839,28 +839,33 @@ class TestWindowsUtils(testutils.CloudbaseInitTestBase):
self._test_set_static_network_config(ipv6=True)
@mock.patch('cloudbaseinit.osutils.windows.WindowsUtils'
'.execute_process')
@mock.patch('cloudbaseinit.osutils.windows.WindowsUtils'
'._get_system_dir')
def _test_rename_network_adapter(self, should_fail, mock_get_system_dir,
mock_execute_process):
base_dir = "fake path"
'._get_network_msft_adapter')
def _test_rename_network_adapter(self, rename_exception,
mock_get_network_adapter):
old_name = "fake_old"
new_name = "fake_new"
mock_get_system_dir.return_value = base_dir
ret_val = 1 if should_fail else 0
mock_execute_process.return_value = (None, None, ret_val)
if should_fail:
adapter = mock.Mock()
adapter.Name = mock.sentinel.old_name
mock_get_network_adapter.return_value = adapter
get_network_adapter_called = 1
if rename_exception:
adapter.rename.side_effect = Exception("fake exception")
with self.assertRaises(exception.CloudbaseInitException):
self._winutils.rename_network_adapter(old_name, new_name)
else:
get_network_adapter_called = 2
self._winutils.rename_network_adapter(old_name, new_name)
mock_get_system_dir.assert_called_once_with()
args = [os.path.join(base_dir, "netsh.exe"), "interface", "set",
"interface", 'name=%s' % old_name, 'newname=%s' % new_name]
mock_execute_process.assert_called_once_with(args, shell=False)
adapter.rename.assert_called()
self.assertEqual(mock_get_network_adapter.call_count,
get_network_adapter_called)
self.assertEqual(mock_get_network_adapter.call_args_list[0].args,
(old_name,))
if not exception:
self.assertEqual(mock_get_network_adapter.call_args_list[1].args,
(new_name,))
def _test_get_config_key_name(self, section):
response = self._winutils._get_config_key_name(section)