Source code for ironicclient.tests.unit.osc.test_plugin

#   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 argparse

import mock
import testtools

from ironicclient.common import http
from ironicclient.osc import plugin
from ironicclient.tests.unit.osc import fakes
from ironicclient.v1 import client


[docs]class MakeClientTest(testtools.TestCase):

[docs]    @mock.patch.object(plugin.utils, 'env', lambda x: None)
    @mock.patch.object(plugin, 'OS_BAREMETAL_API_VERSION_SPECIFIED', new=True)
    @mock.patch.object(plugin.LOG, 'warning', autospec=True)
    @mock.patch.object(client, 'Client', autospec=True)
    def test_make_client(self, mock_client, mock_warning):
        instance = fakes.FakeClientManager()
        instance.get_endpoint_for_service_type = mock.Mock(
            return_value='endpoint')
        plugin.make_client(instance)
        mock_client.assert_called_once_with(os_ironic_api_version='1.6',
                                            session=instance.session,
                                            region_name=instance._region_name,
                                            endpoint='endpoint')
        self.assertFalse(mock_warning.called)
        instance.get_endpoint_for_service_type.assert_called_once_with(
            'baremetal', region_name=instance._region_name,
            interface=instance.interface)

[docs]    @mock.patch.object(plugin.utils, 'env', lambda x: None)
    @mock.patch.object(plugin, 'OS_BAREMETAL_API_VERSION_SPECIFIED', new=False)
    @mock.patch.object(plugin.LOG, 'warning', autospec=True)
    @mock.patch.object(client, 'Client', autospec=True)
    def test_make_client_log_warning_no_version_specified(self, mock_client,
                                                          mock_warning):
        instance = fakes.FakeClientManager()
        instance.get_endpoint_for_service_type = mock.Mock(
            return_value='endpoint')
        instance._api_version = {'baremetal': http.DEFAULT_VER}
        plugin.make_client(instance)
        mock_client.assert_called_once_with(
            os_ironic_api_version=http.DEFAULT_VER,
            session=instance.session,
            region_name=instance._region_name,
            endpoint='endpoint')
        self.assertTrue(mock_warning.called)
        instance.get_endpoint_for_service_type.assert_called_once_with(
            'baremetal', region_name=instance._region_name,
            interface=instance.interface)

[docs]    @mock.patch.object(plugin.utils, 'env', lambda x: '1.29')
    @mock.patch.object(plugin, 'OS_BAREMETAL_API_VERSION_SPECIFIED', new=False)
    @mock.patch.object(plugin.LOG, 'warning', autospec=True)
    @mock.patch.object(client, 'Client', autospec=True)
    def test_make_client_version_from_env_no_warning(self, mock_client,
                                                     mock_warning):
        instance = fakes.FakeClientManager()
        instance.get_endpoint_for_service_type = mock.Mock(
            return_value='endpoint')
        plugin.make_client(instance)
        self.assertFalse(mock_warning.called)


[docs]class BuildOptionParserTest(testtools.TestCase):

[docs]    @mock.patch.object(plugin.utils, 'env', lambda x: None)
    @mock.patch.object(argparse.ArgumentParser, 'add_argument')
    def test_build_option_parser(self, mock_add_argument):
        parser = argparse.ArgumentParser()
        mock_add_argument.reset_mock()
        plugin.build_option_parser(parser)
        version_list = ['1'] + ['1.%d' % i for i in range(
            1, plugin.LAST_KNOWN_API_VERSION + 1)] + ['latest']
        mock_add_argument.assert_called_once_with(
            '--os-baremetal-api-version', action=plugin.ReplaceLatestVersion,
            choices=version_list, default=http.DEFAULT_VER, help=mock.ANY,
            metavar='<baremetal-api-version>')

[docs]    @mock.patch.object(plugin.utils, 'env', lambda x: "latest")
    @mock.patch.object(argparse.ArgumentParser, 'add_argument')
    def test_build_option_parser_env_latest(self, mock_add_argument):
        parser = argparse.ArgumentParser()
        mock_add_argument.reset_mock()
        plugin.build_option_parser(parser)
        version_list = ['1'] + ['1.%d' % i for i in range(
            1, plugin.LAST_KNOWN_API_VERSION + 1)] + ['latest']
        mock_add_argument.assert_called_once_with(
            '--os-baremetal-api-version', action=plugin.ReplaceLatestVersion,
            choices=version_list, default=plugin.LATEST_VERSION, help=mock.ANY,
            metavar='<baremetal-api-version>')

[docs]    @mock.patch.object(plugin.utils, 'env')
    def test__get_environment_version(self, mock_utils_env):
        mock_utils_env.return_value = 'latest'
        result = plugin._get_environment_version(None)
        self.assertEqual(plugin.LATEST_VERSION, result)

        mock_utils_env.return_value = None
        result = plugin._get_environment_version('1.22')
        self.assertEqual("1.22", result)

        mock_utils_env.return_value = "1.23"
        result = plugin._get_environment_version('1.9')
        self.assertEqual("1.23", result)


[docs]class ReplaceLatestVersionTest(testtools.TestCase):

[docs]    @mock.patch.object(plugin.utils, 'env', lambda x: None)
    def test___call___latest(self):
        parser = argparse.ArgumentParser()
        plugin.build_option_parser(parser)
        namespace = argparse.Namespace()
        parser.parse_known_args(['--os-baremetal-api-version', 'latest'],
                                namespace)
        self.assertEqual(plugin.LATEST_VERSION,
                         namespace.os_baremetal_api_version)
        self.assertTrue(plugin.OS_BAREMETAL_API_VERSION_SPECIFIED)

[docs]    @mock.patch.object(plugin.utils, 'env', lambda x: None)
    def test___call___specific_version(self):
        parser = argparse.ArgumentParser()
        plugin.build_option_parser(parser)
        namespace = argparse.Namespace()
        parser.parse_known_args(['--os-baremetal-api-version', '1.4'],
                                namespace)
        self.assertEqual('1.4', namespace.os_baremetal_api_version)
        self.assertTrue(plugin.OS_BAREMETAL_API_VERSION_SPECIFIED)