e17488c239
The netifaces library is no longer maintained, which is why we need to drop this dependency. There is only one place in which netifaces is being used, a trivial function that retrives the mac address for a given ip address. Thankfully, we already have a cloudbase-init "get_adapter_addresses" function that uses ctypes to call GetAdaptersAddresses, which happens to be the same Windows function used by netifaces. Worth mentioning that netifaces is the only compilable cloudbase-init dependency that does not provide a wheel package. Fixes: https://github.com/cloudbase/cloudbase-init/issues/140 Change-Id: Ie52ff722cbf42da7b9bfa9f9942adc1996ce5dd8
180 lines
7.3 KiB
Python
180 lines
7.3 KiB
Python
# Copyright 2014 Cloudbase Solutions Srl
|
|
#
|
|
# 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 socket
|
|
import struct
|
|
import unittest
|
|
import unittest.mock as mock
|
|
|
|
from cloudbaseinit.tests import testutils
|
|
from cloudbaseinit.utils import dhcp
|
|
|
|
|
|
class DHCPUtilsTests(unittest.TestCase):
|
|
|
|
def test_get_dhcp_request_data(self):
|
|
|
|
fake_mac_address = '010203040506'
|
|
fake_mac_address_b = bytearray.fromhex(fake_mac_address)
|
|
|
|
data = b'\x01'
|
|
data += b'\x01'
|
|
data += b'\x06'
|
|
data += b'\x00'
|
|
data += struct.pack('!L', 9999)
|
|
data += b'\x00\x00'
|
|
data += b'\x00\x00'
|
|
data += b'\x00\x00\x00\x00'
|
|
data += b'\x00\x00\x00\x00'
|
|
data += b'\x00\x00\x00\x00'
|
|
data += b'\x00\x00\x00\x00'
|
|
data += fake_mac_address_b
|
|
data += b'\x00' * 10
|
|
data += b'\x00' * 64
|
|
data += b'\x00' * 128
|
|
data += dhcp._DHCP_COOKIE
|
|
data += b'\x35\x01\x01'
|
|
data += b'\x3c' + struct.pack('B', len('fake id')) + 'fake id'.encode(
|
|
'ascii')
|
|
data += b'\x3d\x07\x01'
|
|
data += fake_mac_address_b
|
|
data += b'\x37' + struct.pack('B', len([100]))
|
|
data += struct.pack('B', 100)
|
|
data += dhcp._OPTION_END
|
|
|
|
response = dhcp._get_dhcp_request_data(
|
|
id_req=9999, mac_address=fake_mac_address,
|
|
requested_options=[100], vendor_id='fake id')
|
|
self.assertEqual(data, response)
|
|
|
|
@mock.patch('struct.unpack')
|
|
def _test_parse_dhcp_reply(self, mock_unpack, message_type,
|
|
id_reply, equals_cookie):
|
|
fake_data = 236 * b"1"
|
|
if equals_cookie:
|
|
fake_data += dhcp._DHCP_COOKIE + b'11'
|
|
else:
|
|
fake_data += b'111111'
|
|
fake_data += b'fake'
|
|
fake_data += dhcp._OPTION_END
|
|
|
|
mock_unpack.side_effect = [(message_type, None), (id_reply, None),
|
|
(100, None), (4, None)]
|
|
|
|
response = dhcp._parse_dhcp_reply(data=fake_data, id_req=9999)
|
|
|
|
if message_type != 2:
|
|
self.assertEqual((False, {}), response)
|
|
elif id_reply != 9999:
|
|
self.assertEqual((False, {}), response)
|
|
elif fake_data[236:240] != dhcp._DHCP_COOKIE:
|
|
self.assertEqual((False, {}), response)
|
|
else:
|
|
self.assertEqual((True, {100: b'fake'}), response)
|
|
|
|
def test_parse_dhcp_reply(self):
|
|
self._test_parse_dhcp_reply(message_type=2, id_reply=9999,
|
|
equals_cookie=True)
|
|
|
|
def test_parse_dhcp_reply_false(self):
|
|
self._test_parse_dhcp_reply(message_type=2, id_reply=111,
|
|
equals_cookie=True)
|
|
|
|
def test_parse_dhcp_reply_cookie_false(self):
|
|
self._test_parse_dhcp_reply(message_type=2, id_reply=9999,
|
|
equals_cookie=False)
|
|
|
|
def test_parse_dhcp_reply_other_message_type(self):
|
|
self._test_parse_dhcp_reply(message_type=3, id_reply=9999,
|
|
equals_cookie=True)
|
|
|
|
def test_parse_dhcp_reply_other_reply(self):
|
|
self._test_parse_dhcp_reply(message_type=3, id_reply=111,
|
|
equals_cookie=True)
|
|
|
|
def test_parse_dhcp_reply_other_than_cookie(self):
|
|
self._test_parse_dhcp_reply(message_type=3, id_reply=111,
|
|
equals_cookie=False)
|
|
|
|
@mock.patch('random.randint')
|
|
@mock.patch('socket.socket')
|
|
@mock.patch('cloudbaseinit.utils.dhcp._get_dhcp_request_data')
|
|
@mock.patch('cloudbaseinit.utils.dhcp._parse_dhcp_reply')
|
|
@mock.patch('cloudbaseinit.osutils.factory.get_os_utils')
|
|
def test_get_dhcp_options(self, mock_get_os_utils,
|
|
mock_parse_dhcp_reply,
|
|
mock_get_dhcp_request_data,
|
|
mock_socket, mock_randint):
|
|
mock_randint.return_value = 'fake int'
|
|
mock_socket().getsockname.return_value = ['fake local ip']
|
|
mock_get_mac_address_by_local_ip = (
|
|
mock_get_os_utils.return_value.get_mac_address_by_local_ip)
|
|
mock_get_mac_address_by_local_ip.return_value = 'fake mac'
|
|
mock_get_dhcp_request_data.return_value = 'fake data'
|
|
mock_parse_dhcp_reply.return_value = (True, 'fake replied options')
|
|
|
|
response = dhcp.get_dhcp_options(
|
|
dhcp_host='fake host', requested_options=['fake option'])
|
|
|
|
mock_randint.assert_called_once_with(0, 2 ** 32 - 1)
|
|
mock_socket.assert_called_with(socket.AF_INET, socket.SOCK_DGRAM)
|
|
mock_socket().setsockopt.assert_called_once_with(
|
|
socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
|
mock_socket().bind.assert_called_once_with(('', 68))
|
|
mock_socket().settimeout.assert_called_once_with(5)
|
|
mock_socket().getsockname.assert_called_once_with()
|
|
mock_get_mac_address_by_local_ip.assert_called_once_with(
|
|
'fake local ip')
|
|
mock_get_dhcp_request_data.assert_called_once_with('fake int',
|
|
'fake mac',
|
|
['fake option'],
|
|
'cloudbase-init')
|
|
mock_socket().sendto.assert_called_once_with(
|
|
'fake data', ('fake host', 67))
|
|
mock_socket().recv.assert_called_once_with(1024)
|
|
mock_parse_dhcp_reply.assert_called_once_with(mock_socket().recv(),
|
|
'fake int')
|
|
mock_socket().close.assert_called_once_with()
|
|
self.assertEqual('fake replied options', response)
|
|
|
|
@mock.patch('cloudbaseinit.utils.dhcp._bind_dhcp_client_socket')
|
|
def test_get_dhcp_options_timeout(self, mock_client_socket):
|
|
mock_client_socket.side_effect = [socket.timeout]
|
|
dhcp.get_dhcp_options(dhcp_host='fake host',
|
|
requested_options=['fake option'])
|
|
|
|
def test__bind_dhcp_client_socket_bind_succeeds(self):
|
|
mock_socket = mock.Mock()
|
|
dhcp._bind_dhcp_client_socket(mock_socket, 0, 0)
|
|
|
|
mock_socket.bind.assert_called_once_with(('', 68))
|
|
|
|
@mock.patch('time.sleep')
|
|
def test__bind_dhcp_client_socket(self, mock_time_sleep):
|
|
mock_socket = mock.Mock()
|
|
exc = socket.error()
|
|
exc.errno = 48
|
|
mock_socket.bind = mock.Mock(side_effect=exc)
|
|
|
|
with testutils.LogSnatcher('cloudbaseinit.utils.dhcp') as snatcher:
|
|
with self.assertRaises(socket.error):
|
|
dhcp._bind_dhcp_client_socket(
|
|
mock_socket, max_bind_attempts=4,
|
|
bind_retry_interval=mock.sentinel.bind_retry_interval)
|
|
|
|
expected_occurences = sum(
|
|
1 for item in snatcher.output
|
|
if item.startswith("Retrying to bind DHCP client port in "))
|
|
self.assertEqual(3, expected_occurences)
|