ae15fee086
Every meta data service should return bytes only for these capabilities:
* get_content
* get_user_data
While `_get_meta_data` and any other method derrived from it
(including public keys, certificates etc.) should return homogeneous
data types and only strings, not bytes.
The decoding procedure is handled at its roots, not in the plugins
and is done by only using `encoding.get_as_string` function.
Fixed bugs:
* invalid certificate splitting under maas service which usually
generated an extra invalid certificate (empty string + footer)
* text operations on bytes in maas and cloudstack (split, comparing)
* multiple types for certificates (now only strings)
* not receiving bytes from opennebula service when using `get_user_data`
(which leads to crash under later processing through io.BytesIO)
* erroneous certificate parsing/stripping/replacing under x509 importing
(footer remains, not all possible EOLs replaced as it should)
Also added new and refined actual misleading unittests.
Change-Id: I704c43f5f784458a881293d761a21e62aed85732
261 lines
10 KiB
Python
261 lines
10 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 functools
|
|
import posixpath
|
|
import unittest
|
|
|
|
try:
|
|
import unittest.mock as mock
|
|
except ImportError:
|
|
import mock
|
|
from oslo.config import cfg
|
|
|
|
from cloudbaseinit.metadata.services import base
|
|
from cloudbaseinit.metadata.services import baseopenstackservice
|
|
from cloudbaseinit.tests.metadata import fake_json_response
|
|
from cloudbaseinit.utils import x509constants
|
|
|
|
|
|
CONF = cfg.CONF
|
|
|
|
MODPATH = "cloudbaseinit.metadata.services.baseopenstackservice"
|
|
|
|
|
|
class TestBaseOpenStackService(unittest.TestCase):
|
|
|
|
def setUp(self):
|
|
CONF.set_override("retry_count_interval", 0)
|
|
self._service = baseopenstackservice.BaseOpenStackService()
|
|
date = "2013-04-04"
|
|
fake_metadata = fake_json_response.get_fake_metadata_json(date)
|
|
self._fake_network_config = fake_metadata["network_config"]
|
|
self._fake_content = self._fake_network_config["debian_config"]
|
|
self._fake_public_keys = fake_metadata["public_keys"]
|
|
self._fake_keys = fake_metadata["keys"]
|
|
self._partial_test_get_network_details = functools.partial(
|
|
self._test_get_network_details,
|
|
network_config=self._fake_network_config,
|
|
content=self._fake_content
|
|
)
|
|
|
|
@mock.patch(MODPATH +
|
|
".BaseOpenStackService._get_cache_data")
|
|
def test_get_content(self, mock_get_cache_data):
|
|
response = self._service.get_content('fake name')
|
|
path = posixpath.join('openstack', 'content', 'fake name')
|
|
mock_get_cache_data.assert_called_once_with(path)
|
|
self.assertEqual(mock_get_cache_data.return_value, response)
|
|
|
|
@mock.patch(MODPATH +
|
|
".BaseOpenStackService._get_cache_data")
|
|
def test_get_user_data(self, mock_get_cache_data):
|
|
response = self._service.get_user_data()
|
|
path = posixpath.join('openstack', 'latest', 'user_data')
|
|
mock_get_cache_data.assert_called_once_with(path)
|
|
self.assertEqual(mock_get_cache_data.return_value, response)
|
|
|
|
@mock.patch(MODPATH +
|
|
".BaseOpenStackService._get_cache_data")
|
|
def test_get_meta_data(self, mock_get_cache_data):
|
|
mock_get_cache_data.return_value = '{"fake": "data"}'
|
|
response = self._service._get_meta_data(
|
|
version='fake version')
|
|
path = posixpath.join('openstack', 'fake version', 'meta_data.json')
|
|
mock_get_cache_data.assert_called_with(path, decode=True)
|
|
self.assertEqual({"fake": "data"}, response)
|
|
|
|
@mock.patch(MODPATH +
|
|
".BaseOpenStackService._get_meta_data")
|
|
def test_get_instance_id(self, mock_get_meta_data):
|
|
response = self._service.get_instance_id()
|
|
mock_get_meta_data.assert_called_once_with()
|
|
mock_get_meta_data().get.assert_called_once_with('uuid')
|
|
self.assertEqual(mock_get_meta_data.return_value.get.return_value,
|
|
response)
|
|
|
|
@mock.patch(MODPATH +
|
|
".BaseOpenStackService._get_meta_data")
|
|
def test_get_host_name(self, mock_get_meta_data):
|
|
response = self._service.get_host_name()
|
|
mock_get_meta_data.assert_called_once_with()
|
|
mock_get_meta_data().get.assert_called_once_with('hostname')
|
|
self.assertEqual(mock_get_meta_data.return_value.get.return_value,
|
|
response)
|
|
|
|
@mock.patch(MODPATH +
|
|
".BaseOpenStackService._get_meta_data")
|
|
def test_get_public_keys(self, mock_get_meta_data):
|
|
mock_get_meta_data.return_value.get.side_effect = \
|
|
[self._fake_public_keys, self._fake_keys]
|
|
response = self._service.get_public_keys()
|
|
|
|
mock_get_meta_data.assert_called_once_with()
|
|
mock_get_meta_data.return_value.get.assert_any_call("public_keys")
|
|
mock_get_meta_data.return_value.get.assert_any_call("keys")
|
|
|
|
public_keys = (list(self._fake_public_keys.values()) +
|
|
[key["data"] for key in self._fake_keys
|
|
if key["type"] == "ssh"])
|
|
public_keys = [key.strip() for key in public_keys]
|
|
|
|
self.assertEqual(sorted(list(set(public_keys))),
|
|
sorted(response))
|
|
|
|
@mock.patch(MODPATH +
|
|
".BaseOpenStackService._get_meta_data")
|
|
def _test_get_admin_password(self, mock_get_meta_data, meta_data):
|
|
mock_get_meta_data.return_value = meta_data
|
|
response = self._service.get_admin_password()
|
|
mock_get_meta_data.assert_called_once_with()
|
|
if meta_data and 'admin_pass' in meta_data:
|
|
self.assertEqual(meta_data['admin_pass'], response)
|
|
elif meta_data and 'admin_pass' in meta_data.get('meta'):
|
|
self.assertEqual(meta_data.get('meta')['admin_pass'], response)
|
|
else:
|
|
self.assertIsNone(response)
|
|
|
|
def test_get_admin_pass(self):
|
|
self._test_get_admin_password(meta_data={'admin_pass': 'fake pass'})
|
|
|
|
def test_get_admin_pass_in_meta(self):
|
|
self._test_get_admin_password(
|
|
meta_data={'meta': {'admin_pass': 'fake pass'}})
|
|
|
|
def test_get_admin_pass_no_pass(self):
|
|
self._test_get_admin_password(meta_data={})
|
|
|
|
@mock.patch(MODPATH +
|
|
".BaseOpenStackService._get_meta_data")
|
|
@mock.patch(MODPATH +
|
|
".BaseOpenStackService.get_user_data")
|
|
def _test_get_client_auth_certs(self, mock_get_user_data,
|
|
mock_get_meta_data, meta_data,
|
|
ret_value=None):
|
|
mock_get_meta_data.return_value = meta_data
|
|
mock_get_user_data.side_effect = [ret_value]
|
|
response = self._service.get_client_auth_certs()
|
|
mock_get_meta_data.assert_called_once_with()
|
|
if isinstance(ret_value, bytes) and ret_value.startswith(
|
|
x509constants.PEM_HEADER.encode()):
|
|
mock_get_user_data.assert_called_once_with()
|
|
self.assertEqual([ret_value.decode()], response)
|
|
elif ret_value is base.NotExistingMetadataException:
|
|
self.assertFalse(response)
|
|
else:
|
|
expected = []
|
|
expectation = {
|
|
"meta": 'fake cert',
|
|
"keys": [key["data"].strip() for key in self._fake_keys
|
|
if key["type"] == "x509"]
|
|
}
|
|
for field, value in expectation.items():
|
|
if field in meta_data:
|
|
expected.extend(value if isinstance(value, list)
|
|
else [value])
|
|
self.assertEqual(sorted(list(set(expected))), sorted(response))
|
|
|
|
def test_get_client_auth_certs(self):
|
|
self._test_get_client_auth_certs(
|
|
meta_data={'meta': {'admin_cert0': 'fake ',
|
|
'admin_cert1': 'cert'},
|
|
"keys": self._fake_keys})
|
|
|
|
def test_get_client_auth_certs_no_cert_data(self):
|
|
self._test_get_client_auth_certs(
|
|
meta_data={}, ret_value=x509constants.PEM_HEADER.encode())
|
|
|
|
def test_get_client_auth_certs_no_cert_data_exception(self):
|
|
self._test_get_client_auth_certs(
|
|
meta_data={}, ret_value=base.NotExistingMetadataException)
|
|
|
|
@mock.patch(MODPATH +
|
|
".BaseOpenStackService.get_content")
|
|
@mock.patch(MODPATH +
|
|
".BaseOpenStackService._get_meta_data")
|
|
def _test_get_network_details(self,
|
|
mock_get_meta_data,
|
|
mock_get_content,
|
|
network_config=None,
|
|
content=None,
|
|
search_fail=False,
|
|
no_path=False):
|
|
# mock obtained data
|
|
mock_get_meta_data().get.return_value = network_config
|
|
mock_get_content.return_value = content
|
|
# actual tests
|
|
if search_fail:
|
|
ret = self._service.get_network_details()
|
|
self.assertFalse(ret)
|
|
return
|
|
ret = self._service.get_network_details()
|
|
mock_get_meta_data().get.assert_called_once_with("network_config")
|
|
if network_config and not no_path:
|
|
mock_get_content.assert_called_once_with("network")
|
|
if not network_config:
|
|
self.assertIsNone(ret)
|
|
return
|
|
if no_path:
|
|
self.assertIsNone(ret)
|
|
return
|
|
# check returned NICs details
|
|
nic0 = base.NetworkDetails(
|
|
fake_json_response.NAME0,
|
|
fake_json_response.MAC0.upper(),
|
|
fake_json_response.ADDRESS0,
|
|
fake_json_response.ADDRESS60,
|
|
fake_json_response.NETMASK0,
|
|
fake_json_response.NETMASK60,
|
|
fake_json_response.BROADCAST0,
|
|
fake_json_response.GATEWAY0,
|
|
fake_json_response.GATEWAY60,
|
|
fake_json_response.DNSNS0.split()
|
|
)
|
|
nic1 = base.NetworkDetails(
|
|
fake_json_response.NAME1,
|
|
None,
|
|
fake_json_response.ADDRESS1,
|
|
fake_json_response.ADDRESS61,
|
|
fake_json_response.NETMASK1,
|
|
fake_json_response.NETMASK61,
|
|
fake_json_response.BROADCAST1,
|
|
fake_json_response.GATEWAY1,
|
|
fake_json_response.GATEWAY61,
|
|
None
|
|
)
|
|
self.assertEqual([nic0, nic1], ret)
|
|
|
|
def test_get_network_details_no_config(self):
|
|
self._partial_test_get_network_details(
|
|
network_config=None
|
|
)
|
|
|
|
def test_get_network_details_no_path(self):
|
|
self._fake_network_config.pop("content_path", None)
|
|
self._partial_test_get_network_details(
|
|
network_config=self._fake_network_config,
|
|
no_path=True
|
|
)
|
|
|
|
def test_get_network_details_search_fail(self):
|
|
self._fake_content = "invalid format"
|
|
self._partial_test_get_network_details(
|
|
content=self._fake_content,
|
|
search_fail=True
|
|
)
|
|
|
|
def test_get_network_details(self):
|
|
self._partial_test_get_network_details()
|