summaryrefslogtreecommitdiff
path: root/ironic/tests/common/test_keystone.py
blob: f3e3b4cbb76fbf8ebec40f21d96c145de3ff17cc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# -*- encoding: utf-8 -*-
#
#    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.

from keystoneclient import exceptions as ksexception
import mock

from ironic.common import exception
from ironic.common import keystone
from ironic.tests import base


class FakeCatalog(object):
    def url_for(self, **kwargs):
        return 'fake-url'


class FakeAccessInfo(object):
    def will_expire_soon(self):
        pass


class FakeClient(object):
    def __init__(self, **kwargs):
        self.service_catalog = FakeCatalog()
        self.auth_ref = FakeAccessInfo()

    def has_service_catalog(self):
        return True


class KeystoneTestCase(base.TestCase):

    def setUp(self):
        super(KeystoneTestCase, self).setUp()
        self.config(group='keystone_authtoken',
                    auth_uri='http://127.0.0.1:9898/',
                    admin_user='fake', admin_password='fake',
                    admin_tenant_name='fake')
        self.config(group='keystone', region_name='fake')
        keystone._KS_CLIENT = None

    def test_failure_authorization(self):
        self.assertRaises(exception.KeystoneFailure, keystone.get_service_url)

    @mock.patch.object(FakeCatalog, 'url_for', autospec=True)
    @mock.patch('keystoneclient.v2_0.client.Client', autospec=True)
    def test_get_url(self, mock_ks, mock_uf):
        fake_url = 'http://127.0.0.1:6385'
        mock_uf.return_value = fake_url
        mock_ks.return_value = FakeClient()
        res = keystone.get_service_url()
        self.assertEqual(fake_url, res)

    @mock.patch.object(FakeCatalog, 'url_for', autospec=True)
    @mock.patch('keystoneclient.v2_0.client.Client', autospec=True)
    def test_url_not_found(self, mock_ks, mock_uf):
        mock_uf.side_effect = ksexception.EndpointNotFound
        mock_ks.return_value = FakeClient()
        self.assertRaises(exception.CatalogNotFound, keystone.get_service_url)

    @mock.patch.object(FakeClient, 'has_service_catalog', autospec=True)
    @mock.patch('keystoneclient.v2_0.client.Client', autospec=True)
    def test_no_catalog(self, mock_ks, mock_hsc):
        mock_hsc.return_value = False
        mock_ks.return_value = FakeClient()
        self.assertRaises(exception.KeystoneFailure, keystone.get_service_url)

    @mock.patch('keystoneclient.v2_0.client.Client', autospec=True)
    def test_unauthorized(self, mock_ks):
        mock_ks.side_effect = ksexception.Unauthorized
        self.assertRaises(exception.KeystoneUnauthorized,
                          keystone.get_service_url)

    def test_get_service_url_fail_missing_auth_uri(self):
        self.config(group='keystone_authtoken', auth_uri=None)
        self.assertRaises(exception.KeystoneFailure,
                          keystone.get_service_url)

    @mock.patch('keystoneclient.v2_0.client.Client', autospec=True)
    def test_get_service_url_versionless_v2(self, mock_ks):
        mock_ks.return_value = FakeClient()
        self.config(group='keystone_authtoken', auth_uri='http://127.0.0.1')
        expected_url = 'http://127.0.0.1/v2.0'
        keystone.get_service_url()
        mock_ks.assert_called_once_with(username='fake', password='fake',
                                        tenant_name='fake',
                                        region_name='fake',
                                        auth_url=expected_url)

    @mock.patch('keystoneclient.v3.client.Client', autospec=True)
    def test_get_service_url_versionless_v3(self, mock_ks):
        mock_ks.return_value = FakeClient()
        self.config(group='keystone_authtoken', auth_version='v3.0',
                    auth_uri='http://127.0.0.1')
        expected_url = 'http://127.0.0.1/v3'
        keystone.get_service_url()
        mock_ks.assert_called_once_with(username='fake', password='fake',
                                        tenant_name='fake',
                                        region_name='fake',
                                        auth_url=expected_url)

    @mock.patch('keystoneclient.v2_0.client.Client', autospec=True)
    def test_get_service_url_version_override(self, mock_ks):
        mock_ks.return_value = FakeClient()
        self.config(group='keystone_authtoken',
                    auth_uri='http://127.0.0.1/v2.0/')
        expected_url = 'http://127.0.0.1/v2.0'
        keystone.get_service_url()
        mock_ks.assert_called_once_with(username='fake', password='fake',
                                        tenant_name='fake',
                                        region_name='fake',
                                        auth_url=expected_url)

    @mock.patch('keystoneclient.v2_0.client.Client', autospec=True)
    def test_get_admin_auth_token(self, mock_ks):
        fake_client = FakeClient()
        fake_client.auth_token = '123456'
        mock_ks.return_value = fake_client
        self.assertEqual('123456', keystone.get_admin_auth_token())

    @mock.patch('keystoneclient.v2_0.client.Client', autospec=True)
    def test_get_region_name_v2(self, mock_ks):
        mock_ks.return_value = FakeClient()
        self.config(group='keystone', region_name='fake_region')
        expected_url = 'http://127.0.0.1:9898/v2.0'
        expected_region = 'fake_region'
        keystone.get_service_url()
        mock_ks.assert_called_once_with(username='fake', password='fake',
                                        tenant_name='fake',
                                        region_name=expected_region,
                                        auth_url=expected_url)

    @mock.patch('keystoneclient.v3.client.Client', autospec=True)
    def test_get_region_name_v3(self, mock_ks):
        mock_ks.return_value = FakeClient()
        self.config(group='keystone', region_name='fake_region')
        self.config(group='keystone_authtoken', auth_version='v3.0')
        expected_url = 'http://127.0.0.1:9898/v3'
        expected_region = 'fake_region'
        keystone.get_service_url()
        mock_ks.assert_called_once_with(username='fake', password='fake',
                                        tenant_name='fake',
                                        region_name=expected_region,
                                        auth_url=expected_url)

    @mock.patch('keystoneclient.v2_0.client.Client', autospec=True)
    def test_cache_client_init(self, mock_ks):
        fake_client = FakeClient()
        mock_ks.return_value = fake_client
        self.assertEqual(fake_client, keystone._get_ksclient())
        self.assertEqual(fake_client, keystone._KS_CLIENT)
        self.assertEqual(1, mock_ks.call_count)

    @mock.patch.object(FakeAccessInfo, 'will_expire_soon', autospec=True)
    @mock.patch('keystoneclient.v2_0.client.Client', autospec=True)
    def test_cache_client_cached(self, mock_ks, mock_expire):
        mock_expire.return_value = False
        fake_client = FakeClient()
        keystone._KS_CLIENT = fake_client
        self.assertEqual(fake_client, keystone._get_ksclient())
        self.assertEqual(fake_client, keystone._KS_CLIENT)
        self.assertFalse(mock_ks.called)

    @mock.patch.object(FakeAccessInfo, 'will_expire_soon', autospec=True)
    @mock.patch('keystoneclient.v2_0.client.Client', autospec=True)
    def test_cache_client_expired(self, mock_ks, mock_expire):
        mock_expire.return_value = True
        fake_client = FakeClient()
        keystone._KS_CLIENT = fake_client
        new_client = FakeClient()
        mock_ks.return_value = new_client
        self.assertEqual(new_client, keystone._get_ksclient())
        self.assertEqual(new_client, keystone._KS_CLIENT)
        self.assertEqual(1, mock_ks.call_count)