Closing keystone sessions after done with them.
[snaps.git] / snaps / openstack / utils / tests / keystone_utils_tests.py
1 # Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
2 #                    and others.  All rights reserved.
3 #
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at:
7 #
8 #     http://www.apache.org/licenses/LICENSE-2.0
9 #
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
15 import uuid
16
17 from snaps.config.project import ProjectConfig
18 from snaps.config.user import UserConfig
19 from snaps.openstack.tests.os_source_file_test import OSComponentTestCase
20 from snaps.openstack.utils import keystone_utils, neutron_utils
21
22 __author__ = 'spisarski'
23
24
25 class KeystoneSmokeTests(OSComponentTestCase):
26     """
27     Tests to ensure that the neutron client can communicate with the cloud
28     """
29
30     def test_keystone_connect_success(self):
31         """
32         Tests to ensure that the proper credentials can connect.
33         """
34         keystone = keystone_utils.keystone_client(
35             self.os_creds, self.os_session)
36
37         users = keystone.users.list()
38         self.assertIsNotNone(users)
39
40     def test_keystone_connect_fail(self):
41         """
42         Tests to ensure that the improper credentials cannot connect.
43         """
44         from snaps.openstack.os_credentials import OSCreds
45
46         with self.assertRaises(Exception):
47             keystone = keystone_utils.keystone_client(OSCreds(
48                 username='user', password='pass', auth_url='url',
49                 project_name='project'))
50             keystone.users.list()
51
52
53 class KeystoneUtilsTests(OSComponentTestCase):
54     """
55     Test for the CreateImage class defined in create_image.py
56     """
57
58     def setUp(self):
59         """
60         Instantiates the CreateImage object that is responsible for downloading
61         and creating an OS image file within OpenStack
62         """
63         self.guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
64         self.username = self.guid + '-username'
65         self.user = None
66
67         self.project_name = self.guid + '-projName'
68         self.project = None
69         self.role = None
70         self.keystone = keystone_utils.keystone_client(
71             self.os_creds, self.os_session)
72
73     def tearDown(self):
74         """
75         Cleans the remote OpenStack objects
76         """
77         if self.project:
78             neutron = neutron_utils.neutron_client(
79                 self.os_creds, self.os_session)
80             default_sec_grp = neutron_utils.get_security_group(
81                 neutron, self.keystone, sec_grp_name='default',
82                 project_name=self.os_creds.project_name)
83             if default_sec_grp:
84                 try:
85                     neutron_utils.delete_security_group(
86                         neutron, default_sec_grp)
87                 except:
88                     pass
89
90             keystone_utils.delete_project(self.keystone, self.project)
91
92         if self.user:
93             keystone_utils.delete_user(self.keystone, self.user)
94
95         if self.role:
96             keystone_utils.delete_role(self.keystone, self.role)
97
98         super(self.__class__, self).__clean__()
99
100     def test_create_user_minimal(self):
101         """
102         Tests the keystone_utils.create_user() function
103         """
104         user_settings = UserConfig(
105             name=self.username,
106             password=str(uuid.uuid4()),
107             domain_name=self.os_creds.user_domain_name)
108         self.user = keystone_utils.create_user(self.keystone, user_settings)
109         self.assertEqual(self.username, self.user.name)
110
111         user = keystone_utils.get_user(self.keystone, self.username)
112         self.assertIsNotNone(user)
113         self.assertEqual(self.user, user)
114
115     def test_create_project_minimal(self):
116         """
117         Tests the keyston_utils.create_project() funtion
118         """
119         project_settings = ProjectConfig(
120             name=self.project_name, domain=self.os_creds.project_domain_name)
121         self.project = keystone_utils.create_project(self.keystone,
122                                                      project_settings)
123         self.assertEqual(self.project_name, self.project.name)
124
125         project = keystone_utils.get_project(
126             keystone=self.keystone, project_settings=project_settings)
127         self.assertIsNotNone(project)
128         self.assertEqual(self.project_name, self.project.name)
129
130         domain = keystone_utils.get_domain_by_id(
131             self.keystone, project.domain_id)
132         if self.keystone.version == keystone_utils.V2_VERSION_STR:
133             self.assertIsNone(domain)
134         else:
135             self.assertIsNotNone(domain)
136             self.assertEqual(domain.id, project.domain_id)
137
138     def test_get_endpoint_success(self):
139         """
140         Tests to ensure that proper credentials and proper service type can
141         succeed.
142         """
143         endpoint = keystone_utils.get_endpoint(self.os_creds,
144                                                service_type='identity')
145         self.assertIsNotNone(endpoint)
146
147     def test_get_endpoint_fail_without_proper_service(self):
148         """
149         Tests to ensure that proper credentials and improper service type
150         cannot succeed.
151         """
152         with self.assertRaises(Exception):
153             keystone_utils.get_endpoint(self.os_creds, service_type='glance')
154
155     def test_get_endpoint_fail_without_proper_credentials(self):
156         """
157         Tests to ensure that improper credentials and proper service type
158         cannot succeed.
159         """
160         from snaps.openstack.os_credentials import OSCreds
161
162         with self.assertRaises(Exception):
163             keystone_utils.get_endpoint(
164                 OSCreds(username='user', password='pass', auth_url='url',
165                         project_name='project'),
166                 service_type='image')
167
168     def test_get_endpoint_with_each_interface(self):
169         """
170         Tests to ensure that endpoint urls are obtained with
171         'public', 'internal' and 'admin' interface
172         """
173         endpoint_public = keystone_utils.get_endpoint(self.os_creds,
174                                                       service_type='image',
175                                                       interface='public')
176         endpoint_internal = keystone_utils.get_endpoint(self.os_creds,
177                                                         service_type='image',
178                                                         interface='internal')
179         endpoint_admin = keystone_utils.get_endpoint(self.os_creds,
180                                                      service_type='image',
181                                                      interface='admin')
182         self.assertIsNotNone(endpoint_public)
183         self.assertIsNotNone(endpoint_internal)
184         self.assertIsNotNone(endpoint_admin)
185
186     def test_grant_user_role_to_project(self):
187         """
188         Tests the keystone_utils function grant_user_role_to_project()
189         :return:
190         """
191         user_settings = UserConfig(
192             name=self.username, password=str(uuid.uuid4()),
193             domain_name=self.os_creds.user_domain_name)
194         self.user = keystone_utils.create_user(self.keystone, user_settings)
195         self.assertEqual(self.username, self.user.name)
196
197         project_settings = ProjectConfig(
198             name=self.project_name, domain=self.os_creds.project_domain_name)
199         self.project = keystone_utils.create_project(self.keystone,
200                                                      project_settings)
201         self.assertEqual(self.project_name, self.project.name)
202
203         role_name = self.guid + '-role'
204         self.role = keystone_utils.create_role(self.keystone, role_name)
205         self.assertEqual(role_name, self.role.name)
206
207         keystone_utils.grant_user_role_to_project(
208             self.keystone, self.role, self.user, self.project)
209
210         user_roles = keystone_utils.get_roles_by_user(
211             self.keystone, self.user, self.project)
212         self.assertIsNotNone(user_roles)
213         self.assertEqual(1, len(user_roles))
214         self.assertEqual(self.role.id, user_roles[0].id)